forester 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a837fb2321275845b5c51622079d41896966145e
-  data.tar.gz: 5e1deb643c9233e5d376839948ac74a369bb5e13
+  metadata.gz: 1450e6fa82ffadb91424237f6c9527bc0e9bd9d2
+  data.tar.gz: ec8325c5dc3bde7784651b4d5039edcb7f694631
 SHA512:
-  metadata.gz: 9622068a5b9e8d56dddd96b87e7553d377390b7cfc25d14154dbe4255a30fc6f83f260cf2c8f038728aed4a77f893e161588e475b96de40dfd86f9f86e916ce8
-  data.tar.gz: 8b7b017668323e9c00544518944fdbf1cf7595cdb08b33986d119bf52add39da096cbf3372c73bd4c2b2f7c31631c90a330aa3e3946ce3e93930798eead421a6
+  metadata.gz: 3ca55344989f3b2de019c3dfc5d3cc648c745cb1d8810fc0af44c5a8723b3ad951615a6e959385271bb8d6ced06e1c43182b4efe8e9776038be2cfa39201681c
+  data.tar.gz: 523d4c868e6d329854a29758d29ab9ffdf8dad56daafdcd341ed9cdd5cae91921c12b1d9961e8eaec6b4f39acb418b894f4c94fc644d88ca9e8f90b05cace538

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-26'
+  s.date        = '2016-07-27'
   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/aggregators.rb

@@ -1,6 +1,10 @@
 module Forester
   module Aggregators
 
+    def nodes_with(content_key, content_values)
+      each_node.select { |node| not ( Array(node.get(content_key) { :no_match }) & Array(content_values) ).empty? }
+    end
+
     def with_ancestry(options = {})
       default_options = {
         include_root: true,
@@ -22,28 +26,27 @@ module Forester
       end
     end
 
-    def values_by_field(options)
+    def search(options)
       default_options = {
-        field_to_search:     'name',
-        search_keyword:      :missing_search_keyword,
-        values_key:          :missing_values_key,
-        include_descendants: false,
-        assume_uniqueness:   false
+        single_node: true,
+        by_field:    :name,
+        keywords:    :missing_search_keywords,
+        then_get:    :nodes,
+        of_subtree:  true,
       }
       options = default_options.merge(options)
 
-      found_nodes = nodes_with(options[:field_to_search], options[:search_keyword])
+      found_nodes = nodes_with(options[:by_field], options[:keywords])
+
+      found_nodes = found_nodes.slice(0, 1) if options[:single_node]
 
-      # 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]
+      return found_nodes if options[:then_get] == :nodes
 
       found_nodes.flat_map do |node|
-        if options[:include_descendants]
-          node.own_and_descendants(options[:values_key])
+        if options[:of_subtree]
+          node.own_and_descendants(options[:then_get])
         else
-          node.get(options[:values_key])
+          node.get(options[:then_get])
         end
       end
 

data/lib/forester/tree_node.rb

@@ -21,10 +21,6 @@ module Forester
       end
     end
 
-    def nodes_with(content_key, content_value)
-      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)

data/lib/forester/version.rb

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

data/test/test_treenode.rb

@@ -33,27 +33,38 @@ class TestTreeNode < Minitest::Test
 
 
     expected_value = [7]
-    actual_value = tree.values_by_field({
-      field_to_search: 'name',
-      search_keyword: 'Second node of level 3',
-      values_key: 'value'
+    actual_value = tree.search({
+      by_field:   'name',
+      keywords:   'Second node of level 3',
+      then_get:   'value',
+      of_subtree: false,
+    })
+    assert_equal expected_value, actual_value
+
+    expected_value = [7]
+    actual_value = tree.search({
+      by_field:   'name',
+      keywords:   ['Second node of level 3', 'Not present name'],
+      then_get:   'value',
+      of_subtree: false,
     })
     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
+    actual_values = tree.search({
+      by_field:   'name',
+      keywords:   'Second node of level 3',
+      then_get:   'value',
+      of_subtree: 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'
+    actual_value = tree.search({
+      by_field:   'strings',
+      keywords:   'A hidden secret lies in the deepest leaves...',
+      then_get:   'value',
+      of_subtree: false
     })
     assert_equal expected_value, actual_value
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forester
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Eugenio Bruno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubytree