Skip to content

Commit

Permalink
Implementation for map object from string (#11)
Browse files Browse the repository at this point in the history
* Implementation for map object from string

* remove unnecessary space

* fix ci dotnet compatibility

* fix test dotnet version

* Fix path

* Fix build

* add lgtm

* remover lgtm

* add test for read string

* Fix codacy issues

* Update code documentation on code

* add .editorconfig

* improve documentation part I

* Improving documentation

* improve layout
  • Loading branch information
Daniel-iel authored Dec 18, 2021
1 parent b9cbb7f commit 30cac66
Show file tree
Hide file tree
Showing 25 changed files with 809 additions and 132 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
dotnet-version: ['5.0.x']
dotnet-version: ['6.0.x']

steps:
- uses: actions/checkout@v2
Expand Down Expand Up @@ -73,7 +73,7 @@ jobs:
token: ${{secrets.CODECOV_TOKEN}}
directory: ${{ env.PROJECT_TEST }}
file: coverage.opencover.xml

- name: Publish Package ✉️
if: startsWith(github.ref, 'refs/tags/v')
run: nuget push **\*.nupkg -Source 'https://api.nuget.org/v3/index.json' -ApiKey ${{secrets.NUGET_TOKEN}}
219 changes: 219 additions & 0 deletions app/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,219 @@
# Remove the line below if you want to inherit .editorconfig settings from higher directories
root = true

# C# files
[*.cs]

#### Core EditorConfig Options ####

# Indentation and spacing
indent_size = 4
indent_style = space
tab_width = 4

# New line preferences
end_of_line = crlf
insert_final_newline = false

#### .NET Coding Conventions ####

# Organize usings
dotnet_separate_import_directive_groups = false
dotnet_sort_system_directives_first = false
file_header_template = unset

# this. and Me. preferences
dotnet_style_qualification_for_event = false
dotnet_style_qualification_for_field = false
dotnet_style_qualification_for_method = false
dotnet_style_qualification_for_property = false

# Language keywords vs BCL types preferences
dotnet_style_predefined_type_for_locals_parameters_members = true
dotnet_style_predefined_type_for_member_access = true

# Parentheses preferences
dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:warning
dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:warning
dotnet_style_parentheses_in_other_operators = never_if_unnecessary
dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:warning

# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members

# Expression-level preferences
dotnet_style_coalesce_expression = true:warning
dotnet_style_collection_initializer = true:silent
dotnet_style_explicit_tuple_names = true:error
dotnet_style_namespace_match_folder = true
dotnet_style_null_propagation = true:warning
dotnet_style_object_initializer = true:silent
dotnet_style_operator_placement_when_wrapping = beginning_of_line
dotnet_style_prefer_auto_properties = true:warning
dotnet_style_prefer_compound_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_assignment = true:error
dotnet_style_prefer_conditional_expression_over_return = true:error
dotnet_style_prefer_inferred_anonymous_type_member_names = true:warning
dotnet_style_prefer_inferred_tuple_names = true:warning
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:error
dotnet_style_prefer_simplified_boolean_expressions = true
dotnet_style_prefer_simplified_interpolation = true

# Field preferences
dotnet_style_readonly_field = true:warning

# Parameter preferences
dotnet_code_quality_unused_parameters = all

# Suppression preferences
dotnet_remove_unnecessary_suppression_exclusions = none

# New line preferences
dotnet_style_allow_multiple_blank_lines_experimental = false:warning
dotnet_style_allow_statement_immediately_after_block_experimental = false:warning

#### C# Coding Conventions ####

# var preferences
csharp_style_var_elsewhere = false
csharp_style_var_for_built_in_types = false
csharp_style_var_when_type_is_apparent = false

# Expression-bodied members
csharp_style_expression_bodied_accessors = true
csharp_style_expression_bodied_constructors = false
csharp_style_expression_bodied_indexers = true
csharp_style_expression_bodied_lambdas = true
csharp_style_expression_bodied_local_functions = false
csharp_style_expression_bodied_methods = false
csharp_style_expression_bodied_operators = false
csharp_style_expression_bodied_properties = true

# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true:warning
csharp_style_pattern_matching_over_is_with_cast_check = true:warning
csharp_style_prefer_not_pattern = true:warning
csharp_style_prefer_pattern_matching = true:suggestion
csharp_style_prefer_switch_expression = true:silent

# Null-checking preferences
csharp_style_conditional_delegate_call = true

# Modifier preferences
csharp_prefer_static_local_function = true
csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async

# Code-block preferences
csharp_prefer_braces = true:warning
csharp_prefer_simple_using_statement = true:warning
csharp_style_namespace_declarations = block_scoped:suggestion

# Expression-level preferences
csharp_prefer_simple_default_expression = true:warning
csharp_style_deconstructed_variable_declaration = true:error
csharp_style_implicit_object_creation_when_type_is_apparent = true:silent
csharp_style_inlined_variable_declaration = true:warning
csharp_style_pattern_local_over_anonymous_function = true:warning
csharp_style_prefer_index_operator = true:warning
csharp_style_prefer_null_check_over_type_check = true:error
csharp_style_prefer_range_operator = true:warning
csharp_style_throw_expression = true:silent
csharp_style_unused_value_assignment_preference = discard_variable:silent
csharp_style_unused_value_expression_statement_preference = discard_variable

# 'using' directive preferences
csharp_using_directive_placement = outside_namespace

# New line preferences
csharp_style_allow_blank_line_after_colon_in_constructor_initializer_experimental = false:warning
csharp_style_allow_blank_lines_between_consecutive_braces_experimental = true:warning
csharp_style_allow_embedded_statements_on_same_line_experimental = false:warning

#### C# Formatting Rules ####

# New line preferences
csharp_new_line_before_catch = true
csharp_new_line_before_else = true
csharp_new_line_before_finally = true
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_open_brace = all
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 = true
csharp_indent_labels = one_less_than_current
csharp_indent_switch_labels = true

# 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 = false
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

# Wrapping preferences
csharp_preserve_single_line_blocks = true
csharp_preserve_single_line_statements = true

#### Naming styles ####

# Naming rules

dotnet_naming_rule.interface_should_be_begins_with_i.severity = suggestion
dotnet_naming_rule.interface_should_be_begins_with_i.symbols = interface
dotnet_naming_rule.interface_should_be_begins_with_i.style = begins_with_i

dotnet_naming_rule.types_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.types_should_be_pascal_case.symbols = types
dotnet_naming_rule.types_should_be_pascal_case.style = pascal_case

dotnet_naming_rule.non_field_members_should_be_pascal_case.severity = suggestion
dotnet_naming_rule.non_field_members_should_be_pascal_case.symbols = non_field_members
dotnet_naming_rule.non_field_members_should_be_pascal_case.style = pascal_case

# Symbol specifications

dotnet_naming_symbols.interface.applicable_kinds = interface
dotnet_naming_symbols.interface.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.interface.required_modifiers =

dotnet_naming_symbols.types.applicable_kinds = class, struct, interface, enum
dotnet_naming_symbols.types.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.types.required_modifiers =

dotnet_naming_symbols.non_field_members.applicable_kinds = property, event, method
dotnet_naming_symbols.non_field_members.applicable_accessibilities = public, internal, private, protected, protected_internal, private_protected
dotnet_naming_symbols.non_field_members.required_modifiers =

# Naming styles

dotnet_naming_style.pascal_case.required_prefix =
dotnet_naming_style.pascal_case.required_suffix =
dotnet_naming_style.pascal_case.word_separator =
dotnet_naming_style.pascal_case.capitalization = pascal_case

dotnet_naming_style.begins_with_i.required_prefix = I
dotnet_naming_style.begins_with_i.required_suffix =
dotnet_naming_style.begins_with_i.word_separator =
dotnet_naming_style.begins_with_i.capitalization = pascal_case
13 changes: 7 additions & 6 deletions app/Spinner.Test/Attributes/ObjectMapperTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using Xunit;
using System;
using System.Linq;
using System.Reflection;

namespace Spinner.Test.Attributes
{
Expand All @@ -12,7 +13,7 @@ public class ObjectMapperTest
public void Should_ValidateHowManyContructorsExistsInObjectMapper()
{
// Arrange & Act
var constructors = FileInpect<ObjectMapper>.GetConstructors();
ConstructorInfo[] constructors = FileInpect<ObjectMapper>.GetConstructors();

// Assert
Assert.Single(constructors);
Expand All @@ -22,9 +23,9 @@ public void Should_ValidateHowManyContructorsExistsInObjectMapper()
public void Should_ValidateParansTypeAndNameOnConstructor()
{
// Arrange & Act
var constructors = FileInpect<ObjectMapper>.GetConstructors();
var firstConstructor = constructors[0];
var parameters = firstConstructor.GetParameters();
ConstructorInfo[] constructors = FileInpect<ObjectMapper>.GetConstructors();
ConstructorInfo firstConstructor = constructors[0];
ParameterInfo[] parameters = firstConstructor.GetParameters();

// Assert
Assert.Single(parameters);
Expand All @@ -37,9 +38,9 @@ public void Should_ValidateParansTypeAndNameOnConstructor()
public void Should_ValidateHowManyAttributesExistsInWritePropertyFile()
{
// Arrange & Act
var attibutes = FileInpect<ObjectMapper>.GetAttributes();
object[] attibutes = FileInpect<ObjectMapper>.GetAttributes();

var attributeUsage = attibutes.First() as AttributeUsageAttribute;
AttributeUsageAttribute attributeUsage = attibutes.First() as AttributeUsageAttribute;

// Assert
Assert.Single(attibutes);
Expand Down
53 changes: 53 additions & 0 deletions app/Spinner.Test/Attributes/ReadPropertyTest.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
using Spinner.Attribute;
using Spinner.Test.Helper;
using Xunit;
using System;
using System.Linq;
using System.Reflection;

namespace Spinner.Test.Attributes
{
public class ReadPropertyTest
{
[Fact]
public void Should_ValidateHowManyContructorsExistsInWritePropertyFile()
{
// Arrange & Act
ConstructorInfo[] constructors = FileInpect<ReadProperty>.GetConstructors();

// Assert
Assert.Single(constructors);
}

[Fact]
public void Should_ValidateParansTypeAndNameOfFirstConstructors()
{
// Arrange & Act
ConstructorInfo[] constructors = FileInpect<ReadProperty>.GetConstructors();
ConstructorInfo firstConstructor = constructors[0];
ParameterInfo[] parameters = firstConstructor.GetParameters();

// Assert
Assert.Equal(2, parameters.Length);

Assert.Equal("start", parameters[0].Name);
Assert.Equal(typeof(ushort), parameters[0].ParameterType);

Assert.Equal("lenght", parameters[1].Name);
Assert.Equal(typeof(ushort), parameters[1].ParameterType);
}

[Fact]
public void Should_ValidateHowManyAttributesExistsInWritePropertyFile()
{
// Arrange & Act
object[] attibutes = FileInpect<ReadProperty>.GetAttributes();

AttributeUsageAttribute attributeUsage = attibutes.First() as AttributeUsageAttribute;

// Assert
Assert.Single(attibutes);
Assert.Equal(AttributeTargets.Property, attributeUsage.ValidOn);
}
}
}
19 changes: 10 additions & 9 deletions app/Spinner.Test/Attributes/WritePropertyTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using Xunit;
using System;
using System.Linq;
using System.Reflection;

namespace Spinner.Test.Attributes
{
Expand All @@ -12,7 +13,7 @@ public class WritePropertyTest
public void Should_ValidateHowManyContructorsExistsInWritePropertyFile()
{
// Arrange & Act
var constructors = FileInpect<WriteProperty>.GetConstructors();
ConstructorInfo[] constructors = FileInpect<WriteProperty>.GetConstructors();

// Assert
Assert.Equal(2, constructors.Length);
Expand All @@ -22,9 +23,9 @@ public void Should_ValidateHowManyContructorsExistsInWritePropertyFile()
public void Should_ValidateParansTypeAndNameOfFirstConstructors()
{
// Arrange & Act
var constructors = FileInpect<WriteProperty>.GetConstructors();
var firstConstructor = constructors[0];
var parameters = firstConstructor.GetParameters();
ConstructorInfo[] constructors = FileInpect<WriteProperty>.GetConstructors();
ConstructorInfo firstConstructor = constructors[0];
ParameterInfo[] parameters = firstConstructor.GetParameters();

// Assert
Assert.Equal(3, parameters.Length);
Expand All @@ -43,9 +44,9 @@ public void Should_ValidateParansTypeAndNameOfFirstConstructors()
public void Should_ValidateParansTypeAndNameOfSecondConstructors()
{
// Arrange & Act
var constructors = FileInpect<WriteProperty>.GetConstructors();
var secondConstructor = constructors[1];
var parameters = secondConstructor.GetParameters();
ConstructorInfo[] constructors = FileInpect<WriteProperty>.GetConstructors();
ConstructorInfo secondConstructor = constructors[1];
ParameterInfo[] parameters = secondConstructor.GetParameters();

// Assert
Assert.Equal(4, parameters.Length);
Expand All @@ -64,9 +65,9 @@ public void Should_ValidateParansTypeAndNameOfSecondConstructors()
public void Should_ValidateHowManyAttributesExistsInWritePropertyFile()
{
// Arrange & Act
var attibutes = FileInpect<WriteProperty>.GetAttributes();
object[] attibutes = FileInpect<WriteProperty>.GetAttributes();

var attributeUsage = attibutes.First() as AttributeUsageAttribute;
AttributeUsageAttribute attributeUsage = attibutes.First() as AttributeUsageAttribute;

// Assert
Assert.Single(attibutes);
Expand Down
Loading

0 comments on commit 30cac66

Please sign in to comment.