dagnabit 2.2.6 → 3.0.0

data/lib/dagnabit/vertex/activation.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), %w(.. vertex))
+
+module Dagnabit::Vertex
+  ##
+  # This module provides a method to set up all of the Vertex modules in a
+  # class.
+  module Activation
+    ##
+    # Sets up dagnabit's vertex modules in a vertex class.
+    def acts_as_vertex
+      extend Associations
+      extend Connectivity
+      extend Settings
+
+      include Bonding
+      include Neighbors
+    end
+  end
+end

data/lib/dagnabit/vertex/associations.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), %w(.. vertex))
+
+module Dagnabit::Vertex
+  ##
+  # Associates a vertex with its edges.
+  module Associations
+    include Settings
+
+    ##
+    # An override of {Settings#connected_by} that installs `has_many`
+    # associations named `in_edges` and `out_edges` on a vertex model.
+    #
+    # `in_edges` is the collection of edges that flow _into_ a vertex;
+    # `out_edges` is the collection of edges that flow _out of_ a vertex.
+    #
+    # @return [void]
+    def connected_by(*args)
+      super
+
+      has_many :in_edges,  :class_name => edge_model_name, :foreign_key => 'child_id',  :dependent => :destroy
+      has_many :out_edges, :class_name => edge_model_name, :foreign_key => 'parent_id', :dependent => :destroy
+    end
+  end
+end

data/lib/dagnabit/vertex/bonding.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), %w(.. vertex))
+
+module Dagnabit::Vertex
+  ##
+  # Contains methods for bonding a vertex to a graph.
+  module Bonding
+    ##
+    # Calculates a bond for this vertex (the method receiver) to all source
+    # vertices of `graph`.
+    #
+    # This method expects the receiver to have been persisted, and will raise
+    # `RuntimeError` if that is not the case.
+    #
+    # Persisted edges that already connect the receiver vertex to source
+    # vertices in `graph` will not be duplicated.  Unpersisted edges connecting
+    # the receiver to a source in `graph` _will_ be duplicated, so it is
+    # advised that you ensure that all vertices and edges in `graph` have been
+    # persisted before using {#bond_for}.
+    #
+    # This method requires the existence of an edge model; see
+    # {Settings#edge_model} and {Settings#edge_model_name=}.  If an edge model
+    # has not been set, this method raises `RuntimeError`.
+    #
+    # Edges instantiated by `bond_for` are not automatically saved.
+    #
+    # @param [Dagnabit::Graph] graph the graph to bond
+    # @return [Array<edge_model>] a list of edges that, when saved, will bond the
+    #   vertex to `graph`
+    # @raise [RuntimeError] if an edge model has not been set
+    def bond_for(graph)
+      edge = self.class.edge_model
+
+      raise 'edge_model must be set' unless edge
+      raise "#{self} must be persisted before invoking bond_for" if new_record?
+
+      sources = graph.sources
+      existing = edge.all(:conditions => { :parent_id => id, :child_id => sources.map(&:id) }).map { |e| [e.parent_id, e.child_id] }
+      new = sources.inject([]) { |es, s| es << [id, s.id] }
+
+      (new - existing).map { |p, c| edge.new(:parent_id => p, :child_id => c) }
+    end
+  end
+end

data/lib/dagnabit/vertex/connectivity.rb

