Skip to content

Commit

Permalink
Updated package to support Umbraco 10
Browse files Browse the repository at this point in the history
- added nullable support
- added .editorconfig file
- updated Skybrud.Essentials dependency
  • Loading branch information
abjerner committed Sep 7, 2022
1 parent 29d0a00 commit 9ad2658
Show file tree
Hide file tree
Showing 4 changed files with 250 additions and 42 deletions.
211 changes: 211 additions & 0 deletions src/.editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,211 @@
# 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
trim_trailing_whitespace = true

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

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

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

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

# Modifier preferences
dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent

# Expression-level preferences
dotnet_style_coalesce_expression = true:suggestion
dotnet_style_collection_initializer = true:suggestion
dotnet_style_explicit_tuple_names = true:suggestion
dotnet_style_null_propagation = true:suggestion
dotnet_style_object_initializer = true:suggestion
dotnet_style_prefer_auto_properties = true:silent
dotnet_style_prefer_compound_assignment = true:suggestion
dotnet_style_prefer_conditional_expression_over_assignment = true:silent
dotnet_style_prefer_conditional_expression_over_return = true:silent
dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
dotnet_style_prefer_inferred_tuple_names = true:suggestion
dotnet_style_prefer_is_null_check_over_reference_equality_method = true:suggestion

# Field preferences
dotnet_style_readonly_field = true:suggestion

# Parameter preferences
dotnet_code_quality_unused_parameters = all:suggestion

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

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

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

# Pattern matching preferences
csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
csharp_style_prefer_switch_expression = true:suggestion

# Null-checking preferences
csharp_style_conditional_delegate_call = true:suggestion

# Modifier preferences
csharp_prefer_static_local_function = true:suggestion
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:silent
csharp_prefer_simple_using_statement = true:suggestion

# Expression-level preferences
csharp_prefer_simple_default_expression = true:suggestion
csharp_style_deconstructed_variable_declaration = true:suggestion
csharp_style_inlined_variable_declaration = true:suggestion
csharp_style_pattern_local_over_anonymous_function = true:suggestion
csharp_style_prefer_index_operator = true:suggestion
csharp_style_prefer_range_operator = true:suggestion
csharp_style_throw_expression = true:suggestion
csharp_style_unused_value_assignment_preference = discard_variable:suggestion
csharp_style_unused_value_expression_statement_preference = discard_variable:silent

# 'using' directive preferences
csharp_using_directive_placement = outside_namespace:warning

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

# New line preferences
csharp_new_line_before_catch = false
csharp_new_line_before_else = false
csharp_new_line_before_finally = false
csharp_new_line_before_members_in_anonymous_types = true
csharp_new_line_before_members_in_object_initializers = true
csharp_new_line_before_open_brace = none
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 = no_change
csharp_indent_switch_labels = true

# Space preferences
csharp_space_after_cast = true
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

# Define what we will treat as private fields
dotnet_naming_symbols.private_fields.applicable_kinds = field
dotnet_naming_symbols.private_fields.applicable_accessibilities = private

# Define rule that something must begin with an underscore and be in camel case
dotnet_naming_style.require_underscore_prefix_and_camel_case.required_prefix = _
dotnet_naming_style.require_underscore_prefix_and_camel_case.capitalization = camel_case

