forester 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 419a779f1ffc62fb2fea36308c2c9b92a0a2474a
-  data.tar.gz: 19572a329a088ccd53d41480c929c2e6ee62ac21
+  metadata.gz: ca08cece8313d3e3c8b20bae94f78163b81853cb
+  data.tar.gz: d6b07a8b064d28e35b302a9999f5c45b8a0bcdb2
 SHA512:
-  metadata.gz: 0fc4a63df68429492ef84ed56d819ba617fa8337f9feb9d77e2d92de78d077b1c47ccda3923d1db333eebe0bedb15379e54f6a9d4901612df5e49aa9d5e7ecd3
-  data.tar.gz: bbbb7a95d5a061d35bdec80ae1679d4eb929106e10ae5549590974e6f9f050344919dc9a0f804c402657fe0255f877dcf3fc3163526608ad154841cb642cf4da
+  metadata.gz: 696d7af03b121cba11c01a3fb75aea488edf4a56a415a266bf3c2971f8111358dac17e40a06a110aba00171fd838306034337bbe1b17f9b337c6c91f6676fcd8
+  data.tar.gz: 3ca6bd73015e51026f8aec700ce061affccea8540db8eedab15b6967ae0421931e5497145a59762c53734ac10502f617f38fb24bab4b9aba756a05f14f7070c1

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-19'
+  s.date        = '2016-07-24'
   s.summary     = "A gem to represent and interact with tree data structures"
   s.description = "Based on rubytree and enzymator, this gem lets you build trees and run queries against them."
   s.authors     = ["Eugenio Bruno"]
@@ -19,10 +19,10 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
   s.require_paths = ['lib']
 
-  s.required_ruby_version = '>= 1.9.2'
+  s.required_ruby_version = '>= 2.0.0'
 
-  s.add_runtime_dependency 'rubytree', ['~> 0.9']
-  s.add_runtime_dependency 'enzymator', ['~> 0.0']
+  s.add_runtime_dependency 'rubytree', ['0.9.7']
+  s.add_runtime_dependency 'enzymator', ['1.0.0']
 
   s.add_development_dependency 'rake', ['~> 11.2']
   s.add_development_dependency 'minitest', ['~> 5.9']

data/lib/forester/aggregators.rb

@@ -1,43 +1,64 @@
 module Forester
   module Aggregators
 
+    def own_and_descendants(options = {})
+      default_options = {
+        field: 'name',
+        if_field_missing: ->(c) { [] },
+      }
+
+      options = default_options.merge(options)
+
+      Enzymator::Aggregations::MapReduce.new(
+        {
+          mapping:     ->(node) { Array(node.get(options[:field], &options[:if_field_missing])) },
+          #reduction:   ->(acum, values) { acum.concat(values) },
+          #empty: []
+          # automatically assumed
+        }
+      )
+      .run_on(self)
+    end
+
     def values_by_subtree_of_level(options = {})
       default_options = {
         level:                    1,
         group_field:              'name',
         aggregation_field:        'value',
-        if_field_missing:         lambda { |c| [] },
+        if_field_missing:         ->(c) { [] },
         include_ancestry_in_keys: false, # if false, with_root is ignored
         with_root:                false,
       }
 
       options = default_options.merge(options)
 
-      aggregation_config = {
-        null_result:       lambda { Hash.new },
-        initial_clusters:  lambda { |tree| tree.nodes_of_level(options[:level]) },
-        map:               lambda do |node|
-                              key_nodes = if options[:include_ancestry_in_keys]
-                                            node.ancestry(options[:with_root], true)
-                                          else
-                                            [node]
-                                          end
-                              key = key_nodes.map { |kn| kn.get(options[:group_field]) { |n| n.object_id } }
-                              key = key.first if key.one?
-                              key
-                            end,
-        enumerator:        lambda { |level| level.each_node },
-        map_each:          lambda { |node| node.get(options[:aggregation_field], &options[:if_field_missing]) },
-        reduce_each:       lambda { |acum, value| Array(acum).concat(Array(value)) },
-        reduce:            lambda { |prev, group, result| prev.merge( { group => result } ) },
+      input = nodes_of_level(options[:level])
 
-      }
+      Enzymator::Aggregations::MapReduce.new({
+        mapping: ->(node) {
 
-      aggregated(aggregation_config, options)
-    end
+          key_nodes = if options[:include_ancestry_in_keys]
+                        node.ancestry(options[:with_root], true)
+                      else
+                        [node]
+                      end
+
+          key = key_nodes.map { |kn| kn.get(options[:group_field]) { |n| n.object_id } }
+          key = key.first if key.one?
+
+          value = node.own_and_descendants(
+            {
+              field: options[:aggregation_field],
+              if_field_missing: options[:if_field_missing]
+            }
+          )
 
-    def aggregated(config, options = {})
-      Enzymator::Aggregation.new(config).run_on(self, options)
+          { key => value }
+        },
+        # reduction: ->(acum, hash) { acum.merge(hash) }
+        # empty: {}
+        # automatically assumed
+      }).run_on(input)
     end
 
   end

