Transliteration Refactoring

src/OrchardCore.Modules/OrchardCore.Liquid/Filters/SlugifyFilter.cs

@@ -14,9 +14,8 @@ public SlugifyFilter(ISlugService slugService)
     }
     public ValueTask<FluidValue> ProcessAsync(FluidValue input, FilterArguments arguments, LiquidTemplateContext ctx)
     {
-        var transliterateArg = arguments["transliterate"];
-        var transliterate = transliterateArg.IsNil() || transliterateArg.ToBooleanValue();
+        var slug = _slugService.Slugify(input.ToStringValue());
 
-        return new StringValue(_slugService.Slugify(input.ToStringValue(), transliterate));
+        return new StringValue(slug);
     }
 }

src/OrchardCore.Modules/OrchardCore.Liquid/OrchardCore.Liquid.csproj

@@ -24,6 +24,7 @@
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Module.Targets\OrchardCore.Module.Targets.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Shortcodes.Abstractions\OrchardCore.Shortcodes.Abstractions.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.ResourceManagement\OrchardCore.ResourceManagement.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Abstractions\OrchardCore.Abstractions.csproj" />
   </ItemGroup>
 
   <ItemGroup>

src/OrchardCore.Modules/OrchardCore.Liquid/Startup.cs

@@ -72,7 +72,6 @@ public override void ConfigureServices(IServiceCollection services)
         .AddLiquidFilter<LocalTimeZoneFilter>("local")
         .AddLiquidFilter<UtcTimeZoneFilter>("utc")
         .AddLiquidFilter<SlugifyFilter>("slugify")
-        .AddLiquidFilter<TransliterateFilter>("transliterate")
         .AddLiquidFilter<LiquidFilter>("liquid")
         .AddLiquidFilter<ContentUrlFilter>("href")
         .AddLiquidFilter<AbsoluteUrlFilter>("absolute_url")

src/OrchardCore.Modules/OrchardCore.Liquid/Filters/TransliterateFilter.cs → src/OrchardCore.Modules/OrchardCore.Localization/Liquid/TransliterateFilter.cs

@@ -1,8 +1,8 @@
-using AnyAscii;
 using Fluid;
 using Fluid.Values;
+using OrchardCore.Liquid;
 
-namespace OrchardCore.Liquid.Filters;
+namespace OrchardCore.Localization.Liquid.Filters;
 
 public class TransliterateFilter : ILiquidFilter
 {

src/OrchardCore.Modules/OrchardCore.Localization/Startup.cs

@@ -5,7 +5,9 @@
 using Microsoft.Extensions.Options;
 using OrchardCore.Admin.Models;
 using OrchardCore.DisplayManagement.Handlers;
+using OrchardCore.Liquid;
 using OrchardCore.Localization.Drivers;
+using OrchardCore.Localization.Liquid.Filters;
 using OrchardCore.Localization.Models;
 using OrchardCore.Localization.Services;
 using OrchardCore.Modules;
@@ -34,6 +36,8 @@ public override void ConfigureServices(IServiceCollection services)
             AddDataAnnotationsPortableObjectLocalization();
 
         services.Replace(ServiceDescriptor.Singleton<ILocalizationFileLocationProvider, ModularPoFileLocationProvider>());
+
+        services.AddLiquidFilter<TransliterateFilter>("transliterate");
     }
 
     /// <inheritdocs />

src/OrchardCore.Modules/OrchardCore.Media/OrchardCore.Media.csproj

@@ -39,6 +39,7 @@
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.ResourceManagement\OrchardCore.ResourceManagement.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.Shortcodes.Abstractions\OrchardCore.Shortcodes.Abstractions.csproj" />
     <ProjectReference Include="..\..\OrchardCore\OrchardCore.XmlRpc.Abstractions\OrchardCore.XmlRpc.Abstractions.csproj" />
+    <ProjectReference Include="..\..\OrchardCore\OrchardCore.Abstractions\OrchardCore.Abstractions.csproj" />
   </ItemGroup>
 
   <ItemGroup>

src/OrchardCore.Modules/OrchardCore.Media/Services/SlugifyMediaNameNormalizerService.cs

@@ -1,4 +1,5 @@
 using Microsoft.Extensions.Options;
+using OrchardCore.Localization;
 using OrchardCore.Modules.Services;
 
 namespace OrchardCore.Media.Services;
