key_tree 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3adbed28729cba5c2b3878930ca08c02d9f0fb187ed678d198c0d590bb9f20b7
-  data.tar.gz: 3ecaaa1c9e9df660af725ba6ed901337e886486b862fbd42ba9195db102422df
+  metadata.gz: 1785b5cb1b1cd95bcce54e395760a8fba2c3f18a1fe90ec6142a84371dcecebb
+  data.tar.gz: b2fce6710288a95c80db648556abe8e4b6a35289d743afd451e2b266bf2b3b2f
 SHA512:
-  metadata.gz: cce5c2541a1195967488358d71d2e666a3a0b4a968bf85430a1d26bbf401e2cc3b9d58f62e95ec74886980558304affafc221fecfc6a907c3410d6e2f09f1a5f
-  data.tar.gz: e32567fbee972c5f12547c9445ab1be6a78fe4e2245053f70d938bececd1a7143a897b34cd6533c7f3e41b2d82aa3c8e356cc49a67aae33e6c735925047b747e
+  metadata.gz: 5e6d082279a58dfb080872a193ffa2eaee310b97f64f34120edbe7814935feaebd9fdd73aa4e8071acedaadef4036a66e204b7194c1e1bd9429915b60ef2094e
+  data.tar.gz: bc50e45870118d9ad5c21a0bf2f19dc89f53ec54aba5eb1af7917f87cdf5476eaf6509643c4bb1189d7a8dba02d9ce17a153229cb83ad4bc95065f6cde4d8899

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 /vendor
+Gemfile.lock

data/lib/key_tree/forest.rb

@@ -0,0 +1,89 @@
+require 'key_tree/tree'
+
+module KeyTree
+  #
+  # A forest is a (possibly nested) collection of trees
+  #
+  class Forest < Array
+    def self.[](*contents)
+      contents.reduce(Forest.new) do |result, content|
+        result << KeyTree[content]
+      end.sort!
+    end
+
+    # For a numeric key, return the n:th tree in the forest
+    #
+    # For a key path convertable key, return the closest match in the forest
+    #
+    # When a closer tree contains a prefix of the key, this shadows any
+    # key path matches in trees further away, returning nil. This preserves
+    # the constraints that only leaves may contain a value.
+    #
+    def [](key)
+      case key
+      when Numeric
+        super(key)
+      else
+        each do |tree_or_forest|
+          return tree_or_forest[key] if tree_or_forest.key?(key)
+          return nil if tree_or_forest.prefix?(key)
+        end
+      end
+    end
+
+    # Trees are always smaller than forrests.
+    # Forests are compared by nesting depth, not number of trees.
+    #
+    def <=>(other)
+      return 0 if self == other
+
+      case other
+      when Forest
+        depth <=> other.depth
+      when Tree
+        1
+      else
+        raise ArgumentError, 'only forests and trees are comparable'
+      end
+    end
+
+    # The nesting depth of a forest
+    def depth
+      reduce(1) do |result, tree_or_forest|
+        [result, content_depth(tree_or_forest) + 1].max
+      end
+    end
+
+    def key?(key)
+      any? { |tree_or_forest| tree_or_forest.key?(key) }
+    end
+
+    def prefix?(key)
+      any? { |tree_or_forest| tree_or_forest.prefix?(key) }
+    end
+
+    # Flattening a forest produces a tree with the equivalent view of key paths
+    #
+    def flatten
+      reduce(Tree[]) do |result, tree_or_forest|
+        case tree_or_forest
+        when Forest
+          tree_or_forest.flatten.merge(result)
+        else
+          tree_or_forest.merge(result)
+        end
+      end
+    end
+
+    private
+
+    def content_depth(content)
+      case content
+      when Forest
+        content.depth
+      else
+        0
+      end
+    end
+  end
+end

data/lib/key_tree/tree.rb

@@ -20,8 +20,8 @@ module KeyTree
       super(Path[key_or_path])
     end
 
-    def fetch(key_or_path, *args, **kvargs, &proc)
-      super(Path[key_or_path], *args, **kvargs, &proc)
+    def fetch(key_or_path, *args, &proc)
+      super(Path[key_or_path], *args, &proc)
     end
 
     def values_at(*keys)
@@ -31,7 +31,7 @@ module KeyTree
     def []=(key_or_path, new_value)
       path = Path[key_or_path]
 
-      each_key { |key| delete(key) if path.conflict?(key) }
+      delete_if { |key, _| path.conflict?(key) }
 
       case new_value
       when Hash
@@ -40,5 +40,38 @@ module KeyTree
         super(path, new_value)
       end
     end
+
+    def key?(key_or_path)
+      super(Path[key_or_path])
+    end
+
+    def prefix?(key_or_path)
+      keys.any? { |key| key.prefix?(Path[key_or_path]) }
+    end
+
+    def conflict?(key_or_path)
+      keys.any? { |key| key.conflict?(Path[key_or_path]) }
+    end
+
+    # All trees are created equal. Forests are always larger than trees.
+    #
+    def <=>(other)
+      case other
+      when Forest
+        -1
+      when Tree
+        0
+      else
+        raise ArgumentError, 'only trees and forests are comparable'
+      end
+    end
+
+    # The merging of trees needs some extra consideration; due to the
+    # nature of key paths, prefix conflicts must be deleted
+    #
+    def merge(other)
+      delete_if { |key, _| other.conflict?(key) }
+      super
+    end
   end
 end

data/lib/key_tree/version.rb

@@ -1,3 +1,3 @@
 module KeyTree
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/lib/key_tree.rb

@@ -1,5 +1,6 @@
 require 'key_tree/version'
 require 'key_tree/tree'
+require 'key_tree/forest'
 
 # Manage a tree of keys
 #
@@ -15,6 +16,8 @@ module KeyTree
     case contents
     when Hash
       KeyTree::Tree[contents]
+    when Array
+      KeyTree::Forest[*contents]
     else
       raise ArgumentError, "can't load #{contents.class} into a KeyTree"
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: key_tree
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -79,7 +79,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -87,6 +86,7 @@ files:
 - bin/setup
 - key_tree.gemspec
 - lib/key_tree.rb
+- lib/key_tree/forest.rb
 - lib/key_tree/path.rb
 - lib/key_tree/tree.rb
 - lib/key_tree/version.rb

data/Gemfile.lock

@@ -1,51 +0,0 @@
-PATH
-  remote: .
-  specs:
-    key_tree (0.1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.3.0)
-    diff-lcs (1.3)
-    parallel (1.12.1)
-    parser (2.4.0.2)
-      ast (~> 2.3)
-    powerpack (0.1.1)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rubocop (0.52.1)
-      parallel (~> 1.10)
-      parser (>= 2.4.0.2, < 3.0)
-      powerpack (~> 0.1)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-progressbar (1.9.0)
-    unicode-display_width (1.3.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  key_tree!
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  rubocop (~> 0.52)
-
-BUNDLED WITH
-   1.16.0