structure_flatter 0.0.7

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGMxNDUwZmQ4ZDdjMzBlZWU2M2ZlOWZkMWIwOWNiNGY2YTIxZjdmNA==
+  data.tar.gz: !binary |-
+    ZWZhMzJmYjU4ZTVkMTFhYjU3M2UxNzc4NDUyNzI5NWI0NTA5ZjczNw==
+SHA512:
+  metadata.gz: !binary |-
+    ZmRjYjY4NjgwOWI5MTE0NWFjZTdlODRiMDczM2I1YTdhZmIxMzQ4ODMwYjgz
+    YjlkOGNmY2ExZmU0ZmRhOTMyYWMwMzMwZDFiYjYyZjJiNmY1MzliNTRhN2Uw
+    ZjkyYWI5MzA2NTUyODE4ZmRiNDdjZWE5NTZmZGVlNDMwN2RiOTg=
+  data.tar.gz: !binary |-
+    NmI1ZmJkMTdhY2ZkOWM2MjY4M2UwYjQ3YTA5OWNlNDMwYjRhNTU4MGMzYzE5
+    NDdjMGU4NzA3Yzk3YTZiNDc0NzEzOGI4MDljNTNkZDk5YTRhNjUxNmY2ZDgw
+    ZDg0MjU5MzJkOGY0NDczZDYzNDVhY2YxYWEyZTlkNTBlNDY3N2E=

data/.gitignore

@@ -0,0 +1,26 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Ignore RubyMine's .idea directory
+/.idea/*
+
+# Ignore Aptana's .project file
+/.project
+
+# Ignoring .rvmrc
+/.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color 
+--format documentation 

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in structure_flatter.gemspec
+gemspec
+
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 G580 mgoyal
+
+MIT License
+
+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,65 @@
+# StructureFlatter
+
+When transforming data from one format to another, sometimes we end up with structures that have redundant information or a sub-optimal structure.
+One type of such structure is an array of hash tables where the hash table has a redundant root element that is the singular version of the attribute on the parent object.
+
+For example,
+
+
+    {
+      attribute_one: "foo",
+      cars: [
+        { car: { name: "c1", content: "car one" } },
+        { car: { name: "c2", content: "car two" } },
+        { car: { name: "c3", content: "car three" } }
+      ]
+    }
+
+The "structure_flatter" library flattens all occurrences of the above type of structure from a given array or hash consisting of other hashes, arrays or attributes to arbitrary depth and complexity.
+
+The result of providing the above example will be:
+
+    {
+      attribute_one: "foo",
+      cars: [
+        { name: "c1", content: "car one" },
+        { name: "c2", content: "car two" },
+        { name: "c3", content: "car three" }
+      ]
+    }
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'structure_flatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install structure_flatter
+
+## Usage
+
+Let str holds an array-hash structure that is to be flattened
+
+    str = an_array_hash_structure_to_be_flatten
+
+Use flatten_structure! method of ArrayHashStructure class to flatten the structure
+
+    require 'structure_flatter'
+
+    flattened_str = StructureFlatter::ArrayHashStructure.new(str).flatten_structure!
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/structure_flatter.rb

@@ -0,0 +1,6 @@
+require 'structure_flatter/version'
+require 'structure_flatter/array_hash_structure'
+
+module StructureFlatter
+  # Your code goes here...
+end

data/lib/structure_flatter/array_hash_structure.rb

@@ -0,0 +1,70 @@
+require 'active_support/core_ext/string'
+
+module StructureFlatter
+  class ArrayHashStructure
+
+    # initializing element
+    # passed structure should be a simple or complex structure comprising Hashes and Arrays
+    def initialize(array_hash_structure = nil)
+      @array_hash_structure = array_hash_structure
+    end
+
+    # it flattens the given structure
+    def flatten_structure!(array_hash_structure = @array_hash_structure)
+      case array_hash_structure
+        when Array
+          array_hash_structure.each do |array_element|
+            flatten_structure!(array_element) if ((array_element.class == Array) || (array_element.class == Hash))
+          end
+        when Hash
+          array_hash_structure.each do |hash_key, hash_value|
+            if hash_value.class == Array
+              # trying to flatten the value
+              ArrayHashStructure.flatten_key_value_pair!(hash_key, hash_value)
+              # recursive call
+              flatten_structure!(hash_value)
+            elsif hash_value.class == Hash
+              hash_value.each do |hash_value_key, hash_value_value|
+                # recursive call
+                flatten_structure!(hash_value_value)
+              end
+            else
+              # do nothing
+            end
+          end
+        else
+          # do nothing
+      end
+      return array_hash_structure
+    end
+
+    # it tries to flatten the given key value pair
+    def self.flatten_key_value_pair!(key, value)
+      if self.is_key_value_pair_flattable?(key, value)
+        value.each_index do |index|
+          value[index] = value[index].values.first
+        end
+      end
+      return [key, value]
+    end
+
+    # check if given key value pair is flattable
+    def self.is_key_value_pair_flattable?(key, value)
+      # key should be plural
+      return false unless key.to_s.pluralize == key.to_s
+      # value should be Array
+      return false unless value.class == Array
+      # checking each element of value (which is Array)
+      value.each do |value_element|
+        # should be hash
+        return false unless value_element.class == Hash
+        # it should have only one key-value pair
+        return false unless value_element.count == 1
+        # its key should be singular form of original key
+        return false unless (value_element.keys.first.to_s != key.to_s) && (value_element.keys[0].to_s.pluralize == key.to_s)
+      end
+      return true
+    end
+  end
+end
+

data/lib/structure_flatter/version.rb

@@ -0,0 +1,3 @@
+module StructureFlatter
+  VERSION = '0.0.7'
+end

data/spec/inputs/various_key_value_pairs.rb

@@ -0,0 +1,22 @@
+module VariousKeyValuePairs
+
+  def key_value_pair_1
+    key = :posts
+    value = [
+        {post: {name: 'p1', content: 'post one'}},
+        {post: {name: 'p2', content: 'post two'}},
+        {post: {name: 'p3', content: 'post three'}}
+    ]
+    return [key, value]
+  end
+
+  def key_value_pair_1_result
+    key = :posts
+    value = [
+        {name: 'p1', content: 'post one'},
+        {name: 'p2', content: 'post two'},
+        {name: 'p3', content: 'post three'}
+    ]
+    return [key, value]
+  end
+end

data/spec/inputs/various_structures.rb

@@ -0,0 +1,160 @@
+module VariousStructures
+
+  def nil_structure
+    nil
+  end
+
+  def empty_hash_structure
+    {}
+  end
+
+  def empty_array_structure
+    []
+  end
+
+  def very_simple_hash_structure
+    {:key1 => :value1, :key2 => :value2, :key => :value3}
+  end
+
+  def very_simple_array_structure
+    %w(value1, value2, value3)
+  end
+
+  def simple_hash_structure
+    {
+        posts: [
+            {post: {name: 'p1', content: 'post one'}},
+            {post: {name: 'p2', content: 'post two'}},
+            {post: {name: 'p3', content: 'post three'}}
+        ]
+    }
+  end
+
+  def simple_hash_structure_result
+    {
+        posts: [
+            {name: 'p1', content: 'post one'},
+            {name: 'p2', content: 'post two'},
+            {name: 'p3', content: 'post three'}
+        ]
+    }
+  end
+
+  def complex_hash_structure
+    {
+        attribute_one: 'foo',
+        posts: [
+            {post: {name: 'p1', content: 'post one'}},
+            {post: {name: 'p2', content: 'post two'}},
+            {post: {name: 'p3', content: 'post three'}}
+        ]
+    }
+  end
+
+  def complex_hash_structure_result
+    {
+        attribute_one: 'foo',
+        posts: [
+            {name: 'p1', content: 'post one'},
+            {name: 'p2', content: 'post two'},
+            {name: 'p3', content: 'post three'}
+        ]
+    }
+  end
+
+  def complex_hash_with_mixed_string_and_keys_structure
+    {
+        :attribute_one =>  'foo',
+        posts: [
+            {'post' =>  {'name' =>  'p1', content: 'post one'}},
+            {:post => {name: 'p2', content: 'post two'}},
+            {post: {name: 'p3', content: 'post three'}}
+        ]
+    }
+  end
+
+  def complex_hash_with_mixed_string_and_keys_structure_result
+    {
+        attribute_one: 'foo',
+        posts: [
+            {'name' => 'p1', content: 'post one'},
+            {name: 'p2', content: 'post two'},
+            {name: 'p3', content: 'post three'}
+        ]
+    }
+  end
+
+  def complex_array_structure
+    ['first_element',
+     {
+         attribute_one: 'foo',
+         cars: [
+             {car: {name: 'p1', content: 'car one'}},
+             {car: {name: 'p2', content: 'car two'}},
+             {car: {name: 'p3', content: 'car three'}}
+         ]
+     }]
+  end
+
+  def complex_array_structure_result
+    ['first_element',
+     {
+         attribute_one: 'foo',
+         cars: [
+             {name: 'p1', content: 'car one'},
+             {name: 'p2', content: 'car two'},
+             {name: 'p3', content: 'car three'}
+         ]
+     }]
+  end
+
+  def complex_nested_structure
+    {
+        attribute_one: 'foo',
+        posts: [
+            {post: {name: 'p1', content: 'post one'}},
+            {post: {name: 'p2', content: 'post two'}},
+            {post: {name: 'p3', content: 'post three'}}
+        ],
+        cars: [
+            {car: {name: 'p1', content: 'car one'}},
+            {car: {name: 'p2', content: 'car two'}},
+            {car: {name: 'p3', content: 'car three'}}
+        ],
+        attribute_three: [1, 2,
+                          {
+                              attribute_one: 'foo',
+                              cars: [
+                                  {car: {name: 'p1', content: 'car one'}},
+                                  {car: {name: 'p2', content: 'car two'}},
+                                  {car: {name: 'p3', content: 'car three'}}
+                              ]
+                          }]
+    }
+  end
+
+  def complex_nested_structure_result
+    {
+        attribute_one: 'foo',
+        posts: [
+            {name: 'p1', content: 'post one'},
+            {name: 'p2', content: 'post two'},
+            {name: 'p3', content: 'post three'}
+        ],
+        cars: [
+            {name: 'p1', content: 'car one'},
+            {name: 'p2', content: 'car two'},
+            {name: 'p3', content: 'car three'}
+        ],
+        attribute_three: [1, 2,
+                          {
+                              attribute_one: 'foo',
+                              cars: [
+                                  {name: 'p1', content: 'car one'},
+                                  {name: 'p2', content: 'car two'},
+                                  {name: 'p3', content: 'car three'}
+                              ]
+                          }]
+    }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+# source
+require_relative '../lib/structure_flatter'
+
+# input resources
+require_relative 'inputs/various_structures'
+require_relative 'inputs/various_key_value_pairs'
+
+# gems used
+require 'rspec'
+require 'awesome_print'

data/spec/structure_flatter/array_hash_structure_spec.rb

@@ -0,0 +1,98 @@
+require_relative '../spec_helper'
+
+module StructureFlatter
+  describe ArrayHashStructure do # EXAMPLE GROUP
+
+    include VariousKeyValuePairs
+    include VariousStructures
+
+    describe '.is_root_flattable?' do
+      it 'returns true for simple flattable key-value pair' do
+        ArrayHashStructure.is_key_value_pair_flattable?(*key_value_pair_1).should be_true
+      end
+
+      it 'returns false for non-flattable nil value' do
+        array = [:key, nil]
+        ArrayHashStructure.is_key_value_pair_flattable?(*array).should be_false
+      end
+
+      it 'returns false for non-flattable empty array as value' do
+        array = [:key, []]
+        ArrayHashStructure.is_key_value_pair_flattable?(*array).should be_false
+      end
+
+      it 'returns false for non-flattable empty hash as value' do
+        array = [:key, {}]
+        ArrayHashStructure.is_key_value_pair_flattable?(*array).should be_false
+      end
+
+      it 'returns false for non-flattable key-value pair' do
+        ArrayHashStructure.is_key_value_pair_flattable?(*key_value_pair_1_result).should be_false
+      end
+    end
+
+    describe '.flatten_root!' do
+      it 'flattens flattable key-value pair' do
+        ArrayHashStructure.flatten_key_value_pair!(*key_value_pair_1).should == key_value_pair_1_result
+      end
+
+      it 'does not affect non-flattable key-value pair' do
+        ArrayHashStructure.flatten_key_value_pair!(*key_value_pair_1_result).should == key_value_pair_1_result
+      end
+
+      it 'does not affect non-flattable key-value pair with nil value' do
+        array = [:key, nil]
+        ArrayHashStructure.flatten_key_value_pair!(*array).should == array
+      end
+
+      it 'does not affect non-flattable key-value pair with empty array as value' do
+        array = [:key, []]
+        ArrayHashStructure.flatten_key_value_pair!(*array).should == array
+      end
+
+      it 'does not affect non-flattable key-value pair with empty hash as value' do
+        array = [:key, {}]
+        ArrayHashStructure.flatten_key_value_pair!(*array).should == array
+      end
+    end
+
+    describe '#flatten_structure!' do
+      it 'returns nil structure as it is' do
+        str = ArrayHashStructure.new(nil_structure).flatten_structure!
+        str.should == nil_structure
+      end
+      it 'returns empty hash as it is' do
+        str = ArrayHashStructure.new(empty_hash_structure).flatten_structure!
+        str.should == empty_hash_structure
+      end
+      it 'returns empty array as it is' do
+        str = ArrayHashStructure.new(empty_array_structure).flatten_structure!
+        str.should == empty_array_structure
+      end
+      it 'flattens simple Hash structure' do
+        str = ArrayHashStructure.new(simple_hash_structure).flatten_structure!
+        str.should == simple_hash_structure_result
+      end
+      it 'flattens complex Hash structure' do
+        str = ArrayHashStructure.new(complex_hash_structure).flatten_structure!
+        str.should == complex_hash_structure_result
+      end
+      it 'flattens complex Hash with mixed string and keys structure' do
+        str = ArrayHashStructure.new(complex_hash_with_mixed_string_and_keys_structure).flatten_structure!
+        str.should == complex_hash_with_mixed_string_and_keys_structure_result
+      end
+      it 'flattens complex Array structure' do
+        str = ArrayHashStructure.new(complex_array_structure).flatten_structure!
+        str.should == complex_array_structure_result
+      end
+      it 'flattens complex nested structure' do
+        str = ArrayHashStructure.new(complex_nested_structure).flatten_structure!
+        #ap VariousStructures.structure4
+        #ap VariousStructures.structure4_result
+        #ap str
+        str.should == complex_nested_structure_result
+      end
+    end
+
+  end
+end

data/structure_flatter.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'structure_flatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "structure_flatter"
+  spec.version       = StructureFlatter::VERSION
+  spec.authors       = ["Munish Goyal"]
+  spec.email         = ["munishapc@gmail.com"]
+  spec.description   = %q{Flattens hash-array structures by removing redundant information.}
+  spec.summary       = %q{Flattens Hash Array Structures}
+  spec.homepage      = "http://www.linkedin.com/in/goyalmunish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 0.9"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_dependency "awesome_print", "~> 1.2"
+  spec.add_dependency "activesupport", "~> 4.0"
+end

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: structure_flatter
+version: !ruby/object:Gem::Version
+  version: 0.0.7
+platform: ruby
+authors:
+- Munish Goyal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Flattens hash-array structures by removing redundant information.
+email:
+- munishapc@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/structure_flatter.rb
+- lib/structure_flatter/array_hash_structure.rb
+- lib/structure_flatter/version.rb
+- spec/inputs/various_key_value_pairs.rb
+- spec/inputs/various_structures.rb
+- spec/spec_helper.rb
+- spec/structure_flatter/array_hash_structure_spec.rb
+- structure_flatter.gemspec
+homepage: http://www.linkedin.com/in/goyalmunish
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Flattens Hash Array Structures
+test_files:
+- spec/inputs/various_key_value_pairs.rb
+- spec/inputs/various_structures.rb
+- spec/spec_helper.rb
+- spec/structure_flatter/array_hash_structure_spec.rb