acts_as_graph_vertex 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c77bf69f9ed79801c8a55148fc1448a4af1f9b27
+  data.tar.gz: d38f2b2cd7290bf95e61e5fe743cf97aa099b248
+SHA512:
+  metadata.gz: a765c73435a316e9b14aedfd86b00b70c43bb4676f4f90ddd2a5f360c76ce6967da0f87652ddc5d42d3a5d4132623b138fa4d6e0cf55a6ff2b6239669f0d1115
+  data.tar.gz: 561414bae337114e3883d6f45d1a5761b5270dc38f04504a966b54b8f88001ba3056699c733d0acee5d2fa404704c665e049473a57e2d2df041278d18e0c0830

data/README.md

@@ -0,0 +1,80 @@
+# acts_as_graph_vertex [![Build Status](https://travis-ci.org/nathankleyn/acts_as_graph_vertex.svg?branch=master)](https://travis-ci.org/nathankleyn/acts_as_graph_vertex) [![Coverage Status](https://coveralls.io/repos/nathankleyn/acts_as_graph_vertex/badge.png?branch=master)](https://coveralls.io/r/nathankleyn/acts_as_graph_vertex?branch=master)
+
+Simple mixin for adding graph like functions (parents, children, traversal, etc) to any class.
+
+## Installing
+
+You can install this gem via RubyGems:
+
+```sh
+gem install acts_as_graph_vertex
+```
+
+## Using
+
+Sometimes it's useful to be able to add graph like functionality to existing classes you have. This is where acts_as_graph_vertex comes in! Simply mixin this module, and you'll get basic directed acyclic graph (DAG) functionality for free:
+
+```ruby
+require 'acts_as_graph_vertex'
+
+class MyAmazingClass
+  include ActsAsGraphVertex
+end
+```
+
+And now you can use the functions:
+
+```ruby
+parent = MyAmazingClass.new
+child1 = MyAmazingClass.new
+child2 = MyAmazingClass.new
+child3 = MyAmazingClass.new
+
+# The following calls will create a DAG like the following:
+#
+#            --> child1 --
+#          /               \
+# parent--                   --> child3
+#          \               /
+#            --> child2 --
+
+parent.add_child(child1)
+child2.add_parent(child1)
+child3.add_parent(child1)
+child3.add_parent(child2)
+```
+
+You can now traverse the graph from any of these vertices:
+
+```ruby
+parent.children # => [child1, child2]
+parent.all_children # => [child1, child2, child3]
+child3.parents # => [child1, child2]
+child3.all_parents # => [child1, child2, parent]
+```
+
+Note that this mixin does not currently prevent or handle cyclic dependencies; it's intended to be simple rather than exhaustive. If cycle detection is required, using something as a layer over this mixin such as Tarjan's algorithm for finding strongly connected components of a graph is recommended. Tarjan's algorithm is bundled with the Ruby standard library as `TSort` (despite the naming, this class does not provide topographic sorting).
+
+## License
+
+The MIT License (MIT)
+
+Copyright (c) 2015 Nathan Kleyn
+
+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/lib/acts_as_graph_vertex.rb

@@ -0,0 +1,75 @@
+# A mixin module enabling classes to have parents and children. It provides
+# convenience methods for determining dependencies, and depdenants.
+#
+# Note that in contrast to a tree, this graph module allows multiple parents.
+module ActsAsGraphVertex
+  # The self.included idiom. This is described in great detail in a
+  # fantastic blog post here:
+  #
+  # http://www.railstips.org/blog/archives/2009/05/15/include-vs-extend-in-ruby/
+  #
+  # Basically, this idiom allows us to add both instance *and* class methods
+  # to the class that is mixing this module into itself without forcing them
+  # to call extend and include for this mixin. You'll see this idiom everywhere
+  # in the Ruby/Rails world, so we use it too.
+  def self.included(cls)
+    cls.extend(ClassMethods)
+  end
+
+  # Common methods inherited by all classes
+  module ClassMethods
+    attr_writer :parents, :children
+  end
+
+  # Public: The parents linked to this instance.
+  #
+  # Returns an Array of Objects.
+  def parents
+    @parents ||= []
+  end
+
+  # Public: The children linked to this instance.
+  #
+  # Returns an Array of Objects.
+  def children
+    @children ||= []
+  end
+
+  # Public: Add a vertex to the parents linked to this instance. Will automatically add as a child of the given parent
+  # if the given parent also mixes in the graph functionality.
+  #
+  # vertex - The Object to add as a parent.
+  # add_child - Whether to add this item as a child of the given parent.
+  def add_parent(vertex, add_child = true)
+    return if parents.include?(vertex)
+    vertex.add_child(self, false) if add_child && vertex.respond_to?(:add_child)
+    parents << vertex
+  end
+
+  # Public: Add a vertex to the children linked to this instance. Will automatically add as a parent of the given child
+  # if the given child also mixes in the graph functionality.
+  #
+  # vertex - The Object to add as a child.
+  # add_parent - Whether to add this item as a parent of the given child.
+  def add_child(vertex, add_parent = true)
+    return if children.include?(vertex)
+    vertex.add_parent(self, false) if add_parent && vertex.respond_to?(:add_parent)
+    children << vertex
+  end
+
+  # Public: Convenience method to return all of the parents from this vertex in
+  # the tree upwards to the root of the tree.
+  #
+  # Returns an Array of parent Objects.
+  def all_parents
+    ((parents + parents.map(&:all_parents)).flatten).uniq
+  end
+
+  # Public: Convenience method to return all of the children from this vertex in
+  # the tree downwards to the leaves of the tree.
+  #
+  # Returns an Array of child Objects.
+  def all_children
+    (children + children.map(&:all_children).flatten).uniq
+  end
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_graph_vertex
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Nathan Kleyn
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: filewatcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.28'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: See https://github.com/nathankleyn/acts_as_graph_vertex for more information!
+email:
+- nathan@nathankleyn.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/acts_as_graph_vertex.rb
+homepage: https://github.com/nathankleyn/acts_as_graph_vertex
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Simple mixin for adding graph like functions (parents, children, traversal,
+  etc) to any class.
+test_files: []