forester 4.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10d063cbc60a90d3e5ebe19867e2b47ae74f59fe
-  data.tar.gz: b2fb62970c91d0f75c18f01efb0f7e502da1e05e
+  metadata.gz: 15d624a03bf22e3aa31e6b4d95188d206e408157
+  data.tar.gz: 531f71e74b49b45a6993136e8c184ac1d69fca56
 SHA512:
-  metadata.gz: 53099d57189bde522ff5310b9532ba91f9338beec8f2676735ea837a1c0e23977f333ad177e15d6268981bb0ba24dd104d89b1d5e75ec1c660e0288db87a1cd5
-  data.tar.gz: 8a1e31896c0469536e4279e3095d573cb84f048e689f2693e70134dbaa0263720034cf97f4ceac72628e45720a10388dac085e133afb1292ffa3375a005fa648
+  metadata.gz: 505f8d2c8240652c9abdfc8bdfae4375001c7741f68afd576a3f906533009ea45b73f885a6800aff6b50bbba1241a88855644cd300222f9c3041640253661ec7
+  data.tar.gz: d8dfd6091c239b0bdcab3f3e469670555c98209044285c895d7b42d09dd598fb464ee68716ad9037f2034fa453f8cf478fd50234d1955153786a8e27f9394b9a

data/.gitignore

@@ -5,14 +5,29 @@
 /InstalledFiles
 /pkg/
 /spec/reports/
+/spec/examples.txt
 /test/tmp/
 /test/version_tmp/
 /tmp/
 
+# Used by dotenv library to load environment variables.
+# .env
+
 ## Specific to RubyMotion:
 .dat*
 .repl_history
 build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
 
 ## Documentation cache and generated files:
 /.yardoc/
@@ -20,7 +35,7 @@ build/
 /doc/
 /rdoc/
 
-## Environment normalisation:
+## Environment normalization:
 /.bundle/
 /vendor/bundle
 /lib/bundler/man/

data/.travis.yml

@@ -1,10 +1,9 @@
+sudo: false
 language: ruby
 rvm:
   - 2.0
   - 2.1
   - 2.2
-  - 2.3
-  - 2.4
-  - jruby
-before_install:
-  - gem install bundler
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.15.3

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Forester Changelog
+
+All notable changes to this project since version 5 will be documented in this file. This project adheres to [Semantic Versioning][Semver].
+
+## [Unreleased]
+
+* Your contribution here!
+
+## 5.0.0 (2017-08-06)
+
+* Version 5 release
+
+[Semver]: http://semver.org
+[Unreleased]: https://github.com/eugeniobruno/forester/compare/v5.0.0...HEAD

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eugeniobruno@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in forester.gemspec
 gemspec

