mishmash 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 718d15742a59c5128506b8bcf435b0f85663cc05
+  data.tar.gz: 9b912c09140040ffd628a001d1f8b66e7627ade1
+SHA512:
+  metadata.gz: 2bf78b8a079d8282b96bc49ca0fd5eb2c197b127324e4c7b754736bbcee53abcd1c5fcdd437a7bf6514505b3a1803676d805af1999258d6e6e6075e44587dc3e
+  data.tar.gz: 2f968ba2e3959822a1882ddbc8848d136c72277abea265ce7e346b80dd65f6f6edcd38653f55e8d61a60a7f98a1e9d3793a5c0f54ee483a1b8e6ef2245b9230c

data/.gitignore

@@ -0,0 +1,51 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+.DS_Store

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    mishmash (0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    rake (12.3.2)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  mishmash!
+  rake
+  rspec (~> 3.2)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Ty Rauber
+
+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,85 @@
+# Mishmash
+
+A ruby class for translating *complex* hashes to an alternate schema.
+
+## Features
+
+ * rename keys in a nested hash
+ * condense an array of hash values to an array
+ * return a hash from an array of hashes based on conditional attributes
+ * return an array of hashes filtered by keys
+
+## What? Why?
+
+How do you translate an API response - or multiple responses from different APIs - to a single database schema? 
+
+Mishmash.
+
+## Methods
+
+### hash = Mishmash.new({ "a" => 1 })
+
+Mishmash new accepts and returns an input hash.
+
+### hash.translate({ "a" = "b" })
+
+An instance of Mishmash accepts a schema and returns an translated output.
+
+> { "b" => 1 }
+
+##  Examples
+
+ * rename keys in a nested hash
+ 
+```Ruby
+> Mishmash.new({ "hash"=> {"a" => 1} }).translate({ "hash" =>{ "a" => "b" }})
+=> {"hash" => {"b" => 1}}
+```
+ 
+ * condense an array of hash values to an array
+ 
+ ```Ruby
+ > Mishmash.new({
+        "array" => [
+          {"key" => "value 1"}, 
+          {"key" => "value 2"}
+          ]
+  }).translate({
+    "array" => {"key" => "array_of_values"}
+  })
+
+ => { "array_of_values" => ["value 1", "value 2"] }
+ ```
+ 
+ * return a hash from an array of hashes based on a condition
+
+ ```Ruby
+ > Mishmash.new({
+       "array" => [
+         {"option"=> "1", "value" => "X"},
+         {"option"=> "2", "value" => "Y"}
+       ]
+     }
+   }).translate({"array" => {"option" => "1", "value" => "key"}})
+
+ => {"key" => "X"}
+ ```
+
+
+ * return an array of hashes filtered by keys
+
+ ```Ruby
+ > Mishmash.new({
+       "array" => [
+         {"option"=> "1", "value" => "X"},
+         {"option"=> "2", "value" => "Y"}
+       ]
+     }
+   }).translate({"array" => ["new_array", {"option" => "1", "value" => "key"}]})
+
+ => {"new_array" => [{"key" => "X"}, {"key" => "y"}]}
+ ```
+
+## Inspection
+
+Mishmash .translate() returns an Mishmash instance, allowing for additional translation. Useful for inspecting and navigating a response to determine and appropriate response.

data/lib/mishmash.rb

@@ -0,0 +1,35 @@
+class Mishmash < Hash
+  def initialize(input, schema={}, output={})
+    input.each_pair do |key,value|
+      self[key] = value
+    end
+    self.translate(schema, output) unless schema.empty?
+  end
+
+  def translate(schema, output={})
+    return unless self.is_a?(Hash) && schema.is_a?(Hash)
+    (self.keys | schema.keys).each_with_object({}) do |k, diff|
+      if self[k] && schema[k] && self[k] != schema[k]
+        if self[k].is_a?(Hash) && schema[k].is_a?(Hash)
+         Mishmash.new(self[k]).translate(schema[k], output)
+        elsif self[k].is_a?(Array) &&  schema[k].is_a?(Array)
+          output[schema[k][0]] = self[k].map do |kk,vv|
+            Mishmash.new(kk).translate(schema[k][1])
+          end
+        elsif self[k].is_a?(Array) && schema[k].is_a?(Hash)
+          self[k].each do |kk|
+            if  (self[k].map(&:values).flatten & schema[k].values).empty? || !(kk.values & schema[k].values).empty?
+              Mishmash.new(kk).translate(schema[k], output) 
+            end
+          end
+        elsif output[schema[k]]
+          output[schema[k]] = [output[schema[k]]] unless output[schema[k]].is_a?(Array)
+          output[schema[k]].push(self[k])
+         elsif self[k]
+          output[schema[k]] = self[k]
+        end
+      end
+    end
+    return Mishmash.new(output)
+  end
+end

data/mishmash.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mishmash'
+  spec.version       = '0.1'
+  spec.authors       = ['Ty Rauber']
+  spec.email         = ['tyrauber@mac.com']
+  spec.summary       = %q{ A ruby hash translation library }
+  spec.description   = %q{ Given an input hash, output a translated hash with a given schema. Mishmash.new({a:1}).translate({a:b}) = {b:1} }
+  spec.homepage      = 'https://github.com/tyrauber/Mishmash'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+end

data/spec/mishmash_spec.rb

@@ -0,0 +1,167 @@
+require './lib/mishmash'
+
+describe "Mishmash" do
+  
+  it "should respond to new" do
+    expect(Mishmash.respond_to?('new')).to be(true)
+  end
+  
+  describe "output" do
+    it "shgould respond to translate" do
+      expect(Mishmash.new({"key" => "value"}).respond_to?("translate")).to be(true)
+    end
+  end
+
+  context "translate with alternate schema" do
+
+    it "root keys"  do
+      hash = Mishmash.new({"key" => "value"})
+      expect(hash.translate({"key" => "new_key"})).to eq({"new_key" => "value"}) 
+    end
+
+    it "nested keys to root keys" do
+      hash = Mishmash.new({"hash" => {"key" => "value"}})
+      expect(hash.translate({"hash" => {"key" => "new_key"}})).to eq({"new_key" => "value"}) 
+    end
+  end
+  
+  describe "given an input, schema and output" do
+    let(:input){
+      {
+        "array" => [
+          {"key" => "value 1"}, 
+          {"key" => "value 2"}
+          ]
+      }
+    }
+    let(:output){
+      { 
+        "array_of_values" => ["value 1", "value 2"]
+      }
+    }
+    
+    let(:schema) {
+      {"array" => {"key" => "array_of_values"}}
+    }
+    it "Translate an Array of Hashes to Hash of Arrays with a schema" do
+      expect(Mishmash.new(input).translate(schema)).to eq(output)
+    end
+  end
+  
+  describe "given an input with an array of hashes" do
+    let(:input){
+      {
+        "array" => [
+          {"key" => "value 1"}, 
+          {"key" => "value 2"}
+          ]
+      }
+    }
+    describe "return a hash with array of values" do
+      let(:output){
+        { 
+          "key" => ["value 1", "value 2"]
+        }
+      }
+      let(:schema) {
+        {"array" => {"key" => "key"}}
+      }
+      it "with an alternate key_name" do
+        expect(Mishmash.new(input).translate(schema)).to eq(output)
+      end
+    end
+  end
+  
+  describe "given an input with an array of hashes" do
+    let(:input){
+      {
+        "array" => [
+          {"key" => "value 1"}, 
+          {"key" => "value 2"}
+          ]
+      }
+    }
+    describe "return a hash with array of values" do
+      let(:output){
+        { 
+          "key" => ["value 1", "value 2"]
+        }
+      }
+      let(:schema) {
+        {"array" => {"key" => "key"}}
+      }
+      it "with an alternate key_name" do
+        expect(Mishmash.new(input).translate(schema)).to eq(output)
+      end
+    end
+  end
+  
+  describe "given an input with an array of hashes" do
+    let(:input){
+      {
+        "array" => [
+          {"option"=> "1", "value" => "X"},
+          {"option"=> "2", "value" => "Y"}
+        ]
+      }
+    }
+    describe "return a hash matching a condition" do
+      let(:output){
+        {"option" => "X"}
+      }
+      let(:schema) {
+        {"array" => {"option" => "1", "value" => "option"}}
+      }
+      it "with an alternate key_name" do
+        expect(Mishmash.new(input).translate(schema)).to eq(output)
+      end
+    end
+  end
+  
+  describe "given an input with an array of hashes" do
+    let(:input){
+      {
+        "array" => [
+          {"option"=> "1", "value" => "X"},
+          {"option"=> "2", "value" => "Y"}
+        ]
+      }
+    }
+    describe "return a hash matching a condition" do
+      let(:output){
+        {"option" => "X"}
+      }
+      let(:schema) {
+        {"array" => {"option" => "1", "value" => "option"}}
+      }
+      it "with an alternate key_name" do
+        expect(Mishmash.new(input).translate(schema)).to eq(output)
+      end
+    end
+  end
+  
+  describe "given an input with an array of hashes" do
+    let(:input){
+      {
+        "array" => [
+          {"option"=> "1", "value" => "X"},
+          {"option"=> "2", "value" => "Y"}
+        ]
+      }
+    }
+    describe "return an array of translated and filtered hashes" do
+      let(:output){
+        {"new array" => [
+          {"attribute" => "X"},
+          {"attribute" => "Y"}
+        ]}
+      }
+      let(:schema) {
+        {"array" => [ "new array",  {"value" => "attribute"} ] }
+      }
+      it "with an alternate key_name" do
+        expect(Mishmash.new(input).translate(schema)).to eq(output)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: mishmash
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Ty Rauber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: " Given an input hash, output a translated hash with a given schema.
+  Mishmash.new({a:1}).translate({a:b}) = {b:1} "
+email:
+- tyrauber@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- lib/mishmash.rb
+- mishmash.gemspec
+- spec/mishmash_spec.rb
+homepage: https://github.com/tyrauber/Mishmash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: A ruby hash translation library
+test_files:
+- spec/mishmash_spec.rb