philiprehberger-slug 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d55508ea15a44506254fb9899b5d87869b1749b775615fe11f129dced907f2c
-  data.tar.gz: ca27b4b622a9c6b08798e285d68b39b37813594d1d0701d665a4c9621c038f12
+  metadata.gz: c6417c2057ab93e96dd94c6427ea1176a9e90b0827a03e5b54d69cc88d2265b0
+  data.tar.gz: 34cd902c8265b577a5c991c5d49ef4e142b8cbf5a823d4645e055429202d715d
 SHA512:
-  metadata.gz: 7f4cb22828657d23aab0b6332762ad4c431349bdeef78b5ade464354e955057d58efa6eb60db228218969df69c97064c1211758b23e653b8ea8725a01ea7d9ad
-  data.tar.gz: 39c4c94b8cb023de7617dc082927f3c5c3bb5b94ec1ae5492c618eba379858a5422a5843d09b90535b69c9c88db3d7f55d4b255472314aeb01aa26414d97dfea
+  metadata.gz: 1a76c62679ff50297c41caec2943def332006ed1b04936807e4c437c4bc1b029ffdd0827380ad204721232b55144db4f999f7c828135c31373b596f65c07ad4d
+  data.tar.gz: 799fc05c9c45cf4e179bf9b116074fa378acb5523366b6539e64847d8f9d864a363fe3448d4fc9c58ec3e9e92f6736ccb1cd820478c30e097f3fbe06d19c370f

data/CHANGELOG.md

@@ -7,6 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.3.0] - 2026-04-13
+
+### Added
+- `Slug.valid_slug?(string, separator:)` method for validating well-formed slugs
+- `Slug.humanize(slug, separator:, capitalize:)` method for converting slugs back to human-readable titles
+
+### Changed
+- Optimize transliteration with pre-compiled regex instead of char-by-char iteration
+- Remove unused `mapping_regex` private method from Transliterator
+- Tighten RuboCop metrics to match guide defaults
+
 ## [0.2.0] - 2026-04-01
 
 ### Added

data/README.md

@@ -78,6 +78,26 @@ Philiprehberger::Slug.generate("Hello & World", custom_mapping: { "&" => "and" }
 # => "hello-and-world"
 ```
 
+### Validation
+
+Check whether a string is already a well-formed slug:
+
+```ruby
+Philiprehberger::Slug.valid_slug?("hello-world")   # => true
+Philiprehberger::Slug.valid_slug?("Hello World")    # => false
+Philiprehberger::Slug.valid_slug?("hello--world")   # => false
+```
+
+### Humanize
+
+Convert a slug back to a human-readable title:
+
+```ruby
+Philiprehberger::Slug.humanize("hello-world")                       # => "Hello World"
+Philiprehberger::Slug.humanize("hello-world", capitalize: :first)   # => "Hello world"
+Philiprehberger::Slug.humanize("hello_world", separator: "_")       # => "Hello World"
+```
+
 ### Transliteration
 
 ```ruby
@@ -88,12 +108,11 @@ Philiprehberger::Slug.transliterate("café résumé")  # => "cafe resume"
 
 | Method | Description |
 |--------|-------------|
-| `Slug.generate(string, separator: "-", max: nil, unique: nil)` | Generate a URL-safe slug from any string |
+| `Slug.generate(string, separator:, max:, unique:, custom_mapping:)` | Generate a URL-safe slug from any string |
 | `Slug.generate_batch(strings, separator:, max:, custom_mapping:)` | Generate unique slugs for an array of strings with deduplication |
-| `Slug.transliterate(string)` | Transliterate Unicode characters to ASCII equivalents |
-| `Slug::Generator.call(string, separator: "-", max: nil, unique: nil)` | Core slug generation logic (called by `Slug.generate`) |
-| `Slug::Transliterator.call(string)` | Core transliteration logic (called by `Slug.transliterate`) |
-| `Slug::Transliterator::MAPPING` | Frozen hash of Unicode to ASCII character mappings |
+| `Slug.valid_slug?(string, separator:)` | Check whether a string is a well-formed slug |
+| `Slug.humanize(slug, separator:, capitalize:)` | Convert a slug back to a human-readable title |
+| `Slug.transliterate(string, custom_mapping:)` | Transliterate Unicode characters to ASCII equivalents |
 | `Slug::Error` | Error raised for invalid input (e.g. non-String argument) |
 | `Slug::VERSION` | Current gem version string |
 

data/lib/philiprehberger/slug/transliterator.rb

@@ -55,19 +55,22 @@ module Philiprehberger
         'ϊ' => 'i', 'ϋ' => 'y', 'ΐ' => 'i', 'ΰ' => 'y'
       }.freeze
 
