hashlation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 844322f953a82a82dba511528598cfd9f7cd16407a5ed8e3a5d8d38f0ece3a7b
+  data.tar.gz: f7037b05c2682ac281a9597a95de8ca8fe3c9064e61151992a9ad511025f0c39
+SHA512:
+  metadata.gz: 46501563a71f56b65567d4cc74e8c07a51428c080114bf6ed51d3a947110a024eca3995041056097a8b1d852418c0134dff5e56fb271478c81ca737e6d8c33ba
+  data.tar.gz: e7069b715a4167e6ff4021e260b6324c6e4414c8483045bd8828d3409dee963dc38189bc3085703e980bfc86cedfa42ebb7684987ea09e6c8e00cb99882a3f36

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.1
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml
+# Editor-based HTTP Client requests
+/httpRequests/

data/.idea/classify.iml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+</module>

data/.idea/hashlation.iml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+</module>

data/.idea/inspectionProfiles/Project_Default.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <profile version="1.0">
+    <option name="myName" value="Project Default" />
+    <inspection_tool class="Rubocop" enabled="false" level="WARNING" enabled_by_default="false" />
+  </profile>
+</component>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 2.7.0" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/hashlation.iml" filepath="$PROJECT_DIR$/.idea/hashlation.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.rspec

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

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2022-05-16
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hashlation.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    hashlation (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.5.0)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hashlation!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 rharris389
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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 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.

data/README.md

@@ -0,0 +1,43 @@
+# Hashlation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hashlation'
+```
+
+And then execute:
+
+    $ bundle install
+
+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.**
+
+## 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.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rharris389/hashlation.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hashlation"
+
+# 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

@@ -0,0 +1,8 @@
+#!/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

data/hashlation.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/hashlation/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hashlation"
+  spec.version       = Hashlation::VERSION
+  spec.authors       = ["rharris389"]
+  spec.email         = ["56176404+rharris389@users.noreply.github.com"]
+
+  spec.summary       = "Simple/Lightweight hash parsing gem. "
+  spec.description   = "View keys at every nesting level, "
+  spec.homepage      = "https://github.com/rharris389/hashlation"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = 'https://rubygems.org'
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/rharris389/hashlation"
+  spec.metadata["changelog_uri"] = "https://github.com/rharris389/hashlation/changelog.md"
+
+  # 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.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/hashlation/complex.rb

@@ -0,0 +1,78 @@
+module Hashlation
+  # ---------------------------------------COMPLEX PARSER-----------------------------------------
+  # 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 Complex
+    # Only Assumption is that base level object is a Hash Array or Hash Object
+    def initialize(i, key: nil)
+      case i
+      when Array
+        process_array(i, key: key)
+      when Hash
+        process_hash(i)
+      else
+        puts 'Base object must be Hash Object or Array'
+      end
+    end
+
+    def process_array(i, key: nil)
+      attr_key = key ? sanatize_key(key) : 'array'
+      array = []
+      unless i.empty?
+        i.each do |array_item|
+          array << case array_item.class.to_s.to_sym
+                   when :Hash || :Array
+                     Complex.new(array_item)
+                   else
+                     array_item
+                   end
+        end
+      end
+      self.class.attr_accessor(attr_key)
+      send("#{attr_key}=", array)
+      instance_variable_set("@#{attr_key}", array)
+    end
+
+    def process_hash(i)
+      i.each do |key, value|
+        if key[-1, 1] == '?'
+          handle_method(key: key, value: value)
+        else
+          k_underscore = (key.instance_of? Symbol) ? key : sanatize_key(key)
+          case value
+          when Hash
+            res = Complex.new(value, key: k_underscore)
+            self.class.attr_accessor
+            self.class.attr_accessor(k_underscore)
+            send("#{k_underscore}=", res)
+            instance_variable_set("@#{k_underscore}", res)
+          when Array
+            process_array(value, key: k_underscore)
+          else
+            self.class.attr_accessor(k_underscore)
+            send("#{k_underscore}=", value)
+            instance_variable_set("@#{k_underscore}", value)
+          end
+        end
+      end
+    end
+
+
+    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
+
+    # Allows us to handle methods ending with '?' as Singleton Methods
+    def handle_method(key:, value:)
+      define_singleton_method(key) do
+        return value
+      end
+    end
+
+    def keys
+      instance_variables
+    end
+  end
+end

data/lib/hashlation/simple.rb

@@ -0,0 +1,76 @@
+module Hashlation
+  # ---------------------------------------SIMPLE PARSER-----------------------------------------
+  # SHOULD process MOST common hash keys quickly. Will fail on Leading integers on keys and inclusion of ':' characters
+  class Simple
+    # Only Assumption is that base level object is a Hash Array or Hash Object
+    def initialize(i, key: nil)
+      case i
+      when Array
+        process_array(i, key: key)
+      when Hash
+        process_hash(i)
+      else
+        puts 'Base object must be Hash Object or Array'
+      end
+    end
+
+    def process_array(i, key: nil)
+      attr_key = key ? sanatize_key(key) : 'array'
+      array = []
+      unless i.empty?
+        i.each do |array_item|
+          array << case array_item.class.to_s.to_sym
+                   when :Hash || :Array
+                     Simple.new(array_item)
+                   else
+                     array_item
+                   end
+        end
+      end
+      self.class.attr_accessor(attr_key)
+      send("#{attr_key}=", array)
+      instance_variable_set("@#{attr_key}", array)
+    end
+
+    def process_hash(i)
+      i.each do |key, value|
+        if key[-1, 1] == '?'
+          handle_method(key: key, value: value)
+        else
+          k_underscore = (key.instance_of? Symbol) ? key : sanatize_key(key)
+          case value
+          when Hash
+            res = Simple.new(value, key: k_underscore)
+            self.class.attr_accessor
+            self.class.attr_accessor(k_underscore)
+            send("#{k_underscore}=", res)
+            instance_variable_set("@#{k_underscore}", res)
+          when Array
+            process_array(value, key: k_underscore)
+          else
+            self.class.attr_accessor(k_underscore)
+            send("#{k_underscore}=", value)
+            instance_variable_set("@#{k_underscore}", value)
+          end
+        end
+      end
+    end
+
+    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
+
+    # Allows us to handle methods ending with '?' as Singleton Methods
+    def handle_method(key:, value:)
+      define_singleton_method(key) do
+        return value
+      end
+    end
+
+    def keys
+      instance_variables
+    end
+  end
+end

data/lib/hashlation/version.rb

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

data/lib/hashlation.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "hashlation/version"
+require_relative "hashlation/complex"
+require_relative "hashlation/simple"
+
+module Hashlation
+  class Error < StandardError; end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: hashlation
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- rharris389
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2022-05-16 00:00:00.000000000 Z
+dependencies: []
+description: 'View keys at every nesting level, '
+email:
+- 56176404+rharris389@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".github/.DS_Store"
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".idea/.DS_Store"
+- ".idea/.gitignore"
+- ".idea/classify.iml"
+- ".idea/hashlation.iml"
+- ".idea/inspectionProfiles/Project_Default.xml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hashlation.gemspec
+- lib/hashlation.rb
+- lib/hashlation/complex.rb
+- lib/hashlation/simple.rb
+- lib/hashlation/version.rb
+homepage: https://github.com/rharris389/hashlation
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/rharris389/hashlation
+  source_code_uri: https://github.com/rharris389/hashlation
+  changelog_uri: https://github.com/rharris389/hashlation/changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Simple/Lightweight hash parsing gem.
+test_files: []