collapsium 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5f69b509b0b797408a7a7b49f205cf1664d9931
-  data.tar.gz: c8cddb20e60be62dcf7522ef8008e9d02a4c256b
+  metadata.gz: 3922ea4f400facdd0a8319d6ea4993a5cb64dc54
+  data.tar.gz: a94ad0feef4ca8399de6c9c65b8037238f26a752
 SHA512:
-  metadata.gz: 5586fb4097ab338d3a2d2d4a55d3ae2bd91eebea7d2a02acbe49500c45da8b735922ea989b2f9fbaa4d0134d26308d4ead461a40b86fec99d1c901c81690bf95
-  data.tar.gz: f57e9dd8df1ee2013db148d3acc86a462d10701dbaf72276997ef3e2a10724c51cd663696745d604cf66069684318d7507e3987235ddb48fe476eb5f762dcf81
+  metadata.gz: 2a6d221e5658ff884cbda2078d52eb39a2cf5d3d9167859e43556c4f138ec4b1cc4463b303008c113315325dbdeea0369615e0219be19c4a923e8838183e2f53
+  data.tar.gz: f6a5238d75f3a44572fa0e45339c31261e65560eb852edeb929698595720b1115f781192b13305a1c2cbcf2681505a4bd0cde91f52a33e0047289d71863aa7d3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    collapsium (0.5.1)
+    collapsium (0.6.0)
 
 GEM
   remote: https://rubygems.org/
@@ -59,4 +59,4 @@ DEPENDENCIES
   yard (~> 0.9)
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/lib/collapsium/recursive_fetch.rb

@@ -0,0 +1,97 @@
+# coding: utf-8
+#
+# collapsium
+# https://github.com/jfinkhaeuser/collapsium
+#
+# Copyright (c) 2016 Jens Finkhaeuser and other collapsium contributors.
+# All rights reserved.
+#
+
+require 'collapsium/viral_capabilities'
+
+module Collapsium
+  ##
+  # Provides recursive (deep) fetch function for hashes.
+  module RecursiveFetch
+    # Clone Hash extensions for nested Hashes
+    extend ViralCapabilities
+
+    ##
+    # Fetches the first matching key, or the default value if no match
+    # was found.
+    # If a block is given, it is passed the value containing the key
+    # (the parent), the value at the key, and the default value
+    # in that order.
+    # *Note:* Be careful when using blocks: it's return value becomes
+    # the match value. The typically correct behaviour is to return
+    # the match value passed to the block.
+    def recursive_fetch_one(key, default = nil, &block)
+      # Start simple at the top level.
+      result = fetch(key, default)
+      if result != default
+        if not block.nil?
+          result = yield self, result, default
+        end
+        return result
+      end
+
+      # We have to recurse for nested values
+      result = map do |_, v|
+        # If we have a Hash or Array, we need to recurse.
+        if not (v.is_a? Hash or v.is_a? Array)
+          next
+        end
+
+        enhanced = ViralCapabilities.enhance_value(self, v)
+        inner = enhanced.recursive_fetch_one(key, default, &block)
+        if inner != default
+          next inner
+        end
+      end
+
+      result.compact!
+      return result[0] || default
+    end
+
+    ##
+    # Fetches all matching keys as an array, or the default value if no match
+    # was found. Blocks work as in `#recursive_fetch`
+    def recursive_fetch_all(key, default = nil, &block)
+      result = []
+
+      # Start simple at the top level.
+      ret = fetch(key, default)
+      if ret != default
+        if not block.nil?
+          ret = yield self, ret, default
+        end
+        result << ret
+      end
+
+      # We have to recurse for nested values
+      result += map do |_, v|
+        # If we have a Hash or Array, we need to recurse.
+        if not (v.is_a? Hash or v.is_a? Array)
+          next
+        end
+
+        enhanced = ViralCapabilities.enhance_value(self, v)
+        inner = enhanced.recursive_fetch_all(key, default, &block)
+        if inner != default
+          next inner
+        end
+      end
+
+      # Flatten and compact results to weed out non-matches
+      result = result.flatten
+      result.compact!
+
+      if result.empty?
+        return default
+      end
+      return result
+    end
+
+    alias recursive_fetch recursive_fetch_all
+  end # module RecursiveFetch
+end # module Collapsium

data/lib/collapsium/uber_hash.rb

