trick_bag 0.50.0 → 0.51.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 18fca0df6bf55045308d1addceafea1793c14b87
-  data.tar.gz: 37c89c74b67277d29d959d10a0d17636c6347269
+  metadata.gz: 137cb6576cfd3498b7762313918781e053f12550
+  data.tar.gz: bf7a7e5a71cae9c08a7f8bde90801e422fe63d0a
 SHA512:
-  metadata.gz: fa4fa5ddde0bca6c34ef27af74122b1ae1b669597b135f674b0f8e3dfac812a0d69576cea742ca2fe27ef5473cc1895ff5f046f1da0c36ec7d1104cfb2e5365c
-  data.tar.gz: 377ec62488029e12b522af9e8cc0ec7ee49bdd54028cc85c916b9d4da5c3f7b10ad99ef7e67714c3e17217401a8f6476d7213b056f6e9886f8ab74bd542ac88f
+  metadata.gz: 137370f1acfd51c9378894c6328852013c22c3cb522cd1d93033350cd3145197d4b75c7288f7712af42d21411d92300459eb7a01675f9d4b2d5bb678a8bf9684
+  data.tar.gz: e097d5e75037f2219d8f76c8172afd31ae81a734bbf84dc9860c42b1884a671508c7b73d4b7d4688f7eb02698c5530b4f9a68f12cbbc805a787c5eed51d7f190

data/RELEASE_NOTES.md

@@ -1,3 +1,8 @@
+## v0.51.0
+
+* Add CollectionAccess access and accessor methods.
+
+
 ## v0.50.0
 
 * On MultiCounter, fixed percent_of_total_hash, added fraction_of_total_hash.

data/lib/trick_bag/collections/collection_access.rb

@@ -0,0 +1,59 @@
+# Supports access to nested hashes with a string instead of multiple []'s.
+# Inspired by Josh Szmajda's dot_notation gem at https://github.com/joshsz/dot_notation,
+
+module TrickBag
+module CollectionAccess
+
+  module_function
+
+  # Accesses a collection with a single string that represents n levels of depth.
+  # See the spec file for examples, but here's one:
+  #
+  # h = { 'h' => ['a', 'b'] }
+  # CollectionAccess.access(h, 'h.1') => 'b'
+  #
+  # If an error is raised while trying to access the value with a given key,
+  # an error will be raised showing that error plus the context of which
+  # key failed, as in:
+  #
+  # Error occurred processing key [x.1] in [x.1.2]: undefined method `[]' for nil:NilClass
+  #
+  # @param the collection to access
+  # @param key_string the string representing the keys to use
+  # @separator the string to use to separate the
+  def access(collection, key_string, separator = '.')
+
+    keys = key_string.split(separator)
+    return_object = collection
+
+    keys.each_with_index do |key, index|
+      key = key.to_i if return_object.kind_of?(Array)
+      begin
+        return_object = return_object[key]
+      rescue => e
+        this_key = keys[0..index].join(separator)
+        raise "Error occurred processing key [#{this_key}] in [#{key_string}]: #{e}"
+      end
+    end
+    return_object
+  end
+
+
+  # Like access, but returns a lambda that can be used to access a given collection.
+  # Since lambdas can be called with the subscript operator,
+  # using it can resemble regular hash or array access.
+  # If you don't like this you can use '.call' or '.()' instead.
+  #
+  # An example:
+  #
+  # h = { 'h' => ['a', 'b'] }
+  # accessor = CollectionAccess.accessor(h)
+  # accessor['h.1']    # => 'b'
+  # or
+  # accessor.('h.1')    # => 'b'
+  def accessor(collection, separator = '.')
+    ->(key_string) { access(collection, key_string, separator) }
+  end
+
+end
+end

data/lib/trick_bag/enumerables/buffered_enumerable.rb

@@ -41,7 +41,7 @@ class BufferedEnumerable
   # @param chunk_size the maximum number of objects to be buffered
   # @param fetcher lambda to be called to fetch to fill the buffer
   # @param fetch_notifier lambda to be called to when a fetch is done
-  def self.create_with_lambdas(chunk_size, fetcher, fetch_notifier)
+  def self.create_with_lambdas(chunk_size, fetcher, fetch_notifier = nil)
     instance = self.new(chunk_size)
     instance.fetcher = fetcher
     instance.fetch_notifier = fetch_notifier

data/lib/trick_bag/version.rb

@@ -1,3 +1,3 @@
 module TrickBag
-  VERSION = "0.50.0"
+  VERSION = "0.51.0"
 end

data/spec/trick_bag/collections/collection_access_spec.rb

@@ -0,0 +1,71 @@
+require_relative '../../spec_helper'
+require 'trick_bag/collections/collection_access'
+
+
+module TrickBag
+module CollectionAccess
+
+
+describe CollectionAccess do
+
+  context '#access' do
+
+    it 'works with a single key' do
+      h = { 'a' => 123 }
+      expect(CollectionAccess.access(h, 'a')).to eq(123)
+    end
+
+    it 'works with 2 keys' do
+      h = { 'a' => { 'b' => 234 }}
+      expect(CollectionAccess.access(h, 'a.b')).to eq(234)
+    end
+
+    it 'works with 3 keys' do
+      h = { 'a' => { 'bb' => { 'ccc' => 345 }}}
+      expect(CollectionAccess.access(h, 'a.bb.ccc')).to eq(345)
+    end
+
+    it 'works with spaces as separators' do
+      h = { 'a' => { 'bb' => { 'ccc' => 345 }}}
+      expect(CollectionAccess.access(h, 'a bb ccc', ' ')).to eq(345)
+
+    end
+
+    it 'works with spaces as separators with multiple spaces' do
+      h = { 'a' => { 'bb' => { 'ccc' => 345 }}}
+      expect(CollectionAccess.access(h, 'a      bb ccc', ' ')).to eq(345)
+    end
+
+    it 'works with numeric array subscripts 1 deep' do
+      a = ['a', 'b']
+      expect(CollectionAccess.access(a, '1')).to eq('b')
+    end
+
+    it 'works with a hash containing an array' do
+      h = { 'h' => ['a', 'b'] }
+      expect(CollectionAccess.access(h, 'h.1')).to eq('b')
+    end
+
+    it 'raises an error when accessing an invalid key' do
+      h = { 'h' => ['a', 'b'] }
+      expect(-> { CollectionAccess.access(h, 'x.1.2') }).to raise_error
+    end
+  end
+
+
+  context '#accessor' do
+
+    it 'works with a hash containing an array' do
+      h = { 'h' => ['a', 'b'] }
+      accessor = CollectionAccess.accessor(h)
+      expect(accessor['h.1']).to eq('b')
+    end
+
+  end
+
+
+end
+
+
+end
+end

data/spec/trick_bag/enumerables/buffered_enumerable_spec.rb

@@ -28,12 +28,18 @@ module Enumerables
         end
 
         e = BufferedEnumerable.create_with_lambdas(4, fetcher, fetch_notifier).to_enum
-        (1..10).each do |n|
-          expect(e.next).to eq(n)
-        end
+        (1..10).each { |n| expect(e.next).to eq(n) }
         expect(chunk_fetch_calls).to eq(3)
         expect(object_count).to eq(12)
       end
+
+      specify 'create_with_lambdas can be called without specifying a fetch_notifier' do
+        be = nil
+        f1 = -> { be = BufferedEnumerable.create_with_lambdas(4, fetcher).to_enum }
+        expect(f1).not_to raise_error
+        f2 = -> { (1..10).each { be.next } }
+        expect(f2).not_to raise_error
+      end
     end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: trick_bag
 version: !ruby/object:Gem::Version
-  version: 0.50.0
+  version: 0.51.0
 platform: ruby
 authors:
 - Keith Bennett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: os
@@ -95,6 +95,7 @@ files:
 - RELEASE_NOTES.md
 - Rakefile
 - lib/trick_bag.rb
+- lib/trick_bag/collections/collection_access.rb
 - lib/trick_bag/collections/linked_list.rb
 - lib/trick_bag/core_types.rb
 - lib/trick_bag/enumerables/buffered_enumerable.rb
@@ -120,6 +121,7 @@ files:
 - lib/trick_bag/validations/other_validations.rb
 - lib/trick_bag/version.rb
 - spec/spec_helper.rb
+- spec/trick_bag/collections/collection_access_spec.rb
 - spec/trick_bag/collections/linked_list_spec.rb
 - spec/trick_bag/core_types_spec.rb
 - spec/trick_bag/enumerables/buffered_enumerable_spec.rb
@@ -169,6 +171,7 @@ specification_version: 4
 summary: Miscellaneous general useful tools.
 test_files:
 - spec/spec_helper.rb
+- spec/trick_bag/collections/collection_access_spec.rb
 - spec/trick_bag/collections/linked_list_spec.rb
 - spec/trick_bag/core_types_spec.rb
 - spec/trick_bag/enumerables/buffered_enumerable_spec.rb