key_tree 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1785b5cb1b1cd95bcce54e395760a8fba2c3f18a1fe90ec6142a84371dcecebb
-  data.tar.gz: b2fce6710288a95c80db648556abe8e4b6a35289d743afd451e2b266bf2b3b2f
+  metadata.gz: 03da4a8ba0ff290b08339278a05b0c1eed7233f283c708701f180d7572029319
+  data.tar.gz: df4922248186d247f8da08cd0aefb4d90ef1c07f159be6554caf674c8960a186
 SHA512:
-  metadata.gz: 5e6d082279a58dfb080872a193ffa2eaee310b97f64f34120edbe7814935feaebd9fdd73aa4e8071acedaadef4036a66e204b7194c1e1bd9429915b60ef2094e
-  data.tar.gz: bc50e45870118d9ad5c21a0bf2f19dc89f53ec54aba5eb1af7917f87cdf5476eaf6509643c4bb1189d7a8dba02d9ce17a153229cb83ad4bc95065f6cde4d8899
+  metadata.gz: d24cb6c9b64f15af352d6dcad4042ff89dd02487a76dc80a0695b00bcba4c76a7347dd82a81c57dfbcdabe545fc0d0e75aca1d15e6ba277fdf4f1ee626f4f63b
+  data.tar.gz: a570369076d6594d2996d1e1e27a56a8d8c683b7fd3577afc1c4b9d48d162cd43dac9043ed86e61f133cd9441a9d2709f7ec5d14287a016d263b3b5d720a29a1

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/key_tree.svg)](https://badge.fury.io/rb/key_tree)
+
 # KeyTree
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/key_tree`. To experiment with that code, run `bin/console` for an interactive prompt.

data/lib/key_tree/forest.rb

@@ -1,10 +1,13 @@
 require 'key_tree/tree'
+require 'key_tree/meta_data'
 
 module KeyTree
   #
   # A forest is a (possibly nested) collection of trees
   #
   class Forest < Array
+    include MetaData
+
     def self.[](*contents)
       contents.reduce(Forest.new) do |result, content|
         result << KeyTree[content]

data/lib/key_tree/meta_data.rb

@@ -0,0 +1,22 @@
+require 'key_tree/tree'
+
+module KeyTree
+  #
+  # Mixin for adding a meta_data key tree
+  #
+  module MetaData
+    #
+    # Get the meta_data for an object
+    #
+    def meta_data
+      @meta_data ||= KeyTree::Tree.new
+    end
+
+    # Execute a block with meta data, returning self
+    #
+    def with_meta_data
+      yield(meta_data)
+      self
+    end
+  end
+end

data/lib/key_tree/tree.rb

@@ -1,8 +1,9 @@
 require 'key_tree/path'
-
+require 'key_tree/meta_data'
 module KeyTree
   # A tree of key-value lookup tables (hashes)
   class Tree < Hash
+    include MetaData
     #
     # KeyTree::Tree.new(+hash+)
     #
@@ -69,9 +70,16 @@ module KeyTree
     # The merging of trees needs some extra consideration; due to the
     # nature of key paths, prefix conflicts must be deleted
     #
-    def merge(other)
+    def merge!(other)
+      other = Tree[other] unless other.is_a?(Tree)
       delete_if { |key, _| other.conflict?(key) }
       super
     end
+    alias << merge!
+
+    def merge(other)
+      dup.merge!(other)
+    end
+    alias + merge
   end
 end

data/lib/key_tree/version.rb

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

data/lib/key_tree.rb

@@ -22,4 +22,62 @@ module KeyTree
       raise ArgumentError, "can't load #{contents.class} into a KeyTree"
     end
   end
+
+  # Load a KeyTree from some external serialization
+  #
+  # load +type+: +serialization+
+  #
+  # +type+ is upcased to form a class name that should provide a
+  # +.load+ class method (like YAML or JSON does).
+  #
+  # Example:
+  #   load(yaml: "---\na: 1\n")
+  # => {"a" => 1}
+  #
+  def self.load(typed_serialization = {})
+    unless typed_serialization.size == 1
+      raise ArgumentError, "pick one: #{typed_serialization.keys}"
+    end
+
+    type, serialization = typed_serialization.flatten
+
+    loader = get_loader(type)
+    self[loader.load(serialization)].with_meta_data do |meta_data|
+      meta_data << { load: { type: type.to_sym,
+                             loader: loader } }
+    end
+  end
+
+  # Open an external file and load contents into a KeyTree
+  #
+  def self.open(file_name)
+    type = File.extname(file_name)[/[^.]+/]
+    keytree = File.open(file_name, mode: 'rb:utf-8') do |file|
+      load_from_file(file, type)
+    end
+
+    return keytree unless block_given?
+    yield(keytree)
+  end
+
+  private_class_method
+
+  # Get a class for loading external serialization for +type+
+  # +require+s the class provider if necessary.
+  #
+  def self.get_loader(type)
+    Class.const_get(type.upcase)
+  rescue NameError
+    require type.to_s
+    retry
+  end
+
+  def self.load_from_file(file, type)
+    load(type => file.read).with_meta_data do |meta_data|
+      file_path = file.path
+      meta_data << { file: { path: file_path,
+                             name: File.basename(file_path),
+                             dir: File.dirname(file_path) } }
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: key_tree
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Calle Englund
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-27 00:00:00.000000000 Z
+date: 2018-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,6 +87,7 @@ files:
 - key_tree.gemspec
 - lib/key_tree.rb
 - lib/key_tree/forest.rb
+- lib/key_tree/meta_data.rb
 - lib/key_tree/path.rb
 - lib/key_tree/tree.rb
 - lib/key_tree/version.rb