forester 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4bc0ddc9aa53d1bdab802726bbdc14871584d67
-  data.tar.gz: d43910fab0a17df6bee538e7822a68faba3616b0
+  metadata.gz: 21870a6a2f8976322af18cc53776dc41a6a1dbb9
+  data.tar.gz: 6947433f22479158ef6e08c8d965a2ce0de7a058
 SHA512:
-  metadata.gz: 58c9d3199133b793ffc19f7a40dd85b37a6e93e4595b06c974447f091f274c77433d9be1df9291116cf2ba240b49178ab6813766fac65ddabf40f5176341ebd3
-  data.tar.gz: 05ca996da70214bfb0e5ba33db69ae8d7782b7955fbff7d72893df50ab99a70e9a13a01f92adfe3a94839bc53ff47cb96691b010b12c5625f224083814bb4f0d
+  metadata.gz: 3bc863f4b9fdd51749c3bde9da3baea18265d61cf1f7a240571df07192a0d757fc187fcf1412cc94b1ca2304458e0d23f1de71bc951498496e3f25d177d753f0
+  data.tar.gz: dfdf878a13b18c54d14ce852d9cee9ac4d136b342c44f080032c8b71f82ad93c87cebfe90ff97a63ce14287b287d08ae84287471cba16c3a1370abee1495834d

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-08-27'
+  s.date        = '2016-08-28'
   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/dictionary.rb

@@ -59,6 +59,7 @@ module Forester
           symbolize_keys:    false
         }
         options = default_options.merge(options)
+        options[:fields_to_include] = fields if options[:fields_to_include] == :all
 
         convert_key = ->(k) { k }
         convert_key = ->(k) { k.to_s }   if options[:stringify_keys]

data/lib/forester/tree_node.rb

@@ -5,6 +5,7 @@ module Forester
     def_delegators :@content, :fields, :has?, :put!, :add!, :del!
 
     include Aggregators
+    include Validators
     include Mutators
     include Views
 
@@ -38,8 +39,8 @@ module Forester
         content.get(field)
       elsif block_given?
         yield self
-      elsif default != :raise
-        default
+      elsif options[:default] != :raise
+        options[:default]
       else
         raise ArgumentError.new("the node \"#{name}\" does not have \"#{field}\"")
       end

data/lib/forester/tree_node_ext/mutators.rb

@@ -2,18 +2,26 @@ module Forester
   module Mutators
 
     def add_field!(name, definition, options = {})
+      add_fields!([{ name: name, definition: definition }], options)
+    end
+
+    def add_fields!(fields, options = {})
       default_options = {
         subtree: true
       }
       options = default_options.merge(options)
 
-      if options[:subtree]
-        each_node do |node|
-          node.add_field!(name, definition, options.merge({ subtree: false }))
-        end
-      else
-        value = definition.respond_to?(:call) ? definition.call(self) : definition
-        put!(name, value)
+      target_nodes = options[:subtree] ? each_node : [self]
+
+      target_nodes.each { |node| node.add_fields_to_root!(fields) }
+    end
+
+    def add_fields_to_root!(fields)
+      fields.each do |field|
+        value = field[:definition]
+        value = value.call(self) if value.respond_to?(:call)
+
+        put!(field[:name], value)
       end
     end
 

data/lib/forester/tree_node_ext/validators.rb

