Skip to content

Commit

Permalink
Merge branch 'master' into feature/new-reader-v3
Browse files Browse the repository at this point in the history
# Conflicts:
#	MetadataExtractor/IO/BufferBoundsException.cs
  • Loading branch information
kwhopper committed Nov 8, 2020
2 parents e494571 + c8c1ef1 commit f757004
Show file tree
Hide file tree
Showing 178 changed files with 20,069 additions and 912 deletions.
227 changes: 227 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,230 @@ indent_size = 4
indent_style = space
trim_trailing_whitespace = true
insert_final_newline = true

##### Microsoft.CodeAnalysis.CSharp.CodeStyle

# Newline settings
csharp_new_line_before_open_brace = all
csharp_new_line_before_else = true
csharp_new_line_before_catch = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_between_query_expression_clauses = true

# Indentation preferences
csharp_indent_block_contents = true
csharp_indent_braces = false
csharp_indent_case_contents = true
csharp_indent_case_contents_when_block = false
csharp_indent_switch_labels = true
csharp_indent_labels = flush_left

# Prefer "var" everywhere
csharp_style_var_for_built_in_types = true:suggestion
csharp_style_var_when_type_is_apparent = true:suggestion
csharp_style_var_elsewhere = true:suggestion

# Prefer method-like constructs to have a block body
csharp_style_expression_bodied_methods = false:none
csharp_style_expression_bodied_constructors = false:none
csharp_style_expression_bodied_operators = false:none

# Prefer property-like constructs to have an expression-body
csharp_style_expression_bodied_properties = true:none
csharp_style_expression_bodied_indexers = true:none
csharp_style_expression_bodied_accessors = true:none

# Suggest more modern language features when available
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_throw_expression = true:suggestion
csharp_style_conditional_delegate_call = true:suggestion

# Space preferences
csharp_space_after_cast = false
csharp_space_after_colon_in_inheritance_clause = true
csharp_space_after_comma = true
csharp_space_after_dot = false
csharp_space_after_keywords_in_control_flow_statements = true
csharp_space_after_semicolon_in_for_statement = true
csharp_space_around_binary_operators = before_and_after
csharp_space_around_declaration_statements = do_not_ignore
csharp_space_before_colon_in_inheritance_clause = true
csharp_space_before_comma = false
csharp_space_before_dot = false
csharp_space_before_open_square_brackets = false
csharp_space_before_semicolon_in_for_statement = false
csharp_space_between_empty_square_brackets = false
csharp_space_between_method_call_empty_parameter_list_parentheses = false
csharp_space_between_method_call_name_and_opening_parenthesis = false
csharp_space_between_method_call_parameter_list_parentheses = false
csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
csharp_space_between_method_declaration_name_and_open_parenthesis = false
csharp_space_between_method_declaration_parameter_list_parentheses = false
csharp_space_between_parentheses = false
csharp_space_between_square_brackets = false

# Blocks are allowed
csharp_prefer_braces = true:silent
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = true

# Use language keywords instead of framework type names for type references
dotnet_style_predefined_type_for_locals_parameters_members = true:error
dotnet_style_predefined_type_for_member_access = true:error

# Sort using and Import directives with System.* appearing first
dotnet_sort_system_directives_first = true
dotnet_separate_import_directive_groups = false

# Disallow "this." unless required
dotnet_style_qualification_for_field = false:error
dotnet_style_qualification_for_property = false:error
dotnet_style_qualification_for_method = false:error
dotnet_style_qualification_for_event = false:error

# IDE0004: Remove unnecessary cast
dotnet_diagnostic.IDE0004.severity = warning

# IDE0005: Remove unnecessary using directives
dotnet_diagnostic.IDE0005.severity = warning

# IDE0051: Remove unused private members (no reads or writes)
dotnet_diagnostic.IDE0051.severity = warning

# IDE0052: Remove unread private members (writes but no reads)
dotnet_diagnostic.IDE0052.severity = warning

# IDE0055: Fix formatting
dotnet_diagnostic.IDE0055.severity = warning

# IDE0066: Convert switch statement to expression
dotnet_diagnostic.IDE0066.severity = suggestion

# IDE0073: File header
dotnet_diagnostic.IDE0073.severity = error
file_header_template = Copyright (c) Drew Noakes and contributors. All Rights Reserved. Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.

##### Naming rules

# Non-private static fields are PascalCase
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.severity = error
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.symbols = non_private_static_fields
dotnet_naming_rule.non_private_static_fields_should_be_pascal_case.style = non_private_static_field_style

dotnet_naming_symbols.non_private_static_fields.applicable_kinds = field
dotnet_naming_symbols.non_private_static_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected
dotnet_naming_symbols.non_private_static_fields.required_modifiers = static

dotnet_naming_style.non_private_static_field_style.capitalization = pascal_case

# Non-private readonly fields are PascalCase
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.severity = error
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.symbols = non_private_readonly_fields
dotnet_naming_rule.non_private_readonly_fields_should_be_pascal_case.style = non_private_readonly_field_style

dotnet_naming_symbols.non_private_readonly_fields.applicable_kinds = field
dotnet_naming_symbols.non_private_readonly_fields.applicable_accessibilities = public, protected, internal, protected_internal, private_protected
dotnet_naming_symbols.non_private_readonly_fields.required_modifiers = readonly

dotnet_naming_style.non_private_readonly_field_style.capitalization = pascal_case

# Constants are PascalCase
dotnet_naming_rule.constants_should_be_pascal_case.severity = error
dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
dotnet_naming_rule.constants_should_be_pascal_case.style = constant_style

dotnet_naming_symbols.constants.applicable_kinds = field, local
dotnet_naming_symbols.constants.required_modifiers = const

dotnet_naming_style.constant_style.capitalization = pascal_case

# Static fields are camelCase and start with _
dotnet_naming_rule.static_fields_should_be_camel_case.severity = error
dotnet_naming_rule.static_fields_should_be_camel_case.symbols = static_fields
dotnet_naming_rule.static_fields_should_be_camel_case.style = static_field_style

dotnet_naming_symbols.static_fields.applicable_kinds = field
dotnet_naming_symbols.static_fields.required_modifiers = static

dotnet_naming_style.static_field_style.capitalization = camel_case
dotnet_naming_style.static_field_style.required_prefix = _

# Instance fields are camelCase and start with _
dotnet_naming_rule.instance_fields_should_be_camel_case.severity = error
dotnet_naming_rule.instance_fields_should_be_camel_case.symbols = instance_fields
dotnet_naming_rule.instance_fields_should_be_camel_case.style = instance_field_style

dotnet_naming_symbols.instance_fields.applicable_kinds = field

dotnet_naming_style.instance_field_style.capitalization = camel_case
dotnet_naming_style.instance_field_style.required_prefix = _

# Locals and parameters are camelCase
dotnet_naming_rule.locals_should_be_camel_case.severity = error
dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
dotnet_naming_rule.locals_should_be_camel_case.style = camel_case_style

dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local

dotnet_naming_style.camel_case_style.capitalization = camel_case

# Local functions are PascalCase
dotnet_naming_rule.local_functions_should_be_pascal_case.severity = error
dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
dotnet_naming_rule.local_functions_should_be_pascal_case.style = local_function_style

dotnet_naming_symbols.local_functions.applicable_kinds = local_function

dotnet_naming_style.local_function_style.capitalization = pascal_case

# By default, name items with PascalCase
dotnet_naming_rule.members_should_be_pascal_case.severity = error
dotnet_naming_rule.members_should_be_pascal_case.symbols = all_members
dotnet_naming_rule.members_should_be_pascal_case.style = pascal_case_style

dotnet_naming_symbols.all_members.applicable_kinds = *

dotnet_naming_style.pascal_case_style.capitalization = pascal_case

dotnet_diagnostic.IDE0001.severity = error # Simplify names
dotnet_diagnostic.IDE0002.severity = error # Simplify (member access)
dotnet_diagnostic.IDE0005.severity = error # Using directive is unnecessary
dotnet_diagnostic.IDE0030.severity = error # Use coalesce expression (nullable)
dotnet_diagnostic.IDE0030WithoutSuggestion.severity = error
dotnet_diagnostic.IDE1006.severity = error # Naming styles
dotnet_diagnostic.IDE1006WithoutSuggestion.severity = suggestion

dotnet_diagnostic.CA1028.severity = suggestion # Make enum underlying type Int32
dotnet_diagnostic.CA1031.severity = suggestion # Catch more specific exception type
dotnet_diagnostic.CA1032.severity = suggestion # Exceptions should have certain constructors
dotnet_diagnostic.CA1034.severity = suggestion # Do not nest public type
dotnet_diagnostic.CA1062.severity = suggestion # Validate args in externally visible members
dotnet_diagnostic.CA1707.severity = suggestion # Remove underscores from member name
dotnet_diagnostic.CA1716.severity = suggestion # Rename virtual/interface member to not use keyword (for consumers in other languages)
dotnet_diagnostic.CA1720.severity = suggestion # Identifier contains type name
dotnet_diagnostic.CA1815.severity = suggestion # Should override Equals/==/!=
dotnet_diagnostic.CA1819.severity = suggestion # Properties should not return arrays
dotnet_diagnostic.CA1822.severity = suggestion # Make member static
dotnet_diagnostic.CA1814.severity = suggestion # Replace multidimensional array with jagged array
dotnet_diagnostic.CA1812.severity = suggestion # Internal class is not instantiated
dotnet_diagnostic.CA1724.severity = suggestion # Type name conflicts with namespace

