keycase 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da8baf95ed5db98cd67e6d9ad5ceb98911bd1549a3508eb00522523a520aa9f
-  data.tar.gz: 8adc12f0490f1e3fbbc65e8c47746c183b028f4a8cc326f3fbadec4988e3e32f
+  metadata.gz: 9269ac3f6277ae7eec6635c9bb3a5187522ba0d2d7fb25544d7f1e4aa9fb76f6
+  data.tar.gz: a4ba9ae8a5305896cb5f10775a19f77e7b7ea93d7699c54f628d4e93bc5d84ad
 SHA512:
-  metadata.gz: 02dc22181e2875b26713d9a7227a4168d8ebd9d03e44cbdc7a6fd525a3f3f7b9322b7e4d4738bddad3245d2574b8ad3329fd57c0d45f3c0075fadc084dec27e5
-  data.tar.gz: 84b5aed31fc5628cbf16aa92799de771768fa8bcef8585d789d4e6c00967a833913204fd033dd58fd13dd03bc20752d37aaf5fc86b1db970f28397e065551126
+  metadata.gz: c3c1c1d9292ddcbf6105612cf83c6015701729dcd4735237426726bbd38ba73c69f637600d24d420957c386499818997a4d89402e6eadc4a32fcd089e30e47b5
+  data.tar.gz: bf20fa1ce9b135f12a080c01bb2fcf55906cd66027273b31c29346a818c070d56471695d2a1b68c0fdd21cea5ca56f4d172410c3c0283d245386d43dac3d18a6

data/{LICENSE.txt → LICENSE.md}

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+# MIT License
 
-Copyright (c) 2020 naoigcat
+Copyright © 2020 naoigcat
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,9 +1,9 @@
-#   Keycase
+# Keycase
 
 This gem converts the case of strings, symbols, and keys of hash recursively.
 The convertible cases are camelCase, PascalCase, snake_case, etc.
 
-##  Installation
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -13,16 +13,16 @@ gem "keycase"
 
 And then execute:
 
-    $ bundle install
+  $ bundle install
 
 Or install it yourself as:
 
-    $ gem install keycase
+  $ gem install keycase
 
-##  Usage
+## Usage
 
 ```sh
-$ irb --context-mode=1
+irb --context-mode=1
 ```
 
 ```rb
@@ -64,16 +64,43 @@ $ irb --context-mode=1
 }
 ```
 
-##  Development
+## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-##  Contributing
+Tasks are defined in `mise.toml`. They run **RuboCop, and RSpec inside Docker** (via Docker Compose), so Docker must be available. Use these tasks for syntax checks and tests across supported Ruby versions.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/naoigcat/ruby-keycase.
+Run **RuboCop** on every supported Ruby image (2.3 through 4.0):
 