@@ -0,0 +1,130 @@
+require File.join(File.dirname(__FILE__), %w(.. vertex))
+
+module Dagnabit::Vertex
+  ##
+  # Methods for checking connectivity between vertices.
+  #
+  # This module is meant to be used by ActiveRecord::Base subclasses.
+  module Connectivity
+    include Settings
+
+    ##
+    # Finds all source vertices of the given `vertices`.  A source vertex is a
+    # vertex that has an indegree of zero.
+    #
+    # The result is the set union of all source vertices of the vertices in
+    # `vertices`.  The ordering of the result is unspecified.
+    #
+    # @param [Array<ActiveRecord::Base>] vertices a list of vertices
+    # @return [Array<ActiveRecord::Base>] a list of source vertices
+    def roots_of(*vertices)
+      ids = vertices.map(&:id)
+
+      find_by_sql([%Q{
+        WITH RECURSIVE roots(id) AS (
+          SELECT #{edge_table}.parent_id FROM #{table_name} INNER JOIN #{edge_table} ON #{edge_table}.child_id = #{table_name}.id WHERE #{table_name}.id IN (?)
+          UNION
+          SELECT #{edge_table}.parent_id FROM roots INNER JOIN #{edge_table} ON #{edge_table}.child_id = roots.id
+        )
+        SELECT
+          *
+        FROM
+          #{table_name}
+        WHERE
+          #{table_name}.id IN (SELECT
+                                roots.id
+                               FROM
+                                roots
+                                LEFT JOIN
+                                #{edge_table} ON roots.id = #{edge_table}.child_id
+                               WHERE #{edge_table}.child_id IS NULL)
+      }, ids])
+    end
+
+    ##
+    # Find all ancestors of the given `vertices`.
+    #
+    # The result is the set union of all ancestors of the vertices in
+    # `vertices`.  The ordering of the result is unspecified.
+    #
+    # @param [Array<ActiveRecord::Base>] vertices a list of vertices
+    # @return [Array<ActiveRecord::Base>] a list of ancestor vertices
+    def ancestors_of(*vertices)
+      ids = vertices.map(&:id)
+
+      find_by_sql([%Q{
+        WITH RECURSIVE ancestors(id) AS (
+          SELECT #{edge_table}.parent_id FROM #{table_name} INNER JOIN #{edge_table} ON #{edge_table}.child_id = #{table_name}.id WHERE #{table_name}.id IN (?)
+          UNION
+          SELECT #{edge_table}.parent_id FROM ancestors INNER JOIN #{edge_table} ON #{edge_table}.child_id = ancestors.id
+        )
+        SELECT * FROM #{table_name} WHERE #{table_name}.id IN (SELECT id FROM ancestors)
+      }, ids])
+    end
+
+    ##
+    # Finds all immediate parents of `vertices`.
+    #
+    # The result is the set union of all immediate parents of the vertices in
+    # `vertices`.  The ordering of the result is unspecified.
+    #
+    # @param [Array<ActiveRecord::Base>] vertices a list of vertices
+    # @return [Array<ActiveRecord::Base>] a list of parent vertices
+    def parents_of(*vertices)
+      ids = vertices.map(&:id)
+
+      find_by_sql([%Q{
+        SELECT
+          *
+        FROM
+          #{table_name}
+        WHERE
+          #{table_name}.id IN
+            (SELECT parent_id FROM #{edge_table} WHERE child_id IN (?))
+      }, ids])
+    end
+
+    ##
+    # Finds all immediate children of `vertices`.
+    #
+    # The result is the set union of all immediate children of the vertices in
+    # `vertices`.  The ordering of the result is unspecified.
+    #
+    # @param [Array<ActiveRecord::Base>] vertices a list of vertices
+    # @return [Array<ActiveRecord::Base>] a list of child vertices
+    def children_of(*vertices)
+      ids = vertices.map(&:id)
+
+      find_by_sql([%Q{
+        SELECT
+          *
+        FROM
+          #{table_name}
+        WHERE
+          #{table_name}.id IN
+            (SELECT child_id FROM #{edge_table} WHERE parent_id IN (?))
+      }, ids])
+    end
+
+    ##
+    # Find all descendants of the given `vertices`.
+    #
+    # The result is the set union of all descendants of the vertices in
+    # `vertices`.  The ordering of the result is unspecified.
+    #
+    # @param [Array<ActiveRecord::Base>] vertices a list of vertices
+    # @return [Array<ActiveRecord::Base>] a list of descendant vertices
+    def descendants_of(*vertices)
+      ids = vertices.map(&:id)
+
+      find_by_sql([%Q{
+        WITH RECURSIVE descendants(id) AS (
+          SELECT #{edge_table}.child_id FROM #{table_name} INNER JOIN #{edge_table} ON #{edge_table}.parent_id = #{table_name}.id WHERE #{table_name}.id IN (?)
+          UNION
+          SELECT #{edge_table}.child_id FROM descendants INNER JOIN #{edge_table} ON #{edge_table}.parent_id = descendants.id
+        )
+        SELECT * FROM #{table_name} WHERE #{table_name}.id IN (SELECT id FROM descendants)
+      }, ids])
+    end
+  end
+end

data/lib/dagnabit/vertex/neighbors.rb

@@ -0,0 +1,50 @@
+require File.join(File.dirname(__FILE__), %w(.. vertex))
+
+module Dagnabit::Vertex
+  ##
+  # Provides per-vertex connectivity queries.
+  #
+  # This module should be included into a class that has been extended by
+  # {Dagnabit::Vertex::Connectivity}.  See this module's spec for example usage.
+  module Neighbors
+    ##
+    # Finds all source vertices of the receiver object.
+    #
+    # @return [Array<ActiveRecord::Base>] a list of source vertices
+    def roots
+      self.class.roots_of(self)
+    end
+
+    ##
+    # Finds all ancestors of the receiver object.
+    #
+    # @return [Array<ActiveRecord::Base>] a list of ancestor vertices
+    def ancestors
+      self.class.ancestors_of(self)
+    end
+
+    ##
+    # Finds all parents of the receiver object.
+    #
+    # @return [Array<ActiveRecord::Base>] a list of parent vertices
+    def parents
+      self.class.parents_of(self)
+    end
+
+    ##
+    # Finds all children of the receiver object.
+    #
+    # @return [Array<ActiveRecord::Base>] a list of child vertices
+    def children
+      self.class.children_of(self)
+    end
+
+    ##
+    # Finds all descendants of the receiver object.
+    #
+    # @return [Array<ActiveRecord::Base>] a list of descendant vertices
+    def descendants
+      self.class.descendants_of(self)
+    end
+  end
+end

data/lib/dagnabit/vertex/settings.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), %w(.. vertex))
+
+module Dagnabit::Vertex
+  ##
+  # Contains parameters that can be customized on a per-vertex-model basis.
+  module Settings
+    ##
+    # The name of this vertex's edge model.
+    #
+    # @return [String]
+    attr_accessor :edge_model_name
+
+    ##
+    # The edge model associated with a vertex model.
+    #
+    # @return [Class] the edge model
+    def edge_model
+      edge_model_name.constantize
+    end
+
+    ##
+    # The edge table used by connectivity queries.  Equivalent to
+    #
+    #     edge_model.table_name
+    #
+    # @return [String] the name of the edge table
+    def edge_table
+      edge_model.table_name
+    end
+
+    ##
+    # Sets the name of the edge model associated with a vertex.
+    #
+    # {#edge_model} uses ActiveSupport's `constantize` method to look up the
+    # model from `edge_model_name`.
+    #
+    # @param [String] edge_model_name the name of the edge model to use
+    # @return [void]
+    def connected_by(edge_model_name)
+      self.edge_model_name = edge_model_name
+    end
+
+    ##
+    # This callback ensures that whenever a class that extends Settings is
+    # inherited, the settings for the superclass are passed to the subclass.
+    #
+    # This callback executes any previously-defined definitions of `inherited`
+    # beforee executing its own code.
+    #
+    # @param [Class] subclass the descendant class
+    def inherited(subclass)
+      super
+      subclass.connected_by(edge_model_name)
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dagnabit
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
-  - 2
-  - 2
-  - 6
-  version: 2.2.6
+  - 3
+  - 0
+  - 0
+  version: 3.0.0
 platform: ruby
 authors: 
 - David Yip