@@ -0,0 +1,134 @@
+module Forester
+  module Validators
+
+    def validate_uniqueness_of_field(field, options = {})
+      validate_uniqueness_of_fields([field], options)
+    end
+
+    def validate_uniqueness_of_fields(fields, options = {})
+      default_options = {
+        combination:              false,
+        first_failure_only:       false,
+        within_subtrees_of_level: 0,
+        among_siblings_of_level:  :not_siblings,
+        field_for_failures:       :name,
+        as_failure: ->(node) { node.get(options[:field_for_failures]) }
+      }
+      options = default_options.merge(options)
+
+      return of_combination_of_fields(fields, options) if options[:combination]
+
+      failures = Hash.new(Hash.new([]))
+
+      nodes_of_level(options[:within_subtrees_of_level]).each do |subtree|
+        visited_nodes = []
+        nodes_to_visit =
+          if options[:among_siblings_of_level] == :not_siblings
+            subtree.each_node
+          else
+            nodes_of_level(options[:among_siblings_of_level])
+          end
+
+        nodes_to_visit.each  do |node|
+          visited_nodes.each do |vn|
+            fields.each      do |field|
+              next unless all_have?(field, [vn, node])
+
+              if same_values?(field, [vn, node])
+                k = vn.get(field) # repeated value
+
+                prepare_hash(failures, field, k)
+
+                add_failure_if_new(failures, field, k, options[:as_failure].call(vn))
+                add_failure(       failures, field, k, options[:as_failure].call(node))
+
+                return result(failures) if options[:first_failure_only]
+              end
+            end
+          end
+          visited_nodes << node
+        end
+      end
+
+      result(failures)
+    end
+
+    private
+
+    def of_combination_of_fields(fields, options)
+      failures = Hash.new(Hash.new([]))
+
+      nodes_of_level(options[:within_subtrees_of_level]).each do |subtree|
+        visited_nodes = []
+        nodes_to_visit =
+          if options[:among_siblings_of_level] == :not_siblings
+            subtree.each_node
+          else
+            nodes_of_level(options[:among_siblings_of_level])
+          end
+
+        nodes_to_visit.each  do |node|
+          visited_nodes.each do |vn|
+            next unless all_have_all?(fields, [vn, node])
+
+            if same_values_for_all?(fields, [vn, node])
+              k = fields.map { |f| vn.get(f) } # repeated combination of values
+
+              prepare_hash(failures, fields, k)
+
+              add_failure_if_new(failures, fields, k, options[:as_failure].call(vn))
+              add_failure(       failures, fields, k, options[:as_failure].call(node))
+
+              return result(failures) if options[:first_failure_only]
+            end
+          end
+          visited_nodes << node
+        end
+      end
+
+      result(failures)
+    end
+
+    private
+
+    def all_have?(field, nodes)
+      all_have_all?([field], nodes)
+    end
+
+    def all_have_all?(fields, nodes)
+      nodes.all? { |n| fields.all? { |f| n.has?(f) } }
+    end
+
+    def same_values?(field, nodes)
+      same_values_for_all?([field], nodes)
+    end
+
+    def same_values_for_all?(fields, nodes)
+      fields
+        .map  { |f| nodes.map { |n| n.get(f) } }
+        .all? { |vs| vs.uniq.length <= 1 }
+    end
+
+    def prepare_hash(hash, key, subkey)
+      hash[key]         = {} unless hash.has_key?(key)
+      hash[key][subkey] = [] unless hash[key].has_key?(subkey)
+    end
+
+    def add_failure_if_new(failures, key, subkey, value)
+      add_failure(failures, key, subkey, value) unless failures[key][subkey].include?(value)
+    end
+
+    def add_failure(failures, key, subkey, value)
+      failures[key][subkey] << value
+    end
+
+    def result(failures)
+      {
+        is_valid: failures.empty?,
+        repeated: failures.each_with_object({}) { |(k,v), h| h[k] = v.keys },
+        failures: failures
+      }
+    end
+
+  end
+end

data/lib/forester/tree_node_ext/views.rb

