depth 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cbf679b511350ae5c34519b2af1aa2ad1f671aa
-  data.tar.gz: 9c3a7f17b5d983bdb7ac462cd64978dc2507f411
+  metadata.gz: 12186cff293335e8e867ec9c826644c4b175160c
+  data.tar.gz: 1de2bcf3603c3838ae27c95f4b3f4cd3d961ee4b
 SHA512:
-  metadata.gz: 47001c6d7a175db444704a672a0d91fd9592be04161b90f91bf75d5d6f21ec6ed9f568b1ccf769b047e9f556eed18b73141972a9b7a1cd7150d8a610656c88c5
-  data.tar.gz: 00bb1f310d035a13002f25dc10e393e18259cc1c2e5ea298ad1ab5fda02824dd9742ebea6440b9602a209464011336fb49029ce9b5c59ba0fefe3ed7d4b6d72c
+  metadata.gz: a3d24285ec52b1ac2f878ab29a6287c548794a7e0dfd1e50eb6d4d2e916df996434a404690cb83b58a3ccf36961217843c5e647f76ea4d831749b272ba8c6bd7
+  data.tar.gz: c65350a161b063d0c855a05a58a9bcfe089cf503f9a462f2ec686f00239de91049233f99154216ddcc7813595125a9f9b83c8a4e6f41f0df488ec7ab991d223d

data/README.md

@@ -71,6 +71,10 @@ Routes can be defined as an array of keys or indeces:
   ]}
   route = ['$and', 1, '$or', 0, '#otherfeed', 'thing']
   Depth::ComplexHash.new(hash).find(route) # => []
+
+  # Or with a default
+  Depth::ComplexHash.new(hash).find(%w(not a route), default: 'hello') # => 'hello'
+
 ```
 
 But there's something cool hidden in the `set` message,
@@ -106,6 +110,39 @@ an array, no worries, just say so in the route:
   route = ['$and', 1, '$or', 0, RouteElement.new('#sup', type: :array), 0]
 ```
 
+Find can also perform the same magic if you set the keyword
+argument `create` to be true. A default value can also be supplied:
+
+```ruby
+  hash = { '$and' => [
+    { '#weather' => { 'something' => [], 'thisguy' => 4 } },
+    { '$or' => [
+      { '#otherfeed' => {'thing' => [] } },
+    ]}
+  ]}
+  route = ['$and', 1, '$or', 0, '#sup', 'thisthing']
+  Depth::ComplexHash.new(hash).find(route, create: true)
+  puts hash.inspect #=>
+  # hash = { '$and' => [
+  #   { '#weather' => { 'something' => [], 'thisguy' => 4 } },
+  #   { '$or' => [
+  #     { '#otherfeed' => {'thing' => [] } },
+  #     { '#sup' => { } },
+  #   ]}
+  # ]}
+
+  # Or if you supply a default value as well
+  val = Depth::ComplexHash.new(hash).find(route, create: true, default: 'blargle')
+  puts val #=> 'blargle'
+  puts hash.inspect #=>
+  # hash = { '$and' => [
+  #   { '#weather' => { 'something' => [], 'thisguy' => 4 } },
+  #   { '$or' => [
+  #     { '#otherfeed' => {'thing' => [] } },
+  #     { '#sup' => { 'thisthing' => 'blargle' } },
+  #   ]}
+  # ]}
+```
 ### Enumeration
 
 The messages signatures relating to enumeration are:
@@ -116,7 +153,7 @@ The messages signatures relating to enumeration are:
 * `map` = yields `key_or_index`, `fragment` and `parent_type`, returns a new complex hash
 * `map_values` = yields  `fragment`, returns a new complex hash
 * `map_keys` = yields `key_or_index`, returns a new complex hash
-* `map!`, `map_keys!` and `map_keys_and_values!`, returns a new complex hash
+* `map!`, `map_keys!` and `map_keys_and_values!`, returns the base complex hash
 * `reduce(memo)` = yields `memo`, `key` and `fragment`, returns memo
 * `each_with_object(obj)` = yields `key`, `fragment` and `object`, returns object
 
@@ -124,6 +161,12 @@ _Fragment refers to a chunk of the original hash_
 
 These, perhaps, require a bit more explanation:
 
+_NB_ All of these methods yield an argument at the end
+which is the route taken to get to this fragment of the hash,
+I've not detailed the use of it here because it's rarely necessary but
+it's available in case you have some complex map rules that change
+based on where you are in the hash.
+
 #### each
 
 The staple, and arguably the most important, of all the enumeration methods,

data/lib/depth/actions.rb

@@ -14,11 +14,19 @@ module Depth
       object[route.last.key] = value
     end
 
-    def find(route)
+    def find(route, create: false, default: nil)
       route = RouteElement.convert_route(route)
