hashlation 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ea79a7925cc1bbb74a610f5a501cda5bd7e75fce4ef3cf07769e16bd7182bd6
-  data.tar.gz: 89dd89bbe44300fc32075c695b412719a357da34862cc16ed88e6b68914f3bcf
+  metadata.gz: 52fc04f602d14cd91c6c7f9041b1fe49700e522b4dee867334d646e2961ba3ec
+  data.tar.gz: e018fc8740c10f9cf02f5fab2b4e5c7439df395e7ef0fd18aa362dad2b15667c
 SHA512:
-  metadata.gz: dd5bf21e523ba96bfb500461e12fba4c8d27c590df9fcd1fcc5bf4808f7f36470242bb41d318cb8f41579ee64ad0abb980d5df4267ffe53becf6f634e875a017
-  data.tar.gz: 9bbec94a8480565dbd3153cb14e6a7023b065bea688b63b1db4406f533634e2bf440210be10e65d3ffd35c1804bfb1a11b5d46a9305e5999fb8c7ff4bdefce44
+  metadata.gz: ffc0fb90dd2edd7d3188e4b4f080a53f28189a4a3605384db2077878048af9453e62fd702e815a48094c8d091517d24c328a08d909e501d2b09336d571941991
+  data.tar.gz: 7c091b00481934e018c8af726dd0a6b1e9d34a981b263667884892da6de0e3bf80ec58349fcbb982e1f98aad87ed9e730bc18edfc4d882de7a11c66b39656e7a

data/README.md

@@ -1,5 +1,7 @@
 # Hashlation
 
+FAST and VERSATILE hash transformer. Born of the need to more easily read and traverse deeply nested response objects. Faster at 1 to 1 comparisons and more versatile than both OpenStruct and Hashie.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -19,49 +21,28 @@ Or install it yourself as:
 
     
     
-## Methods
+## Usage
 
 The returned `obj` includes the method `.keys` to list the keys on the object at every level.
 
----
-
-### Simple 
-
-Handles simple string/symbol keys in conversion as well as singleton_methods. Very fast, but cannot handle edge cases in keys.
-
-Usage:
-
-`obj = Hashlation::Simple.new(hash)`
-
-
----
-
-### Complex
+`obj = Hashlation::Any.new(hash)`
 
-Handles MOST key types in conversion. If you know that your keys will contain leading Integer characters, or ':' use this method.
-
-Usage:
-
-`obj = Hashlation::Complex.new(hash)`
-
----
-
-** If `Complex` fails due to inability to read a key, please report in GitHub Issues. Thanks! **
+Handles both simple and complex string/symbol keys in translation. Defines singleton_methods for keys ending in '?'.
 
 ---
 
 ## Translated Keys Format:
 
-Keys that cannot be set as-is by attr_accessor will be transformed.
-
-### Simple:
+Keys that cannot be set as-is by attr_accessor will be transformed. For example:
 
 - `'Test-Name' -> obj.test_name`
 
-### Complex:
-
 - `'11123:12312' -> obj._11123_12312`
 
+** If `Any` fails due to inability to read a key, please report in GitHub Issues. Thanks! **
+
+---
+
 ## 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.

data/hashlation.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["56176404+rharris389@users.noreply.github.com"]
 
   spec.summary       = "Lightweight response parsing"
-  spec.description   = "Lightweight parser for cleaner navigation of large or deeply nested hashes."
+  spec.description   = "Lightweight parser for cleaner navigation of large and deeply nested hashes."
   spec.homepage      = "https://github.com/rharris389/hashlation"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")

data/lib/hashlation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hashlation
-  VERSION = "1.0.0"
+  VERSION = "1.1.1"
 end

data/lib/hashlation.rb

@@ -3,8 +3,8 @@
 require_relative "hashlation/version"
 
 module Hashlation
-  # SHOULD process ANY Hash object return, if object if failing, it is likely that a key is not getting transformed
-  # correctly, add that character to the transformation string to process correctly.
+  # SHOULD process ANY Hash object return, if object if failing it is likely that a key is not getting transformed correctly.
+  # Add that character to the transformation string to process correctly.
   class Any
     # Only Assumption is that base level object is a Hash Array or Hash Object
     def initialize(i, key: nil)
@@ -23,8 +23,8 @@ module Hashlation
       array = []
       unless i.empty?
         i.each do |array_item|
-          array << case array_item.class.to_s.to_sym
-                   when :Hash || :Array
+          array << case array_item
+                   when Hash || Array
                      Any.new(array_item)
                    else
                      array_item
@@ -46,7 +46,6 @@ module Hashlation
           handle_method(key: key, value: value)
         else
           k_underscore = (key.instance_of? Symbol) ? key : key.underscore
-
           case value
           when Hash
             res = Any.new(value, key: k_underscore)
@@ -72,8 +71,8 @@ module Hashlation
       end
     end
 
+    # Use Begin/Rescue to submit complex keys be sanitized and written to attr_accessor without needlessly checking keys.
     def handle_complex_key(key, value)
-      # If this is to be responses may contain improper keys, uncomment and implement for all attr names
       k_special_underscore = key[0,1] =~ /^[0-9].*/ ? "_#{key.tr(':', '_').underscore}" : key.tr(':', '_').underscore
       self.class.attr_accessor(k_special_underscore)
       send("#{k_special_underscore}=", value)
@@ -87,6 +86,7 @@ module Hashlation
       end
     end
 
+    # Get keys at this object level.
     def keys
       instance_variables
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashlation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - rharris389
@@ -10,7 +10,8 @@ bindir: exe
 cert_chain: []
 date: 2022-05-17 00:00:00.000000000 Z
 dependencies: []
-description: Lightweight parser for cleaner navigation of large or deeply nested hashes.
+description: Lightweight parser for cleaner navigation of large and deeply nested
+  hashes.
 email:
 - 56176404+rharris389@users.noreply.github.com
 executables: []