pomona 0.6.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e46fd3f505f3d16d9a6e52dccb81777709281e31
+  data.tar.gz: 68c792bc59061bc4885f1184879a8ac059d53b39
+SHA512:
+  metadata.gz: 6156620e8aeaf867c94b28cd19ae5c68d7149da1a3b82ce36c2db1ac891be11326ca993b9d7cfd472084c3fae54e71b525e034ef8d9b9775d224d24edd2bdf25
+  data.tar.gz: 7fc7ed2ac3c3e316c8c9f9919b776402ca4f7fce5e1ff5caa02f58318d8efb0458578843cdec48d860522903dc3b748b07b54df80c79110a269e1c7d4fb4e9e8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at elliott.a.young@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 ElliottAYoung
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+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 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.

data/README.md

@@ -0,0 +1,162 @@
+# Pomona
+
+Pomona is a simple, lightweight gem for creating and managing tree data structures in Ruby. It works using a custom data structure (the Tree) to contain small hashes of data (the Nodes) that can be queried and searched.
+
+And of course it's a subtle, shameless [Harry Potter reference](http://harrypotter.wikia.com/wiki/Pomona_Sprout).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pomona'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install pomona
+
+## Usage
+
+###Basics
+
+Using Pomona is simple - to create a new Tree simply run:
+
+```ruby
+tree = Tree.new
+
+# Tree is now created as so:
+{
+   tree_array: []
+}
+```
+
+Once you have your tree you can simply add any nodes to it by using ```#add_node``` like so:
+
+```ruby
+tree.add_node({ data: "Your Data"})
+```
+After creation your new Node will automatically have a unique auto-generated id and an empty ```children``` array added to it. It will now look like this:
+
+```ruby
+{
+    tree_array: [
+    	{ id: 1, data: "Your Data", children: [] }
+    ]
+}
+```
+
+You can now attach any additional (child) Nodes onto the one you've created by simply specifying the id when adding the Node.
+
+```ruby
+tree.add_node({ data: "New Data" }, 1)
+```
+
+This will attach the Node to your previously created one, making the tree look like this:
+
+```ruby
+{
+    tree_array: [
+    	{ id: 1, data: "Your Data", children: [
+    		{ id: 2, data: "New Data", children: [] }
+    	]}
+    ]
+}
+```
+
+###Searching the Tree
+Given the following example tree:
+
+```ruby
+{
+  tree_array: [
+    { name: "Rickon Stark", id: 1, children: [
+        { name: "Brandon Stark", id: 2, children: [] },
+        { name: "Eddard Stark", id: 3, children: [
+            { name: "Robb Stark", id: 6, children: [] },
+            { name: "Sansa Stark", id: 7, children: [] },
+            { name: "Arya Stark", id: 8, children: [] },
+            { name: "Bran Stark", id: 9, children: [] },
+            { name: "Rickon Stark II", id: 10, children: [] },
+          ]
+         },
+         { name: "Lyanna Stark", id: 4, children: [
+                { name: "Jon Snow", id: 11, children: [] },
+            ]
+         },
+         { name: "Benjen Stark", id: 5, children: [] }
+      ]
+    }
+  ]
+}
+```
+
+We can search and aggregate any data from this by using the following commands:
+
+#### #find(id)
+Find will return the Node with the id you've passed as a paramater:
+
+```ruby
+tree.find(8)
+ { name: "Arya Stark", id: 8, children: [] }
+```
+
+#### #values_at(keys)
+Values_at works very similarly to its Hash counterpart with two primary differences:
+
+1. It is able to take in an array of keys that it will search with, or a singular key you want to find.
+2. It will return a nested Array if an array of keys is passed, or a flattened array if only one is passed.
+
+```ruby
+# Multiple Keys
+
+tree.values_at([:id, :name])
+[
+   ["Rickon Stark", 1], ["Brandon Stark", 2], ["Eddard Stark", 3],
+   ["Robb Stark", 6], ["Sansa Stark", 7], ["Arya Stark", 8],
+   ["Bran Stark", 9], ["Rickon Stark II", 10], ["Lyanna Stark", 4],
+   ["Jon Stark", 11], ["Benjen Stark", 5]
+]
+
+# One Key
+tree.values_at(:id)
+[
+	1, 2, 3, 6, 7, 8, 9, 10, 4, 11, 5
+]
+```
+
+###Deleteing from the Tree
+To remove a Node from the tree simply use the ```remove_node``` method on your ```Tree``` object, specifying the id of the Node you wish to remove.
+
+NOTE: This method will delete any children of the Node you've deleted as well, as they are now orphaned data.
+
+```ruby
+tree.remove_node(3)
+
+{
+  tree_array: [
+    { name: "Rickon Stark", id: 1, children: [
+         { name: "Brandon Stark", id: 2, children: [] },
+	     { name: "Lyanna Stark", id: 4, children: [
+	         { name: "Jon Snow", id: 11, children: [] },
+	       ]
+	     },
+	     { name: "Benjen Stark", id: 5, children: [] }
+      ]
+    }
+  ]
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/pomona. 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

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pomona"
+
+# 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

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/lib/pomona.rb

@@ -0,0 +1,2 @@
+require "pomona/version"
+require "pomona/tree"

data/lib/pomona/exceptions.rb

@@ -0,0 +1,5 @@
+class NodeNotFound < ArgumentError
+  def initialize(msg="The ID for a Node you have provided does not exist")
+    super
+  end
+end

data/lib/pomona/extractor.rb

@@ -0,0 +1,25 @@
+require "pomona/exceptions"
+
+module Extractor
+  def self.get_all_by_keys(tree_array = [], keys = [], values = [])
+    tree_array.each do |tree_node|
+      values << tree_node.node.values_at(*keys)
+      Extractor.get_all_by_keys(tree_node.children, keys, values) if tree_node.children.any?
+    end
+
+    values
+  end
+
+  def self.find_node_by_id(id, tree_array)
+    #TODO: Get this working without using an instance variable for target
+    tree_array.each do |tree_node|
+      if tree_node.id == id
+        @target = tree_node
+      else
+        Extractor.find_node_by_id(id, tree_node.children) if tree_node.children.any?
+      end
+    end
+
+    @target.nil? ? (raise NodeNotFound) : (return @target)
+  end
+end

data/lib/pomona/node.rb

@@ -0,0 +1,14 @@
+require "pomona/exceptions"
+
+class Node
+  attr_reader :id, :parent_id
+  attr_accessor :children, :node
+
+  def initialize(data_hash, id, parent_id)
+    @id = id
+    node_data = { id: @id, children: [] }
+    @node = data_hash.merge(node_data)
+    @children = @node[:children]
+    @parent_id = parent_id
+  end
+end

data/lib/pomona/pruner.rb

@@ -0,0 +1,11 @@
+require "pomona/exceptions"
+
+module Pruner
+  def self.remove_node_and_descendents(node, parent_node)
+    if parent_node.kind_of?(Array)
+      parent_node.delete_if { |n| n.id == node.id }
+    else
+      parent_node.children.delete_if { |n| n.id == node.id }
+    end
+  end
+end

data/lib/pomona/tree.rb

@@ -0,0 +1,72 @@
+require "pomona/node"
+require "pomona/extractor"
+require "pomona/pruner"
+require "pomona/exceptions"
+
+class Tree
+  attr_reader :data
+
+  def initialize
+    @data = { tree_array: [] }
+  end
+
+  def add_node(node_hash, parent_id = nil)
+    #Creates a new node to be attached to a parent
+    #Grants a generated id to the node
+    node = Node.new(node_hash, next_id, parent_id)
+    attach_to_parent(node, parent_id)
+  end
+
+  def remove_node(id)
+    #Removes a node from the Tree by its id
+    #Removes all of their descendents as well
+    node_to_delete = find(id)
+    parent_node = find_parent_node(node_to_delete)
+    Pruner.remove_node_and_descendents(node_to_delete, parent_node)
+  end
+
+  def values_at(keys)
+    #Returns an array of data from the tree based on the given keys
+    data = Extractor.get_all_by_keys(@data[:tree_array], keys)
+    flatten_output_array(data)
+  end
+
+  def find(id)
+    #Finds and returns a Node by its id using the Extractor
+    Extractor.find_node_by_id(id, @data[:tree_array])
+  end
+
+  private
+
+  def next_id
+    #Finds the next highest id to put a node in at
+    ids = values_at(:id).sort
+    ids[-1].nil? ? 1 : (ids[-1] + 1)
+  end
+
+  def attach_to_parent(node, parent_id)
+    #Attaches the newly created node to a parent node
+    #If parent_id is nil will simply attach it to the top level
+    if parent_id.nil?
+      @data[:tree_array] << node
+    else
+      parent = find(parent_id)
+      parent.children << node
+    end
+  end
+
+  def flatten_output_array(output_array)
+    #Flattens the output array of values_at if it only contains data for one key
+    return output_array if output_array.empty?
+    output_array[0].length == 1 ? output_array.flatten : output_array
+  end
+
+  def find_parent_node(node)
+    #Finds the parent node of the given node. If it is a top level node, returns the tree_array instead
+    if node.parent_id.nil?
+      @data[:tree_array]
+    else
+      find(node.parent_id)
+    end
+  end
+end

data/lib/pomona/version.rb

@@ -0,0 +1,3 @@
+module Pomona
+  VERSION = "0.6.0"
+end

data/pomona.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pomona/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "pomona"
+  spec.version       = Pomona::VERSION
+  spec.authors       = ["ElliottAYoung"]
+  spec.email         = ["elliott.a.young@gmail.com"]
+
+  spec.summary       = "A lightweight solution for creating and managing tree data structures"
+  spec.description   = "A lightweight solution for creating and managing tree data structures"
+  spec.homepage      = "https://github.com/ElliottAYoung/Pomona"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: pomona
+version: !ruby/object:Gem::Version
+  version: 0.6.0
+platform: ruby
+authors:
+- ElliottAYoung
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A lightweight solution for creating and managing tree data structures
+email:
+- elliott.a.young@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/pomona.rb
+- lib/pomona/exceptions.rb
+- lib/pomona/extractor.rb
+- lib/pomona/node.rb
+- lib/pomona/pruner.rb
+- lib/pomona/tree.rb
+- lib/pomona/version.rb
+- pomona.gemspec
+homepage: https://github.com/ElliottAYoung/Pomona
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: A lightweight solution for creating and managing tree data structures
+test_files: []
+has_rdoc: