keycase 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9269ac3f6277ae7eec6635c9bb3a5187522ba0d2d7fb25544d7f1e4aa9fb76f6
-  data.tar.gz: a4ba9ae8a5305896cb5f10775a19f77e7b7ea93d7699c54f628d4e93bc5d84ad
+  metadata.gz: f9cd4f359e0bdcfad518f08a8bbb845060cb4d66d2d8a3738b68aa46c53f183e
+  data.tar.gz: d0c79c9129587e65c2588efff8a969c5877ac802d1e1b818c2f9eaf2ff8bb114
 SHA512:
-  metadata.gz: c3c1c1d9292ddcbf6105612cf83c6015701729dcd4735237426726bbd38ba73c69f637600d24d420957c386499818997a4d89402e6eadc4a32fcd089e30e47b5
-  data.tar.gz: bf20fa1ce9b135f12a080c01bb2fcf55906cd66027273b31c29346a818c070d56471695d2a1b68c0fdd21cea5ca56f4d172410c3c0283d245386d43dac3d18a6
+  metadata.gz: 606ecc4d4358942e9b5e00c4f5ac1c6dfda3fc0b548948b69c3d3fb30dfe935c6382c3964cb7ca4a737d8cad755c2d2db8ca55d0f40291faff1d3ab60072d2d6
+  data.tar.gz: 376edfd2e6bc64564adb3b11ef63e658cc540d0c7759b6388bf84973e0fcee55b056b5d21ed01577c6346a0cdf01e13fdb2270ed195efced6e3e8d9436f048ae

data/README.md

@@ -64,6 +64,96 @@ irb --context-mode=1
 }
 ```
 
+## Interface
+
+Keycase is provided as Ruby refinements. Enable the case conversion you want with `using`.
+
+| Refinement | String/Symbol conversion | Hash/Array key conversion |
+| --- | --- | --- |
+| `Keycase::CamelCase` | `to_camel_case` | `with_camel_case_keys` |
+| `Keycase::PascalCase` | `to_pascal_case` | `with_pascal_case_keys` |
+| `Keycase::SnakeCase` | `to_snake_case` | `with_snake_case_keys` |
+| `Keycase::ScreamingSnakeCase` | `to_screaming_snake_case` | `with_screaming_snake_case_keys` |
+| `Keycase::KebabCase` | `to_kebab_case` | `with_kebab_case_keys` |
+| `Keycase::TrainCase` | `to_train_case` | `with_train_case_keys` |
+
+`String#to_*` returns a converted string. `Symbol#to_*` returns a converted symbol. Other objects respond to these methods and return themselves unchanged.
+
+`Hash#with_*_keys` and `Array#with_*_keys` recursively convert only Hash keys.
+Arrays are traversed so hashes inside arrays are converted. Values that are not Hash or Array objects are returned unchanged.
+Key type is preserved: string keys remain strings, and symbol keys remain symbols.
+
+```rb
+using Keycase::SnakeCase
+
+"userID".to_snake_case
+# => "user_id"
+
+:userID.to_snake_case
+# => :user_id
+
+[
+  { "userID" => 1 },
+  { :createdAt => "2026-05-09" },
+].with_snake_case_keys
+# => [
+#   { "user_id" => 1 },
+#   { :created_at => "2026-05-09" },
+# ]
+```
+
+## Options
+
+All `with_*_keys` methods accept an options hash.
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `max_depth` | `nil` | Maximum nested Hash/Array depth to traverse. `nil` means no depth limit. |
+
+Depth starts at `0` for the receiver itself. Each nested Hash or Array increases
+the depth by `1`. Leaf values are not counted.
+
+```rb
+using Keycase::CamelCase
+
+{ user: { profile_data: { display_name: "Alice" } } }.with_camel_case_keys(max_depth: 2)
+# => { :user => { :profileData => { :displayName => "Alice" } } }
+
+{ user: { profile_data: { display_name: "Alice" } } }.with_camel_case_keys(max_depth: 1)
+# raises Keycase::StructureTooDeepError
+```
+
+## Errors
+
+`with_*_keys` raises Keycase-specific errors when recursive conversion cannot be completed without ambiguity or infinite traversal.
+
+| Error | Raised when |
+| --- | --- |
+| `Keycase::CircularStructureError` | A Hash or Array references itself through the current traversal path. |
+| `Keycase::KeyCollisionError` | Multiple source keys in the same Hash convert to the same destination key. |
+| `Keycase::StructureTooDeepError` | Traversal exceeds the supplied `max_depth`. |
+
+Circular references are rejected because recursive conversion could not finish.
+Reusing the same non-circular object from multiple places is supported; each path is converted into a separate result object.
+
+```rb
+using Keycase::CamelCase
+
+hash = {}
+hash[:self_reference] = hash
+hash.with_camel_case_keys
+# raises Keycase::CircularStructureError
+```
+
+Key collisions are rejected so conversion never silently overwrites data. The check is performed per Hash after the keys are converted.
+
+```rb
+using Keycase::CamelCase
+
+{ :user_id => 1, :userID => 2 }.with_camel_case_keys
+# raises Keycase::KeyCollisionError
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests with the local Ruby version defined in `mise.toml` (currently Ruby 3.4.9). You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -97,6 +187,23 @@ To list all tasks and descriptions:
 mise tasks
 ```
 