@@ -15,30 +15,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-01 00:00:00 -05:00
-default_executable: dagnabit-test
+date: 2011-01-10 00:00:00 -06:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: activerecord
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 9
+        hash: 3
         segments: 
         - 2
         - 3
-        - 5
-        version: 2.3.5
-  requirement: *id001
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  type: :development
+  name: autotest
   prerelease: false
-  name: jeweler
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,28 +46,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: bluecloth
   prerelease: false
-  name: mocha
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
+        hash: 3
         segments: 
         - 0
-        - 9
-        - 8
-        version: 0.9.8
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
+        version: "0"
   type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: cucumber
   prerelease: false
-  name: pg
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -77,28 +74,26 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rake
   prerelease: false
-  name: shoulda
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - "="
+    - - ">="
       - !ruby/object:Gem::Version 
-        hash: 35
+        hash: 3
         segments: 
-        - 2
-        - 10
-        - 2
-        version: 2.10.2
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
+        - 0
+        version: "0"
   type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rcov
   prerelease: false
-  name: sqlite3-ruby
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -107,26 +102,28 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id006
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
   prerelease: false
-  name: redgreen
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 15
         segments: 
+        - 2
         - 0
-        version: "0"
-  requirement: *id007
-- !ruby/object:Gem::Dependency 
+        - 0
+        version: 2.0.0
   type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: pg
   prerelease: false
-  name: rcov
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -135,12 +132,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id008
-- !ruby/object:Gem::Dependency 
   type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: yard
   prerelease: false
-  name: ZenTest
-  version_requirements: &id009 !ruby/object:Gem::Requirement 
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -149,77 +146,52 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  requirement: *id009
-description: 
-email: yipdw@northwestern.edu
+  type: :development
+  version_requirements: *id009
+description: Directed acyclic graph support library for applications using ActiveRecord on top of PostgreSQL.
+email: 
+- yipdw@member.fsf.org
 executables: 
 - dagnabit-test
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .autotest
-- .document
-- .gitignore
-- Gemfile
-- Gemfile.lock
-- History.txt
+- History.md
+- MIGRATION.md
+- README.md
 - LICENSE
-- README.rdoc
-- Rakefile
-- VERSION.yml
-- bin/dagnabit-test
-- dagnabit.gemspec
-- init.rb
+- lib/dagnabit/edge/activation.rb
+- lib/dagnabit/edge/associations.rb
+- lib/dagnabit/edge/connectivity.rb
+- lib/dagnabit/edge.rb
+- lib/dagnabit/graph.rb
+- lib/dagnabit/migration.rb
+- lib/dagnabit/version.rb
+- lib/dagnabit/vertex/activation.rb
+- lib/dagnabit/vertex/associations.rb
+- lib/dagnabit/vertex/bonding.rb
+- lib/dagnabit/vertex/connectivity.rb
+- lib/dagnabit/vertex/neighbors.rb
+- lib/dagnabit/vertex/settings.rb
+- lib/dagnabit/vertex.rb
 - lib/dagnabit.rb
-- lib/dagnabit/activation.rb
-- lib/dagnabit/link/associations.rb
-- lib/dagnabit/link/class_methods.rb
-- lib/dagnabit/link/configuration.rb
-- lib/dagnabit/link/cycle_prevention.rb
-- lib/dagnabit/link/named_scopes.rb
-- lib/dagnabit/link/transitive_closure_link_model.rb
-- lib/dagnabit/link/transitive_closure_recalculation.rb
-- lib/dagnabit/link/transitive_closure_recalculation/on_create.rb
-- lib/dagnabit/link/transitive_closure_recalculation/on_destroy.rb
-- lib/dagnabit/link/transitive_closure_recalculation/on_update.rb
-- lib/dagnabit/link/transitive_closure_recalculation/utilities.rb
-- lib/dagnabit/link/validations.rb
-- lib/dagnabit/node/associations.rb
-- lib/dagnabit/node/class_methods.rb
-- lib/dagnabit/node/configuration.rb
-- lib/dagnabit/node/neighbors.rb
-- test/connections/native_postgresql/connection.rb
-- test/connections/native_sqlite3/connection.rb
-- test/dagnabit/link/test_associations.rb
-- test/dagnabit/link/test_class_methods.rb
-- test/dagnabit/link/test_configuration.rb
-- test/dagnabit/link/test_cycle_prevention.rb
-- test/dagnabit/link/test_named_scopes.rb
-- test/dagnabit/link/test_transitive_closure_link_model.rb
-- test/dagnabit/link/test_transitive_closure_recalculation.rb
-- test/dagnabit/link/test_validations.rb
-- test/dagnabit/node/test_associations.rb
-- test/dagnabit/node/test_class_methods.rb
-- test/dagnabit/node/test_configuration.rb
-- test/dagnabit/node/test_neighbors.rb
-- test/helper.rb
-- test/models/beta_node.rb
-- test/models/custom_data_link.rb
-- test/models/customized_link.rb
-- test/models/customized_link_node.rb
-- test/models/link.rb
-- test/models/node.rb
-- test/schema/schema.rb
+- bin/dagnabit-test
+- db/connection.rb
+- db/connections/postgresql/connection.rb
+- db/models/edge.rb
+- db/models/other_edge.rb
+- db/models/other_vertex.rb
+- db/models/vertex.rb
+- db/schema.rb
 has_rdoc: true
-homepage: http://gitorious.org/dagnabit/dagnabit
+homepage: http://rubygems.org/gems/dagnabit
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -246,27 +218,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Directed acyclic graph plugin for ActiveRecord
-test_files: 
-- test/connections/native_postgresql/connection.rb
-- test/connections/native_sqlite3/connection.rb
-- test/dagnabit/link/test_associations.rb
-- test/dagnabit/link/test_class_methods.rb
-- test/dagnabit/link/test_configuration.rb
-- test/dagnabit/link/test_cycle_prevention.rb
-- test/dagnabit/link/test_named_scopes.rb
-- test/dagnabit/link/test_transitive_closure_link_model.rb
-- test/dagnabit/link/test_transitive_closure_recalculation.rb
-- test/dagnabit/link/test_validations.rb
-- test/dagnabit/node/test_associations.rb
-- test/dagnabit/node/test_class_methods.rb
-- test/dagnabit/node/test_configuration.rb
-- test/dagnabit/node/test_neighbors.rb
-- test/helper.rb
-- test/models/beta_node.rb
-- test/models/custom_data_link.rb
-- test/models/customized_link.rb
-- test/models/customized_link_node.rb
-- test/models/link.rb
-- test/models/node.rb
-- test/schema/schema.rb
+summary: Directed acyclic graph plugin for ActiveRecord/PostgreSQL
+test_files: []
+