data/lib/forester/tree_node.rb

@@ -28,6 +28,37 @@ module Forester
       end
     end
 
+    def values_by_field(options)
+      default_options = {
+        field_to_search: 'name',
+        search_keyword: :missing_search_keyword,
+        values_key: :missing_values_key,
+        include_descendants: false,
+        assume_uniqueness: false
+      }
+      options = default_options.merge(options)
+
+      found_nodes = nodes_with(options[:field_to_search], options[:search_keyword])
+
+      # When assuming that node names are unique,
+      # if more than one node was found,
+      # discard all but the first one
+      found_nodes = found_nodes.slice(0, 1) if options[:assume_uniqueness]
+
+      found_nodes.flat_map do |node|
+        if options[:include_descendants]
+          node.own_and_descendants({ field: options[:values_key] })
+        else
+          node.get(options[:values_key])
+        end
+      end
+
+    end
+
+    def nodes_with(content_key, content_value)
+      each_node.select { |node| Array(node.get(content_key) { :no_match }).include? content_value }
+    end
+
     def get(field, &block)
       content.public_send(field, &block)
     end

data/lib/forester/version.rb

@@ -1,13 +1,12 @@
 module Forester
   class Version
     MAJOR = 0
-    MINOR = 0
-    PATCH = 4
+    MINOR = 1
+    PATCH = 0
     PRE = nil
 
     class << self
 
-      # @return [String]
       def to_s
         [MAJOR, MINOR, PATCH, PRE].compact.join('.')
       end

data/test/test_treenode.rb

@@ -30,6 +30,46 @@ class TreeNodeTest < Minitest::Test
     aggregation_result = tree.values_by_subtree_of_level(level: 2, aggregation_field: 'strings', include_ancestry_in_keys: true)
 
     assert_equal expected, aggregation_result
+
+
+    expected_value = [7]
+    actual_value = tree.values_by_field({
+      field_to_search: 'name',
+      search_keyword: 'Second node of level 3',
+      values_key: 'value'
+    })
+    assert_equal expected_value, actual_value
+
+    expected_values = [7, 8, 9]
+    actual_values = tree.values_by_field({
+      field_to_search: 'name',
+      search_keyword: 'Second node of level 3',
+      values_key: 'value',
+      include_descendants: true
+    })
+    assert_equal expected_values, actual_values
+
+    expected_value = [7]
+    actual_value = tree.values_by_field({
+      field_to_search: 'strings',
+      search_keyword: 'A hidden secret lies in the deepest leaves...',
+      values_key: 'value'
+    })
+    assert_equal expected_value, actual_value
+
+
+    expected_names = ["A hidden secret lies in the deepest leaves...", "Just kidding.", "Could forester handle trees with hundreds of levels?", "Maybe."]
+
+    found_nodes = tree.nodes_with('name', 'Second node of level 3')
+    assert_equal 1, found_nodes.length
+
+    actual_names = found_nodes.flat_map do |node|
+      node.own_and_descendants({
+        field: 'strings'
+      })
+    end
+
+    assert_equal expected_names, actual_names
   end
 
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: forester
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Eugenio Bruno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-19 00:00:00.000000000 Z
+date: 2016-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubytree
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.7
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.7
 - !ruby/object:Gem::Dependency
   name: enzymator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '11.2'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '5.9'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
 description: Based on rubytree and enzymator, this gem lets you build trees and run
@@ -112,17 +112,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A gem to represent and interact with tree data structures