+## Release Authentication
+
+Gem releases from GitHub Actions use RubyGems Trusted Publishing. No long-lived RubyGems API key or GitHub secret is required; GitHub Actions obtains a short-lived RubyGems API token through OIDC during the release job.
+
+Configure the trusted publisher once on RubyGems.org:
+
+1.  Log in to <https://rubygems.org> with an owner account for the `keycase` gem.
+2.  Open the `keycase` gem page and go to `Trusted publishers`.
+3.  Create a GitHub Actions trusted publisher with these values:
+
+    -   Repository owner: `naoigcat`
+    -   Repository name: `ruby-keycase`
+    -   Workflow filename: `release.yml`
+    -   Environment name: `release`
+
+After this setup, run the `Release Gem` workflow manually from GitHub Actions. Enter the version already committed in `lib/keycase/version.rb`; the workflow verifies the version, creates the `v<version>` tag through Bundler's release task, and publishes the gem to RubyGems.org.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/naoigcat/ruby-keycase>.

data/lib/keycase/camel_case.rb

@@ -2,7 +2,8 @@
 
 require "set"
 
-require_relative "recursive_transform/engine"
+require_relative "support/transformer"
+require_relative "support/tokenizer"
 
 module Keycase
   module CamelCase
@@ -18,17 +19,9 @@ module Keycase
 
     refine String do
       def to_camel_case
-        gsub(/(?<=[A-Z])(?=[A-Z][a-z])/) do |_|
-          "_"
-        end.gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
-          "_"
-        end.gsub(/(?<=\b|\W|_)[0-9A-Za-z]+(?=\b|\W|_)/) do |matched|
-          matched.capitalize
-        end.sub(/^(?:\W|_)*([A-Z]+(?=[A-Z][0-9A-Za-z]|\d|$)|[A-Z][a-z])/) do |_|
-          Regexp.last_match(1).downcase
-        end.gsub(/(?:\b|\W|_)*([0-9A-Z])/) do |_|
-          Regexp.last_match(1)
-        end.gsub(/(?:\W|_)*$/, "")
+        Keycase::Support::Tokenizer.words(self).map do |word|
+          word.capitalize
+        end.join.sub(/^./, &:downcase)
       end
     end
 