-      route.reduce(Traverser.new(base)) { |t, route_el|
-        t.next(route_el.key)
+      parent = route[0 ... -1].reduce(Traverser.new(base)) { |t, route_el|
+        if create
+          t.next_or_create(route_el.key) { route_el.create }
+        else
+          t.next(route_el.key)
+        end
       }.object
+      object = parent ? parent[route.last.key] : nil
+      return object unless object.nil?
+      return parent[route.last.key] = default if create && default
+      default
     end
 
     def alter(route, key: nil, value: nil)

data/lib/depth/enumeration/enumerable.rb

@@ -8,9 +8,9 @@ module Depth
       #:nocov:
 
       def each_with_object(object, &block)
-        object.tap do |o|
-          each do |key, fragment|
-            block.call(key, fragment, o)
+        object.tap do |obj|
+          each do |key, fragment, route|
+            block.call(key, fragment, obj, route)
           end
         end
       end
@@ -18,11 +18,11 @@ module Depth
       def select(&block)
         new_q = self.class.new(base.class.new)
         routes_to_delete = []
-        enumerate do |node|
+        enumerate do |node, route|
           key = node.parent_key
           existing = new_q.find(node.route)
           fragment = existing.nil? ? node.fragment : existing
-          keep = block.call(key, fragment)
+          keep = block.call(key, fragment, route)
           if keep
             new_q.alter(node.route, key: key, value: fragment)
           else
@@ -34,12 +34,12 @@ module Depth
       end
 
       def reject(&block)
-        select{ |key, fragment| !block.call(key, fragment) }
+        select{ |key, fragment, route| !block.call(key, fragment, route) }
       end
 
       def reduce(memo, &block)
-        each do |key, fragment|
-          memo = block.call(memo, key, fragment)
+        each do |key, fragment, route|
+          memo = block.call(memo, key, fragment, route)
         end
         memo
       end
@@ -60,36 +60,36 @@ module Depth
       end
 
       def map_keys(&block)
-        map do |key, fragment|
-          [block.call(key), fragment]
+        map do |key, fragment, route|
+          [block.call(key, route), fragment]
         end
       end
 
       def map_values(&block)
-        map do |key, fragment, parent_type|
-          [key, block.call(fragment)]
+        map do |key, fragment, route|
+          [key, block.call(fragment, route)]
         end
       end
 
       def map(&block)
-        node_map do |node, new_q|
+        node_map do |node, new_q, route|
           orig_key = node.parent_key
           existing = new_q.find(node.route)
           orig_fragment = existing.nil? ? node.fragment : existing
-          block.call(orig_key, orig_fragment)
+          block.call(orig_key, orig_fragment, route)
         end
       end
 
       def each(&block)
-        enumerate { |node| block.call(node.parent_key, node.fragment) }
+        enumerate { |node, route| block.call(node.parent_key, node.fragment, route) }
       end
 
       private
 
       def node_map(&block)
         new_q = self.class.new(base.class.new)
-        enumerate do |node|
-          key, val = block.call(node, new_q)
+        enumerate do |node, route|
+          key, val = block.call(node, new_q, route)
           new_q.alter(node.route, key: key, value: val)
         end
         new_q
@@ -102,7 +102,7 @@ module Depth
           if current.next?
             current = current.next
           elsif !current.root?
-            yield(current)
+            yield(current, current.humanized_route)
             current = current.parent
           end
         end while !current.root? || current.next?

data/lib/depth/enumeration/node.rb

@@ -15,6 +15,10 @@ module Depth
         route.reverse
       end
 
+      def humanized_route
+        route.map(&:key_or_index)
+      end
+
       def next
         if array?
           val = fragment[current_index]

data/lib/depth/traverser.rb

@@ -9,12 +9,12 @@ module Depth
     end
 
     def next(key_or_index)
-      return Traverser.new(nil) if object.nil? 
+      return Traverser.new(nil) if object.nil?
       Traverser.new(object[key_or_index])
     end
 
     def next_or_create(key_or_index, &block)
-      return Traverser.new(nil) if object.nil? 
+      return Traverser.new(nil) if object.nil?
       object[key_or_index] = block.call if object[key_or_index].nil?
       Traverser.new(object[key_or_index])
     end

data/lib/depth/version.rb

@@ -1,3 +1,3 @@
 module Depth
-  VERSION = '0.1.0'
+  VERSION = '0.3.0'
 end

data/spec/depth/actions_spec.rb

@@ -102,6 +102,31 @@ module Depth
     end
 
     describe '#find' do
+      context 'with create true' do
+        it 'should create the route if it needs to' do
+          route = [['$yo', :array], 0, '$thing']
+          expect {
+            subject.find(route, create: true)
+          }.to change { subject.base['$yo'] }.to( [{}] )
+        end
+
+        context 'with a default value' do
+          it 'should create the route and value it needs to' do
+            route = [['$yo', :array], 0, '$thing']
+            expect {
+              subject.find(route, create: true, default: 4)
+            }.to change { subject.base['$yo'] }.to( [{'$thing' => 4}] )
+          end
+        end
+      end
+
+      context 'with a default value and a missing route' do
+        it 'should return the default' do
+          route = ['$yo', 0, '$thing']
+          expect(subject.find(route, default: 'blah')).to eq 'blah'
+        end
+      end
+
       it 'should let me find an existing value' do
         route = [['$and', :array], [0, :hash],
                  ['#weather', :hash], ['something', :array]]

data/spec/depth/enumerable_spec.rb

@@ -157,7 +157,7 @@ module Depth::Enumeration
 
       context 'with alteration' do
         let(:result) do
-          subject.map do |k, v|
+          subject.map do |k, v, r|
             next [k, v] unless k.is_a?(String)
             ["#{k}Altered", 'redacted']
           end
@@ -218,6 +218,22 @@ module Depth::Enumeration
     end
 
     describe '#each' do
+      it 'should keep track of where we are' do
+        routes = []
+        subject.each do |_, _, route|
+          routes << route
+        end
+
+        expected = [
+          ["$and", 0, "#weather", "something"], ["$and", 0, "#weather"],
+          ["$and", 0], ["$and", 1, "$or", 0, "#otherfeed", "thing"],
+          ["$and", 1, "$or", 0, "#otherfeed"], ["$and", 1, "$or", 0],
+          ["$and", 1, "$or"], ["$and", 1], ["$and"]
+        ]
+
+        expect(routes).to eq(expected)
+      end
+
       it 'should sort through all keys and values' do
         enumerated = []
         subject.each do |key, fragment|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: depth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Max
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-07 00:00:00.000000000 Z
+date: 2016-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler