deepopenstruct 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+MIT-LICENSE

data/.gitignore

@@ -0,0 +1,23 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+*.gem
+*.log
+
+## PROJECT::SPECIFIC

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Aaron Gough (http://thingsaaronmade.com/)
+
+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.rdoc

@@ -0,0 +1,50 @@
+== deepopenstruct
+
+DeepOpenStruct is a simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays. It is particularly suitable for creating easy-to-use data structures from YAML files, and as such is a useful tool for creating simple reflective API wrappers.
+
+=== Installation
+
+  gem install deepopenstruct
+  
+=== Usage
+
+  require 'rubygems'
+  require 'deepopenstruct'
+  
+  complex_data = {
+    :name => "Bob Winkle",
+    :age => 65,
+    :jobs => [
+      {'start_year' => 1980, 'title' => 'Chef'},
+      {'start_year' => 1985, 'title' => 'Programmer'}
+    ],
+    :attributes => {
+      :birthplace => "Darwin",
+      :year_of_birth => 1945
+    }
+  }
+  
+  simple_data = DeepOpenStruct.load(complex_data)
+  
+  simple_data.name
+  # => "Bob Winkle"
+  
+  simple_data.jobs.first.title
+  # => "Chef"
+  
+  simple_data.attributes.birthplace
+  # => "Darwin"
+
+=== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request! Bonus points for topic/feature branches.
+
+=== Author & Credits
+
+Author:: {Aaron Gough}[mailto:aaron@aarongough.com]
+
+Copyright (c) 2010 {Aaron Gough}[http://thingsaaronmade.com/] ({thingsaaronmade.com}[http://thingsaaronmade.com/]), released under the MIT license

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "deepopenstruct"
+    gem.summary = %Q{A simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays}
+    gem.description = %Q{DeepOpenStruct is a simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays. It is particularly suitable for creating easy-to-use data structures from YAML files, and as such is a useful tool for creating simple reflective API wrappers.}
+    gem.email = "aaron@aarongough.com"
+    gem.homepage = "http://github.com/aarongough/deepopenstruct"
+    gem.authors = ["Aaron Gough"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "deepopenstruct #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/deepopenstruct.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{deepopenstruct}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Aaron Gough"]
+  s.date = %q{2010-06-04}
+  s.description = %q{DeepOpenStruct is a simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays. It is particularly suitable for creating easy-to-use data structures from YAML files, and as such is a useful tool for creating simple reflective API wrappers.}
+  s.email = %q{aaron@aarongough.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "deepopenstruct.gemspec",
+     "lib/deepopenstruct.rb",
+     "test/setup/test_unit_extensions.rb",
+     "test/test_helper.rb",
+     "test/unit/deepopenstruct_test.rb"
+  ]
+  s.homepage = %q{http://github.com/aarongough/deepopenstruct}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays}
+  s.test_files = [
+    "test/setup/test_unit_extensions.rb",
+     "test/test_helper.rb",
+     "test/unit/deepopenstruct_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/lib/deepopenstruct.rb

@@ -0,0 +1,26 @@
+require 'ostruct'
+
+class DeepOpenStruct
+  def self.load(item)
+    raise ArgumentError, "DeepOpenStruct must be passed a Hash or Array" unless(item.is_a?(Hash) || item.is_a?(Array))
+    item = item.clone
+    if(item.is_a?(Hash))
+      item.merge!(item) do |key, value, oldvalue|
+        if(value.is_a?(Hash) || value.is_a?(Array))
+          DeepOpenStruct.load(value)
+        else
+          value
+        end
+      end
+      return OpenStruct.new(item)
+    elsif(item.is_a?(Array))
+      return item.map do |value|
+        if(value.is_a?(Hash) || value.is_a?(Array))
+          DeepOpenStruct.load(value)
+        else
+          value
+        end
+      end
+    end
+  end
+end

data/test/setup/test_unit_extensions.rb

@@ -0,0 +1,21 @@
+module Test::Unit
+  # Used to fix a minor minitest/unit incompatibility in flexmock
+  AssertionFailedError = Class.new(StandardError)
+  
+  class TestCase
+   
+    def self.test(name, &block)
+      test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+      defined = instance_method(test_name) rescue false
+      raise "#{test_name} is already defined in #{self}" if defined
+      if block_given?
+        define_method(test_name, &block)
+      else
+        define_method(test_name) do
+          flunk "No implementation provided for #{name}"
+        end
+      end
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'test/unit'
+require 'ostruct'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'deepopenstruct'
+
+require_files = []
+require_files.concat Dir[File.join(File.dirname(__FILE__), 'setup', '*.rb')]
+
+require_files.each do |file|
+  require File.expand_path(file)
+end
+
+class Test::Unit::TestCase
+end

data/test/unit/deepopenstruct_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class TestDeepOpenStruct < Test::Unit::TestCase
+  
+  test "should convert hash into openstruct" do
+    hash = {:item_1 => 1, 'item_2' => 2, "item_3" => 3}
+    assert_nothing_raised do
+      deepstruct = DeepOpenStruct.load(hash)
+      assert_equal 1, deepstruct.item_1
+      assert_equal 2, deepstruct.item_2
+      assert_equal 3, deepstruct.item_3
+    end
+  end
+  
+  test "should convert array of hashes into array of openstructs" do
+    array = [{:hash_1 => 1}, {:hash_2 => 2}, {:hash_3 => 3}]
+    assert_nothing_raised do
+      deepstruct = DeepOpenStruct.load(array)
+      assert_equal 1, deepstruct[0].hash_1
+      assert_equal 2, deepstruct[1].hash_2
+      assert_equal 3, deepstruct[2].hash_3
+    end
+  end
+  
+  test "should convert nested hash into nested openstruct" do
+    hash = {:hash_1 => {:foo => :blah}, :hash_2 => {:foo => :blah, :deep_nest => {:foo => :blah}}}
+    assert_nothing_raised do
+      deepstruct = DeepOpenStruct.load(hash)
+      assert_equal :blah, deepstruct.hash_1.foo
+      assert_equal :blah, deepstruct.hash_2.foo
+      assert_equal :blah, deepstruct.hash_2.deep_nest.foo
+    end
+  end
+  
+  test "should convert arrays of hashes in hash into arrays of openstructs" do
+    hash = {:array => [1, 2, {:foo => :blah, :array => [3, 4, {:see => :more}]}]}
+    assert_nothing_raised do
+      deepstruct = DeepOpenStruct.load(hash)
+      assert_kind_of Array, deepstruct.array
+      assert_equal 1, deepstruct.array[0]
+      assert_equal 2, deepstruct.array[1]
+      assert_kind_of OpenStruct, deepstruct.array[2]
+      assert_equal :blah, deepstruct.array[2].foo
+      assert_kind_of Array, deepstruct.array[2].array
+      assert_equal 3, deepstruct.array[2].array[0]
+      assert_equal 4, deepstruct.array[2].array[1]
+      assert_kind_of OpenStruct, deepstruct.array[2].array[2]
+      assert_equal :more, deepstruct.array[2].array[2].see
+    end      
+  end
+  
+  test "should raise ArgumentError if argument supplied to initialize is not a Hash or Array" do
+    [1, "hello", 3.00, OpenStruct.new({:blah => :foo})].each do |item|
+      assert_raises ArgumentError, "should have raised error when initialized with #{item.class}" do
+        test = DeepOpenStruct.load(item)
+      end
+    end
+  end
+  
+  test "should not not create side effects on array" do
+    array = [{:hash_1 => 1}, {:hash_2 => 2}, {:hash_3 => 3}]
+    deepstruct = DeepOpenStruct.load(array)
+    assert_kind_of Hash, array[0]
+  end
+  
+  test "should not not create side effects on hash" do
+    hash = {:array => [1, 2, {:foo => :blah, :array => [3, 4, {:see => :more}]}]}
+    deepstruct = DeepOpenStruct.load(hash)
+    assert_kind_of Hash, hash[:array][2]
+    assert_kind_of Hash, hash[:array][2][:array][2]
+  end
+  
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: deepopenstruct
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Aaron Gough
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-04 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: DeepOpenStruct is a simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays. It is particularly suitable for creating easy-to-use data structures from YAML files, and as such is a useful tool for creating simple reflective API wrappers.
+email: aaron@aarongough.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- deepopenstruct.gemspec
+- lib/deepopenstruct.rb
+- test/setup/test_unit_extensions.rb
+- test/test_helper.rb
+- test/unit/deepopenstruct_test.rb
+has_rdoc: true
+homepage: http://github.com/aarongough/deepopenstruct
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple library for creating easy-to-use data structures from complex sets of nested Hashes and Arrays
+test_files: 
+- test/setup/test_unit_extensions.rb
+- test/test_helper.rb
+- test/unit/deepopenstruct_test.rb