@@ -40,7 +33,7 @@ module Keycase
 
     refine Array do
       def with_camel_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_array(
+        Keycase::Support::Transformer.transform_array(
           self,
           ::Set.new,
           0,
@@ -53,7 +46,7 @@ module Keycase
 
     refine Hash do
       def with_camel_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_hash(
+        Keycase::Support::Transformer.transform_hash(
           self,
           ::Set.new,
           0,

data/lib/keycase/kebab_case.rb

@@ -2,7 +2,8 @@
 
 require "set"
 
-require_relative "recursive_transform/engine"
+require_relative "support/transformer"
+require_relative "support/tokenizer"
 
 module Keycase
   module KebabCase
@@ -18,13 +19,9 @@ module Keycase
 
     refine String do
       def to_kebab_case
-        gsub(/(?<=[A-Z])(?=[A-Z][a-z])/) do |_|
-          "-"
-        end.gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
-          "-"
-        end.gsub(/(?<=\b|\W|_)[0-9A-Za-z]+(?=\b|\W|_)/) do |matched|
-          "-#{matched.downcase}"
-        end.gsub(/(?:\W|_)+/, "-").gsub(/^(?:\W|_)*|(?:\W|_)*$/, "").downcase
+        Keycase::Support::Tokenizer.words(self).map do |word|
+          word.downcase
+        end.join("-")
       end
     end
 
@@ -36,7 +33,7 @@ module Keycase
 
     refine Array do
       def with_kebab_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_array(
+        Keycase::Support::Transformer.transform_array(
           self,
           ::Set.new,
           0,
@@ -49,7 +46,7 @@ module Keycase
 
     refine Hash do
       def with_kebab_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_hash(
+        Keycase::Support::Transformer.transform_hash(
           self,
           ::Set.new,
           0,

data/lib/keycase/pascal_case.rb

@@ -2,7 +2,8 @@
 
 require "set"
 
-require_relative "recursive_transform/engine"
+require_relative "support/transformer"
+require_relative "support/tokenizer"
 
 module Keycase
   module PascalCase
@@ -18,17 +19,9 @@ module Keycase
 
     refine String do
       def to_pascal_case
-        gsub(/(?<=[A-Z])(?=[A-Z][a-z])/) do |_|
-          "_"
-        end.gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
-          "_"
-        end.gsub(/(?<=\b|\W|_)[0-9A-Za-z]+(?=\b|\W|_)/) do |matched|
-          matched.capitalize
-        end.sub(/^(?:\W|_)*([A-Z]+(?=[A-Z][0-9A-Za-z]|\d|$)|[A-Z][a-z])/) do |_|
-          Regexp.last_match(1).capitalize
-        end.gsub(/(?:\b|\W|_)*([0-9A-Z])/) do |_|
-          Regexp.last_match(1)
-        end.gsub(/(?:\W|_)*$/, "")
+        Keycase::Support::Tokenizer.words(self).map do |word|
+          word.capitalize
+        end.join
       end
     end
 
@@ -40,7 +33,7 @@ module Keycase
 
     refine Array do
       def with_pascal_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_array(
+        Keycase::Support::Transformer.transform_array(
           self,
           ::Set.new,
           0,
@@ -53,7 +46,7 @@ module Keycase
 
     refine Hash do
       def with_pascal_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_hash(
+        Keycase::Support::Transformer.transform_hash(
           self,
           ::Set.new,
           0,

data/lib/keycase/screaming_snake_case.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "support/transformer"
+require_relative "support/tokenizer"
+
+module Keycase
+  module ScreamingSnakeCase
+    refine Object do
+      def to_screaming_snake_case
+        self
+      end
+
+      def with_screaming_snake_case_keys(_options = {})
+        self
+      end
+    end
+
+    refine String do
+      def to_screaming_snake_case
+        Keycase::Support::Tokenizer.words(self).map do |word|
+          word.upcase
+        end.join("_")
+      end
+    end
+
+    refine Symbol do
+      def to_screaming_snake_case
+        to_s.to_screaming_snake_case.to_sym
+      end
+    end
+
+    refine Array do
+      def with_screaming_snake_case_keys(options = {})
+        Keycase::Support::Transformer.transform_array(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_screaming_snake_case
+        end
+      end
+    end
+
+    refine Hash do
+      def with_screaming_snake_case_keys(options = {})
+        Keycase::Support::Transformer.transform_hash(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_screaming_snake_case
+        end
+      end
+    end
+  end
+end

data/lib/keycase/snake_case.rb

@@ -2,7 +2,8 @@
 
 require "set"
 
-require_relative "recursive_transform/engine"
+require_relative "support/transformer"
+require_relative "support/tokenizer"
 
 module Keycase
   module SnakeCase
@@ -18,13 +19,9 @@ module Keycase
 
     refine String do
       def to_snake_case
-        gsub(/(?<=[A-Z])(?=[A-Z][a-z])/) do |_|
-          "_"
-        end.gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
-          "_"
-        end.gsub(/(?<=\b|\W|_)[0-9A-Za-z]+(?=\b|\W|_)/) do |matched|
-          "_#{matched.downcase}"
-        end.gsub(/(?:\W|_)+/, "_").gsub(/^(?:\W|_)*|(?:\W|_)*$/, "").downcase
+        Keycase::Support::Tokenizer.words(self).map do |word|
+          word.downcase
+        end.join("_")
       end
     end
 
@@ -36,7 +33,7 @@ module Keycase
 
     refine Array do
       def with_snake_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_array(
+        Keycase::Support::Transformer.transform_array(
           self,
           ::Set.new,
           0,
@@ -49,7 +46,7 @@ module Keycase
 
     refine Hash do
       def with_snake_case_keys(options = {})
-        Keycase::RecursiveTransform::Engine.transform_hash(
+        Keycase::Support::Transformer.transform_hash(
           self,
           ::Set.new,
           0,

data/lib/keycase/support/tokenizer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Keycase
+  module Support
+    module Tokenizer
+      module_function
+
+      def words(value)
+        value
+          .gsub(/(?<=[A-Z])(?=[A-Z][a-z])/) do |_|
+            "_"
+          end
+          .gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
+            "_"
+          end
+          .scan(/[0-9A-Za-z]+/)
+      end
+    end
+  end
+end

data/lib/keycase/{recursive_transform/engine.rb → support/transformer.rb}

@@ -3,8 +3,8 @@
 require_relative "errors"
 
 module Keycase
-  module RecursiveTransform
-    module Engine
+  module Support
+    module Transformer
       class << self
         def transform_hash(hash, visiting, depth, max_depth, &key_converter)
           check_depth!(depth, max_depth)

data/lib/keycase/train_case.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "support/transformer"
+require_relative "support/tokenizer"
+
+module Keycase
+  module TrainCase
+    refine Object do
+      def to_train_case
+        self
+      end
+
+      def with_train_case_keys(_options = {})
+        self
+      end
+    end
+
+    refine String do
+      def to_train_case
+        Keycase::Support::Tokenizer.words(self).map do |word|
+          word.capitalize
+        end.join("-")
+      end
+    end
+
+    refine Symbol do
+      def to_train_case
+        to_s.to_train_case.to_sym
+      end
+    end
+
+    refine Array do
+      def with_train_case_keys(options = {})
+        Keycase::Support::Transformer.transform_array(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_train_case
+        end
+      end
+    end
+
+    refine Hash do
+      def with_train_case_keys(options = {})
+        Keycase::Support::Transformer.transform_hash(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_train_case
+        end
+      end
+    end
+  end
+end

data/lib/keycase/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Keycase
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/keycase.rb

@@ -1,12 +1,15 @@
 # frozen_string_literal: true
 
 require "keycase/version"
-require "keycase/recursive_transform/errors"
-require "keycase/recursive_transform/engine"
+require "keycase/support/errors"
+require "keycase/support/transformer"
+require "keycase/support/tokenizer"
 require "keycase/camel_case"
 require "keycase/kebab_case"
 require "keycase/pascal_case"
+require "keycase/screaming_snake_case"
 require "keycase/snake_case"
+require "keycase/train_case"
 
 module Keycase
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: keycase
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - naoigcat
@@ -25,9 +25,12 @@ files:
 - lib/keycase/camel_case.rb
 - lib/keycase/kebab_case.rb
 - lib/keycase/pascal_case.rb
-- lib/keycase/recursive_transform/engine.rb
-- lib/keycase/recursive_transform/errors.rb
+- lib/keycase/screaming_snake_case.rb
 - lib/keycase/snake_case.rb
+- lib/keycase/support/errors.rb
+- lib/keycase/support/tokenizer.rb
+- lib/keycase/support/transformer.rb
+- lib/keycase/train_case.rb
 - lib/keycase/version.rb
 homepage: https://github.com/naoigcat/ruby-keycase
 licenses: