lab42_nhash 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dfa964b499cd8f9c9fb458f0082eacf0f990cfac
-  data.tar.gz: f5c06457ecdd6652fd05a33e768791192993a37d
+  metadata.gz: 61f49c29e0db80ae41ba77a021fa52ddff6c8358
+  data.tar.gz: d82b50f5129c0dc580647654593f64179a0a95fb
 SHA512:
-  metadata.gz: aacab0eb78da5bbeb5b945624e0c2fa058634ba87731dee6803cae4caf27c9e9d21f8910b18a75579528a167d556417b1caeb25bdcea512ca31fd3e614d3f779
-  data.tar.gz: 7aa8904790917d875576b024692427ea49fe3b252096aca527b3c25f101d8afb7a035822262f9a41533cc6d4c402ef68eeefa9afecd893d92f3a86f8c9e8d52d
+  metadata.gz: 7d2f0c0e1426d9034430be22df2f220463413b75d13069e40533aa8e31226493b1ae5fce8a887a51f1ab6ce0b40fe0964f03ede6275f7ee04635106b07c1775b
+  data.tar.gz: 12bab1e9b0f31058465e54b72fb12cce5641148c29ae864eeac1e5636b2c5afb15e4b10c6a6555a95fb55640391e9a200c47474220bfb2398a0cb5d373b48bd9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lab42_nhash (0.1.1)
+    lab42_nhash (0.1.2)
       forwarder2 (~> 0.2)
       ruby_parser (~> 3.6)
 

data/demo/090-compound-values.md

