simple-immutable 1.0.2 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64a3fdc5e88962936613bf54a490e1b04342d083a5be7818045036c607fbb5fd
-  data.tar.gz: 6bb051df21c2809e9ee3596d5f9cb571111032876c3480e07691a0fb44ad610c
+  metadata.gz: 8b64e7bb0ef88ead17af2b5d1bca5ea4dc3a19c566a441ee8fe519afe7ac47c3
+  data.tar.gz: 4dedaf9317e816780dc86427b99a2b070a1ec46da22ca56446e8ceb120ba615a
 SHA512:
-  metadata.gz: 4dc8c01c9763ddb8ed545cb3a45357c2de743f83e9cc002e5cc52329bf2909e8de4ee38255bebd6a87e09f811d20244c16fff49d63b2e40f53b9ef73faf33639
-  data.tar.gz: fc24b0ce11427a6fece8911e9fa1021ab5bfb5b1edd63b1ac699cd1866c3919903d97f04652bbd432b8b645e08a3cc674fddf1c3e02fc55263ac0761b2a5ccbd
+  metadata.gz: '0029d88bfa9788f39948eacc0707af394d2702b31800ec86ef83e76f9e1b4dbeb672ce619877a5f0e9f09da93b9b1edcdf3a0dc471c84b73fd1fd8415f168a6e'
+  data.tar.gz: abd71b228155f72f7953868cd445722c013b3ce9067d9ecc2075cd5c518a12905a0cd3ed768d7adec505291b53f6f383ce0fc6b63e2b1181ff0887f2fdf7c09c

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  Exclude:
+    - bin/**/*
+    - test/**/*
+    - scripts/**/*
+    - ./*.gemspec
+    - Gemfile
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Enabled: false
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/NumericPredicate:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 20
+
+Lint/IneffectiveAccessModifier:
+  Enabled: false

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in {gemname}.gemspec
 gemspec
+
+gem "rubocop", "~> 0.87.1"

data/Makefile

@@ -1,7 +1,11 @@
 default: test
 
+.PHONY: test
+
 test:
-	ruby lib/simple/immutable.rb
+	ruby test/immutable_test.rb
+	ruby test/immutable_w_null_record_test.rb
+	bin/rubocop
 
 release:
 	scripts/release.rb

data/VERSION

@@ -1 +1 @@
-1.0.2
+1.0.6

data/bin/rubocop

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path("../bundle", __FILE__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300) =~ /This file was generated by Bundler/
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/simple-immutable.rb

@@ -1 +1,3 @@
-require "simple/immutable"
+# rubocop:disable Naming/FileName
+
+require_relative "simple/immutable"

data/lib/simple/immutable.rb

@@ -6,34 +6,73 @@ class Simple::Immutable
 
   # turns an object, which can be a hash or array of hashes, arrays, and scalars
   # into an object which you can use to access with dot methods.
-  def self.create(object, max_depth = 5)
+  def self.create(object, max_depth: 8, null_record: nil)
     case object
     when Array
       raise ArgumentError, "Object nested too deep (or inner loop?)" if max_depth < 0
 
-      object.map { |obj| create obj, max_depth - 1 }
+      object.map { |obj| create obj, null_record: null_record, max_depth: max_depth - 1 }
     when Hash
-      new(object)
+      new(object, null_record)
     else
       object
     end
   end
 
+  def self.raw_data(immutable)
+    case immutable
+    when SELF
+      hsh = immutable.instance_variable_get :@hsh
+      null_record = immutable.instance_variable_get :@null_record
+
+      if null_record
+        null_record.merge(hsh)
+      else
+        hsh
+      end
+    when Array
+      immutable.map { |e| raw_data(e) }
+    else
+      immutable
+    end
+  end
+
+  # adds to_json support.
+  def as_json(opts)
+    @hsh.as_json(opts)
+  end
+
   private
 
-  def initialize(hsh)
+  def initialize(hsh, null_record = nil)
     @hsh = hsh
+    @null_record = null_record
+  end
+
+  # rubycop:disable Lint/IneffectiveAccessModifier
+
+  # fetches key from a hsh, regardless of it being a Symbol or a String.
+  # Yields the block if the key cannot be found.
+  def self.fetch_symbol_or_string_from_hash(hsh, key, &block)
+    if hsh
+      hsh.fetch(key.to_sym) do
+        hsh.fetch(key.to_s, &block)
+      end
+    else
+      yield
+    end
   end
 
   def method_missing(sym, *args, &block)
     if args.empty? && !block
-      begin
-        value = @hsh.fetch(sym.to_sym) { @hsh.fetch(sym.to_s) }
-        return SELF.create(value)
-      rescue KeyError
-        # STDERR.puts "Missing attribute #{sym} for Immutable w/#{@hsh.inspect}"
-        nil
+      value = SELF.fetch_symbol_or_string_from_hash(@hsh, sym) do
+        SELF.fetch_symbol_or_string_from_hash(@null_record, sym) do
+          # STDERR.puts "Missing attribute #{sym} for Immutable w/#{@hsh.inspect}"
+          super
+        end
       end
+
+      return SELF.create(value)
     end
 
     super
@@ -51,7 +90,7 @@ class Simple::Immutable
       super
   end
 
-  def respond_to?(sym)
+  def respond_to?(sym, include_all = false)
     super || @hsh.key?(sym.to_s) || @hsh.key?(sym.to_sym)
   end
 
@@ -59,90 +98,3 @@ class Simple::Immutable
     @hsh == other
   end
 end
-
-if $PROGRAM_NAME == __FILE__
-
-  # rubocop:disable Metrics/AbcSize
-
-  require "test-unit"
-
-  class Simple::Immutable::TestCase < Test::Unit::TestCase
-    Immutable = ::Simple::Immutable
-
-    def hsh
-      {
-        a: "a-value",
-        "b": "b-value",
-        "child": {
-          name: "childname",
-          grandchild: {
-            name: "grandchildname"
-          }
-        },
-        "children": [
-          "anna",
-          "arthur",
-          {
-            action: {
-              keep_your_mouth_shut: true
-            }
-          }
-        ]
-      }
-    end
-
-    def immutable
-      Immutable.create hsh
-    end
-
-    def test_hash_access
-      assert_equal "a-value", immutable.a
-      assert_equal "b-value", immutable.b
-    end
-
-    def test_comparison
-      immutable = Immutable.create hsh
-
-      assert_equal immutable, hsh
-      assert_not_equal({}, immutable)
-    end
-
-    def test_child_access
-      child = immutable.child
-      assert_kind_of(Immutable, child)
-      assert_equal "childname", immutable.child.name
-      assert_equal "grandchildname", immutable.child.grandchild.name
-    end
-
-    def test_array_access
-      assert_kind_of(Array, immutable.children)
-      assert_equal 3, immutable.children.length
-      assert_equal "anna", immutable.children[0]
-
-      assert_kind_of(Immutable, immutable.children[2])
-      assert_equal true, immutable.children[2].action.keep_your_mouth_shut
-    end
-
-    def test_base_class
-      assert_nothing_raised do
-        immutable.object_id
-      end
-    end
-
-    def test_missing_keys
-      assert_raise(NoMethodError) do
-        immutable.foo
-      end
-    end
-
-    def test_skip_when_args_or_block
-      assert_raise(NoMethodError) do
-        immutable.a(1, 2, 3)
-      end
-      assert_raise(NoMethodError) do
-        immutable.a { :dummy }
-      end
-    end
-  end
-
-end

data/test/immutable_test.rb

@@ -0,0 +1,93 @@
+# rubocop:disable Metrics/AbcSize
+
+require "test-unit"
+require_relative "../lib/simple-immutable"
+
+class Simple::Immutable::TestCase < Test::Unit::TestCase
+  Immutable = ::Simple::Immutable
+
+  def hsh
+    {
+      a: "a-value",
+      "b": "b-value",
+      "child": {
+        name: "childname",
+        grandchild: {
+          name: "grandchildname"
+        }
+      },
+      "children": [
+        "anna",
+        "arthur",
+        {
+          action: {
+            keep_your_mouth_shut: true
+          }
+        }
+      ]
+    }
+  end
+
+  def immutable
+    Immutable.create hsh
+  end
+
+  def test_hash_access
+    assert_equal "a-value", immutable.a
+    assert_equal "b-value", immutable.b
+  end
+
+  def test_comparison
+    immutable = Immutable.create hsh
+
+    assert_equal immutable, hsh
+    assert_not_equal({}, immutable)
+  end
+
+  def test_child_access
+    child = immutable.child
+    assert_kind_of(Immutable, child)
+    assert_equal "childname", immutable.child.name
+    assert_equal "grandchildname", immutable.child.grandchild.name
+  end
+
+  def test_array_access
+    assert_kind_of(Array, immutable.children)
+    assert_equal 3, immutable.children.length
+    assert_equal "anna", immutable.children[0]
+
+    assert_kind_of(Immutable, immutable.children[2])
+    assert_equal true, immutable.children[2].action.keep_your_mouth_shut
+  end
+
+  def test_base_class
+    assert_nothing_raised do
+      immutable.object_id
+    end
+  end
+
+  def test_missing_keys
+    assert_raise(NoMethodError) do
+      immutable.foo
+    end
+  end
+
+  def test_skip_when_args_or_block
+    # raise NoMethodError when called with arguments
+    assert_raise(NoMethodError) do
+      immutable.a(1, 2, 3)
+    end
+
+    # raise NoMethodError when called with a block argument
+    assert_raise(NoMethodError) do
+      immutable.a { :dummy }
+    end
+  end
+
+  def test_raw_data
+    expected  = hsh
+
+    assert_equal(expected, Immutable.raw_data(immutable))
+    assert_equal(expected[:children], Immutable.raw_data(immutable.children))
+  end
+end

data/test/immutable_w_null_record_test.rb

@@ -0,0 +1,63 @@
+# rubocop:disable Metrics/AbcSize
+
+require "test-unit"
+require_relative "../lib/simple-immutable"
+
+class Simple::Immutable::WithNullRecordTestCase < Test::Unit::TestCase
+  Immutable = ::Simple::Immutable
+
+  def hsh
+    {
+      a: "a-value",
+      "b": "b-value",
+      "child": {
+        name: "childname",
+        grandchild: {
+          name: "grandchildname"
+        }
+      },
+      "children": [
+        "anna",
+        "arthur",
+        {
+          action: {
+            keep_your_mouth_shut: true
+          }
+        }
+      ]
+    }
+  end
+
+  def null_record
+    {
+      foo: "foo-value",
+      "bar" => "bar-value"
+    }
+  end
+
+  def immutable
+    Immutable.create hsh, null_record: null_record
+  end
+
+  def test_hash_access
+    assert_equal "a-value", immutable.a
+    assert_equal "b-value", immutable.b
+  end
+
+  def test_null_record_access
+    assert_equal "foo-value", immutable.foo
+    assert_equal "bar-value", immutable.bar
+  end
+
+  def test_missing_keys
+    assert_raise(NoMethodError) do
+      immutable.unknown
+    end
+  end
+
+  def test_raw_data
+    # raw data does contain null_record
+    expected = hsh.merge(null_record)
+    assert_equal(expected, Immutable.raw_data(immutable))
+  end
+end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: simple-immutable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.6
 platform: ruby
 authors:
 - radiospiel
 - mediapeers GmbH
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-03 00:00:00.000000000 Z
+date: 2021-07-13 00:00:00.000000000 Z
 dependencies: []
 description: Immutable ruby objects implementing dot and [] accessors.
 email: eno@radiospiel.org
@@ -18,6 +18,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".tm_properties"
 - Gemfile
 - Makefile
@@ -25,15 +26,18 @@ files:
 - VERSION
 - bin/bundle
 - bin/console
+- bin/rubocop
 - lib/simple-immutable.rb
 - lib/simple/immutable.rb
 - scripts/release
 - scripts/release.rb
 - simple-immutable.gemspec
+- test/immutable_test.rb
+- test/immutable_w_null_record_test.rb
 homepage: http://github.com/radiospiel/simple-immutable
 licenses: []
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -48,8 +52,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Immutable ruby objects
-test_files: []
+test_files:
+- test/immutable_test.rb
+- test/immutable_w_null_record_test.rb