lab42_diggy_methods 0.1.2 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f9642e13d0932c3f95de27b981501ef89e4f73f02cb2befaee5ef583294b5eb
-  data.tar.gz: 6677dde97b01b2a652a06ceb755371ddc13eb6ce6c935eb38a123518c7da37ad
+  metadata.gz: cd7c9c8c8932a3b06dd8d5cbaae76cc8983d90ffef39df1baca0bfed35eb2020
+  data.tar.gz: de17d940d1e5adffd415efc59ff3aba510da695db0f372135db2fa675f625215
 SHA512:
-  metadata.gz: 93bf1546ea98a27bf88a16180be58b32616af3c70f8418a1a9978f76b2cdd14083acf144c8f215441a1fa81fdb1a7ed7484f941103a62a25f37748161255c61f
-  data.tar.gz: 649f3fb72dea384c11a2f86d17c09836dd4b88cfc8762876aa180f0897466f9a01219942e0c99228a36eae5a31b2c24c5d4f9428c217bd2bfb301c695f93ecfe
+  metadata.gz: 9e049dd334f90743481c9e3ce898586171149e4de1f8733654fc63e9ee85555ceb8d09e49f64b656096534e042bc0ca5b8e64851d856c80cd290eeb478a8119c
+  data.tar.gz: 834efe604015307a109e8ac2d0790c5c44187144aae1c5740819952c3c8aa671d1edea0a9e5348b7c1d4324801df4b88956f044e19d0a8afa6afbbe8096d7253

data/README.md

@@ -33,7 +33,7 @@ Well let us [speculate about](https://github.com/RobertDober/speculate_about) it
 
 ### Context: `Diggy` function
 
-An extension to the Kernel as an alias to `Lab42::DiggyMethods.new`
+An extension to the Kernel as an alias for `Lab42::DiggyMethods.new`
 
 Given
 ```ruby
@@ -48,7 +48,7 @@ Then we can access its fields as follows
   expect(diggy.b.d.e).to eq(3)
 ```
 
-And we can use a shortcut for `key.__data__` by using `key!`A
+And we can use a shortcut for `key.__data__` by using `key!`
 ```ruby
     expect(diggy.b.d!).to eq(e: 3)
 ```
@@ -60,7 +60,13 @@ And that works for leave nodes too of course
 
 And in case of missing keys
 ```ruby
-    expect{ diggy.b.d.f }.to raise_error(KeyError, "key not found: :f")
+    expect{ diggy.b.d.f }.to raise_error(KeyError, "key not found: b.d.f")
+```
+
+And this works for arrays too:
+```ruby
+    with_array = Diggy(a: [b: {}])
+    expect { with_array.a.first.b.c }.to raise_error(KeyError, "key not found: a.b.c")
 ```
 
 If we access unknown keys we get the usual `KeyError` error, however we must not pass, nonhashable data
@@ -70,7 +76,7 @@ But if we pass an array
     expect{ Diggy([:a]) }.to raise_error(ArgumentError)
 ```
 
-### Context: Using in ERB
+### Context: Using in ERB with `__binding__`
 
 In order to take advantage of this syntax we want to pass the binding of a `Diggy` object to `ERB`
 
@@ -90,6 +96,49 @@ Then we can pass the binding to the template
     expect(ERB.new(template_text).result(data.__binding__)).to eq("YHS")
 ```
 
+#### Context: Merging bindings
+
+In some cases `Diggy` will not be the only useful _binding_ in an `ERB` Template
+we can work around this as follows
+
+Given a diggy and a module
+```ruby
+    let(:diggy) { Diggy(a: 1) }
+    let :mod  do
+      Module.new do
+        def b; 42 end
+      end
+    end
+```
+And we extend the `diggy` with the module
+```ruby
+    before { diggy.extend(mod) }
+```
+
+Then the module's methods become accessible in the binding
+```ruby
+    expect(diggy.__binding__.eval("b")).to eq(42)
+```
+
+### Context: Iteration
+
+If an element in a diggy object is an array we descend
+
+Given yet another diggy™
+```ruby
+    let(:diggy) { Diggy(a: [b: 1, c: 2]) }
+```
+
+Then we get an array
+```ruby
+    expect(diggy.a).to be_an(Array)
+```
+
+And it contains diggy instances
+```ruby
+    expect(diggy.a.first.b).to eq(1)
+```
+
 # LICENSE
 
 Copyright 2022 Robert Dober robert.dober@gmail.com

data/lib/lab42/diggy_methods/version.rb

@@ -2,7 +2,7 @@
 
 module Lab42
   class DiggyMethods
-    VERSION = "0.1.2"
+    VERSION = "0.1.7"
   end
 end
 #  SPDX-License-Identifier: Apache-2.0

data/lib/lab42/diggy_methods.rb

@@ -12,8 +12,9 @@ module Lab42
 
     private
 
-    def initialize(a=nil, **data_)
+    def initialize(a=nil, __key_chain__: [], **data_)
       @data = _make_data_from_args(a, data_)
+      @key_chain = __key_chain__
     end
 
     def _make_data_from_args(a, data_)
@@ -37,7 +38,7 @@ module Lab42
       raise ArgumentError, "positional argument must be a hash or respond to to_h if present"
     end
 
-    def method_missing(name)
+    def method_missing(name, *)
       if name.to_s.end_with?"!"
         @data.fetch(name.to_s.sub(/!\z/, "").to_sym)
       else
@@ -45,14 +46,30 @@ module Lab42
       end
     end
 
-    def _method_missing_try_descend(name)
-      found = @data.fetch(name)
+    def _make_diggy_array(found, key)
+      found.map { self.class.new(_1, __key_chain__: _new_key_chain(key)) }
+    end
+
+    def _maybe_make_diggy(found, key)
       if found.respond_to?(:to_h)
-        self.class.new(**found)
+        self.class.new(**found, __key_chain__: _new_key_chain(key))
       else
         found
       end
     end
+
+    def _method_missing_try_descend(name)
+      found = @data.fetch(name) { raise KeyError, "key not found: #{_new_key_chain(name).join(".")}" }
+      if Array === found
+        _make_diggy_array(found, name)
+      else
+        _maybe_make_diggy(found, name)
+      end
+    end
+
+    def _new_key_chain(key)
+      @key_chain + [key]
+    end
   end
 end
 #  SPDX-License-Identifier: Apache-2.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_diggy_methods
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.7
 platform: ruby
 authors:
 - Robert Dober
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-01 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies: []
 description: |
   Create an instance of me with a Hash and access the (nested) values
@@ -25,7 +25,7 @@ files:
 - lib/lab42/diggy_methods.rb
 - lib/lab42/diggy_methods/kernel.rb
 - lib/lab42/diggy_methods/version.rb
-homepage: https://github.com/robertdober/lab42_diggy_methods
+homepage: https://github.com/robertdober/diggy_methods
 licenses:
 - Apache-2.0
 metadata: {}