data/{LICENSE → LICENSE.txt}

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 eugeniobruno
+Copyright (c) 2017 Eugenio Bruno
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -9,13 +9,13 @@ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,49 +1,85 @@
 # Forester
 
 [![Gem Version](https://badge.fury.io/rb/forester.svg)](https://badge.fury.io/rb/forester)
+[![Build Status](https://travis-ci.org/eugeniobruno/forester.svg?branch=master)](https://travis-ci.org/eugeniobruno/forester)
+[![Coverage Status](https://coveralls.io/repos/github/eugeniobruno/forester/badge.svg?branch=master)](https://coveralls.io/github/eugeniobruno/forester?branch=master)
+[![Code Climate](https://codeclimate.com/github/eugeniobruno/forester.svg)](https://codeclimate.com/github/eugeniobruno/forester)
+[![Dependency Status](https://gemnasium.com/eugeniobruno/forester.svg)](https://gemnasium.com/eugeniobruno/forester)
 
-Based on *rubytree*, this gem lets you build trees and run queries against them.
+Forester's functionality is a superset of [RubyTree](https://github.com/evolve75/RubyTree)'s that further facilitates the work with tree data structures at the right level of abstraction.
 
-## FAQ
+## Installation
 
-- What's the difference between forester and rubytree?
+Add this line to your application's Gemfile:
 
-The main class provided by the *rubytree* gem is **Tree::TreeNode**. In the case of forester, it is **Forester::TreeNode**, which is nothing more than a subclass of the former.
+    gem 'forester'
 
-- Why is this a separate gem and not just a pull request in rubytree?
+And then execute:
 
-Because I needed to develop a certain feature on top of TreeNode in a time-sensitive manner. Rubytree devs should feel free to take anything they like from this project.
+    $ bundle
 
-- Why is forester not a fork of rubytree?
+Or install it yourself as:
 
-Because I didn't feel the need to copy the whole codebase. All I needed was to extend the functionality of a class.
+    $ gem install forester
 
-- What can I do with forester?
+## Usage
 
-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.
+Here is a simple example:
 
-## Installation
+```ruby
+serialized_tree = {
+  label: 'anything',
+  count: 0,
+  children: [
+    {
+      label: 'first child',
+      count: 1,
+      children: [
+        {
+          label: 'first grandchild',
+          count: 3
+        }
+      ]
+    },
+    {
+      label: 'second child',
+      count: 2
+    }
+  ]
+}
 
-Add this line to your application's Gemfile:
+# Any node can have any set of fields
 
-    gem 'forester'
+tree = Forester.tree_factory.from_root_hash(serialized_tree, children_key: :children)
 
-And then execute:
+all_counts = tree.each_node(traversal: :breadth_first).map { |n| n.get(:count) }
+# [0, 1, 2, 3]
 
-    $ bundle
+tree.add_child_content(label: 'third child')
 
-Or install it yourself as:
+tree.validate_uniqueness_of_field(:label)
+# { is_valid: true, repeated: {}, failures: {} }
 
-    $ gem install forester
+tree.as_root_hash
+# a hash with the same structure as serialized_tree
+```
 
-## Usage
+The full set of utilities are covered with unit tests, which also serve as usage examples.
+
+
+## Development
 
-Build your tree with any of the factory methods in TreeFactory, and then start messaging the resulting instance of TreeNode.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/eugeniobruno/forester. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+

data/Rakefile

@@ -1,11 +1,11 @@
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new do |t|
+Rake::TestTask.new(:test) do |t|
   t.libs << 'test'
-  t.pattern = "test/**/test_*.rb"
+  t.test_files = FileList['test/**/test_*.rb']
 end
 
-desc "Run tests"
 task default: :test
 
 desc 'Start a REPL session'
@@ -14,4 +14,4 @@ task :console do
   require 'pry'
   ARGV.clear
   Pry.start
-end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'forester'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/forester.gemspec

@@ -1,30 +1,38 @@
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'forester/version'
 
-Gem::Specification.new do |s|
-  s.name        = 'forester'
-  s.version     = Forester::Version
-  s.date        = '2017-02-26'
-  s.summary     = "A trees library"
-  s.description = "Forester is a collection of utilities to represent and interact with tree data structures."
-  s.authors     = "Eugenio Bruno"
-  s.email       = 'eugeniobruno@gmail.com'
-  s.homepage    = 'https://github.com/eugeniobruno/forester'
-  s.license     = 'MIT'
+Gem::Specification.new do |spec|
+  spec.name     = 'forester'
+  spec.version  = Forester::VERSION
+  spec.date     = '2017-08-06'
+  spec.authors  = ['Eugenio Bruno']
+  spec.email    = ['eugeniobruno@gmail.com']
 
-  s.files         = `git ls-files`.split($/)
-  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
-  s.require_paths = ['lib']
+  spec.summary  = 'Forester is a library to work with tree data structures.'
+  spec.homepage = 'https://github.com/eugeniobruno/forester'
+  spec.license  = 'MIT'
 
-  s.required_ruby_version = '>= 2.0.0'
+  spec.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir           = 'bin'
+  spec.executables      = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths    = ['lib']
+  spec.extra_rdoc_files = %w[LICENSE.txt README.md CODE_OF_CONDUCT.md CHANGELOG.md]
 
-  s.add_runtime_dependency 'rubytree', '0.9.7'
+  spec.required_ruby_version = '>= 2.0.0'
 
-  s.add_development_dependency 'rake', '~> 12.0'
-  s.add_development_dependency 'minitest', '~> 5.10'
-  s.add_development_dependency 'simplecov', '~> 0.14'
-  s.add_development_dependency 'pry-byebug', '~> 3.4'
+  spec.add_runtime_dependency 'rubytree', '= 0.9.7'
 
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-bender', '~> 0.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
 end

data/lib/forester.rb

@@ -1,17 +1,19 @@
-require 'tree'
-require 'forwardable'
+require 'forester/version'
+
 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'
+require 'tree'
 
-require 'forester/node_content/base'
-require 'forester/node_content/dictionary'
-require 'forester/node_content/list'
-require 'forester/node_content/factory'
+require 'forester/tree_node_ext/iterators'
+require 'forester/tree_node_ext/mutators'
+require 'forester/tree_node_ext/validators'
+require 'forester/tree_node_ext/serializers'
 
 require 'forester/tree_node'
 require 'forester/tree_factory'
+
+module Forester
+  def self.tree_factory
+    @tree_factory ||= TreeFactory.new
+  end
+end

data/lib/forester/tree_factory.rb

@@ -1,76 +1,45 @@
 module Forester
-  module TreeFactory
-
-    extend self
-
-    def node_from_hash(hash, options = {}, &block)
-      # TODO remove the whole node_content folder in next major version
-      # and let the user choose a class for the contents via a custom parser.
-      # That class should have the interface of the one used by the default parser.
-      # The default parser should be the constructor of Hash::Accessible, which
-      # is defined in the gem 'hash_ext'. Add it as a runtime dependency.
-      do_node_from_hash(hash, nil, options, &block)
-    end
-
-    def from_yaml_file(file, options = {})
-      from_hash_with_root_key(YAML.load_file(file), options)
-    end
-
-    def from_root_hash(hash, options = {})
-      from_hash_with_root_key({ root: hash }, options)
-    end
-
-    def from_hash_with_root_key(hash, options = {})
+  class TreeFactory
+    def from_root_hash(root_hash, options = {})
       default_options = {
-        max_level:    :last,
-        children_key: :children,
-        root_key:     :root
+        max_depth: :none,
       }
       options = default_options.merge(options)
 
-      options[:max_level] = -2 if options[:max_level] == :last
+      options[:max_depth] = -2 if options[:max_depth] == :none
 
       dummy_root = TreeNode.new('<TEMP>')
-      real_root  = fetch_indifferently(hash, options[:root_key])
 
-      tree = with_children(dummy_root, [real_root], options[:children_key], options[:max_level] + 1).first_child
+      tree = with_children(dummy_root, [root_hash], options.fetch(:children_key), options[:max_depth] + 1).first_child
       tree.detached_subtree_copy
     end
 
-    private
-
-    def fetch_indifferently(hash, key, default = nil)
-      [key, key.to_s, key.to_s.to_sym].uniq.map { |k| hash[k] }.compact.first || default || hash.fetch(root_key)
+    def node_from_content(content)
+      TreeNode.new(SecureRandom.uuid, content)
     end
 
+    private
+
     def with_children(tree_node, children, children_key, levels_remaining)
       return tree_node if levels_remaining == 0
+
       children.each do |child_hash|
-        child_node     = do_node_from_hash(child_hash, children_key)
-        child_children = fetch_indifferently(child_hash, children_key, [])
+        child_node     = node_from_hash(child_hash, children_key)
+        child_children = child_hash.fetch(children_key, [])
 
         tree_node << with_children(child_node, child_children, children_key, levels_remaining - 1)
       end
+
       tree_node
     end
 
-    def do_node_from_hash(hash, children_key, options = {}, &block)
-      content = NodeContent::Factory.from_hash(hash, children_key)
-      node(content, options, &block)
+    def node_from_hash(hash, children_key)
+      content = without_key(hash, children_key)
+      node_from_content(content)
     end
 
-    def node(content, options = {})
-      default_options = {
-        uid: SecureRandom.uuid
-      }
-      options = default_options.merge(options)
-
-      name = options[:uid]
-      new_node = TreeNode.new(name, content)
-
-      yield new_node if block_given?
-      new_node
+    def without_key(hash, key)
+      hash.dup.tap { |h| h.delete(key) }
     end
-
   end
 end