-##  License
+```sh
+mise run -j 1 rubocop
+```
+
+Run **RSpec** the same way:
+
+```sh
+mise run -j 1 rspec
+```
+
+These commands execute the version-specific tasks in order (`rubocop23` … `rubocop40`, `rspec23` … `rspec40`). To run against a **single** Ruby version, use the matching task name, for example:
+
+```sh
+mise run rubocop34
+mise run rspec34
+```
+
+To list all tasks and descriptions:
+
+```sh
+mise tasks
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at <https://github.com/naoigcat/ruby-keycase>.
+
+## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/keycase.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "lib/keycase/version"
 
 Gem::Specification.new do |spec|
@@ -7,23 +9,24 @@ Gem::Specification.new do |spec|
   spec.email                  = ["17925623+naoigcat@users.noreply.github.com"]
 
   spec.summary                = "Converts the case of strings, symbols, and keys of hash."
-  spec.description            = <<~DESCRIPTION
+  spec.description            = <<-DESCRIPTION
     This gem converts the case of strings, symbols, and keys of hash recursively.
     The convertible cases are camelCase, PascalCase, snake_case, etc.
   DESCRIPTION
   spec.homepage               = "https://github.com/naoigcat/ruby-keycase"
   spec.license                = "MIT"
-  spec.required_ruby_version  = Gem::Requirement.new(">= 2.0.0")
+  spec.required_ruby_version  = Gem::Requirement.new(">= 2.3.0")
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.require_paths          = ["lib"]
   spec.files                  = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").select do |f|
+      f.match(%r{^lib/|^LICENSE\.md$|^README\.md$|^keycase\.gemspec$})
+    end
   end
-  spec.bindir                 = "exe"
-  spec.executables            = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths          = ["lib"]
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["rubygems_mfa_required"] = "true"
 end

data/lib/keycase/camel_case.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "recursive_transform/engine"
+
 module Keycase
   module CamelCase
     refine Object do
@@ -5,16 +11,18 @@ module Keycase
         self
       end
 
-      def with_camel_case_keys
+      def with_camel_case_keys(_options = {})
         self
       end
     end
 
     refine String do
       def to_camel_case
-        gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
+        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| # rubocop:disable Style/SymbolProc
+        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
@@ -31,17 +39,27 @@ module Keycase
     end
 
     refine Array do
-      def with_camel_case_keys
-        map do |value| # rubocop:disable Style/SymbolProc
-          value.with_camel_case_keys
+      def with_camel_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_array(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_camel_case
         end
       end
     end
 
     refine Hash do
-      def with_camel_case_keys
-        each_with_object({}) do |(key, value), memo|
-          memo[key.to_camel_case] = value.with_camel_case_keys
+      def with_camel_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_hash(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_camel_case
         end
       end
     end

data/lib/keycase/kebab_case.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "recursive_transform/engine"
+
 module Keycase
   module KebabCase
     refine Object do
@@ -5,14 +11,16 @@ module Keycase
         self
       end
 
-      def with_kebab_case_keys
+      def with_kebab_case_keys(_options = {})
         self
       end
     end
 
     refine String do
       def to_kebab_case
-        gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
+        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}"
@@ -27,17 +35,27 @@ module Keycase
     end
 
     refine Array do
-      def with_kebab_case_keys
-        map do |value| # rubocop:disable Style/SymbolProc
-          value.with_kebab_case_keys
+      def with_kebab_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_array(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_kebab_case
         end
       end
     end
 
     refine Hash do
-      def with_kebab_case_keys
-        each_with_object({}) do |(key, value), memo|
-          memo[key.to_kebab_case] = value.with_kebab_case_keys
+      def with_kebab_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_hash(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_kebab_case
         end
       end
     end

data/lib/keycase/pascal_case.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "recursive_transform/engine"
+
 module Keycase
   module PascalCase
     refine Object do
@@ -5,16 +11,18 @@ module Keycase
         self
       end
 
-      def with_pascal_case_keys
+      def with_pascal_case_keys(_options = {})
         self
       end
     end
 
     refine String do
       def to_pascal_case
-        gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
+        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| # rubocop:disable Style/SymbolProc
+        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
@@ -31,17 +39,27 @@ module Keycase
     end
 
     refine Array do
-      def with_pascal_case_keys
-        map do |value| # rubocop:disable Style/SymbolProc
-          value.with_pascal_case_keys
+      def with_pascal_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_array(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_pascal_case
         end
       end
     end
 
     refine Hash do
-      def with_pascal_case_keys
-        each_with_object({}) do |(key, value), memo|
-          memo[key.to_pascal_case] = value.with_pascal_case_keys
+      def with_pascal_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_hash(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_pascal_case
         end
       end
     end

data/lib/keycase/recursive_transform/engine.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+require_relative "errors"
+
+module Keycase
+  module RecursiveTransform
+    module Engine
+      class << self
+        def transform_hash(hash, visiting, depth, max_depth, &key_converter)
+          check_depth!(depth, max_depth)
+
+          oid = hash.object_id
+          raise CircularStructureError, "Keycase detected a circular reference in a Hash" if visiting.include?(oid)
+
+          visiting.add(oid)
+          begin
+            hash.each_with_object({}) do |(key, value), memo|
+              new_key = key_converter.call(key)
+              if memo.key?(new_key)
+                message = "Keycase detected a key collision: #{key.inspect} converted to " \
+                          "#{new_key.inspect}, which already exists in the transformed hash"
+                raise KeyCollisionError, message
+              end
+
+              memo[new_key] = transform_value(
+                value,
+                visiting,
+                depth + 1,
+                max_depth,
+                &key_converter
+              )
+            end
+          ensure
+            visiting.delete(oid)
+          end
+        end
+
+        def transform_array(array, visiting, depth, max_depth, &key_converter)
+          check_depth!(depth, max_depth)
+
+          oid = array.object_id
+          raise CircularStructureError, "Keycase detected a circular reference in an Array" if visiting.include?(oid)
+
+          visiting.add(oid)
+          begin
+            array.map do |element|
+              transform_value(
+                element,
+                visiting,
+                depth + 1,
+                max_depth,
+                &key_converter
+              )
+            end
+          ensure
+            visiting.delete(oid)
+          end
+        end
+
+        def transform_value(value, visiting, depth, max_depth, &key_converter)
+          case value
+          when Hash
+            transform_hash(value, visiting, depth, max_depth, &key_converter)
+          when Array
+            transform_array(value, visiting, depth, max_depth, &key_converter)
+          else
+            value
+          end
+        end
+
+        private
+
+        def check_depth!(depth, max_depth)
+          return if max_depth.nil?
+
+          raise StructureTooDeepError, "Keycase nesting exceeds max_depth (#{max_depth})" if depth > max_depth
+        end
+      end
+    end
+  end
+end

data/lib/keycase/recursive_transform/errors.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Keycase
+  # Signals that recursive key conversion cannot finish because the input graph loops.
+  class CircularStructureError < StandardError; end
+
+  # Signals that conversion would overwrite data by mapping multiple source keys to one key.
+  class KeyCollisionError < StandardError; end
+
+  # Signals that the caller's depth limit rejected input that is too deeply nested.
+  class StructureTooDeepError < StandardError; end
+end

data/lib/keycase/snake_case.rb

@@ -1,3 +1,9 @@
+# frozen_string_literal: true
+
+require "set"
+
+require_relative "recursive_transform/engine"
+
 module Keycase
   module SnakeCase
     refine Object do
@@ -5,14 +11,16 @@ module Keycase
         self
       end
 
-      def with_snake_case_keys
+      def with_snake_case_keys(_options = {})
         self
       end
     end
 
     refine String do
       def to_snake_case
-        gsub(/(?<=[0-9a-z])(?=[A-Z])/) do |_|
+        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}"
@@ -27,17 +35,27 @@ module Keycase
     end
 
     refine Array do
-      def with_snake_case_keys
-        map do |value| # rubocop:disable Style/SymbolProc
-          value.with_snake_case_keys
+      def with_snake_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_array(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_snake_case
         end
       end
     end
 
     refine Hash do
-      def with_snake_case_keys
-        each_with_object({}) do |(key, value), memo|
-          memo[key.to_snake_case] = value.with_snake_case_keys
+      def with_snake_case_keys(options = {})
+        Keycase::RecursiveTransform::Engine.transform_hash(
+          self,
+          ::Set.new,
+          0,
+          options[:max_depth]
+        ) do |key|
+          key.to_snake_case
         end
       end
     end

data/lib/keycase/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Keycase
-  VERSION = "1.0.0".freeze
+  VERSION = "1.1.0"
 end

data/lib/keycase.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 require "keycase/version"
+require "keycase/recursive_transform/errors"
+require "keycase/recursive_transform/engine"
 require "keycase/camel_case"
 require "keycase/kebab_case"
 require "keycase/pascal_case"

metadata

@@ -1,38 +1,32 @@
 --- !ruby/object:Gem::Specification
 name: keycase
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - naoigcat
-autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2020-07-07 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
-description: |
-  This gem converts the case of strings, symbols, and keys of hash recursively.
-  The convertible cases are camelCase, PascalCase, snake_case, etc.
+description: |2
+      This gem converts the case of strings, symbols, and keys of hash recursively.
+      The convertible cases are camelCase, PascalCase, snake_case, etc.
 email:
 - 17925623+naoigcat@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- Gemfile
-- LICENSE.txt
+- LICENSE.md
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - keycase.gemspec
 - lib/keycase.rb
 - 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/snake_case.rb
 - lib/keycase/version.rb
 homepage: https://github.com/naoigcat/ruby-keycase
@@ -41,7 +35,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/naoigcat/ruby-keycase
   source_code_uri: https://github.com/naoigcat/ruby-keycase
-post_install_message: 
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -49,15 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
-signing_key: 
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Converts the case of strings, symbols, and keys of hash.
 test_files: []

data/.gitignore

@@ -1,14 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-
-# bundler
-Gemfile.lock

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper

data/.travis.yml

@@ -1,6 +0,0 @@
----
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.5
-before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-gemspec
-
-gem "rake", "~> 12.0"
-gem "rspec", "~> 3.0"

data/Rakefile

@@ -1,6 +0,0 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "keycase"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here