recursive-open-struct 1.1.3 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cc972f20fd1aba4f8eea6fe1766c17c7d9e663a3ed999e8375549ac37ae4b08
-  data.tar.gz: 9c0d0230d431aedeae47f0f2026d77196dfb230c3ebe9359763b4265c9a4c4d6
+  metadata.gz: '0020068d7158163ebaa61a88a20513fda9662cabbb36227b9516c4c3579b579d'
+  data.tar.gz: 95da83b2e949d013183b4f7715ca0820e71e12cebb6a91bd095cbef8c739013c
 SHA512:
-  metadata.gz: dcdc725048e24182c562551875b2fa90d100248008af5dd4a974bb8df82f48ec5f618b3d76458d16f868b76b55263e96d3576a6d92f5ace69979beb29ae3213f
-  data.tar.gz: d67c50798fcaa7ca49003a924e57df0a22e83a5d688ef6ff90b61f462855f2b6ef8882e5873c0994558416030a9b265fe60cccfe586fd5bf9688e463d92279fe
+  metadata.gz: c1a8203c90c1cda06131dd1bd342d928458af25d8a66880c80b9db1ebe5abbf411792b8377f73558e13f1815d8a2e6fb43b7b270cbd21d9202c8dedc9b3cc107
+  data.tar.gz: c44fdc3e770d7f3be3ad5348174b62d36fe38c245516943195127152a549437fc26bb7a23047d79e3d71a08d12fdeebeb4bf12efd1b759172fedfde03625ecf1

data/.github/workflows/ruby.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['3.1', '3.2', '3.3', head, jruby, jruby-head]
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@943103cae7d3f1bb1e4951d5fcc7928b40e4b742 # 1.177.1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.travis.yml

@@ -11,7 +11,8 @@ rvm:
   # Current stable supported by Travis
   - 2.5.8
   - 2.6.6
-  - 2.7.1
+  - 2.7.2
+  - 3.0.0
   - jruby-9.1.9.0
   # Future
   - ruby-head

data/AUTHORS.txt

@@ -8,18 +8,24 @@ Recursive-open-struct was written by these fine people:
 * Ewoud Kohl van Wijngaarden <ewoud@kohlvanwijngaarden.nl>
 * Federico Aloi <federico.aloi@gmail.com>
 * fervic <roberto@runawaybit.com>
+* Hartley McGuire <skipkayhil@gmail.com>
 * Igor Victor <gogainda@yandex.ru>
+* Ilya Umanets <ilya.umanets@sabiogroup.com>
 * Jean Boussier <jean.boussier@gmail.com>
 * Joe Rafaniello <jrafanie@redhat.com>
 * Kris Dekeyser <kris.dekeyser@libis.be>
+* Maple Ong <maple.ong@gusto.com>
 * Matt Culpepper <matt@culpepper.co>
 * Matthew O'Riordan <matthew.oriordan@gmail.com>
 * Offirmo <offirmo.net@gmail.com>
 * Pedro Sena <sena.pedro@gmail.com>
 * Peter Yeremenko <peter.yeremenko@gmail.com>
 * Pirate Praveen <praveen@debian.org>
+* Richard Degenne <richard.degenne+github@gmail.com>
+* Richard Degenne <richard.degenne@gmail.com>
 * Sebastian Gaul <sebastian@mgvmedia.com>
 * Thiago Guimaraes <thiagogsr@gmail.com>
 * Tom Chapin <tchapin@gmail.com>
 * Victor Guzman <victor.guzman@runawaybit.com>
 * William (B.J.) Snow Orvis <aetherknight@gmail.com>
+* Wynn (B.J.) Snow Orvis <aetherknight@gmail.com>

data/CHANGELOG.md