@@ -3,7 +3,7 @@ module Forester
 
     def as_root_hash(options = {})
       default_options = {
-        fields_to_include: fields, # all of them
+        fields_to_include: :all,
         max_level:         :last,
         children_key:      :children,
         stringify_keys:    false,

data/lib/forester/version.rb

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

data/lib/forester.rb

@@ -4,6 +4,7 @@ require 'securerandom'
 require 'yaml'
 
 require 'forester/tree_node_ext/aggregators'
+require 'forester/tree_node_ext/validators'
 require 'forester/tree_node_ext/mutators'
 require 'forester/tree_node_ext/views'
 

data/test/test_tree_node.rb

@@ -12,10 +12,23 @@ class TestTreeNode < Minitest::Test
   end
 
   def test_values
-    expected = (0..9).reduce(:+)
+    values = (0..9).to_a
+
+    expected = values.reduce(:+)
     actual   = @@tree.reduce(0) { |acum, node| acum + node.get('value') }
 
     assert_equal expected, actual
+
+    assert_equal values, @@tree.get('value', { subtree: true })
+  end
+
+  def test_missing_values
+    assert_equal 0,    @@tree.get('value')
+    assert_equal 'no', @@tree.get('whatever', { default: 'no' })
+    assert_equal 'no', @@tree.get('whatever', { default: 'missing' }) { 'no' }
+    assert_equal 'no', @@tree.get('whatever') { 'no' }
+    assert_equal 'no', @@tree.get('whatever') { |n| 'no' }
+    assert_equal 1,    @@tree.get('whatever') { |n| n.get('value') + 1 }
   end
 
   def test_levels

data/test/test_validators.rb

@@ -0,0 +1,245 @@
+require 'minitest/autorun'
+require 'forester'
+
+require_relative './simple_tree_helper'
+
+class TestValidators < Minitest::Test
+
+  include SimpleTreeHelper
+
+  def test_validate_uniqueness_of_field_uniques
+    expected = {
+      is_valid: true,
+      repeated: {},
+      failures: {}
+    }
+
+    ['name', :name, 'special', 'ghost'].each do |field|
+      actual = @@tree.validate_uniqueness_of_field(field)
+      assert_equal expected, actual
+    end
+
+  end
+
+  def test_validate_uniqueness_of_field_color
+    expected = {
+      is_valid: false,
+      repeated: {
+        :color => ['Green', 'Yellow']
+        },
+      failures: {
+        :color => {
+          'Green'  => ['First node of level 1', 'Second node of level 1'],
+          'Yellow' => ['First node of level 4', 'Second node of level 4']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color)
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_field_color_first_failure_only
+    expected = {
+      is_valid: false,
+      repeated: {
+        :color => ['Green']
+        },
+      failures: {
+        :color => {
+          'Green'  => ['First node of level 1', 'Second node of level 1']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color, {
+      first_failure_only: true
+    })
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_field_color_among_siblings_of_level_1
+    expected = {
+      is_valid: false,
+      repeated: {
+        :color => ['Green']
+        },
+      failures: {
+        :color => {
+          'Green' => ['First node of level 1', 'Second node of level 1']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color, {
+      among_siblings_of_level: 1
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_field_color_among_siblings_of_level_2
+    expected = {
+      is_valid: true,
+      repeated: {},
+      failures: {}
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color, {
+      among_siblings_of_level: 2
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_field_color_within_subtrees_of_level_1
+    expected = {
+      is_valid: false,
+      repeated: {
+        :color => ['Yellow']
+        },
+      failures: {
+        :color => {
+          'Yellow' => ['First node of level 4', 'Second node of level 4']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color, {
+      within_subtrees_of_level: 1,
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_field_color_within_subtrees_of_level_3
+    expected = {
+      is_valid: false,
+      repeated: {
+        :color => ['Yellow']
+        },
+      failures: {
+        :color => {
+          'Yellow' => ['First node of level 4', 'Second node of level 4']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color, {
+      within_subtrees_of_level: 3,
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_field_color_within_subtrees_of_level_4
+    expected = {
+      is_valid: true,
+      repeated: {},
+      failures: {}
+    }
+
+    actual = @@tree.validate_uniqueness_of_field(:color, {
+      within_subtrees_of_level: 4,
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_fields_name_color
+    expected = {
+      is_valid: false,
+      repeated: {
+        'color' => ['Green', 'Yellow']
+        },
+      failures: {
+        'color' => {
+          'Green'  => ['First node of level 1', 'Second node of level 1'],
+          'Yellow' => ['First node of level 4', 'Second node of level 4']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_fields(['name', 'color'])
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_combination_of_fields_name_color
+    expected = {
+      is_valid: true,
+      repeated: {},
+      failures: {}
+    }
+
+    actual = @@tree.validate_uniqueness_of_fields(['name', 'color'], {
+      combination: true
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_fields_color_tone_first_failure_only
+    expected = {
+      is_valid: false,
+      repeated: {
+        'color' => ['Green']
+        },
+      failures: {
+        'color' => {
+          'Green' => ['First node of level 1', 'Second node of level 1']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_fields(['color', 'tone'], {
+      first_failure_only: true
+    })
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_fields_color_tone
+    expected = {
+      is_valid: false,
+      repeated: {
+        'color' => ['Green', 'Yellow'],
+        'tone'  => ['Dark']
+        },
+      failures: {
+        'color' => {
+          'Green'  => ['First node of level 1', 'Second node of level 1'],
+          'Yellow' => ['First node of level 4', 'Second node of level 4']
+        },
+        'tone' => {
+          'Dark' => ['First node of level 1', 'Second node of level 1']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_fields(['color', 'tone'])
+
+    assert_equal expected, actual
+  end
+
+  def test_validate_uniqueness_of_combination_of_fields_color_tone
+    expected = {
+      is_valid: false,
+      repeated: {
+        ['color', 'tone'] => [['Green', 'Dark']]
+        },
+      failures: {
+        ['color', 'tone'] => {
+          ['Green', 'Dark'] => ['First node of level 1', 'Second node of level 1']
+        }
+      }
+    }
+
+    actual = @@tree.validate_uniqueness_of_fields(['color', 'tone'], {
+      combination: true
+    })
+
+    assert_equal expected, actual
+  end
+
+end

data/test/trees/simple_tree.yml

@@ -7,6 +7,8 @@ root:
   children:
   - name: First node of level 1
     value: 1
+    color: Green
+    tone: Dark
     children:
     - name: First node of level 2
       value: 2
@@ -15,12 +17,15 @@ root:
         - I want to be the very best
         - like no one ever was
     - name: Second node of level 2
+      special: No other node has this field
       value: 3
       strings:
         - I have a sibling to my left
         - She wants to catch them all
   - name: Second node of level 1
     value: 4
+    color: Green
+    tone: Dark
     children:
     - name: Third node of level 2
       value: 5
@@ -38,8 +43,10 @@ root:
         children:
         - name: First node of level 4
           value: 8
+          color: Yellow
         - name: Second node of level 4
           value: 9
+          color: Yellow
           strings:
             - Could forester handle trees with hundreds of levels?
             - Maybe.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forester
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Eugenio Bruno
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-27 00:00:00.000000000 Z
+date: 2016-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubytree
@@ -87,6 +87,7 @@ files:
 - lib/forester/tree_node.rb
 - lib/forester/tree_node_ext/aggregators.rb
 - lib/forester/tree_node_ext/mutators.rb
+- lib/forester/tree_node_ext/validators.rb
 - lib/forester/tree_node_ext/views.rb
 - lib/forester/version.rb
 - test/simple_tree_helper.rb
@@ -94,6 +95,7 @@ files:
 - test/test_mutators.rb
 - test/test_tree_factory.rb
 - test/test_tree_node.rb
+- test/test_validators.rb
 - test/test_views.rb
 - test/trees/simple_tree.yml
 homepage: http://rubygems.org/gems/forester
@@ -126,5 +128,6 @@ test_files:
 - test/test_mutators.rb
 - test/test_tree_factory.rb
 - test/test_tree_node.rb
+- test/test_validators.rb
 - test/test_views.rb
 - test/trees/simple_tree.yml