hashlation 0.1.1 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3ec5607c29923a8ef6ccb8e880c75780adb8dc4ed40f32b938601b17d2acd88
-  data.tar.gz: 7925a5d3ce2fbefcfa44005730968105b47af93cec4dc76d6dcb8f9c7b22aba5
+  metadata.gz: a4749821b8641ec38d5873ef319710ea86068b57dde8691fd2c9ea4d588f5a1f
+  data.tar.gz: 1f1ba4280c4b9970fc9e6222712d630309d63c8ed1645746cf4a2abff1b56119
 SHA512:
-  metadata.gz: b7fa942c882b82fbb703a6abf5120e7261f1e50024630748b767e78fe7fbb4d77a38d649f5520d116ddc52a413fd01696b129b3fbd1c608c6154e532b34fb9cd
-  data.tar.gz: 399d3a0325b7c6b1395f6976d20df5bde8662ddc35f885e305e8eb7b25c27b1feaa9514951b0a0508982d0feec6c6210b9865c90207c2df7bfcd5029c13031cc
+  metadata.gz: faabb932c886ab678c0387150cbfecac339de828cbbbdc1532460baf7883a86ed9273b52930e7aa84a1b8c83d0449280e25914bb010aba1e054445b383ab7492
+  data.tar.gz: ced1723b25e56f8426f0cdf1927c12f24b5eae62d4a399821276a572d81495f96509340677a858b57b7b152bd9106b12b1fe02431f69646d25f343eb4c1e7834

data/README.md

@@ -16,17 +16,51 @@ Or install it yourself as:
 
     $ gem install hashlation
 
-## Usage
 
-    Hashlation::Simple -> Hashlation::Simple.new(hash) 
     
-    Handles simple string/symbol keys in conversion as well as singleton_methods. Much faster, but cannot hanlde edge cases in response. 
-
-    Hashlation::Complex -> Hashlation::Complex.new(hash) 
-    
-    Handles MOST key types in conversion. If you know that your keys will contain leading Integer characters, or ':'.
     
-    **If ::Complex fails due to inability to read key, please report an Issue.**
+## Methods
+
+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
+
+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! **
+
+---
+
+## Translated Keys Format:
+
+Keys that cannot be set as-is by attr_accessor will be transformed.
+
+### Simple:
+
+- `'Test-Name' -> obj.test_name`
+
+### Complex:
+
+- `'11123:12312' -> obj._11123_12312`
 
 ## Development
 
@@ -41,3 +75,7 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/rharri
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+---
+
+*Naming credit belongs to my wife, who bales out my inability to name stuff..*

data/hashlation.gemspec

@@ -8,11 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["rharris389"]
   spec.email         = ["56176404+rharris389@users.noreply.github.com"]
 
-  spec.summary       = "Simple/Lightweight hash parsing gem."
-  spec.description   = "Quickly parses hashes into objects for cleaner navigation of large response objects.
-                         Hashlation::Simple.new(hash_object) will handle most common string and symbol keys.
-                         Certain characters in a key, such as a leading Integer or a ':' will not translate with Simple.
-                         These must be processed with the Hashlation::Complex.new(hash_object) method. Name credit to my wife."
+  spec.summary       = "Lightweight response parsing"
+  spec.description   = "Lightweight parser for cleaner navigation of large or 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/complex.rb

@@ -60,7 +60,6 @@ module Hashlation
 
     def sanatize_key(key)
       # If this is to be responses may contain improper keys, uncomment and implement for all attr names
-      # the PrimeTrust API responses only need to be underscored as they do not contain leading integers or dis-allowed characters
       key[0,1] =~ /^[0-9].*/ ? "_#{key.tr(':', '_').underscore}" : key.tr(':', '_').underscore
     end
 

data/lib/hashlation/simple.rb

@@ -58,7 +58,6 @@ module Hashlation
 
     def sanatize_key(key)
       # If this is to be responses may contain improper keys, uncomment and implement for all attr names
-      # the PrimeTrust API responses only need to be underscored as they do not contain leading integers or dis-allowed characters
       key.underscore
     end
 

data/lib/hashlation/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hashlation
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.4
 platform: ruby
 authors:
 - rharris389
@@ -10,11 +10,7 @@ bindir: exe
 cert_chain: []
 date: 2022-05-16 00:00:00.000000000 Z
 dependencies: []
-description: |-
-  Quickly parses hashes into objects for cleaner navigation of large response objects.
-                           Hashlation::Simple.new(hash_object) will handle most common string and symbol keys.
-                           Certain characters in a key, such as a leading Integer or a ':' will not translate with Simple.
-                           These must be processed with the Hashlation::Complex.new(hash_object) method. Name credit to my wife.
+description: Lightweight parser for cleaner navigation of large or deeply nested hashes.
 email:
 - 56176404+rharris389@users.noreply.github.com
 executables: []
@@ -73,5 +69,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Simple/Lightweight hash parsing gem.
+summary: Lightweight response parsing
 test_files: []