dotnet_diagnostic.CA1303.severity = none # Literal string should be localised

# working around bug
dotnet_diagnostic.RS0041.severity = none # Public members should not use oblivious types

# TODO review these diagnostics as many/all are probably valid, keep current output behavior (english text with localized numbers)
dotnet_diagnostic.CA1304.severity = none # Method behaviour depends upon user's locale (specify CultureInfo f.e. ToLower())
dotnet_diagnostic.CA1305.severity = none # Method behaviour depends upon user's locale (specify IFormatProvider f.e. ToString())
dotnet_diagnostic.CA1307.severity = none # Method behaviour depends upon user's locale (specify StringComparison f.e. StartsWith(), Equals())

# TODO fix these
dotnet_diagnostic.CA1825.severity = none # Avoid unnecessary zero-length array allocations

# TODO review these
dotnet_diagnostic.CA2000.severity = suggestion # Dispose disposables
4 changes: 2 additions & 2 deletions Directory.Build.props
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<Project>

<PropertyGroup>
<VersionPrefix>2.3.1</VersionPrefix>
<VersionPrefix>2.4.3</VersionPrefix>
<DebugType>portable</DebugType>
<LangVersion>preview</LangVersion>
<Nullable>enable</Nullable>
Expand All @@ -26,7 +26,7 @@
</ItemGroup>

<ItemGroup>
<None Include="$(MSBuildThisFileDirectory)\docs\metadata-extractor-logo-122.png" Pack="true" PackagePath="\" />
<None Include="$(MSBuildThisFileDirectory)docs\metadata-extractor-logo-122.png" Pack="true" PackagePath="\" />
</ItemGroup>

</Project>
2 changes: 1 addition & 1 deletion MetadataExtractor.PowerShell/ShowJpegStructure.cs
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ public JpegSegment(JpegSegmentType type, int length, int padding, long offset, s
[UsedImplicitly]
public sealed class ShowJpegStructure : PSCmdlet
{
private static readonly ByteTrie<string> _appSegmentByPreambleBytes = new ByteTrie<string>
private static readonly ByteTrie<string?> _appSegmentByPreambleBytes = new ByteTrie<string?>(null)
{
{ "Adobe", Encoding.UTF8.GetBytes(AdobeJpegReader.JpegSegmentPreamble) },
{ "Ducky", Encoding.UTF8.GetBytes(DuckyReader.JpegSegmentPreamble) },
Expand Down
67 changes: 38 additions & 29 deletions MetadataExtractor.Tests/DirectoryTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

using System;
using System.Diagnostics.CodeAnalysis;
using System.Globalization;
using System.Text;
using MetadataExtractor.Formats.Exif;
using Xunit;
Expand Down Expand Up @@ -85,31 +86,39 @@ public void SetAndGetIntArray()
Assert.Equal(outputString.ToString(), _directory.GetString(tagType));
}

[Fact]
public void SetStringAndGetDate()
[Theory]
#pragma warning disable format
[InlineData("2002:01:30 23:59:59", 2002, 1, 30, 23, 59, 59, 0, DateTimeKind.Unspecified)]
[InlineData("2002:01:30 23:59", 2002, 1, 30, 23, 59, 0, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01-30 23:59:59", 2002, 1, 30, 23, 59, 59, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01-30 23:59", 2002, 1, 30, 23, 59, 0, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01-30T23:59:59.099-08:00", 2002, 1, 31, 7, 59, 59, 99, DateTimeKind.Utc)]
[InlineData("2002-01-30T23:59:59.9", 2002, 1, 30, 23, 59, 59,900, DateTimeKind.Unspecified)]
[InlineData("2002-01-30T23:59:59.09", 2002, 1, 30, 23, 59, 59, 90, DateTimeKind.Unspecified)]
[InlineData("2002-01-30T23:59:59.099", 2002, 1, 30, 23, 59, 59, 99, DateTimeKind.Unspecified)]
[InlineData("2002-01-30T23:59:59-08:00", 2002, 1, 31, 7, 59, 59, 0, DateTimeKind.Utc)]
[InlineData("2002-01-30T23:59:59", 2002, 1, 30, 23, 59, 59, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01-30T23:59:59+0100", 2002, 1, 30, 22, 59, 59, 0, DateTimeKind.Utc)]
[InlineData("2002-01-30T23:59-08:00", 2002, 1, 31, 7, 59, 0, 0, DateTimeKind.Utc)]
[InlineData("2002-01-30T23:59", 2002, 1, 30, 23, 59, 0, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01-30", 2002, 1, 30, 0, 0, 0, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01", 2002, 1, 1, 0, 0, 0, 0, DateTimeKind.Unspecified)]
[InlineData("2002", 2002, 1, 1, 0, 0, 0, 0, DateTimeKind.Unspecified)]
[InlineData("2002-01-30T23:59:59.099-08:00", 2002, 1, 31, 7, 59, 59, 99, DateTimeKind.Utc, "ar")]
#pragma warning restore format
public void SetStringAndGetDate(string str, int year, int month, int day, int hour, int minute, int second, int milli, DateTimeKind kind, string? culture = null)
{
// ReSharper disable once UnusedParameter.Local
void Test(string str, DateTime expected)
{
_directory.Set(1, str);
Assert.Equal(expected, _directory.GetDateTime(1));
}
CultureInfo.CurrentCulture = string.IsNullOrWhiteSpace(culture) ? CultureInfo.CurrentCulture : CultureInfo.GetCultureInfo(culture);

// TODO revisit these commented cases and introduce GetDateTimeOffset impl/test
_directory.Set(1, str);

Test("2002:01:30 23:59:59", new DateTime(2002, 1, 30, 23, 59, 59, DateTimeKind.Unspecified));
Test("2002:01:30 23:59", new DateTime(2002, 1, 30, 23, 59, 0, DateTimeKind.Unspecified));
Test("2002-01-30 23:59:59", new DateTime(2002, 1, 30, 23, 59, 59, DateTimeKind.Unspecified));
Test("2002-01-30 23:59", new DateTime(2002, 1, 30, 23, 59, 0, DateTimeKind.Unspecified));
// test("2002-01-30T23:59:59.099-08:00", new DateTime(2002, 1, 30, 23, 59, 59, 99, DateTimeKind.Unspecified));
Test("2002-01-30T23:59:59.099", new DateTime(2002, 1, 30, 23, 59, 59, 99, DateTimeKind.Unspecified));
// test("2002-01-30T23:59:59-08:00", new DateTime(2002, 1, 30, 23, 59, 59, DateTimeKind.Unspecified));
Test("2002-01-30T23:59:59", new DateTime(2002, 1, 30, 23, 59, 59, DateTimeKind.Unspecified));
// test("2002-01-30T23:59-08:00", new DateTime(2002, 1, 30, 23, 59, 0, DateTimeKind.Unspecified));
Test("2002-01-30T23:59", new DateTime(2002, 1, 30, 23, 59, 0, DateTimeKind.Unspecified));
Test("2002-01-30", new DateTime(2002, 1, 30, 0, 0, 0, DateTimeKind.Unspecified));
Test("2002-01", new DateTime(2002, 1, 1, 0, 0, 0, DateTimeKind.Unspecified));
Test("2002", new DateTime(2002, 1, 1, 0, 0, 0, DateTimeKind.Unspecified));
var expected = new DateTime(year, month, day, hour, minute, second, milli, kind);
var actual = _directory.GetDateTime(1);

Assert.Equal(expected.Kind, actual.Kind);
Assert.Equal(expected, actual);

// TODO revisit these commented cases and introduce GetDateTimeOffset impl/test
}

[Fact]
Expand Down Expand Up @@ -151,13 +160,13 @@ public void GetNonExistentTagIsNullForAllTypes()
Assert.Null(_directory.GetRationalArray(ExifDirectoryBase.TagAperture));
Assert.Null(_directory.GetStringArray(ExifDirectoryBase.TagAperture));

Assert.False(_directory.TryGetBoolean(ExifDirectoryBase.TagAperture, out bool _));
Assert.False(_directory.TryGetDateTime(ExifDirectoryBase.TagAperture, out DateTime _));
Assert.False(_directory.TryGetDouble(ExifDirectoryBase.TagAperture, out double _));
Assert.False(_directory.TryGetInt32(ExifDirectoryBase.TagAperture, out int _));
Assert.False(_directory.TryGetInt64(ExifDirectoryBase.TagAperture, out long _));
Assert.False(_directory.TryGetRational(ExifDirectoryBase.TagAperture, out Rational _));
Assert.False(_directory.TryGetSingle(ExifDirectoryBase.TagAperture, out float _));
Assert.False(_directory.TryGetBoolean(ExifDirectoryBase.TagAperture, out _));
Assert.False(_directory.TryGetDateTime(ExifDirectoryBase.TagAperture, out _));
Assert.False(_directory.TryGetDouble(ExifDirectoryBase.TagAperture, out _));
Assert.False(_directory.TryGetInt32(ExifDirectoryBase.TagAperture, out _));
Assert.False(_directory.TryGetInt64(ExifDirectoryBase.TagAperture, out _));
Assert.False(_directory.TryGetRational(ExifDirectoryBase.TagAperture, out _));
Assert.False(_directory.TryGetSingle(ExifDirectoryBase.TagAperture, out _));
}

[Fact]
Expand Down
Loading

0 comments on commit f757004

Please sign in to comment.