# Apply our rule to private fields
dotnet_naming_rule.private_fields_must_begin_with_underscore_and_be_in_camel_case.symbols = private_fields
dotnet_naming_rule.private_fields_must_begin_with_underscore_and_be_in_camel_case.style = require_underscore_prefix_and_camel_case
dotnet_naming_rule.private_fields_must_begin_with_underscore_and_be_in_camel_case.severity = warning
10 changes: 5 additions & 5 deletions src/Skybrud.Essentials.Umbraco/PublishedContentExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,13 @@ public static class PublishedContentExtensions {
/// has been found or the top of the tree has been reached. If none of the content items along the path specify
/// a culture, the default culture configured in Umbraco (typically <c>en-US</c>) will be used as fallback.</para>
/// </remarks>
public static CultureInfo GetCultureInfo(this IPublishedContent content, Uri uri = null) {
public static CultureInfo? GetCultureInfo(this IPublishedContent? content, Uri? uri = null) {

// If no content item is specified, we return the default culture
if (content == null) return null;

// Get culture code via Umbraco's extension method
string code = content.GetCultureFromDomains(uri);
string? code = content.GetCultureFromDomains(uri);

// If no culture code was found, try the parent node - otherwise return the matching CultureInfo
return string.IsNullOrWhiteSpace(code) ? GetCultureInfo(content.Parent, uri) : CultureInfo.GetCultureInfo(code);
Expand Down Expand Up @@ -77,16 +77,16 @@ public static CultureInfo GetCultureInfo(this IPublishedContent content, Uri uri
/// has been found or the top of the tree has been reached. If none of the content items along the path specify
/// a culture, the default culture configured in Umbraco (typically <c>en-US</c>) will be used as fallback.</para>
/// </remarks>
public static CultureInfo GetCultureInfo(this IPublishedContent content, IUmbracoContextAccessor umbracoContextAccessor, ISiteDomainMapper siteDomainMapper, Uri uri = null) {
public static CultureInfo? GetCultureInfo(this IPublishedContent? content, IUmbracoContextAccessor umbracoContextAccessor, ISiteDomainMapper siteDomainMapper, Uri? uri = null) {

// If no content item is specified, we return the default culture
if (content == null) {
IUmbracoContext ctx = umbracoContextAccessor.GetRequiredUmbracoContext();
return CultureInfo.GetCultureInfo(ctx.Domains.DefaultCulture);
return CultureInfo.GetCultureInfo(ctx.Domains!.DefaultCulture);
}

// Get culture code via Umbraco's extension method
string code = content.GetCultureFromDomains(umbracoContextAccessor, siteDomainMapper, uri);
string? code = content.GetCultureFromDomains(umbracoContextAccessor, siteDomainMapper, uri);

// If no culture code was found, try the parent node - otherwise return the matching CultureInfo
return string.IsNullOrWhiteSpace(code) ? GetCultureInfo(content.Parent, umbracoContextAccessor, siteDomainMapper, uri) : CultureInfo.GetCultureInfo(code);
Expand Down
40 changes: 15 additions & 25 deletions src/Skybrud.Essentials.Umbraco/Scheduling/TaskHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
using System.IO;
using System.Linq;
using System.Text;
using Microsoft.AspNetCore.Hosting;
using Skybrud.Essentials.Time;
using Umbraco.Cms.Core;
using Umbraco.Cms.Core.Hosting;
using Umbraco.Cms.Core.Extensions;
using Umbraco.Cms.Core.Services;
using Umbraco.Cms.Core.Sync;

Expand All @@ -17,7 +18,7 @@ public class TaskHelper {

private readonly IRuntimeState _runtimeState;
private readonly IServerRoleAccessor _serverRoleAccessor;
private readonly IHostingEnvironment _hostingEnvironment;
private readonly IWebHostEnvironment _webHostEnvironment;

#region Properties

Expand All @@ -40,11 +41,11 @@ public class TaskHelper {
/// </summary>
/// <param name="runtimeState">A reference to the current <see cref="IRuntimeState"/>.</param>
/// <param name="serverRoleAccessor">A reference to the current <see cref="IServerRoleAccessor"/>.</param>
/// <param name="hostingEnvironment">A reference to the current <see cref="IHostingEnvironment"/>.</param>
public TaskHelper(IRuntimeState runtimeState, IServerRoleAccessor serverRoleAccessor, IHostingEnvironment hostingEnvironment) {
/// <param name="webHostEnvironment">A reference to the current <see cref="IWebHostEnvironment"/>.</param>
public TaskHelper(IRuntimeState runtimeState, IServerRoleAccessor serverRoleAccessor, IWebHostEnvironment webHostEnvironment) {
_runtimeState = runtimeState;
_serverRoleAccessor = serverRoleAccessor;
_hostingEnvironment = hostingEnvironment;
_webHostEnvironment = webHostEnvironment;
}

#endregion
Expand All @@ -57,23 +58,12 @@ public TaskHelper(IRuntimeState runtimeState, IServerRoleAccessor serverRoleAcce
/// <param name="task">The task.</param>
/// <returns>The name of the task.</returns>
protected virtual string GetTaskName(object task) {

switch (task) {

case null:
throw new ArgumentNullException(nameof(task));

case string str:
return str;

case Type type:
return type.FullName;

default:
return task.GetType().FullName;

}

return task switch {
null => throw new ArgumentNullException(nameof(task)),
string str => str,
Type type => type.FullName!,
_ => task.GetType().FullName!
};
}

/// <summary>
Expand Down Expand Up @@ -107,7 +97,7 @@ public DateTime GetLastRunTimeUtc(object task) {
/// <param name="minute">The minute the task should run.</param>
/// <param name="weekdays">The days of the week the task should run.</param>
/// <returns><c>true</c> if the task should run; otherwise <c>false</c>.</returns>
public bool ShouldRun(object task, DateTime now, int hour, int minute, DayOfWeek[] weekdays) {
public bool ShouldRun(object task, DateTime now, int hour, int minute, DayOfWeek[]? weekdays) {

// Determine when the task is supposed to run on the current day
DateTime scheduled = new(now.Year, now.Month, now.Day, hour, minute, 0);
Expand Down Expand Up @@ -218,8 +208,8 @@ public void AppendToLog(object task, StringBuilder stringBuilder) {
/// <returns>The directory path for the task.</returns>
protected virtual string GetTaskDirectoryPath(string taskName) {
string directory = taskName.IndexOf("Limbo.", StringComparison.Ordinal) == 0 ? "Limbo" : "Skybrud";
string path = Path.Combine(Constants.SystemDirectories.Umbraco, directory, "Tasks", taskName);
return _hostingEnvironment.MapPathContentRoot(path);
string path = Path.Combine(Constants.SystemDirectories.Data, directory, "Tasks", taskName);
return _webHostEnvironment.MapPathContentRoot(path);
}

/// <summary>
Expand Down
31 changes: 19 additions & 12 deletions src/Skybrud.Essentials.Umbraco/Skybrud.Essentials.Umbraco.csproj
Original file line number Diff line number Diff line change
@@ -1,41 +1,48 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>net5.0</TargetFramework>
<TargetFramework>net6.0</TargetFramework>
<Nullable>enable</Nullable>
</PropertyGroup>

<PropertyGroup>
<Version>1.0.0-alpha002</Version>
<Version>2.0.0-alpha001</Version>
<Authors>Anders Bjerner</Authors>
<Company>Limbo</Company>
<Product>Skybrud.Essentials</Product>
<Description>Skybrud.Essentials addon for working with Umbraco 9.</Description>
<Description>Skybrud.Essentials addon for working with Umbraco 10.</Description>
<Copyright>Copyright © 2022</Copyright>
</PropertyGroup>

<!-- Information for the NuGet package -->
<PropertyGroup>
<PackageId>Skybrud.Essentials.Umbraco</PackageId>
<PackageTags>Skybrud, Limbo, Essentials, Umbraco</PackageTags>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://packages.skybrud.dk/skybrud.essentials.umbraco/</PackageProjectUrl>
<PackageIcon>Limbo.png</PackageIcon>
<PackageReadmeFile>NUGET.md</PackageReadmeFile>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/skybrud/Skybrud.Essentials.Umbraco</RepositoryUrl>
</PropertyGroup>

<!-- Include NuGet dependencies -->
<ItemGroup>
<PackageReference Include="Skybrud.Essentials" Version="1.1.34" />
<PackageReference Include="Umbraco.Cms.Core" Version="9.0.0" />
<PackageReference Include="Umbraco.Cms.Web.Website" Version="9.0.0" />
<PackageReference Include="Umbraco.Cms.Web.BackOffice" Version="9.0.0" />
<PackageReference Include="Skybrud.Essentials" Version="1.1.42" />
<PackageReference Include="Umbraco.Cms.Core" Version="10.0.0" />
<PackageReference Include="Umbraco.Cms.Web.Website" Version="10.0.0" />
<PackageReference Include="Umbraco.Cms.Web.BackOffice" Version="10.0.0" />
</ItemGroup>

<PropertyGroup>
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\Skybrud.Essentials.Umbraco.xml</DocumentationFile>
</PropertyGroup>

<!-- Include package icon for NuGet -->
<ItemGroup>
<None Include="../build/Limbo.png" Pack="true" PackagePath="\" />
<Content Include="../build/Limbo.png" Pack="true" PackagePath="\" />
<None Include="..\..\NUGET.md" Pack="true" PackagePath="\" />
</ItemGroup>

<!-- Generate XML documentation -->
<PropertyGroup>
<DocumentationFile>bin\$(Configuration)\$(TargetFramework)\$(AssemblyName).xml</DocumentationFile>
</PropertyGroup>

</Project>

0 comments on commit 9ad2658

Please sign in to comment.