forester 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1450e6fa82ffadb91424237f6c9527bc0e9bd9d2
-  data.tar.gz: ec8325c5dc3bde7784651b4d5039edcb7f694631
+  metadata.gz: 8a6a1cffe04ece8277a5828f27c9f36f1ea2ba31
+  data.tar.gz: bdafe433a52570d2e30535698febf2a50ebf8b47
 SHA512:
-  metadata.gz: 3ca55344989f3b2de019c3dfc5d3cc648c745cb1d8810fc0af44c5a8723b3ad951615a6e959385271bb8d6ced06e1c43182b4efe8e9776038be2cfa39201681c
-  data.tar.gz: 523d4c868e6d329854a29758d29ab9ffdf8dad56daafdcd341ed9cdd5cae91921c12b1d9961e8eaec6b4f39acb418b894f4c94fc644d88ca9e8f90b05cace538
+  metadata.gz: 3a0ef594c8f942bf12044e5d232f7d7bf07c2be20d914378dc5b32727b8c6220d382eb71b49f71eca090aafd506d83db448523bb0fa4a7e90cbc0c4fba78c931
+  data.tar.gz: d7ad4fe1a9257eceaa20f6e66b13446535909a8eb68356b8240755c3ba3bd9711a1bd0e7e35dd673e47ff9bf1ea5bd656ba09edcfff0ce1e2d445f4c4308c07c

data/README.md

@@ -1,6 +1,6 @@
 # Forester
 
-Based on *rubytree* and *enzymator*, this gem lets you build trees and run queries against them.
+Based on *rubytree*, this gem lets you build trees and run queries against them.
 
 ## FAQ
 
@@ -18,7 +18,7 @@ Because I didn't feel the need to copy the whole codebase. All I needed was to e
 
 - What can I do with forester?
 
-Everything you can do with rubytree, possibly in a more intention-revealing way, plus arbitrary, configurable aggregations on trees. Simple examples can be found in the tests.
+Everything you can do with rubytree, possibly in a more intention-revealing way, plus some configurable aggregations on trees. Simple examples can be found in the tests.
 
 ## Installation
 

data/forester.gemspec

@@ -6,7 +6,7 @@ require 'forester/version'
 Gem::Specification.new do |s|
   s.name        = 'forester'
   s.version     = Forester::Version
-  s.date        = '2016-07-27'
+  s.date        = '2016-08-20'
   s.summary     = "A gem to represent and interact with tree data structures"
   s.description = "Based on rubytree, this gem lets you build trees and run queries against them."
   s.authors     = ["Eugenio Bruno"]

data/lib/forester/node_content/base.rb

@@ -0,0 +1,9 @@
+module Forester
+  module NodeContent
+    class Base < SimpleDelegator
+
+
+
+    end
+  end
+end

data/lib/forester/node_content/dictionary.rb

@@ -0,0 +1,102 @@
+module Forester
+  module NodeContent
+    class Dictionary < Base
+
+      def fields
+        keys
+      end
+
+      def has_key?(key, indifferent = true)
+        if indifferent
+          equivs(key).any? { |k| super(k) }
+        else
+          super(key)
+        end
+      end
+      alias_method :has?, :has_key?
+
+      def [](key)
+        super(best key)
+      end
+
+      def fetch(key, default = :yield_to_block, &block)
+        best_key = best key
+        if default == :yield_to_block
+          super(best_key, &block)
+        else
+          super(best_key, default, &block)
+        end
+      end
+      alias_method :get, :fetch
+
+      def []=(key, value, options = {})
+        default_options = {
+          symbolize_key: true
+        }
+        options = default_options.merge(options)
+
+        super(symbolize_if(options[:symbolize_key]).call(key), value)
+      end
+      alias_method :put!, :[]=
+
+      def delete(key, default = :yield_to_block, &block)
+        best_key = best key
+        if default == :yield_to_block
+          super(best_key, &block)
+        else
+          super(best_key, default, &block)
+        end
+      end
+      alias_method :del!, :delete
+
+      def to_hash(options = {})
+        default_options = {
+          fields_to_include: fields, # all of them
+          stringify_keys:    false,
+          symbolize_keys:    false
+        }
+        options = default_options.merge(options)
+
+        convert_key = stringify_if options[:stringify_keys]
+        convert_key = symbolize_if options[:symbolize_keys]
+
+        each_with_object({}) do |(k, v), hash|
+          if equivs(k).any? { |eq| options[:fields_to_include].include?(eq) }
+            hash[convert_key.call(k)] = v
+          end
+        end
+      end
+
+      def merge(dictionary)
+        self.class.new(super)
+      end
+
+      protected
+
+      def equivs(key)
+        [key, key.to_s, key.to_s.to_sym].uniq
+      end
+
+      def best(key)
+        equivs(key).find { |k| has_key?(k, false) } || key
+      end
+
+      def stringify_if(bool)
+        if bool
+          ->(k) { k.to_s }
+        else
+          ->(k) { k }
+        end
+      end
+
+      def symbolize_if(bool)
+        if bool
+          ->(k) { k.to_sym }
+        else
+          ->(k) { k }
+        end
+      end
+
+    end
+  end
+end

data/lib/forester/node_content/factory.rb

@@ -0,0 +1,27 @@
+module Forester
+  module NodeContent
+    class Factory
+
+      class << self
+
+        def from_hash(hash, children_key, indifferent = true)
+          ret = without_key(hash, children_key)
+          ret = Dictionary.new(ret) if indifferent
+          ret
+        end
+
+        def from_array(array)
+          List.new(array)
+        end
+
+        private
+
+        def without_key(hash, key)
+          hash.reject { |k, _| k.to_s == key.to_s }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/forester/node_content/list.rb

@@ -0,0 +1,31 @@
+module Forester
+  module NodeContent
+    class List < Base
+
+      def include?(*args)
+        super
+      end
+      alias_method :has?, :include?
+
+      def fetch(*args)
+        super
+      end
+      alias_method :get, :fetch
+
+      def push(*args)
+        super
+      end
+      alias_method :add!, :push
+
+      def delete(*args)
+        super
+      end
+      alias_method :del!, :delete
+
+      def to_array
+        Array.new(self)
+      end
+
+    end
+  end
+end

data/lib/forester/tree_factory.rb

@@ -21,19 +21,19 @@ module Forester
 
       def from_hash(hash, children_key, uid = SecureRandom.uuid)
         name = uid
-        content = NodeContentFactory.from_hash(hash, children_key)
+        content = NodeContent::Factory.from_hash(hash, children_key)
         TreeNode.new(name, content)
       end
 
       private
 
       def fetch_indifferently(hash, key, default = nil)
-        [key.to_sym, key.to_s].map { |k| hash[k] }.compact.first || default || hash.fetch(root_key)
+        [key, key.to_s, key.to_s.to_sym].uniq.map { |k| hash[k] }.compact.first || default || hash.fetch(root_key)
       end
 
       def with_children(tree_node, children, children_key)
         children.each do |child|
-          child_node = TreeFactory.from_hash(child, children_key)
+          child_node     = from_hash(child, children_key)
           child_children = fetch_indifferently(child, children_key, []) # nth level
 
           tree_node << with_children(child_node, child_children, children_key)

data/lib/forester/tree_node.rb

@@ -1,6 +1,9 @@
 module Forester
   class TreeNode < Tree::TreeNode
 
+    extend Forwardable
+    def_delegators :@content, :fields, :has?, :put!, :add!, :del!
+
     include Aggregators
     include Mutators
     include Views
@@ -23,12 +26,20 @@ module Forester
 
     alias_method :each_node, :breadth_each
 
-    def get(field, &block)
-      content.public_send(field, { yield_to: self }, &block)
+    def get(field, default = :raise_error, &block)
+      if has?(field)
+        content.get(field)
+      elsif block_given?
+        yield self
+      elsif default != :raise_error
+        default
+      else
+        raise ArgumentError.new("the node \"#{name}\" does not have \"#{field}\"")
+      end
     end
 
-    def field_names
-      content.field_names
+    def name
+      content.get(:name, super)
     end
 
     def contents

data/lib/forester/{mutators.rb → tree_node_ext/mutators.rb}

@@ -3,7 +3,7 @@ module Forester
 
     def add_field!(name, definition)
       value = if definition.respond_to? :call then definition.call(self) else definition end
-      content.set!(name, value)
+      put!(name, value)
     end
 
     def add_field_to_subtree!(name, definition)

data/lib/forester/tree_node_ext/views.rb

@@ -0,0 +1,25 @@
+module Forester
+  module Views
+
+    def as_nested_hash(options = {})
+      default_options = {
+        fields_to_include: fields, # all of them
+        stringify_keys:    false,
+        symbolize_keys:    false
+      }
+      options = default_options.merge(options)
+
+      hash = content.to_hash(options)
+
+      children_key = :children
+      children_key = children_key.to_s if options[:stringify_keys]
+
+      hash.merge(
+        {
+          children_key => children.map { |node| node.as_nested_hash(options) }
+        }
+      )
+    end
+
+  end
+end

data/lib/forester/version.rb

@@ -1,7 +1,7 @@
 module Forester
   class Version
     MAJOR = 3
-    MINOR = 0
+    MINOR = 1
     PATCH = 0
     PRE = nil
 

data/lib/forester.rb

@@ -1,12 +1,16 @@
 require 'tree'
+require 'forwardable'
 require 'securerandom'
 require 'yaml'
 
-require 'forester/aggregators'
-require 'forester/mutators'
-require 'forester/views'
+require 'forester/tree_node_ext/aggregators'
+require 'forester/tree_node_ext/mutators'
+require 'forester/tree_node_ext/views'
+
+require 'forester/node_content/base'
+require 'forester/node_content/dictionary'
+require 'forester/node_content/list'
+require 'forester/node_content/factory'
+
 require 'forester/tree_node'
 require 'forester/tree_factory'
-require 'forester/node_content'
-require 'forester/node_content_factory'
-require 'forester/hash_with_indifferent_access'

data/test/test_mutators.rb

@@ -8,9 +8,15 @@ class TestMutators < Minitest::Test
     path_to_trees = "#{File.dirname(__FILE__)}/trees"
     tree = Forester::TreeFactory.from_yaml_file("#{path_to_trees}/simple_tree.yml")
 
+    tree.add_field_to_subtree!('number_four', 4)
+
+    assert_equal 4, tree.get(:number_four)
+    assert_equal 4, tree.get('number_four')
+
     tree.add_field_to_subtree!(:number_five, 5)
 
     assert_equal 5, tree.get(:number_five)
+    assert_equal 5, tree.get('number_five')
 
     number_one = 1
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forester
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Eugenio Bruno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-27 00:00:00.000000000 Z
+date: 2016-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubytree
@@ -79,15 +79,16 @@ files:
 - Rakefile
 - forester.gemspec
 - lib/forester.rb
-- lib/forester/aggregators.rb
-- lib/forester/hash_with_indifferent_access.rb
-- lib/forester/mutators.rb
-- lib/forester/node_content.rb
-- lib/forester/node_content_factory.rb
+- lib/forester/node_content/base.rb
+- lib/forester/node_content/dictionary.rb
+- lib/forester/node_content/factory.rb
+- lib/forester/node_content/list.rb
 - lib/forester/tree_factory.rb
 - lib/forester/tree_node.rb
+- lib/forester/tree_node_ext/aggregators.rb
+- lib/forester/tree_node_ext/mutators.rb
+- lib/forester/tree_node_ext/views.rb
 - lib/forester/version.rb
-- lib/forester/views.rb
 - test/test_mutators.rb
 - test/test_treenode.rb
 - test/test_views.rb

data/lib/forester/hash_with_indifferent_access.rb

@@ -1,28 +0,0 @@
-module Forester
-  class HashWithIndifferentAccess < SimpleDelegator
-
-    def has_key?(key)
-      equivs(key).any? { |k| super(k) }
-    end
-
-    def fetch(key, default = nil, &block)
-      maybe_key = equivs(key).select { |k| __getobj__.has_key?(k) }
-      if maybe_key.empty?
-        super(key)
-      else
-        super(maybe_key.first)
-      end
-    end
-
-    def [](key)
-      equivs(key).map { |k| super(k) }.compact.first || super
-    end
-
-    protected
-
-    def equivs(key)
-      [key.to_sym, key.to_s]
-    end
-
-  end
-end

data/lib/forester/node_content.rb

@@ -1,37 +0,0 @@
-module Forester
-  class NodeContent
-
-    def initialize(hash)
-      @hash = HashWithIndifferentAccess.new(hash)
-    end
-
-    def field_names
-      @hash.keys
-    end
-
-    def to_hash
-      @hash.each_with_object({}) do |(k, v), hash|
-        hash[k.to_sym] = v
-      end
-    end
-
-    def set!(key, value)
-      @hash[key] = value
-    end
-
-    def method_missing(name, *args, &block)
-      if @hash.has_key?(name)
-        @hash[name]
-      elsif block_given?
-        yield args.fetch(0, {yield_to: self})[:yield_to]
-      else
-        raise ArgumentError.new("the node \"#{self.name}\" does not have any \"#{name}\"")
-      end
-    end
-
-    def respond_to_missing?(name, include_private = false)
-      @hash.has_key?(name) || super
-    end
-
-  end
-end

data/lib/forester/node_content_factory.rb

@@ -1,19 +0,0 @@
-module Forester
-  class NodeContentFactory
-
-    class << self
-
-      def from_hash(hash, children_key)
-        NodeContent.new(HashWithIndifferentAccess.new(without_key(hash, children_key)))
-      end
-
-      private
-
-      def without_key(hash, key)
-        hash.reject { |k, _| k.to_s == key.to_s }
-      end
-
-    end
-
-  end
-end

data/lib/forester/views.rb

@@ -1,22 +0,0 @@
-module Forester
-  module Views
-
-    def as_nested_hash(options = {})
-      default_options = {
-        fields_to_include: field_names,
-        stringify_keys: false
-      }
-      options = default_options.merge(options)
-
-      hash = content.to_hash
-      hash.select! { |k, _| options[:fields_to_include].map(&:to_s).include? k.to_s }
-      hash = hash.each_with_object({}) { |(k, v), h| h[k.to_s] = v } if options[:stringify_keys]
-
-      children_key = :children
-      children_key = children_key.to_s if options[:stringify_keys]
-
-      hash.merge({ children_key => children.map { |node| node.as_nested_hash(options) } })
-    end
-
-  end
-end