fancy-open-struct 0.1.6 → 0.2.0

data/.travis.yml

@@ -1,5 +1,11 @@
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - jruby-19mode # JRuby in 1.9 mode
+    # Rubies 2.1.2
+  - 2.1.2
+
+  # Rubies 2.0.0
+  - 2.0.0
+
+  # Rubies 1.9.x
+  - 1.9.3
+  - jruby-19mode # JRuby in 1.9 mode

data/CHANGELOG

@@ -0,0 +1,9 @@
+0.2.0
+  - Replaced the display_recursive_open_hash method with functionality from the awesome_print gem.
+    Note: This fundamentally changes the way how this method operates, and is not backwards compatible.
+  - Aliased the display_recursive_open_hash method to the debug_inspect method.
+  - Changed method_missing so that it is private
+
+0.1.6
+  - This version is a complete drop-in replacement for RecursiveOpenStruct (v 0.4.5) with all of the
+    passing tests from RecursiveOpenStruct, and all of the methods (including debugging methods).

data/Gemfile

@@ -1,3 +1,2 @@
 source 'http://rubygems.org'
-gemspec
-
+gemspec

data/README.rdoc

@@ -4,7 +4,6 @@
 {<img src="http://allthebadges.io/tomchapin/fancy-open-struct/gemnasium.png" alt="Dependencies" />}[http://allthebadges.io/tomchapin/fancy-open-struct/gemnasium]
 {<img src="http://allthebadges.io/tomchapin/fancy-open-struct/travis.png" alt="Build Status" />}[http://allthebadges.io/tomchapin/fancy-open-struct/travis]
 {<img src="http://allthebadges.io/tomchapin/fancy-open-struct/coveralls.png" alt="Coverage" />}[http://allthebadges.io/tomchapin/fancy-open-struct/coveralls]
-{<img src="http://allthebadges.io/tomchapin/fancy-open-struct/code_climate.png" alt="Code Climate" />}[http://allthebadges.io/tomchapin/fancy-open-struct/code_climate]
 
 FancyOpenStruct is a subclass of OpenStruct, and is a variant of RecursiveOpenStruct.
 

data/Rakefile

@@ -18,8 +18,6 @@ Rake::RDocTask.new do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
-task :default => :spec
-
 task :fix_permissions do
   File.umask 0022
   filelist = `git ls-files`.split("\n")
@@ -27,4 +25,6 @@ task :fix_permissions do
   FileUtils.chmod 0755, ['lib', 'spec'], :verbose => true
 end
 
-task :build => :fix_permissions
+task :build => :fix_permissions
+
+task :default => :spec

data/fancy-open-struct.gemspec

@@ -1,18 +1,19 @@
 # -*- encoding: utf-8 -*-
 
-require './lib/fancy-open-struct'
-
-Gem::Specification.new do |s|
-  s.name = "fancy-open-struct"
-  s.version = FancyOpenStruct::VERSION
-  s.authors = ["Thomas H. Chapin"]
-  s.email = "tchapin@gmail.com"
-  s.date = Time.now.utc.strftime("%Y-%m-%d")
-  s.homepage = "http://github.com/tomchapin/fancy-open-struct"
-  s.licenses = ["MIT"]
-
-  s.summary = "OpenStruct subclass that returns nested hash attributes as FancyOpenStructs"
-  s.description = <<-QUOTE.gsub(/^    /, '')
+require './lib/fancy-open-struct/version'
+
+Gem::Specification.new do |spec|
+
+  spec.name = "fancy-open-struct"
+  spec.version = FancyOpenStruct::VERSION
+  spec.authors = ["Thomas H. Chapin"]
+  spec.email = "tchapin@gmail.com"
+  spec.date = Time.now.utc.strftime("%Y-%m-%d")
+  spec.homepage = "http://github.com/tomchapin/fancy-open-struct"
+  spec.licenses = ["MIT"]
+
+  spec.summary = "OpenStruct subclass that returns nested hash attributes as FancyOpenStructs"
+  spec.description = <<-QUOTE.gsub(/^    /, '')
     FancyOpenStruct is a subclass of OpenStruct, and is a variant of RecursiveOpenStruct.
     This allows you to convert nested hashes into a structure where keys and values can be
     navigated and modified via dot-syntax, like: foo.bar = :something. This particular gem
@@ -21,24 +22,29 @@ Gem::Specification.new do |s|
 
   QUOTE
 
-  s.files = `git ls-files`.split("\n")
-  s.test_files = `git ls-files spec`.split("\n")
-  s.require_paths = ["lib"]
-  s.extra_rdoc_files = [
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files spec`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.extra_rdoc_files = [
       "LICENSE.txt",
+      "CHANGELOG",
       "README.rdoc"
   ]
 
-  s.add_development_dependency "bundler"
-  s.add_development_dependency "rake"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rdoc"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "coveralls"
-  s.add_development_dependency "guard"
-  s.add_development_dependency "guard-rspec"
-  s.add_development_dependency "guard-bundler"
-  s.add_development_dependency "simplecov-multi"
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency "awesome_print"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-bundler"
+  spec.add_development_dependency "simplecov-multi"
 
 end
 

data/lib/fancy-open-struct.rb

@@ -1,13 +1,14 @@
 require 'ostruct'
 require 'forwardable'
+require 'awesome_print'
+require 'fancy-open-struct/version'
 
 class FancyOpenStruct < OpenStruct
-  VERSION = "0.1.6"
 
   extend Forwardable
 
   hash_methods = Hash.instance_methods(false) - (Hash.instance_methods(false) & OpenStruct.instance_methods(false)) - [:[], :[]=]
-  def_delegators :@table, *hash_methods
+  def_instance_delegators :@table, *hash_methods
 
   def initialize(hash=nil, args={})
     @recurse_over_arrays = args.fetch(:recurse_over_arrays, false)
@@ -21,18 +22,6 @@ class FancyOpenStruct < OpenStruct
     @sub_elements = {}
   end
 
-  def to_h
-    @table.dup.update(@sub_elements) do |k, oldval, newval|
-      if newval.kind_of?(self.class)
-        newval.to_h
-      elsif newval.kind_of?(Array)
-        newval.map { |a| a.kind_of?(self.class) ? a.to_h : a }
-      else
-        raise "Cached value of unsupported type: #{newval.inspect}"
-      end
-    end
-  end
-
   def new_ostruct_member(name)
     name = name.to_sym
     unless self.respond_to?(name)
@@ -52,7 +41,7 @@ class FancyOpenStruct < OpenStruct
     name
   end
 
-  def recurse_over_array array
+  def recurse_over_array(array)
     array.map do |a|
       if a.is_a? Hash
         self.class.new(a, :recurse_over_arrays => true)
@@ -64,54 +53,43 @@ class FancyOpenStruct < OpenStruct
     end
   end
 
-  def debug_inspect(io = STDOUT, indent_level = 0, recursion_limit = 12)
-    display_recursive_open_hash(io, @table, indent_level, recursion_limit)
+  def to_h
+    @table.dup.update(@sub_elements) do |k, oldval, newval|
+      if newval.kind_of?(self.class)
+        newval.to_h
+      elsif newval.kind_of?(Array)
+        newval.map { |a| a.kind_of?(self.class) ? a.to_h : a }
+      else
+        raise "Cached value of unsupported type: #{newval.inspect}"
+      end
+    end
   end
 
-  def display_recursive_open_hash(io, ostrct_or_hash, indent_level, recursion_limit)
-
-    if recursion_limit <= 0
-      # protection against recursive structure (like in the tests)
-      io.puts '  '*indent_level + '(recursion limit reached)'
-    else
-      #puts ostrct_or_hash.inspect
-      if ostrct_or_hash.is_a?(self.class)
-        ostrct_or_hash = ostrct_or_hash.marshal_dump
-      end
+  alias_method :to_hash, :to_h
 
-      # We'll display the key values like this :    key =  value
-      # to align display, we look for the maximum key length of the data that will be displayed
-      # (everything except hashes)
-      data_indent = ostrct_or_hash \
-        .reject { |k, v| v.is_a?(self.class) || v.is_a?(Hash) } \
-        .max { |a, b| a[0].to_s.length <=> b[0].to_s.length }[0].to_s.length
-      # puts "max length = #{data_indent}"
+  def debug_inspect(options = {})
+    # Refer to the "Awesome Print" gem documentation for information about which options are available
+    # The awesome_print gem can be found at https://rubygems.org/gems/awesome_print
+    ap(@table, options)
+  end
 
-      ostrct_or_hash.each do |key, value|
-        if value.is_a?(self.class) || value.is_a?(Hash)
-          io.puts '  '*indent_level + key.to_s + '.'
-          display_recursive_open_hash(io, value, indent_level + 1, recursion_limit - 1)
-        else
-          io.puts '  '*indent_level + key.to_s + ' '*(data_indent - key.to_s.length) + ' = ' + value.inspect
-        end
-      end
-    end
+  alias_method :display_recursive_open_hash, :debug_inspect
 
-    true
+  # Hash getter method which translates the key to a Symbol
+  def [](key)
+    @table[key.to_sym]
   end
 
-  def [](*args)
-    len = args.length
-    raise ArgumentError, "wrong number of arguments (#{len} for 1)", caller(1) if len != 1
-    @table[args[0].to_sym]
+  # Hash setter method which translates the key to a Symbol and also creates
+  # a getter method (OpenStruct member) for accessing the key/value later via dot syntax
+  def []=(key, value)
+    modifiable[new_ostruct_member(key.to_sym)] = value
   end
 
-  def []=(*args)
-    len = args.length
-    raise ArgumentError, "wrong number of arguments (#{len} for 2)", caller(1) if len != 2
-    modifiable[new_ostruct_member(args[0].to_sym)] = args[1]
-  end
+  private
 
+  # Dynamically handle any attempts to get or set values via dot syntax
+  # if the OpenStruct member methods haven't already been created
   def method_missing(mid, *args) # :nodoc:
     mname = mid.id2name
     len = args.length

data/lib/fancy-open-struct/version.rb

@@ -0,0 +1,5 @@
+require 'ostruct'
+
+class FancyOpenStruct < OpenStruct
+  VERSION = "0.2.0"
+end

data/spec/fancy_open_struct_spec.rb

@@ -1,4 +1,4 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+require 'spec_helper'
 require 'fancy-open-struct'
 
 describe FancyOpenStruct do
@@ -47,6 +47,7 @@ describe FancyOpenStruct do
   end # describe behavior it inherits from OpenStruct
 
   describe "improvements on OpenStruct" do
+
     it "can be converted back to a hash" do
       h = {:asdf => 'John Smith'}
       fos = FancyOpenStruct.new(h)
@@ -54,32 +55,16 @@ describe FancyOpenStruct do
     end
 
     describe 'hash methods' do
-      it "handles hash methods for setting values" do
-        fos = FancyOpenStruct.new
-        fos['blah'] = "John Smith"
-        fos[:foo] = "George Washington"
-        fos.blah.should == "John Smith"
-        fos.foo.should == "George Washington"
-      end
 
-      it 'converts string hash keys to symbols' do
-        fos = FancyOpenStruct.new
-        fos['blah'] = "John Smith"
-        fos['blah'].should == "John Smith"
-        fos[:blah].should == "John Smith"
-        fos.blah.should == "John Smith"
-        fos.to_h['blah'].should == nil
-      end
+      let(:fos) { FancyOpenStruct.new }
 
       it 'forwards all of the basic Hash methods directly to the @table instance variable' do
-        fos = FancyOpenStruct.new
         Hash.instance_methods(false).each do |method_name|
           fos.respond_to?(method_name).should be_true
         end
       end
 
       it 'recovers gracefully even when the internal hash @table is directly modified via hash methods' do
-        fos = FancyOpenStruct.new
         fos.foo = 'bar'
         fos.to_h.should == {:foo => "bar"}
         other_hash = {:baz => :qux}
@@ -91,6 +76,33 @@ describe FancyOpenStruct do
         fos.foo.should == nil
         fos.baz.should == nil
       end
+
+      describe 'The Hash table getter method, []' do
+        it 'only accepts one argument' do
+          expect { fos[:key1, :key2] }.to raise_error(ArgumentError, /2 for 1/)
+        end
+
+        it "handles hash methods for setting values" do
+          fos['blah'] = "John Smith"
+          fos[:foo] = "George Washington"
+          fos.blah.should == "John Smith"
+          fos.foo.should == "George Washington"
+        end
+
+        it 'converts string hash keys to symbols' do
+          fos['blah'] = "John Smith"
+          fos['blah'].should == "John Smith"
+          fos[:blah].should == "John Smith"
+          fos.blah.should == "John Smith"
+          fos.to_h['blah'].should == nil
+        end
+      end
+
+      describe 'The Hash table setter method, []=' do
+        it 'only accepts two arguments' do
+          expect { fos[:key1, :key2] = :value }.to raise_error(ArgumentError, /3 for 2/)
+        end
+      end
     end
 
     context 'using strings instead of symbols as hash keys' do
@@ -169,7 +181,6 @@ describe FancyOpenStruct do
       end
     end
 
-
     describe 'recursing over arrays' do
       let(:blah_list) { [{:foo => '1'}, {:foo => '2'}, 'baz'] }
       let(:h) { {:blah => blah_list} }
@@ -182,11 +193,11 @@ describe FancyOpenStruct do
         it { subject.blah[1].foo.should == '2' }
         it { subject.blah_as_a_hash.should == blah_list }
         it { subject.blah[2].should == 'baz' }
-        it "Retains changes acfoss Array lookups" do
+        it "Retains changes across Array look-ups" do
           subject.blah[1].foo = "Dr Scott"
           subject.blah[1].foo.should == "Dr Scott"
         end
-        it "propagates the changes through to .to_h acfoss Array lookups" do
+        it "propagates the changes through to .to_h across Array look-ups" do
           subject.blah[1].foo = "Dr Scott"
           subject.to_h.should == {
               :blah => [{:foo => '1'}, {:foo => "Dr Scott"}, 'baz']
@@ -198,7 +209,7 @@ describe FancyOpenStruct do
           subject { FancyOpenStruct.new(deep_hash, :recurse_over_arrays => true) }
 
           it { subject.foo.blah.length.should == 3 }
-          it "Retains changes acfoss Array lookups" do
+          it "Retains changes across Array look-ups" do
             subject.foo.blah[1].foo = "Dr Scott"
             subject.foo.blah[1].foo.should == "Dr Scott"
           end
@@ -211,7 +222,7 @@ describe FancyOpenStruct do
 
           it { subject.blah.length.should == 1 }
           it { subject.blah[0].length.should == 3 }
-          it "Retains changes acfoss Array lookups" do
+          it "Retains changes across Array look-ups" do
             subject.blah[0][1].foo = "Dr Scott"
             subject.blah[0][1].foo.should == "Dr Scott"
           end
@@ -233,68 +244,40 @@ describe FancyOpenStruct do
 
   describe "additional features" do
 
-    before(:each) do
-      h1 = {:a => 'a'}
-      h2 = {:a => 'b', :h1 => h1}
-      h1[:h2] = h2
-      @fos = FancyOpenStruct.new(h2)
-    end
+    it "should have a simple way of display complex FancyOpenStruct data" do
+      h = {
+          :blah => {
+              :blargh => 'Brad'
+          },
+          'example_string' => {
+              :foo => :bar,
+              :baz => {'qux' => :zam}
+          }
+      }
+      fos = FancyOpenStruct.new(h)
 
-    it "should have a simple way of display" do
-      @output = <<-QUOTE
-a = "b"
-h1.
-  a = "a"
-  h2.
-    a = "b"
-    h1.
-      a = "a"
-      h2.
-        a = "b"
-        h1.
-          a = "a"
-          h2.
-            a = "b"
-            h1.
-              a = "a"
-              h2.
-                a = "b"
-                h1.
-                  a = "a"
-                  h2.
-                    a = "b"
-                    h1.
-                      a = "a"
-                      h2.
-                        (recursion limit reached)
-      QUOTE
-      @io = StringIO.new
-      @fos.debug_inspect(@io)
-      @io.string.should match /^a = "b"$/
-      @io.string.should match /^h1\.$/
-      @io.string.should match /^  a = "a"$/
-      @io.string.should match /^  h2\.$/
-      @io.string.should match /^    a = "b"$/
-      @io.string.should match /^    h1\.$/
-      @io.string.should match /^      a = "a"$/
-      @io.string.should match /^      h2\.$/
-      @io.string.should match /^        a = "b"$/
-      @io.string.should match /^        h1\.$/
-      @io.string.should match /^          a = "a"$/
-      @io.string.should match /^          h2\.$/
-      @io.string.should match /^            a = "b"$/
-      @io.string.should match /^            h1\.$/
-      @io.string.should match /^              a = "a"$/
-      @io.string.should match /^              h2\.$/
-      @io.string.should match /^                a = "b"$/
-      @io.string.should match /^                h1\.$/
-      @io.string.should match /^                  a = "a"$/
-      @io.string.should match /^                  h2\.$/
-      @io.string.should match /^                    a = "b"$/
-      @io.string.should match /^                    h1\.$/
-      @io.string.should match /^                      a = "a"$/
-      @io.string.should match /^                      h2\.$/
-      @io.string.should match /^                        \(recursion limit reached\)$/
+      expected_result = "{" + \
+                        "\n           :blah => {" + \
+                        "\n  :blargh => \"Brad\"" + \
+                        "\n }," + \
+                        "\n :example_string => {" + \
+                        "\n  :foo => :bar," + \
+                        "\n  :baz => {" + \
+                        "\n   \"qux\" => :zam" + \
+                        "\n  }" + \
+                        "\n }" + \
+                        "\n}" + \
+                        "\n"
+
+      debug_inspect = capture_stdout do
+        fos.debug_inspect(:indent => 1, :plain => true)
+      end
+      debug_inspect.string.should == expected_result
+
+      display_recursive_open_hash = capture_stdout do
+        fos.display_recursive_open_hash(:indent => 1, :plain => true)
+      end
+      display_recursive_open_hash.string.should == expected_result
     end
 
     it "creates nested objects via subclass" do

data/spec/spec_helper.rb

@@ -1,19 +1,16 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
 require 'rspec'
 require 'pry'
 require 'simplecov'
 require 'coveralls'
 
-Coveralls.wear!
-
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
     SimpleCov::Formatter::HTMLFormatter,
     Coveralls::SimpleCov::Formatter
 ]
 SimpleCov.start
 
+require 'fancy-open-struct'
+
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }

data/spec/support/capture_stdout.rb

@@ -0,0 +1,14 @@
+require 'stringio'
+
+module Kernel
+
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    return out
+  ensure
+    $stdout = STDOUT
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fancy-open-struct
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +208,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
+- CHANGELOG
 - README.rdoc
 files:
 - .coveralls.yml
@@ -199,14 +216,17 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.rdoc
 - Rakefile
 - fancy-open-struct.gemspec
 - lib/fancy-open-struct.rb
+- lib/fancy-open-struct/version.rb
 - spec/fancy_open_struct_spec.rb
 - spec/spec_helper.rb
+- spec/support/capture_stdout.rb
 homepage: http://github.com/tomchapin/fancy-open-struct
 licenses:
 - MIT
@@ -219,7 +239,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -235,3 +255,4 @@ summary: OpenStruct subclass that returns nested hash attributes as FancyOpenStr
 test_files:
 - spec/fancy_open_struct_spec.rb
 - spec/spec_helper.rb
+- spec/support/capture_stdout.rb