fjrodafo-slugify 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 263918f7e400ff93653a4b7ad4674a997520fcd52713bafc73227b8bb00acff8
-  data.tar.gz: 486916c0a92a699950c3b6c482c331201c111cb5f1d54a8affae074bc0c43848
+  metadata.gz: 3763460c961dfb76f6f92b96ed2663f33912bb2076f2ef3befda806db7b100ab
+  data.tar.gz: ad3bff584c50e70e5f1e16fa7240eb5f3663d0730e3c92afa2a66e96e831b623
 SHA512:
-  metadata.gz: 2037b3259af8e404cb575150c4c4ed6a9aa3641a8d36dd921c40a408ba6024eb950bf3fd4414774375462980cfff59af5b8bce7e3b17fb13a462f6c4735fc7c9
-  data.tar.gz: a2156d58da867dfb221ba46d07b7560186f13b115d0c3fdf57e9460e8c82884166daaba90468e6a433bcc30351b99253b777e0d25c9eb23f12abb8638449e4c2
+  metadata.gz: e5d66d732b9196950964325e634404032c12222773270c5450ef62ffa7a85393b2ba95e3697754d046dd75ed6b0d1020e7cb7cc8cca910bd8901dd7a5d96fcf4
+  data.tar.gz: 44a5ce6d92d87921f8031ae8b27a845330d4a4a0f1e94a5a9f94ddd35c65c4152dcba6dfd30417ef23b07940b63f2feb9e75b027a1eb05d73de0bdbe621b8e67

data/README.md

@@ -6,18 +6,18 @@ gem install fjrodafo-slugify
 
 ## Run it!
 
-```rb
-# Import the gem
+```ruby
+# Load the gem
 require "fjrodafo/slugify"
 ```
 
-```rb
-Fjrodafo::Slugify.to_slug("¡Hola Mundo!")
-# => "hola-mundo"
+```ruby
+Fjrodafo::Slugify.to_slug("Hello, World!")
+# => "hello-world"
 ```
 
 ## Links
 
-Contribute to the repository on [GitHub](https://github.com/FJrodafo/slugify).
+Contribute to the repository on [GitHub](https://github.com/FJrodafo/Slugify).
 
 Check out this gem on [GitHub Packages](https://github.com/FJrodafo/Slugify/pkgs/rubygems/fjrodafo-slugify) or [RubyGems](https://rubygems.org/gems/fjrodafo-slugify) website!

data/bin/fjrodafo-slugify

@@ -2,4 +2,4 @@
 
 require "fjrodafo/slugify"
 
-puts FJrodafo::Slugify.to_slug("Hola, Mundo!")
+puts FJrodafo::Slugify.to_slug(ARGV.join(" "))

data/lib/fjrodafo/slugify/transliteration.rb

@@ -1,15 +1,25 @@
+# Main module for the gem
 module FJrodafo
+  # Submodule for slugify functionality
   module Slugify
+    # Module that contains the character transliteration mappings
     module Transliteration
+      # A hash mapping special or accented characters to their ASCII equivalents
+      # Used to replace characters that are not URL-friendly
       MAP = {
         "ø" => "o",
         "ß" => "ss",
         "æ" => "ae",
         "œ" => "oe",
         "ł" => "l"
-      }.freeze
+      }.freeze  # Freeze the hash to make it immutable
 
+      # String of all characters to replace, used with `String#tr`
+      # Example: "øßæœł"
       FROM = MAP.keys.join.freeze
+
+      # String of replacement characters, used with `String#tr`
+      # Example: "ossaeoel"
       TO   = MAP.values.join.freeze
     end
   end

data/lib/fjrodafo/slugify.rb

@@ -1,23 +1,31 @@
+# Load the file that contains the Transliteration module which defines the character replacement map for special characters
 require_relative "slugify/transliteration"
 
+# Main module for the gem
 module FJrodafo
+  # Submodule that provides the "slugify" functionality
   module Slugify
+    # Class method that converts any text into a URL-safe slug
+    # @param text [String] The input text to convert
+    # @return [String] The resulting slug
     def self.to_slug(text)
+      # Return an empty string if the input is nil
       return "" if text.nil?
 
+      # Convert the input to string (in case it is not a string) and chain transformations to produce a slug
       text
-        .to_s
-        .downcase
-        .strip
-        .unicode_normalize(:nfd)
+        .to_s                      # Convert the input to a string, in case it's nil, a number, or another type
+        .downcase                  # Convert the string to lowercase
+        .strip                     # Remove leading and trailing spaces
+        .unicode_normalize(:nfd)   # Normalize Unicode to separate accents
         .tr(
-          Transliteration::FROM,
+          Transliteration::FROM,   # Replace special characters according to the map
           Transliteration::TO
         )
-        .gsub(/\p{Mn}/, "")
-        .gsub(/[^a-z0-9\s-]/, "")
-        .gsub(/[\s_-]+/, "-")
-        .gsub(/^-+|-+$/, "")
+        .gsub(/\p{Mn}/, "")        # Remove accent marks (diacritics)
+        .gsub(/[^a-z0-9\s-]/, "")  # Remove everything except a-z, 0-9, space, or hyphen
+        .gsub(/[\s_-]+/, "-")      # Replace consecutive spaces, underscores, or hyphens with a single hyphen
+        .gsub(/^-+|-+$/, "")       # Remove hyphens at the start or end
     end
   end
 end

data/test/test_fjrodafo-slugify.rb

@@ -2,6 +2,11 @@ require "minitest/autorun"
 require "fjrodafo/slugify"
 
 class FJrodafoSlugifyTest < Minitest::Test
+  def test_empty
+    assert_equal "",
+      FJrodafo::Slugify.to_slug("")
+  end
+
   def test_hello_world
     assert_equal "hello-world",
       FJrodafo::Slugify.to_slug("Hello, World!")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fjrodafo-slugify
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Francisco José Rodríguez Afonso
@@ -36,7 +36,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="