forester 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b068adf6d25cfadca224f86d1b64a7668fadf5d
-  data.tar.gz: 9d4494437e8bc4387b4254217e178a41890c2a3c
+  metadata.gz: 268ad2f30fdb06a9fbc2fe57e2f044a1a234639a
+  data.tar.gz: 008ea947763719e1d4c1ea5101a8d889979907f9
 SHA512:
-  metadata.gz: a0e0684ef70d37ddfd9e4751ecaad5a8fe3fcd03d06a33f0f05158882295e31192a09a9478b1dfdf0323f91934827a68c4b78c5dc3ad2624c6ad6e429b248c9a
-  data.tar.gz: b5619bcb98e2ca43789f8422cd33c38747997fc695c7dad7bdee14676d728f4cbaa152ea3b4b4b207c2ad53197a1a65e545e857d2febbb42e5e988a581165735
+  metadata.gz: 1fa2bd80e48031e9ccc8e269e20a3b60266252f4f857c046cfa2e53bbf7599eb6f5270b5c6724f628d8cecbe66f8d198f0c96f4e2dc660999c456326b2d6d047
+  data.tar.gz: ed777a43b80efdf961a89e7dd03010b432096e9236b6f48cf64a25b12cb96941f9eef1bfecec60664008630ecc40a7cd3098d8689956c5999d9c67471adfc618

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake/testtask'
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
+  t.pattern = "test/**/test_*.rb"
 end
 
 desc "Run tests"

data/lib/forester.rb

@@ -3,6 +3,8 @@ require 'securerandom'
 require 'yaml'
 
 require 'forester/aggregators'
+require 'forester/mutators'
+require 'forester/views'
 require 'forester/tree_node'
 require 'forester/tree_factory'
 require 'forester/node_content'

data/lib/forester/aggregators.rb

@@ -3,7 +3,7 @@ module Forester
 
     def own_and_descendants(options = {})
       default_options = {
-        field: 'name',
+        field: :name,
         if_field_missing: -> (c) { [] },
       }
 

data/lib/forester/mutators.rb

@@ -0,0 +1,14 @@
+module Forester
+  module Mutators
+
+    def add_field!(name, definition)
+      value = if definition.respond_to? :call then definition.call(self) else definition end
+      content.set!(name, value)
+    end
+
+    def add_field_to_subtree!(name, definition)
+      each_node { |node| node.add_field!(name, definition) }
+    end
+
+  end
+end

data/lib/forester/node_content.rb

@@ -5,6 +5,20 @@ module Forester
       @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.fetch(name)

data/lib/forester/node_content_factory.rb

@@ -10,7 +10,7 @@ module Forester
       private
 
       def without_key(hash, key)
-        hash.reject { |k, _| k == key }
+        hash.reject { |k, _| k.to_s == key.to_s }
       end
 
     end

data/lib/forester/tree_node.rb

@@ -2,6 +2,8 @@ module Forester
   class TreeNode < Tree::TreeNode
 
     include Aggregators
+    include Mutators
+    include Views
 
     def ancestry(include_root = true, include_self = false, descending = true)
       ancestors = self.parentage           || []
@@ -14,9 +16,7 @@ module Forester
       if l.between?(0, max_level) then each_level.take(l + 1).last else [] end
     end
 
-    def max_level
-      node_height
-    end
+    alias_method :max_level, :node_height
 
     def each_level
       Enumerator.new do |yielder|
@@ -32,16 +32,18 @@ module Forester
       each_node.select { |node| Array(node.get(content_key) { :no_match }).include? content_value }
     end
 
+    alias_method :each_node, :breadth_each
+
     def get(field, &block)
       content.public_send(field, &block)
     end
 
-    def contents
-      each_node.map(&:content)
+    def field_names
+      content.field_names
     end
 
-    def each_node
-      breadth_each
+    def contents
+      each_node.map(&:content)
     end
 
   end

data/lib/forester/version.rb

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

data/lib/forester/views.rb

@@ -0,0 +1,22 @@
+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

data/test/test_mutators.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'forester'
+
+class TestMutators < Minitest::Test
+
+  def test_mutators
+
+    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_five, 5)
+
+    assert_equal 5, tree.get(:number_five)
+
+    number_one = 1
+
+    tree.add_field_to_subtree!(:number_six, -> (node) { node.get(:number_five) + number_one })
+
+    assert_equal 6, tree.get(:number_six)
+
+  end
+
+end

data/test/test_treenode.rb

@@ -1,7 +1,7 @@
 require 'minitest/autorun'
 require 'forester'
 
-class TreeNodeTest < Minitest::Test
+class TestTreeNode < Minitest::Test
 
   def test_tree_node
 

data/test/test_views.rb

@@ -0,0 +1,25 @@
+require 'minitest/autorun'
+require 'forester'
+
+class TestViews < Minitest::Test
+
+  def test_views
+
+    path_to_trees = "#{File.dirname(__FILE__)}/trees"
+    tree = Forester::TreeFactory.from_yaml_file("#{path_to_trees}/simple_tree.yml")
+
+    hash = (YAML.load(File.read("#{path_to_trees}/simple_tree.yml")))
+    add_empty_children_keys(hash['root'])
+
+    assert_equal hash['root'], tree.as_nested_hash({ stringify_keys: true })
+
+  end
+
+  private
+
+  def add_empty_children_keys(hash)
+    hash['children'] = hash.fetch('children', [])
+    hash['children'].each { |child| add_empty_children_keys(child) }
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forester
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Eugenio Bruno
@@ -81,12 +81,16 @@ files:
 - 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/tree_factory.rb
 - lib/forester/tree_node.rb
 - lib/forester/version.rb
+- lib/forester/views.rb
+- test/test_mutators.rb
 - test/test_treenode.rb
+- test/test_views.rb
 - test/trees/simple_tree.yml
 homepage: http://rubygems.org/gems/forester
 licenses:
@@ -113,5 +117,7 @@ signing_key:
 specification_version: 4
 summary: A gem to represent and interact with tree data structures
 test_files:
+- test/test_mutators.rb
 - test/test_treenode.rb
+- test/test_views.rb
 - test/trees/simple_tree.yml