@@ -1,3 +1,41 @@
+1.3.1 / 2024/10/03
+==================
+
+* FIX for
+  [#79](https://github.com/aetherknight/recursive-open-struct/issues/79):
+  Revert #72's change to marshalling and dumping since it is an API-breaking
+  change. It will be re-added in a new major version after releasing a fix.
+
+1.3.0 / 2024/10/01
+==================
+
+* [#72](https://github.com/aetherknight/recursive-open-struct/pull/72): Maple
+  Ong: Better handle marshalling and dumping ROS
+* [#78](https://github.com/aetherknight/recursive-open-struct/pull/78): Hartley
+  McGuire: Add ostruct as a dependency since newer Ruby versions are going to
+  remove it
+
+1.2.2 / 2024/06/18
+==================
+
+* [#75](https://github.com/aetherknight/recursive-open-struct/pull/75): Richard
+  Degenne: Fix Ruby 3.1 `#freeze`
+
+1.2.1 / 2024/05/27
+==================
+
+* Fix a test that is flakey with JRuby
+
+1.2.0 / 2024/05/27
+==================
+
+* [#76](https://github.com/aetherknight/recursive-open-struct/pull/76):
+  IlyaUmanets: Add `raise_on_missing` option, causing ROS to raise
+  `NoMethodError` instead of returning `nil` if a field doesn't exist
+* MAINT: Switched to Github Actions for CI
+* MAINT: No longer officially supporting Ruby versions of 3.0.x or earlier,
+  updated CI to test 3.1.x, 3.2.x, 3.3.x
+
 1.1.3 / 2020/10/15
 ==================
 

data/README.md

@@ -62,6 +62,23 @@ ros = RecursiveOpenStruct.new(h, preserve_original_keys: true)
 ros.to_h # => { 'fear' => 'is', 'the' => 'mindkiller' }
 ```
 
+### Optional: Raise error on missing attribute
+
+This option allows to raise an error if you try to call an attribute you didn't specify in hash
+
+```ruby
+h = { 'fear' => 'is', 'the' => 'mindkiller' } }
+ros = RecursiveOpenStruct.new(h, raise_on_missing: true)
+ros.undefined # => undefined method `undefined' for #<RecursiveOpenStruct fear="is", the="mindkiller">
+```
+
+The default behaviour returns nil
+
+```ruby
+h = { 'fear' => 'is', 'the' => 'mindkiller' } }
+ros = RecursiveOpenStruct.new(h)
+ros.undefined # => nil
+```
 
 ## Installation
 

data/lib/recursive_open_struct/version.rb

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

data/lib/recursive_open_struct.rb

@@ -23,7 +23,8 @@ class RecursiveOpenStruct < OpenStruct
     {
       mutate_input_hash: false,
       recurse_over_arrays: false,
-      preserve_original_keys: false
+      preserve_original_keys: false,
+      raise_on_missing: false
     }
   end
 
@@ -124,6 +125,10 @@ class RecursiveOpenStruct < OpenStruct
       if @table.key?(_get_key_from_table_(key))
         new_ostruct_member!(key)
         public_send(mid)
+      elsif @options[:raise_on_missing]
+        err = NoMethodError.new "undefined method `#{mid}' for #{self}", mid, args
+        err.set_backtrace caller(1)
+        raise err
       end
     else
       err = NoMethodError.new "undefined method `#{mid}' for #{self}", mid, args
@@ -132,6 +137,14 @@ class RecursiveOpenStruct < OpenStruct
     end
   end
 
+  def freeze
+    @table.each_key do |key|
+      new_ostruct_member!(key)
+    end
+
+    super
+  end
+
   # TODO: Rename to new_ostruct_member! once we care less about Rubies before
   # 2.4.0.
   def new_ostruct_member(name)

data/recursive-open-struct.gemspec

@@ -40,5 +40,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rdoc', [">= 0"])
   s.add_development_dependency('rspec', "~> 3.2")
   s.add_development_dependency('simplecov', [">= 0"])
+
+  s.add_dependency('ostruct')
 end
 

data/spec/recursive_open_struct/indifferent_access_spec.rb

@@ -160,6 +160,30 @@ describe RecursiveOpenStruct do
         end
       end
 
+      context 'when undefined method' do
+        context 'when raise_on_missing is enabled' do
+          subject(:recursive) { RecursiveOpenStruct.new(recursive_hash, raise_on_missing: true) }
+          let(:recursive_hash) { {:foo => [ {'bar' => [ { 'foo' => :bar} ] } ] } }
+
+          specify 'raises NoMethodError' do
+            expect {
+              recursive.undefined_method
+            }.to raise_error(NoMethodError)
+          end
+        end
+
+        context 'when raise_on_missing is disabled' do
+          context 'preserves the original keys' do
+            subject(:recursive) { RecursiveOpenStruct.new(recursive_hash) }
+            let(:recursive_hash) { {:foo => [ {'bar' => [ { 'foo' => :bar} ] } ] } }
+
+            specify 'returns nil' do
+              expect(recursive.undefined_method).to be_nil
+            end
+          end
+        end
+      end
+
     end
 
   end

data/spec/recursive_open_struct/open_struct_behavior_spec.rb

@@ -108,5 +108,41 @@ describe RecursiveOpenStruct do
         it { expect(subject.methods.map(&:to_sym)).to_not include :asdf= }
       end # describe #methods
     end # describe handling of arbitrary attributes
+
+    describe "handling of freezing" do
+      let(:hash) { { :asdf => 'John Smith' } }
+
+      before do
+        ros.freeze
+      end
+
+      it "can read existing keys" do
+        expect(ros.asdf).to eq 'John Smith'
+      end
+
+      it "cannot write new keys" do
+        expect { ros.new_key = 'new_value' }.to raise_error FrozenError
+      end
+
+      it "cannot write existing keys" do
+        expect { ros.asdf = 'new_value' }.to raise_error FrozenError
+      end
+
+      context "with recursive structure" do
+        let(:hash) { { :key => { :subkey => 42 } } }
+
+        it "can read existing sub-elements" do
+          expect(ros.key.subkey).to eq 42
+        end
+
+        it "can write new sub-elements" do
+          expect { ros.key.new_subkey = 43 }.not_to raise_error
+        end
+
+        it "can write existing sub-elements" do
+          expect { ros.key.subkey = 43 }.not_to raise_error
+        end
+      end
+    end
   end # describe behavior it inherits from OpenStruct
 end

data/spec/recursive_open_struct/ostruct_2_0_0_spec.rb

@@ -89,7 +89,7 @@ describe RecursiveOpenStruct do
 
     context "hash" do
       it "calculates table hash" do
-        expect(ros.hash).to be ros.instance_variable_get('@table').hash
+        expect(ros.hash).to eq(ros.instance_variable_get('@table').hash)
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: recursive-open-struct
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.3.1
 platform: ruby
 authors:
 - William (B.J.) Snow Orvis
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2024-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ostruct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: |
   RecursiveOpenStruct is a subclass of OpenStruct. It differs from
   OpenStruct in that it allows nested hashes to be treated in a recursive
@@ -114,6 +128,7 @@ extra_rdoc_files:
 - README.md
 files:
 - ".document"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
@@ -143,7 +158,7 @@ homepage: https://github.com/aetherknight/recursive-open-struct
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +173,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.5.9
+signing_key:
 specification_version: 4
 summary: OpenStruct subclass that returns nested hash attributes as RecursiveOpenStructs
 test_files: