snaky_hash 1.0.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e99b35c24440f1bdfff52d7df4819b0d3aa662bdbe22a6d71d1c80830229fc92
-  data.tar.gz: 9fa5b0c87bda98373f1fd2361aca7f5288dd37ab813f868a405dfdffc72a43b8
+  metadata.gz: 5995aa841b28557864f23d3d2e08c861d5854805c8eb8bed7e68719b89412a44
+  data.tar.gz: 035cd4ab1644739be5ab0bfcea8388bc37110e4cd4b3d495b70715652bd3cd35
 SHA512:
-  metadata.gz: 731ec98f1d8eb0538a1b707ac09bbc7ddc18489993a332a872d2e1115d5d46d0c0a814d71729788fbd01a3b01990402d60116d321aa385a745970b67ca6ce364
-  data.tar.gz: 671f10410a228e0989e940da413c6a13ce8404d315393cef59b9b043db05c7574afae1835c43a9728d06e81f15a9f64f01ec1c36f50d0a6564d8c703cea74a96
+  metadata.gz: b2ee23b5884158fe2642c73b2d00665900e509a606942008cc2e02aee79becd46d01f71e16e4702d027f9961cbd24f5892ecf4bf06915344def299b4488f9324
+  data.tar.gz: fa72da01cb55b92152f9274f3dcb2920c6948d73ed11d0d3af70cfa86b713985b73746e3a8b60f0cf8873e8fea62dbd4dcc9d659e329ccbaad32ff901052ea34

data/CHANGELOG.md

@@ -12,6 +12,18 @@ and this project adheres to [Semantic Versioning v2](https://semver.org/spec/v2.
 
 ## [Unreleased]
 
+## [2.0.0] - 2022-08-29
+### Changed
+- **BREAKING**: `SnakeHash::Snake` is now a mixin, now with support for symbol or string keys
+```ruby
+class MySnakedHash < Hashie::Mash
+  include SnakyHash::Snake.new(key_type: :string) # or :symbol
+end
+```
+### Added
+- `SnakyHash::StringKeyed`: a Hashie::Mash class with snake-cased String keys
+- `SnakyHash::SymbolKeyed`: a Hashie::Mash class with snake-cased Symbol keys
+
 ## [1.0.1] - 2022-08-26
 ### Added
 - Missing LICENSE.txt file to release

data/README.md

@@ -5,7 +5,7 @@ and provide a nice psuedo-object interface.
 
 It has its roots in the `Rash` (specifically the [`rash_alt`](https://github.com/shishi/rash_alt) flavor), which is a special `Mash`, made popular by the `hashie` gem.
 
-`SnakyHash::Snake` does inherit from `Hashie::Mash` and adds some additional behaviors.
+Classes that include `SnakyHash::Snake` should inherit from `Hashie::Mash`.
 
 ## Installation
 
@@ -19,7 +19,45 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-For now, please see specs
+```ruby
+class MySnakedHash < Hashie::Mash
+  include SnakyHash::Snake.new(key_type: :string) # or :symbol
+end
+
+snake = MySnakedHash.new(a: 'a', 'b' => 'b', 2 => 2, 'VeryFineHat' => 'Feathers')
+snake.a # => 'a'
+snake.b # => 'b'
+snake[2] # 2
+snake.very_fine_hat # => 'Feathers'
+snake[:very_fine_hat] # => 'Feathers'
+snake['very_fine_hat'] # => 'Feathers'
+```
+
+Note above that you can access the values via the string, or symbol.
+The `key_type` determines how the key is actually stored, but the hash acts as "indifferent".
+Note also that keys which do not respond to `to_sym`, because they don't have a natural conversion to a Symbol,
+are left as-is.
+
+### Stranger Things
+
+I don't recommend using these features... but they exist (for now).
+You can still access the original un-snaked camel keys.
+And through them you can even use un-snaked camel methods.
+
+```ruby
+snake.key?('VeryFineHat') # => true
+snake['VeryFineHat'] # => 'Feathers'
+snake.VeryFineHat # => 'Feathers', PLEASE don't do this!!!
+snake['VeryFineHat'] = 'pop' # Please don't do this... you'll get a warning, and it works (for now), but no guarantees.
+# WARN -- : You are setting a key that conflicts with a built-in method MySnakedHash#VeryFineHat defined in MySnakedHash. This can cause unexpected behavior when accessing the key as a property. You can still access the key via the #[] method.
+# => "pop"
+snake.very_fine_hat = 'pop' # => 'pop', do this instead!!!
+snake.very_fine_hat # => 'pop'
+snake[:very_fine_hat] = 'moose' # => 'moose', or do this instead!!!
+snake.very_fine_hat # => 'moose'
+snake['very_fine_hat'] = 'cheese' # => 'cheese', or do this instead!!!
+snake.very_fine_hat # => 'cheese'
+```
 
 ## Development
 

data/lib/snaky_hash/snake.rb

@@ -1,51 +1,72 @@
-require "hashie/mash"
-
+# This is a module-class hybrid.
+#
+# Hashie's standard SymbolizeKeys is similar to the functionality we want.
+# ... but not quite.  We need to support both String (for oauth2) and Symbol keys (for oauth).
+# include Hashie::Extensions::Mash::SymbolizeKeys
 module SnakyHash
-  class Snake < Hashie::Mash
-    # This is similar to the functionality we want.
-    # include Hashie::Extensions::Mash::SymbolizeKeys
-
-    protected
-
-    # Converts a key to a string,
-    #   but only if it is able to be converted to a symbol.
-    #
-    # @api private
-    # @param [<K>] key the key to attempt convert to a symbol
-    # @return [String, K]
-    def convert_key(key)
-      key.respond_to?(:to_sym) ? underscore_string(key.to_s) : key
+  class Snake < Module
+    def initialize(key_type: :string)
+      super()
+      @key_type = key_type
     end
 
-    # Unlike its parent Mash, a SnakyHash::Snake will convert other
-    #   Hashie::Hash values to a SnakyHash::Snake when assigning
-    #   instead of respecting the existing subclass
-    def convert_value(val, duping = false) #:nodoc:
-      case val
-      when self.class
-        val.dup
-      when ::Hash
-        val = val.dup if duping
-        self.class.new(val)
-      when ::Array
-        val.collect { |e| convert_value(e) }
-      else
-        val
-      end
+    def included(base)
+      conversions_module = SnakyModulizer.to_mod(@key_type)
+      base.include(conversions_module)
     end
 
-    # converts a camel_cased string to a underscore string
-    # subs spaces with underscores, strips whitespace
-    # Same way ActiveSupport does string.underscore
-    def underscore_string(str)
-      str.to_s.strip
-         .tr(" ", "_")
-         .gsub(/::/, "/")
-         .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
-         .gsub(/([a-z\d])([A-Z])/, '\1_\2')
-         .tr("-", "_")
-         .squeeze("_")
-         .downcase
+    module SnakyModulizer
+      def self.to_mod(key_type)
+        Module.new do
+          # Converts a key to a symbol, or a string, depending on key_type,
+          #   but only if it is able to be converted to a symbol,
+          #   and after underscoring it.
+          #
+          # @api private
+          # @param [<K>] key the key to attempt convert to a symbol
+          # @return [Symbol, K]
+
+          case key_type
+          when :string then
+            define_method(:convert_key) { |key| key.respond_to?(:to_sym) ? underscore_string(key.to_s) : key }
+          when :symbol then
+            define_method(:convert_key) { |key| key.respond_to?(:to_sym) ? underscore_string(key.to_s).to_sym : key }
+          else
+            raise ArgumentError, "SnakyHash: Unhandled key_type: #{key_type}"
+          end
+
+          # Unlike its parent Mash, a SnakyHash::Snake will convert other
+          #   Hashie::Hash values to a SnakyHash::Snake when assigning
+          #   instead of respecting the existing subclass
+          define_method :convert_value do |val, duping = false| #:nodoc:
+            case val
+            when self.class
+              val.dup
+            when ::Hash
+              val = val.dup if duping
+              self.class.new(val)
+            when ::Array
+              val.collect { |e| convert_value(e) }
+            else
+              val
+            end
+          end
+
+          # converts a camel_cased string to a underscore string
+          # subs spaces with underscores, strips whitespace
+          # Same way ActiveSupport does string.underscore
+          define_method :underscore_string do |str|
+            str.to_s.strip
+               .tr(" ", "_")
+               .gsub(/::/, "/")
+               .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+               .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+               .tr("-", "_")
+               .squeeze("_")
+               .downcase
+          end
+        end
+      end
     end
   end
 end

data/lib/snaky_hash/string_keyed.rb

@@ -0,0 +1,5 @@
+module SnakyHash
+  class StringKeyed < Hashie::Mash
+    include SnakyHash::Snake.new(key_type: :string)
+  end
+end

data/lib/snaky_hash/symbol_keyed.rb

@@ -0,0 +1,5 @@
+module SnakyHash
+  class SymbolKeyed < Hashie::Mash
+    include SnakyHash::Snake.new(key_type: :symbol)
+  end
+end

data/lib/snaky_hash/version.rb

@@ -2,6 +2,6 @@
 
 module SnakyHash
   module Version
-    VERSION = "1.0.1".freeze
+    VERSION = "2.0.0".freeze
   end
 end

data/lib/snaky_hash.rb

@@ -6,7 +6,10 @@ require "version_gem"
 
 require_relative "snaky_hash/version"
 require_relative "snaky_hash/snake"
+require_relative "snaky_hash/string_keyed"
+require_relative "snaky_hash/symbol_keyed"
 
+# This is the namespace for this gem
 module SnakyHash
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snaky_hash
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
 - Peter Boling
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-block_is_expected
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'A Hashie::Mash joint to make #snakelife better'
 email:
 - peter.boling@gmail.com
@@ -95,16 +109,18 @@ files:
 - SECURITY.md
 - lib/snaky_hash.rb
 - lib/snaky_hash/snake.rb
+- lib/snaky_hash/string_keyed.rb
+- lib/snaky_hash/symbol_keyed.rb
 - lib/snaky_hash/version.rb
 homepage: https://gitlab.com/oauth-xx/snaky_hash
 licenses:
 - MIT
 metadata:
   homepage_uri: https://gitlab.com/oauth-xx/snaky_hash
-  source_code_uri: https://gitlab.com/oauth-xx/snaky_hash/-/tree/v1.0.1
-  changelog_uri: https://gitlab.com/oauth-xx/snaky_hash/-/blob/v1.0.1/CHANGELOG.md
+  source_code_uri: https://gitlab.com/oauth-xx/snaky_hash/-/tree/v2.0.0
+  changelog_uri: https://gitlab.com/oauth-xx/snaky_hash/-/blob/v2.0.0/CHANGELOG.md
   bug_tracker_uri: https://gitlab.com/oauth-xx/snaky_hash/-/issues
-  documentation_uri: https://www.rubydoc.info/gems/snaky_hash/1.0.1
+  documentation_uri: https://www.rubydoc.info/gems/snaky_hash/2.0.0
   wiki_uri: https://gitlab.com/oauth-xx/snaky_hash/-/wikis/home
   rubygems_mfa_required: 'true'
 post_install_message: