recursive-open-struct 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ce4a65c03dbe16514c0c612776ec39b9a2c311b
-  data.tar.gz: 3ff3fa9d5f9ebb3f9d51dd682102a1b78e1b426e
+  metadata.gz: 603694b270a6d4511c7154607cdb8d8c481f9c8b
+  data.tar.gz: 6c8f56108aefab75a7a1d3baeeb4a5963db1356d
 SHA512:
-  metadata.gz: a3d79ba1465c421d5d0b0364b28b6bcc1b49d62e766e1aa7d2c5a1670a561e079808e32a2664bf055e654cf94bdb8fd53fe6a3c3087a4078c35c484d7b92d2d7
-  data.tar.gz: 5fded05b30f636676539de9aaed356c735e9adb43fedc020691494ace3330eccb9ad78349646511a0a5b3164dabe91452e1e95d7263191ffdd12baa721ecc23e
+  metadata.gz: 8949632d753c57bfe7d5c191673346c1275d7805dbccf20a3ef52f03bd832b86d7755324b9b28728a9fddde09e004f20b13580693ce0e3dfaf4ef5cf239c5da4
+  data.tar.gz: 82f5fa6407b595972a9016995087d280b8136db3a9a64bc85b335dd316d52016e94b04b5db84682896ec8ad0f7994c63d02331a811abb710eb1de398c23749d6

data/.travis.yml

@@ -4,13 +4,12 @@ rvm:
   # - 1.9.3  # json gem now requires Ruby ~> 2.0
   - 2.0.0
   - 2.1.10
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.2.9
+  - 2.3.6
+  - 2.4.3
   - ruby-head
   - jruby-19mode
-  - jruby-9.0.5.0
-  - jruby-9.1.5.0
+  - jruby-9.1.9.0
   - jruby-head
 sudo: false
 matrix:

data/AUTHORS.txt

@@ -2,6 +2,7 @@ Recursive-open-struct was written by these fine people:
 
 * Beni Cherniavsky-Paskin <cben@redhat.com>
 * Cédric Felizard <cedric@felizard.fr>
+* Edward Betts <edward@4angle.com>
 * Federico Aloi <federico.aloi@gmail.com>
 * fervic <roberto@runawaybit.com>
 * Joe Rafaniello <jrafanie@redhat.com>

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+1.1.0 / 2018-02-03
+==================
+
+* NEW/FIX [#56](https://github.com/aetherknight/recursive-open-struct/issues/56):
+  Add better support for Ruby 2.3+'s `#dig` method (when it exists for the
+  current version of Ruby), so that nested Hashes are properly converted to
+  RecursiveOpenStructs. `OpenStruct#dig`'s implementation was returning Hashes
+  and does not handle `recurse_over_arrays` so ROS needs special support.
+  Thanks to maxp-edcast for reporting the issue.
+* FIX [#55](https://github.com/aetherknight/recursive-open-struct/pull/55):
+  EdwardBetts: Fixed a typo in the documentation/comment for `#method_missing`
+
 1.0.5 / 2017-06-21
 ==================
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2017, The Recursive-open-struct developers (given in the
+Copyright (c) 2009-2018, The Recursive-open-struct developers (given in the
 file AUTHORS.txt).
 
 Permission is hereby granted, free of charge, to any person obtaining

data/README.md

@@ -64,5 +64,5 @@ clear, and concise, and well organized.
 
 ## Copyright
 
-Copyright (c) 2009-2017, The Recursive-open-struct developers (given in the
+Copyright (c) 2009-2018, The Recursive-open-struct developers (given in the
 file AUTHORS.txt). See LICENSE.txt for details.

data/lib/recursive_open_struct.rb

@@ -4,6 +4,7 @@ require 'recursive_open_struct/version'
 require 'recursive_open_struct/debug_inspect'
 require 'recursive_open_struct/deep_dup'
 require 'recursive_open_struct/ruby_19_backport'
+require 'recursive_open_struct/dig'
 
 # TODO: When we care less about Rubies before 2.4.0, match OpenStruct's method
 # names instead of doing things like aliasing `new_ostruct_member` to
@@ -11,6 +12,7 @@ require 'recursive_open_struct/ruby_19_backport'
 
 class RecursiveOpenStruct < OpenStruct
   include Ruby19Backport if RUBY_VERSION =~ /\A1.9/
+  include Dig if OpenStruct.public_instance_methods.include? :dig
   include DebugInspect
 
   def initialize(hash=nil, args={})
@@ -66,7 +68,8 @@ class RecursiveOpenStruct < OpenStruct
     @table.key?(mname) || super
   end
 
-  # Adapted implementation of method_missing to accomodate the differences between ROS and OS.
+  # Adapted implementation of method_missing to accommodate the differences
+  # between ROS and OS.
   #
   # TODO: Use modifiable? instead of modifiable, and new_ostruct_member!
   # instead of new_ostruct_member once we care less about Rubies before 2.4.0.
@@ -113,7 +116,7 @@ class RecursiveOpenStruct < OpenStruct
   # Support Ruby 2.4.0+'s changes in a way that doesn't require dynamically
   # modifying ROS.
   #
-  # TODO: Once we care less about Rubies before 2.4.0, reverse this sot hat
+  # TODO: Once we care less about Rubies before 2.4.0, reverse this so that
   # new_ostruct_member points to our version and not OpenStruct's.
   alias new_ostruct_member! new_ostruct_member
   # new_ostruct_member! is private, but new_ostruct_member is not on OpenStruct in 2.4.0-rc1?!

data/lib/recursive_open_struct/dig.rb

@@ -0,0 +1,22 @@
+class RecursiveOpenStruct < OpenStruct
+  module Dig
+
+    # Replaces +OpenStruct#dig+ to properly support treating nested values as
+    # RecursiveOpenStructs instead of returning the nested Hashes.
+    def dig(name, *names)
+      begin
+        name = name.to_sym
+      rescue NoMethodError
+        raise TypeError, "#{name} is not a symbol nor a string"
+      end
+
+      name_val = self[name]
+
+      if names.length > 0 && name_val.respond_to?(:dig)
+        name_val.dig(*names)
+      else
+        name_val
+      end
+    end
+  end
+end

data/lib/recursive_open_struct/version.rb

@@ -3,5 +3,5 @@
 require 'ostruct'
 
 class RecursiveOpenStruct < OpenStruct
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/spec/recursive_open_struct/ostruct_2_0_0_spec.rb

@@ -6,7 +6,7 @@ describe RecursiveOpenStruct do
   let(:hash) { {:foo => 'foo', 'bar' => :bar} }
   subject(:ros) { RecursiveOpenStruct.new(hash) }
 
-  describe "OpenStruct 2.0 methods" do
+  describe "OpenStruct 2.0+ methods" do
 
     context "Hash style setter" do
 
@@ -106,6 +106,6 @@ describe RecursiveOpenStruct do
       end
     end
 
-  end
+  end # describe OpenStruct 2.0+ methods
 
 end

data/spec/recursive_open_struct/ostruct_2_3_0_spec.rb

@@ -0,0 +1,49 @@
+require_relative '../spec_helper'
+require 'recursive_open_struct'
+
+describe RecursiveOpenStruct do
+  describe "OpenStruct 2.3.0+ methods" do
+    describe "#dig" do
+      # We only care when Ruby supports `#dig`.
+      if OpenStruct.public_instance_methods.include? :dig
+        context "recurse_over_arrays: false" do
+          subject { RecursiveOpenStruct.new(a: { b: 2, c: ["doo", "bee", { inner: "one"}]}) }
+
+          describe "OpenStruct-like behavior" do
+            it { expect(subject.dig(:a, :b)).to eq 2 }
+            it { expect(subject.dig(:a, :c, 0)).to eq "doo" }
+            it { expect(subject.dig(:a, :c, 2, :inner)).to eq "one" }
+          end
+
+          describe "recursive behavior" do
+            it {
+              expect(subject.dig(:a)).to eq RecursiveOpenStruct.new(
+                { b: 2, c: ["doo", "bee", { inner: "one"}]}
+              )
+            }
+            it { expect(subject.dig(:a, :c, 2)).to eq({inner: "one"}) }
+          end
+        end
+
+        context "recurse_over_arrays: true" do
+          subject { RecursiveOpenStruct.new({a: { b: 2, c: ["doo", "bee", { inner: "one"}]}}, recurse_over_arrays: true) }
+
+          describe "OpenStruct-like behavior" do
+            it { expect(subject.dig(:a, :b)).to eq 2 }
+            it { expect(subject.dig(:a, :c, 0)).to eq "doo" }
+            it { expect(subject.dig(:a, :c, 2, :inner)).to eq "one" }
+          end
+
+          describe "recursive behavior" do
+            it {
+              expect(subject.dig(:a)).to eq RecursiveOpenStruct.new(
+                { b: 2, c: ["doo", "bee", { inner: "one"}]}
+              )
+            }
+            it { expect(subject.dig(:a, :c, 2)).to eq RecursiveOpenStruct.new(inner: "one") }
+          end
+        end
+      end
+    end # describe #dig
+  end # describe OpenStruct 2.3+ methods
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recursive-open-struct
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - William (B.J.) Snow Orvis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-06-22 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -127,6 +127,7 @@ files:
 - lib/recursive_open_struct.rb
 - lib/recursive_open_struct/debug_inspect.rb
 - lib/recursive_open_struct/deep_dup.rb
+- lib/recursive_open_struct/dig.rb
 - lib/recursive_open_struct/ruby_19_backport.rb
 - lib/recursive_open_struct/version.rb
 - recursive-open-struct.gemspec
@@ -134,6 +135,7 @@ files:
 - spec/recursive_open_struct/indifferent_access_spec.rb
 - spec/recursive_open_struct/open_struct_behavior_spec.rb
 - spec/recursive_open_struct/ostruct_2_0_0_spec.rb
+- spec/recursive_open_struct/ostruct_2_3_0_spec.rb
 - spec/recursive_open_struct/recursion_and_subclassing_spec.rb
 - spec/recursive_open_struct/recursion_spec.rb
 - spec/spec_helper.rb
@@ -157,7 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: OpenStruct subclass that returns nested hash attributes as RecursiveOpenStructs
@@ -166,6 +168,7 @@ test_files:
 - spec/recursive_open_struct/indifferent_access_spec.rb
 - spec/recursive_open_struct/open_struct_behavior_spec.rb
 - spec/recursive_open_struct/ostruct_2_0_0_spec.rb
+- spec/recursive_open_struct/ostruct_2_3_0_spec.rb
 - spec/recursive_open_struct/recursion_and_subclassing_spec.rb
 - spec/recursive_open_struct/recursion_spec.rb
 - spec/spec_helper.rb