@@ -18,11 +19,15 @@ public SlugifyMediaNameNormalizerService(
 
     public string NormalizeFolderName(string folderName)
     {
-        return _slugService.Slugify(folderName, _options.Transliterate);
+        return _options.Transliterate
+            ? _slugService.SlugifyAndTransliterate(folderName)
+            : _slugService.Slugify(folderName);
     }
 
     public string NormalizeFileName(string fileName)
     {
-        return _slugService.Slugify(Path.GetFileNameWithoutExtension(fileName), _options.Transliterate) + Path.GetExtension(fileName);
+        return _options.Transliterate
+            ? _slugService.SlugifyAndTransliterate(Path.GetFileNameWithoutExtension(fileName))
+            : _slugService.Slugify(Path.GetFileNameWithoutExtension(fileName)) + Path.GetExtension(fileName);
     }
 }

src/OrchardCore/OrchardCore.Abstractions/Localization/Extensions/StringExtensions.cs

@@ -0,0 +1,12 @@
+namespace OrchardCore.Localization;
+
+/// <summary>
+/// 
+/// </summary>
+public static class StringExtensions
+{
+    /// <summary>
+    /// Converts the non-Latin characters to their ASCII equivalents.
+    /// </summary>
+    public static string Transliterate(this string text) => AnyAscii.Transliteration.Transliterate(text);
+}

src/OrchardCore/OrchardCore.Abstractions/Localization/Extensions/TransliterationSlugServiceExtensions.cs

@@ -0,0 +1,19 @@
+using OrchardCore.Modules.Services;
+
+namespace OrchardCore.Localization;
+
+public static class TransliterationSlugServiceExtensions
+{
+    /// <summary>
+    /// Converts the specified text to a URL-friendly slug after applying transliteration.
+    /// </summary>
+    /// <param name="slugService">The slug service used to generate the slug from the transliterated text.</param>
+    /// <param name="text">The input text to transliterate and convert to a slug. Cannot be null or empty.</param>
+    /// <returns>A slugified string representing the transliterated input text.</returns>
+    public static string SlugifyAndTransliterate(this ISlugService slugService, string text)
+    {
+        ArgumentException.ThrowIfNullOrEmpty(text);
+
+        return slugService.Slugify(text.Transliterate());
+    }
+}

src/OrchardCore/OrchardCore.Abstractions/Modules/Services/ISlugService.cs

@@ -9,15 +9,6 @@ public interface ISlugService
     /// <returns>The slug created from the input text.</returns>
     string Slugify(string text);
 
-    /// <summary>
-    /// Transforms specified text to the form suitable for URL slugs,
-    /// optionally transliterating non-Latin characters to their ASCII equivalents first.
-    /// </summary>
-    /// <param name="text">The text to transform.</param>
-    /// <param name="transliterate">Whether to transliterate non-Latin characters before slugifying.</param>
-    /// <returns>The slug created from the input text.</returns>
-    string Slugify(string text, bool transliterate);
-
     /// <summary>
     /// Transforms specified text to a custom form generally not suitable for URL slugs.
     /// Allows you to use a specified separator char.

src/OrchardCore/OrchardCore.Abstractions/OrchardCore.Abstractions.csproj

@@ -16,6 +16,7 @@
   </ItemGroup>
 
   <ItemGroup>
+    <PackageReference Include="AnyAscii" />
     <PackageReference Include="JsonPath.Net" />
     <PackageReference Include="Microsoft.IO.RecyclableMemoryStream" />
     <PackageReference Include="ZString" />

src/OrchardCore/OrchardCore/Modules/Services/SlugService.cs

@@ -1,6 +1,5 @@
 using System.Globalization;
 using System.Text;
-using AnyAscii;
 using Cysharp.Text;
 
 namespace OrchardCore.Modules.Services;
@@ -10,16 +9,6 @@ public class SlugService : ISlugService
     private const char Hyphen = '-';
     private const int MaxLength = 1000;
 
-    public string Slugify(string text, bool transliterate)
-    {
-        if (transliterate && !string.IsNullOrEmpty(text))
-        {
-            text = text.Transliterate();
-        }
-
-        return Slugify(text);
-    }
-
     public string Slugify(string text, char separator)
     {
         throw new NotImplementedException();

src/OrchardCore/OrchardCore/OrchardCore.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <!-- NuGet properties-->
@@ -14,7 +14,6 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="AnyAscii" />
     <PackageReference Include="ncrontab" />
     <PackageReference Include="NodaTime" />
   </ItemGroup>

test/OrchardCore.Tests/Apis/Context/SiteStartup.cs

@@ -23,6 +23,7 @@ public void ConfigureServices(IServiceCollection services)
                 "OrchardCore.Tenants"
             )
             .AddTenantFeatures(
+                "OrchardCore.Localization",
                 "OrchardCore.Apis.GraphQL"
             )
             .ConfigureServices(collection =>

test/OrchardCore.Tests/Modules/OrchardCore.Liquid/SlugifyFilterTests.cs

@@ -0,0 +1,54 @@
+using Fluid;
+using OrchardCore.Liquid;
+using OrchardCore.Tests.Apis.Context;
+
+namespace OrchardCore.Tests.Modules.OrchardCore.Liquid;
+
+public class SlugifyFilterTests
+{
+    [Theory]
+    [InlineData("Æneid Æneid", "æneid-æneid")]
+    [InlineData("Aeneid Aeneid", "aeneid-aeneid")]
+    public async Task SlugifyFilterShouldReturnSlugifiedString(string text, string expected)
+    {
+        // Arrange
+        var context = new SiteContext();
+
+        await context.InitializeAsync();
+
+        // Act & Assert
+        await context.UsingTenantScopeAsync(async scope =>
+        {
+            var template = $$$"""{{ "{{{text}}}" | slugify }}""";
+
+            var liquidTemplateManager = scope.ServiceProvider.GetRequiredService<ILiquidTemplateManager>();
+
+            var result = await liquidTemplateManager.RenderStringAsync(template, NullEncoder.Default, null);
+
+            Assert.NotEmpty(result);
+            Assert.Equal(expected, result);
+        });
+    }
+
+    [Fact]
+    public async Task SlugifyThenTransliterateFilterShouldReturnSlugifiedTransliteratedString()
+    {
+        // Arrange
+        var context = new SiteContext();
+
+        await context.InitializeAsync();
+
+        // Act & Assert
+        await context.UsingTenantScopeAsync(async scope =>
+        {
+            var template = """{{ "Æneid Æneid" | transliterate | slugify }}""";
+
+            var liquidTemplateManager = scope.ServiceProvider.GetRequiredService<ILiquidTemplateManager>();
+
+            var result = await liquidTemplateManager.RenderStringAsync(template, NullEncoder.Default, null);
+
+            Assert.NotEmpty(result);
+            Assert.Equal("aeneid-aeneid", result);
+        });
+    }
+}

test/OrchardCore.Tests/Modules/OrchardCore.Liquid/TransliterateFilterTests.cs

@@ -0,0 +1,36 @@
+using Fluid;
+using OrchardCore.Liquid;
+using OrchardCore.Tests.Apis.Context;
+
+namespace OrchardCore.Tests.Modules.OrchardCore.Liquid;
+
+public class TransliterateFilterTests
+{
+    [Theory]
+    [InlineData("Æneid", "Aeneid")]
+    [InlineData("æneid", "aeneid")]
+    [InlineData("Aeneid", "Aeneid")]
+    [InlineData("aeneid", "aeneid")]
+    [InlineData("Ελληνικά", "Ellinika")]
+    [InlineData("джинсы_клеш", "dzhinsy_klesh")]
+    public async Task TransliterateFilterShouldReturnTransliteratedString(string text, string expected)
+    {
+        // Arrange
+        var context = new SiteContext();
+
+        await context.InitializeAsync();
+
+        // Act & Assert
+        await context.UsingTenantScopeAsync(async scope =>
+        {
+            var template = $$$"""{{ "{{{text}}}" | transliterate }}""";
+
+            var liquidTemplateManager = scope.ServiceProvider.GetRequiredService<ILiquidTemplateManager>();
+
+            var result = await liquidTemplateManager.RenderStringAsync(template, NullEncoder.Default, null);
+
+            Assert.NotEmpty(result);
+            Assert.Equal(expected, result);
+        });
+    }
+}

test/OrchardCore.Tests/Tokens.Content/SlugServiceTests.cs

@@ -1,3 +1,4 @@
+using OrchardCore.Localization;
 using OrchardCore.Modules.Services;
 
 namespace OrchardCore.Tests.Tokens.Content;
@@ -81,14 +82,7 @@ public void ShouldPreserveNonLatinCharacters(string input, string expected)
     [Fact]
     public void ShouldTransliterateWhenRequested()
     {
-        var slug = _slugService.Slugify("Æneid", transliterate: true);
+        var slug = _slugService.SlugifyAndTransliterate("Æneid");
         Assert.Equal("aeneid", slug);
     }
-
-    [Fact]
-    public void ShouldNotTransliterateWhenDisabled()
-    {
-        var slug = _slugService.Slugify("Æneid", transliterate: false);
-        Assert.Equal("æneid", slug);
-    }
 }