@@ -10,6 +10,7 @@
 require 'collapsium/recursive_merge'
 require 'collapsium/recursive_dup'
 require 'collapsium/recursive_sort'
+require 'collapsium/recursive_fetch'
 require 'collapsium/indifferent_access'
 require 'collapsium/pathed_access'
 require 'collapsium/prototype_match'
@@ -25,6 +26,7 @@ module Collapsium
     include RecursiveMerge
     include RecursiveDup
     include RecursiveSort
+    include RecursiveFetch
     include PathedAccess
     include PrototypeMatch
 

data/lib/collapsium/version.rb

@@ -8,5 +8,5 @@
 #
 module Collapsium
   # The current release version
-  VERSION = "0.5.1".freeze
+  VERSION = "0.6.0".freeze
 end

data/spec/recursive_fetch_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+require_relative '../lib/collapsium/recursive_fetch'
+
+describe ::Collapsium::RecursiveFetch do
+  let(:tester) do
+    h = {
+      "foo" => 42,
+      "bar" => 123,
+      "baz" => {
+        "foo" => 321,
+        "unique" => "something"
+      }
+    }
+    h.extend(::Collapsium::RecursiveFetch)
+  end
+
+  context "fetching basics" do
+    it ":fetch_one fetches the first value found" do
+      expect(tester.recursive_fetch_one("foo")).to eql 42
+      expect(tester.recursive_fetch_one("unique")).to eql "something"
+    end
+
+    it ":fetch fetches all values" do
+      expect(tester.recursive_fetch("foo")).to eql [42, 321]
+    end
+  end
+
+  context "defaults" do
+    it "uses nil by default" do
+      expect(tester.recursive_fetch_one('does not exist')).to be_nil
+      expect(tester.recursive_fetch('does not exist')).to be_nil
+    end
+
+    it "uses a given value" do
+      expect(tester.recursive_fetch_one('does not exist', 42)).to eql 42
+      expect(tester.recursive_fetch('does not exist', 42)).to eql 42
+    end
+  end
+
+  context "blocks" do
+    it ":fetch_one invokes the block once" do
+      called = 0
+      tester.recursive_fetch_one('foo') do |parent, result, default|
+        expect(parent['foo']).to eql 42
+        expect(result).to eql 42
+        expect(default).to be_nil
+        called += 1
+      end
+
+      expect(called).to eql 1
+    end
+
+    it ":fetch invokes the block twice" do
+      called = 0
+      tester.recursive_fetch('foo') do |parent, result, default|
+        expect(parent['foo'].is_a?(Integer)).to be_truthy
+        expect(result.is_a?(Integer)).to be_truthy
+        expect(default).to be_nil
+        called += 1
+      end
+
+      expect(called).to eql 2
+    end
+
+    it "can alter the value" do
+      called = 0
+      ret = tester.recursive_fetch_one('foo') do |parent, result, default|
+        expect(parent['foo']).to eql 42
+        expect(result).to eql 42
+        expect(default).to be_nil
+        called += 1
+
+        next "new value"
+      end
+
+      expect(called).to eql 1
+      expect(ret).to eql "new value"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: collapsium
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Jens Finkhaeuser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-02 00:00:00.000000000 Z
+date: 2016-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -119,6 +119,7 @@ files:
 - lib/collapsium/pathed_access.rb
 - lib/collapsium/prototype_match.rb
 - lib/collapsium/recursive_dup.rb
+- lib/collapsium/recursive_fetch.rb
 - lib/collapsium/recursive_merge.rb
 - lib/collapsium/recursive_sort.rb
 - lib/collapsium/support/array_methods.rb
@@ -133,6 +134,7 @@ files:
 - spec/pathed_access_spec.rb
 - spec/prototype_match_spec.rb
 - spec/recursive_dup_spec.rb
+- spec/recursive_fetch_spec.rb
 - spec/recursive_merge_spec.rb
 - spec/recursive_sort_spec.rb
 - spec/spec_helper.rb
@@ -170,6 +172,7 @@ test_files:
 - spec/pathed_access_spec.rb
 - spec/prototype_match_spec.rb
 - spec/recursive_dup_spec.rb
+- spec/recursive_fetch_spec.rb
 - spec/recursive_merge_spec.rb
 - spec/recursive_sort_spec.rb
 - spec/spec_helper.rb