+      MAPPING_REGEX = Regexp.union(MAPPING.keys).freeze
+
       # Transliterate Unicode characters to ASCII equivalents
       #
       # @param string [String] input string
+      # @param custom_mapping [Hash, nil] custom character replacements
       # @return [String] transliterated string
       def self.call(string, custom_mapping: nil)
-        mapping = custom_mapping ? MAPPING.merge(custom_mapping) : MAPPING
-        string.each_char.map { |char| mapping[char] || char }.join
-      end
-
-      def self.mapping_regex
-        @mapping_regex ||= Regexp.union(MAPPING.keys)
+        if custom_mapping
+          merged = MAPPING.merge(custom_mapping)
+          regex = Regexp.union(merged.keys)
+          string.gsub(regex) { |match| merged[match] }
+        else
+          string.gsub(MAPPING_REGEX) { |match| MAPPING[match] }
+        end
       end
-      private_class_method :mapping_regex
     end
   end
 end

data/lib/philiprehberger/slug/version.rb

@@ -2,6 +2,6 @@
 
 module Philiprehberger
   module Slug
-    VERSION = '0.2.0'
+    VERSION = '0.3.0'
   end
 end

data/lib/philiprehberger/slug.rb

@@ -52,5 +52,38 @@ module Philiprehberger
     def self.transliterate(string, custom_mapping: nil)
       Transliterator.call(string, custom_mapping: custom_mapping)
     end
+
+    # Check whether a string is a well-formed slug
+    #
+    # @param string [String] the string to validate
+    # @param separator [String] the allowed separator character (default: "-")
+    # @return [Boolean] true if the string is a valid slug
+    def self.valid_slug?(string, separator: '-')
+      return false unless string.is_a?(String)
+      return false if string.empty?
+
+      sep = Regexp.escape(separator)
+      string.match?(/\A[a-z0-9]+(?:#{sep}[a-z0-9]+)*\z/)
+    end
+
+    # Convert a slug back to a human-readable title
+    #
+    # @param slug [String] the slug to humanize
+    # @param separator [String] the separator used in the slug (default: "-")
+    # @param capitalize [Symbol] capitalization strategy: :words, :first, or :none
+    # @return [String] the human-readable string
+    # @raise [Error] if input is not a String
+    def self.humanize(slug, separator: '-', capitalize: :words)
+      raise Error, "Input must be a String, got #{slug.class}" unless slug.is_a?(String)
+      return '' if slug.empty?
+
+      result = slug.gsub(separator, ' ')
+      case capitalize
+      when :words then result.gsub(/\b[a-z]/, &:upcase)
+      when :first then result.sub(/\A[a-z]/, &:upcase)
+      when :none then result
+      else raise Error, "Unknown capitalize option: #{capitalize}"
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: philiprehberger-slug
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Philip Rehberger
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-04-01 00:00:00.000000000 Z
+date: 2026-04-13 00:00:00.000000000 Z
 dependencies: []
 description: Generate URL-safe slugs from any string with built-in Unicode transliteration,
   configurable separators, word-boundary truncation, and collision-aware uniqueness.