@@ -45,6 +45,59 @@ And that we can also use interpolation:
  #   entries[0].get!(:value).assert == '42'
 ```
 
+### Enhanced Search
+
+`NHash::Enum` of course implements `Enumerable`. However, when looking for keys we need to rescue from `KeyError` very frequently.
+
+Here is a demonstration of that.
+
+```ruby
+    nh = NHash.new(
+          entries: [
+            {a: 1},
+            {b: 2}
+          ])
+          .with_indifferent_access
+    entries = nh.get :entries
+```
+
+In order to find `b` the quite obvious code is
+
+```ruby
+    entries.find{ |entry|
+      begin
+        entry.get(:b)
+      rescue KeyError
+      end
+    }.get(:b).assert == 2
+```
+
+Now that code is not very readable, is it? Being cluttered by the rescue block and needing to invoke the get again?
+
+Here is how we would like to write (and read) that kind of code:
+
+```ruby
+    entries.get{ |entry|
+      entry.get :b
+    }.assert == 2
+```
+
+This can even be shortened to
+
+```ruby
+    entries.get{ 2 * get(:b) }
+      .assert == 4
+```
+
+or
+
+```ruby
+    entries.get(:b).assert == 2
+```
+
+
+
+
 
 
 

data/lib/lab42/nhash/enum.rb

@@ -1,5 +1,7 @@
 require 'forwarder'
 
+require_relative 'invocation'
+
 module Lab42
   class NHash
     class Enum
@@ -11,12 +13,20 @@ module Lab42
       forward :last!, to_object: :self, as: :fetch!, with: -1 
       
       include Enumerable
+      include Invocation
 
       attr_reader :parent
 
       def [] idx
         Lab42::NHash.from_value @enum[idx], @options
       end
+      
+      def each blk=nil, &block
+        behavior = blk || block
+        @enum.each do | ele |
+          behavior.( Lab42::NHash.from_value ele, @options )
+        end
+      end
 
       def fetch! idx
         result = self[ idx ]
@@ -24,6 +34,12 @@ module Lab42
 
         ERB.new( result ).result @parent.current_binding
       end
+      
+      def get keyexp=nil, &block
+        behavior = block || keyexp
+        raise ArgumentError, 'need key or behavior' unless behavior
+        Proc === behavior ? _get_with_behavior( behavior ) : _get_with_key( keyexp )
+      end
 
       private
       def initialize enum, options
@@ -32,6 +48,26 @@ module Lab42
         @options = options
       end
 
+      def _get_with_key keyexp
+        each do |ele, sentinel|
+          begin
+            return ele.get keyexp
+          rescue KeyError
+          end
+        end
+        raise KeyError, "key not found: #{keyexp.inspect}"
+      end
+
+      def _get_with_behavior behavior
+        each do |ele, sentinel|
+          begin
+            return _invoke behavior, ele
+          rescue KeyError
+          end
+        end
+        raise KeyError, "key not found: #{keyexp.inspect}"
+        
+      end
     end # class Enum
   end # class NHash
 end # module Lab42

data/lib/lab42/nhash/version.rb

@@ -1,5 +1,5 @@
 module Lab42
   class NHash
-    VERSION = '0.1.1'
+    VERSION = '0.1.2'
   end # class NHash
 end # module Lab42

data/spec/unit/compound/enum_spec.rb

@@ -1,41 +1,33 @@
 require 'spec_helper'
 
 describe NHash::Enum do
-  subject do
-    nh = NHash.new(
-      a: 42,
-      entries: [
-        { val: '<%= get :a %>' },
-        '<%= get(:a) * 2 %>',
-        21
-      ] )
-      .with_indifferent_access
-  end
-  let(:enum){ subject.get :entries }
 
-  it 'is returned for arrays' do
-    expect( subject.get :entries ).to be_instance_of described_class
-  end
+  context 'Enumerable behavior' do
+    context 'Hashes' do 
+      subject do
+        NHash.new( entries: [{a: 1}] ).with_indifferent_access
+      end
+      let(:entries){ subject.get :entries }
 
-  context 'behaves like an array' do
-    it 'for #[]' do
-      expect( enum[2] ).to eq 21
-    end
-    it 'for #first' do
-      expect( enum.first.get :val ).to eq '<%= get :a %>'
-    end
-    it 'for #last' do
-      expect( enum.last ).to eq 21
-    end
-  end # context :behaves
+      it 'are yielded as NHash instances' do
+        entries.each do | entry |
+          expect( entry ).to be_kind_of NHash
+        end
+      end
+    end # context 'yields NHashes'
 
-  context 'preservers the context' do
-    it 'evaluates with indifferent access' do
-      expect( enum.first.get('val') ).to eq '<%= get :a %>'
-    end
+    context 'Arrays' do 
+      subject do
+        NHash.new( entries: [[{a:1}]] ).with_indifferent_access
+      end
+      let(:entries){ subject.get :entries }
+      it 'are yielded as NHash::Enum instances' do 
+        entries.each do | entry |
+          expect( entry ).to be_kind_of described_class
+        end
+      end
+
+    end # context 'yields NHash::Enum instances'
+  end # context 'Enumerable behavior'
 
-    it 'interpolates in the context of the original object' do
-      expect( enum.first.get!('val') ).to eq '42'
-    end
-  end # context 'preservers the context'
 end

data/spec/unit/compound/get_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe NHash::Enum do
+
+  subject do
+    NHash.new(
+      entries: [
+        {a: 1},
+        {b: 2}
+      ]
+    ).with_indifferent_access
+  end
+  let(:entries){ subject.get :entries }
+  
+
+  context 'get with keys' do 
+    it 'finds a key' do
+      expect( entries.get :a ).to eq 1
+      expect( entries.get :b ).to eq 2
+    end
+    
+    it '... or not' do
+      expect( ->{ entries.get :c } ).to raise_error KeyError
+    end
+  end # context 'get with keys'
+
+  context 'get with blox' do 
+    it 'finds a key and returns the bloxs return value' do
+      expect( entries.get{ |e| e.get(:b) * 2 } ).to eq 4
+      expect( entries.get(->(e){ e.get(:b) * 2 }) ).to eq 4
+    end
+    it 'can instance exec the behavior' do
+      expect( entries.get{ get(:b) + 1 } ).to eq 3
+      expect( entries.get(->{ get(:b) + 1 }) ).to eq 3
+    end
+  end # context 'get with blox'
+  
+end

data/spec/unit/compound/hash_enum_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe NHash::Enum do
+  subject do
+    nh = NHash.new(
+      a: 42,
+      entries: [
+        { val: '<%= get :a %>' },
+        '<%= get(:a) * 2 %>',
+        21
+      ] )
+      .with_indifferent_access
+  end
+  let(:enum){ subject.get :entries }
+
+  it 'is returned for arrays' do
+    expect( subject.get :entries ).to be_instance_of described_class
+  end
+
+  context 'behaves like an array' do
+    it 'for #[]' do
+      expect( enum[2] ).to eq 21
+    end
+    it 'for #first' do
+      expect( enum.first.get :val ).to eq '<%= get :a %>'
+    end
+    it 'for #last' do
+      expect( enum.last ).to eq 21
+    end
+  end # context :behaves
+
+  context 'behaves like an Enumerable' do 
+    it 'via Lab42::NHash::Enum' do
+      expect( enum ).to be_kind_of described_class
+      expect( described_class ).to be < Enumerable
+    end
+    
+  end # context 'behaves like an Enumerable'
+
+  context 'preservers the context' do
+    it 'evaluates with indifferent access' do
+      expect( enum.first.get('val') ).to eq '<%= get :a %>'
+    end
+
+    it 'interpolates in the context of the original object' do
+      expect( enum.first.get!('val') ).to eq '42'
+    end
+  end # context 'preservers the context'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lab42_nhash
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Robert Dober
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-27 00:00:00.000000000 Z
+date: 2014-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: forwarder2
@@ -168,6 +168,8 @@ files:
 - spec/unit/afixes/prefix_spec.rb
 - spec/unit/afixes/suffix_spec.rb
 - spec/unit/compound/enum_spec.rb
+- spec/unit/compound/get_spec.rb
+- spec/unit/compound/hash_enum_spec.rb
 - spec/unit/compound/nhash_spec.rb
 - spec/unit/factories/from_sources_using_hashes_spec.rb
 - spec/unit/factories/from_sources_using_yaml_files_spec.rb
@@ -224,6 +226,8 @@ test_files:
 - spec/unit/afixes/prefix_spec.rb
 - spec/unit/afixes/suffix_spec.rb
 - spec/unit/compound/enum_spec.rb
+- spec/unit/compound/get_spec.rb
+- spec/unit/compound/hash_enum_spec.rb
 - spec/unit/compound/nhash_spec.rb
 - spec/unit/factories/from_sources_using_hashes_spec.rb
 - spec/unit/factories/from_sources_using_yaml_files_spec.rb