open_struct_factory 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7cd3524565084916d8e9c402b6cbf5bb8786908b
+  data.tar.gz: 3c104557a0dddb00aa8086450c6a00446222c2c4
+SHA512:
+  metadata.gz: 0b5cb9566a446365fc4f60a33271dbcbeacb16078839e7fed947812484fb33b73f863ef4410e364804e28a9aabb6bfc43785fd50f5c77f4d2bb46ef996d4517b
+  data.tar.gz: ba54ae59b50d67c7fe09aa7b556e0f5054b5af79a01bee242a8f9e42b40164351e383e2dd50c19f5a4422a09235cfa7f57146082290fa159b8711578d10db172

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Xavier Defrang
+
+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,76 @@
+# OpenStructFactory
+
+A factory to create `OpenStruct` objects from nested hashes and arrays.
+
+The main difference with other gems such as [recursive-open-struct](https://github.com/aetherknight/recursive-open-struct) is that this library is entirely decoupled: it doesn't inherit from `OpenStruct` and doesn't rely on any core extensions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'open_struct_factory'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install open_struct_factory
+
+## Usage
+
+```ruby
+
+require 'ostruct'
+require 'open_struct_factory'
+
+book_data = {
+  title: "The World as Will and Representation",
+  author: {
+    name: "Arthur Schopenhauer",
+    birth_date: "1788-02-22",
+    birth_place: "Danzig",
+  },
+  publications: [
+    {edition: "1st edition", year: 1818},
+    {edition: "2nd expanded edition", year: 1844},
+  ]
+}
+
+book = OpenStructFactory.create(book_data)
+
+puts book.title
+# => The World as Will and Representation
+
+puts book.author.name
+# => Arthur Schopenhauer
+
+puts book.publications[1].year
+# => 1844
+
+```
+
+A block can optionally be passed, it will be called for each key and give you the opportunity to sanitize the property name to be added to the `OpenStruct`:
+
+```ruby
+
+data = {
+  "SomePeople" => "LoveTheirCamelCase",
+}
+
+obj = OpenStructFactory.create(data) { |key| key.downcase }
+
+puts obj.somepeople
+# => LoveTheirCamelCase
+
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/open_struct_factory/fork )
+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 a new Pull Request

data/Rakefile

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

data/lib/open_struct_factory/version.rb

@@ -0,0 +1,3 @@
+module OpenStructFactory
+  VERSION = "0.1.0"
+end

data/lib/open_struct_factory.rb

@@ -0,0 +1,31 @@
+require "open_struct_factory/version"
+
+module OpenStructFactory
+
+  # Creates an OpenStruct from the given hash
+  # * It recursively transform nested hashes into OpenStruct
+  # * It recursively goes through arrays, transforming hashes into OpenStruct
+  # * An optional block can be passed to process the hash keys
+  def self.create(hash, &block) # :yields: key
+    properties = {}
+    hash.each do |key, value|
+      property_name = block_given? ? (yield key) : key
+      properties[property_name] = process_value(value, &block)
+    end
+    OpenStruct.new(properties)
+  end
+
+  private
+
+  def self.process_value(value, &block)
+    case value
+    when Hash
+     create(value, &block)
+    when Array
+      value.map { |v| process_value(v, &block) }
+    else
+       value
+    end
+  end
+
+end

data/open_struct_factory.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'open_struct_factory/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "open_struct_factory"
+  spec.version       = OpenStructFactory::VERSION
+  spec.authors       = ["Xavier Defrang"]
+  spec.email         = ["xavier.defrang@gmail.com"]
+  spec.summary       = %q{A factory to create OpenStruct objects from nested hashes and arrays}
+  spec.description   = %q{A factory to create OpenStruct objects from nested hashes and arrays}
+  spec.homepage      = "http://github.com/xavier/open_struct_factory"
+  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", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/open_struct_factory_spec.rb

@@ -0,0 +1,118 @@
+require "spec_helper"
+
+describe OpenStructFactory do
+
+  describe ".create" do
+
+    context "when given a simple hash" do
+
+      let(:hash) do
+        {:foo => "bar", "baz" => 123}
+      end
+
+      it "creates an OpenStruct" do
+        os = OpenStructFactory.create(hash)
+        expect(os.foo).to eq("bar")
+        expect(os.baz).to eq(123)
+      end
+
+    end
+
+    context "when given a hash with a single level of nesting" do
+
+      let(:hash) do
+        {
+          :foo => "bar",
+          :baz => 123,
+          "nested" => {
+            :qux => true,
+          }
+        }
+      end
+
+      it "creates a nested OpenStruct" do
+        os = OpenStructFactory.create(hash)
+        expect(os.foo).to eq("bar")
+        expect(os.baz).to eq(123)
+        expect(os.nested.qux).to eq(true)
+      end
+
+    end
+
+    context "when given a hash with several levels of nesting" do
+
+      let(:hash) do
+        {
+          :foo => {
+            :bar => {
+              "baz" => {
+                :qux => true
+              }
+            }
+          }
+        }
+      end
+
+      it "creates a nested OpenStruct" do
+        os = OpenStructFactory.create(hash)
+        expect(os.foo.bar.baz.qux).to eq(true)
+      end
+
+    end
+
+    context "when given a hash containing an array of non-aggregates" do
+
+      let(:hash) do
+        {:foo => "bar", :baz => [1, 2, "three"]}
+      end
+
+      it "creates an OpenStruct" do
+        os = OpenStructFactory.create(hash)
+        expect(os.foo).to eq("bar")
+        expect(os.baz).to eq([1, 2, "three"])
+      end
+
+    end
+
+    context "when given a hash containing an array of hashes" do
+
+      let(:hash) do
+        {
+          :foo => [
+            {:bar => 1},
+            {:baz => {:qux => true}},
+          ]
+        }
+      end
+
+      it "creates a nested OpenStruct" do
+        os = OpenStructFactory.create(hash)
+        expect(os.foo[0].bar).to eq(1)
+        expect(os.foo[1].baz.qux).to eq(true)
+      end
+
+    end
+
+    context "when given a block" do
+
+      let(:hash) do
+        {
+          "FOO" => 123,
+          "Bar" => {
+            "BAZ" => {
+              "qux" => true
+            }
+          }
+        }
+      end
+
+      it "creates a nested OpenStruct with property names processed by the given block" do
+        os = OpenStructFactory.create(hash) { |property_name| property_name.downcase }
+        expect(os.foo).to eq(123)
+        expect(os.bar.baz.qux).to eq(true)
+      end
+    end
+
+  end # .create
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "ostruct"
+require_relative "../lib/open_struct_factory"

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: open_struct_factory
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Xavier Defrang
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A factory to create OpenStruct objects from nested hashes and arrays
+email:
+- xavier.defrang@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/open_struct_factory.rb
+- lib/open_struct_factory/version.rb
+- open_struct_factory.gemspec
+- spec/open_struct_factory_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/xavier/open_struct_factory
+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: A factory to create OpenStruct objects from nested hashes and arrays
+test_files:
+- spec/open_struct_factory_spec.rb
+- spec/spec_helper.rb