key_tree 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47919143e113a4448b85cf800098227c6e47a5bcb92501e7d612722e7c06898f
-  data.tar.gz: 2b44f183949638a0a379297c0cb8ea6c50d0aa756c7e5a17e52324c9d3d96957
+  metadata.gz: 62d952100ee8c4be7d81a400178f58455618e239253b9cc1b40ab5667c95ab6b
+  data.tar.gz: 8c761dc94c958fd3be1b50b6536576cf4b9a808979c9bf01c877b1e23221bab3
 SHA512:
-  metadata.gz: 2122707f4be42067a53db54c4fa98a13ecc55ff64fddc91c8ec3d40dbd5fddef9c1e3f01028ee3e662ce8e47d7f10bb4a3bc6d2ffbd156291e9223dedb4e283b
-  data.tar.gz: a1c2bc1e22162a646d2a88444e70017f093cde440fce3b9eeeefeba65d662c7e2d65ea3bad6f5c7d9f12cb3191a37e7fd4d4a380a1971e1aefa2ff4b2ed73c0b
+  metadata.gz: 92e7da5bd0166fadaabb78713728975147dde76c81237e2d2e0b56ecd0a3c05744beacce87dad796b17b57ec55ccd83e1d53e1a4179a10e612e7917736301ce7
+  data.tar.gz: 740929794520b7085bc6b57bc75e559e165e4fc1ea1235db1da0743275bad34e336952a9d776bee7df7679bf4f3c39c517e175a070a395f53bea9ea9f4b90ac7

data/.rubocop.yml

@@ -5,3 +5,8 @@ Metrics/BlockLength:
 Style/BlockDelimiters:
   Exclude:
     - 'spec/*_spec.rb'
+
+# Rubocop 0.56 causes false positives
+# https://github.com/bbatsov/rubocop/issues/5887
+Lint/SplatKeywordArguments:
+  Enabled: false

data/RELEASE_NOTES.md

@@ -1,5 +1,40 @@
 # Release Notes
 
+## v0.5.1 – 2018-05-19
+
+### New methods
+
+  * `KeyTree::Tree#default_key?(key)`
+  * `KeyTree::Tree#format(fmtstr)`
+  * `KeyTree::Tree#to_h(string_keys: false)`
+  * `KeyTree::Tree#to_json`
+  * `KeyTree::Tree#to_yaml`
+
+### Bug fixes
+
+#### Make forests aware of default values in trees
+
+Ensure that forests pick up default values from a tree.
+
+  * ebd1cb06 Return trees and forests untouched
+  * 3451a430 Propagate default_proc in fetch
+  * e121a4c4 Consider trees to have a key if #default_key?
+  * 50bc56ec Detect if a default_proc yields a key value
+
+### New features
+
+#### Key tree content exporters
+
+Support for exporting the contents of a key tree to Hash, JSON, and YAML.
+Also includes a convenience string formatter, that fills format strings
+with values from a `Tree`.
+
+  * 9b5f05f0 Make exported hash key format selectable
+  * e3434d7e Add custom format method
+  * fa6a9b16 Serialize the contents of a tree to json or yaml
+  * 3fc6466b Convert a tree back into nested hashes
+  * e5aecd8b Split symbols into key paths
+
 ## v0.5.0 – 2018-04-17
 
 ### Changed methods

data/lib/key_tree/forest.rb

@@ -37,12 +37,16 @@ module KeyTree
     end
 
     def tree_with_key(key)
-      result = trees.detect { |tree| tree.prefix?(key) }
+      result = trees.detect do |tree|
+        tree.prefix?(key) || tree.default_key?(key)
+      end
       result || raise(KeyError, "key not found: #{key}")
     end
 
     def trees_with_key(key)
-      result = trees.select { |tree| tree.prefix?(key) }
+      result = trees.select do |tree|
+        tree.prefix?(key) || tree.default_key?(key)
+      end
       raise(KeyError, "key not found: #{key}") if result.empty?
       result
     end

data/lib/key_tree/path.rb

@@ -29,7 +29,7 @@ module KeyTree
       when String
         initialize(key_or_path.split('.'))
       when Symbol
-        append(key_or_path)
+        initialize(key_or_path.to_s)
       when Array
         key_or_path.each { |key| append(key.to_sym) }
       else

data/lib/key_tree/tree.rb

@@ -1,5 +1,6 @@
 require 'key_tree/path'
 require 'key_tree/meta_data'
+
 module KeyTree
   # A tree of key-value lookup tables (hashes)
   class Tree < Hash
@@ -21,8 +22,9 @@ module KeyTree
       super(Path[key_or_path])
     end
 
-    def fetch(key_or_path, *args, &proc)
-      super(Path[key_or_path], *args, &proc)
+    def fetch(key_or_path, *args, &missing_key)
+      missing_key ||= default_proc
+      super(Path[key_or_path], *args, &missing_key)
     end
 
     def values_at(*keys)
@@ -46,6 +48,14 @@ module KeyTree
       super(Path[key_or_path])
     end
 
+    def default_key?(key_or_path)
+      return unless default_proc
+      default_proc.yield(self, Path[key_or_path])
+      true
+    rescue KeyError
+      false
+    end
+
     def prefix?(key_or_path)
       keys.any? { |key| key.prefix?(Path[key_or_path]) }
     end
@@ -68,5 +78,42 @@ module KeyTree
       dup.merge!(other, &merger)
     end
     alias + merge
+
+    # Format +fmtstr+ with values from the Tree
+    def format(fmtstr)
+      Kernel.format(fmtstr, Hash.new { |_, key| fetch(key) })
+    end
+
+    # Convert a Tree back to nested hashes.
+    #
+    # to_h => Hash, with symbol keys
+    # to_h(string_keys: true) => Hash, with string keys
+    def to_h(**kwargs)
+      to_hash_tree(**kwargs)
+    end
+
+    # Convert a Tree to JSON, with string keys
+    def to_json
+      to_hash_tree(string_keys: true).to_json
+    end
+
+    # Convert a Tree to YAML, with string keys
+    def to_yaml
+      to_hash_tree(string_keys: true).to_yaml
+    end
+
+    private
+
+    def to_hash_tree(key_pairs = self, string_keys: false)
+      hash = key_pairs.group_by do |path, _|
+        string_keys ? path.first.to_s : path.first
+      end
+      hash.transform_values do |next_level|
+        next_level.map! { |path, value| [path[1..-1], value] }
+        first_key, first_value = next_level.first
+        next first_value if first_key.nil? || first_key.empty?
+        to_hash_tree(next_level)
+      end
+    end
   end
 end

data/lib/key_tree.rb

@@ -15,10 +15,12 @@ require 'key_tree/loader'
 module KeyTree
   def self.[](contents = {})
     case contents
+    when Tree, Forest
+      contents
     when Hash
-      KeyTree::Tree[contents]
+      Tree[contents]
     when Array
-      KeyTree::Forest[*contents]
+      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.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-17 00:00:00.000000000 Z
+date: 2018-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git-version-bump