edge 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/edge/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jack Christensen
+
+MIT License
+
+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,91 @@
+# Edge
+
+Edge provides graph functionality to ActiveRecord using recursive common table
+expressions. It has only been tested with PostgreSQL, but it uses Arel for
+SQL generation so it should work with any database and adapter that support
+recursive CTEs.
+
+acts_as_forest enables an entire tree or even an entire forest of trees to
+be loaded in a single query. All parent and children associations are
+preloaded.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'edge'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edge
+
+## Usage
+
+acts_as_forest adds tree / multi-tree functionality. All it needs a parent_id
+column. This can be overridden by passing a :foreign_key option to
+acts_as_forest.
+
+    class Location < ActiveRecord::Base
+      acts_as_forest :order => "name"
+    end
+    
+    usa = Location.create! :name => "USA"
+    illinois = usa.children.create! :name => "Illinois"
+    chicago = illinois.children.create! :name => "Chicago"
+    indiana = usa.children.create! :name => "Indiana"
+    canada = Location.create! :name => "Canada"
+    british_columbia = canada.children.create! :name => "British Columbia"
+    
+    Location.root.all # [usa, canada]
+    Location.find_forest # [usa, canada] with all children and parents preloaded
+    Location.find_tree usa.id # load a single tree.
+
+## Benchmarks
+
+Edge includes a performance benchmarks. You can create test forests with a
+configurable number of trees, depth, number of children per node, and
+size of payload per node.
+
+    jack@moya:~/work/edge$ ruby -I lib -I bench bench/forest_find.rb --help
+    Usage: forest_find [options]
+        -t, --trees NUM                  Number of trees to create
+        -d, --depth NUM                  Depth of trees
+        -c, --children NUM               Number of children per node
+        -p, --payload NUM                Characters of payload per node
+
+Even on slower machines entire trees can be loaded quickly.
+        
+    jack@moya:~/work/edge$ ruby -I lib -I bench bench/forest_find.rb
+    Trees: 50
+    Depth: 3
+    Children per node: 10
+    Payload characters per node: 16
+    Descendants per tree: 110
+    Total records: 5550
+                                                   user     system      total        real
+    Load entire forest 10 times                4.260000   0.010000   4.270000 (  4.422442)
+    Load one tree 100 times                    0.830000   0.040000   0.870000 (  0.984642)
+
+### Running the benchmarks
+    
+1. Create a database such as edge_bench.
+2. Configure bench/database.yml to connect to it.
+3. Load bench/database_structure.sql into your bench database.
+4. Run benchmark scripts from root of gem directory (remember to pass ruby
+   the include paths for lib and bench)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+MIT

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bench/benchmark_helper.rb

@@ -0,0 +1,19 @@
+require 'edge'
+require 'benchmark'
+require 'securerandom'
+require 'optparse'
+
+database_config = YAML.load_file(File.expand_path("../database.yml", __FILE__))
+ActiveRecord::Base.establish_connection database_config["bench"]
+
+class ActsAsForestRecord < ActiveRecord::Base
+  acts_as_forest
+end
+
+def clean_database
+  ActsAsForestRecord.delete_all
+end
+
+def vacuum_analyze
+  ActiveRecord::Base.connection.execute "VACUUM ANALYZE acts_as_forest_records"
+end

data/bench/database.yml

@@ -0,0 +1,4 @@
+bench:
+  adapter: postgresql
+  encoding: unicode
+  database: edge_bench

data/bench/database_structure.sql

@@ -0,0 +1,9 @@
+DROP TABLE IF EXISTS acts_as_forest_records;
+
+CREATE TABLE acts_as_forest_records(
+  id serial PRIMARY KEY,
+  parent_id integer REFERENCES acts_as_forest_records,
+  payload varchar NOT NULL
+);
+
+CREATE INDEX ON acts_as_forest_records (parent_id);

data/bench/forest_find.rb

@@ -0,0 +1,71 @@
+require 'benchmark_helper'
+
+options = {}
+optparse = OptionParser.new do |opts|
+  options[:num_trees] = 50
+  opts.on '-t NUM', '--trees NUM', Integer, 'Number of trees to create' do |n|
+    options[:num_trees] = n
+  end
+  
+  options[:depth] = 3
+  opts.on '-d NUM', '--depth NUM', Integer, 'Depth of trees' do |n|
+    options[:depth] = n
+  end
+  
+  options[:num_children] = 10
+  opts.on '-c NUM', '--children NUM', Integer, 'Number of children per node' do |n|
+    options[:num_children] = n
+  end
+  
+  options[:payload_size] = 16
+  opts.on '-p NUM', '--payload NUM', Integer, 'Characters of payload per node' do |n|
+    options[:payload_size] = n
+  end
+end
+
+optparse.parse!
+
+NUM_TREES = options[:num_trees]
+DEPTH = options[:depth]
+NUM_CHILDREN = options[:num_children]
+PAYLOAD_SIZE = options[:payload_size]
+
+
+def create_forest_tree(current_depth = 1, parent = nil)
+  node = ActsAsForestRecord.create! :parent => parent, :payload => "z" * PAYLOAD_SIZE
+  unless current_depth == DEPTH
+    NUM_CHILDREN.times { create_forest_tree current_depth + 1, node }
+  end
+  node
+end
+
+clean_database
+ActsAsForestRecord.transaction do
+  NUM_TREES.times { create_forest_tree }
+end
+vacuum_analyze
+
+puts "Trees: #{NUM_TREES}"
+puts "Depth: #{DEPTH}" 
+puts "Children per node: #{NUM_CHILDREN}"
+puts "Payload characters per node: #{PAYLOAD_SIZE}"
+puts "Descendants per tree: #{ActsAsForestRecord.find_tree(ActsAsForestRecord.root.first.id).descendants.size}"
+puts "Total records: #{ActsAsForestRecord.count}"
+
+
+Benchmark.bm(40) do |x|
+  load_entire_forest_times = 10
+  x.report("Load entire forest #{load_entire_forest_times} times") do
+    load_entire_forest_times.times do
+      ActsAsForestRecord.find_forest
+    end
+  end
+  
+  load_one_tree_times = 100
+  first_tree_id = ActsAsForestRecord.root.first.id
+  x.report("Load one tree #{load_one_tree_times} times") do
+    load_one_tree_times.times do
+      ActsAsForestRecord.find_tree first_tree_id
+    end
+  end
+end

data/edge.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/edge/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jack Christensen"]
+  gem.email         = ["jack@jackchristensen.com"]
+  gem.description   = %q{Graph functionality for ActiveRecord}
+  gem.summary       = %q{Graph functionality for ActiveRecord. Provides tree/forest modeling structure that can load entire trees in a single query.}
+  gem.homepage      = "https://github.com/JackC/edge"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "edge"
+  gem.require_paths = ["lib"]
+  gem.version       = Edge::VERSION
+  
+  gem.add_dependency 'activerecord', ">= 3.2.0"
+  
+  gem.add_development_dependency 'pg'
+  gem.add_development_dependency 'rspec', "~> 2.8.0"
+  gem.add_development_dependency 'guard', ">= 0.10.0"
+  gem.add_development_dependency 'guard-rspec', ">= 0.6.0"   
+end

data/lib/edge.rb

@@ -0,0 +1,8 @@
+require 'active_record'
+
+require "edge/forest"
+require "edge/version"
+
+module Edge
+  # Your code goes here...
+end

data/lib/edge/forest.rb

@@ -0,0 +1,146 @@
+module Edge
+  module Forest
+    # acts_as_forest models a tree/multi-tree structure.
+    module ClassMethods
+      # options:
+      #
+      # * foreign_key - column name to use for parent foreign_key (default: parent_id)
+      # * order - how to order children (default: none)
+      def acts_as_forest(options={})
+        options.assert_valid_keys :foreign_key, :order
+        
+        class_attribute :forest_foreign_key
+        self.forest_foreign_key = options[:foreign_key] || "parent_id"
+        
+        class_attribute :forest_order
+        self.forest_order = options[:order] || nil
+                
+        common_options = {
+          :class_name => self,
+          :foreign_key => forest_foreign_key
+        }
+      
+        belongs_to :parent, common_options
+          
+        children_options = if forest_order
+          common_options.merge(:order => forest_order)
+        else
+          common_options
+        end
+        
+        has_many :children, children_options
+        
+        scope :root, where(forest_foreign_key => nil)
+        
+        include Edge::Forest::InstanceMethods
+        
+        # Finds entire forest and preloads all associations. It can be used at
+        # the end of an ActiveRecord finder chain.
+        #
+        # Example:
+        #    # loads all locations
+        #    Location.find_forest
+        #
+        #    # loads all nodes with matching names and all there descendants
+        #    Category.where(:name => %w{clothing books electronics}).find_forest
+        def find_forest
+          all_nodes = Arel::Table.new(:all_nodes)
+              
+          original_term = (current_scope || scoped).arel
+          iterated_term = Arel::SelectManager.new Arel::Table.engine
+          iterated_term.from(arel_table)
+            .project(arel_table.columns)
+            .join(all_nodes)
+            .on(arel_table[forest_foreign_key].eq all_nodes[:id])
+          
+          union = original_term.union(iterated_term)
+          
+          as_statement = Arel::Nodes::As.new all_nodes, union
+          
+          manager = Arel::SelectManager.new Arel::Table.engine
+          manager.with(:recursive, as_statement).from(all_nodes).project(Arel.star)
+          manager.order(forest_order) if forest_order
+          
+          records = find_by_sql manager.to_sql
+
+          records_by_id = records.each_with_object({}) { |r, h| h[r.id] = r }
+
+          # Set all children associations to an empty array
+          records.each do |r|
+            children_association = r.association(:children)
+            children_association.target = []
+          end
+
+          top_level_records = []
+          
+          records.each do |r|
+            parent = records_by_id[r[forest_foreign_key]]
+            if parent
+              r.association(:parent).target = parent
+              parent.association(:children).target.push(r)
+            else
+              top_level_records.push(r)
+            end
+          end
+          
+          top_level_records
+        end
+        
+        # Finds an a tree or trees by id.
+        #
+        # If any requested ids are not found it raises
+        # ActiveRecord::RecordNotFound.
+        def find_tree(id_or_ids)
+          trees = where(:id => id_or_ids).find_forest
+          if id_or_ids.kind_of?(Array)
+            raise ActiveRecord::RecordNotFound unless trees.size == id_or_ids.size
+            trees
+          else
+            raise ActiveRecord::RecordNotFound if trees.empty?
+            trees.first
+          end
+        end
+      end      
+    end
+    
+    module InstanceMethods
+      # Returns the root of this node. If this node is root returns self.
+      def root
+        parent ? parent.root : self
+      end
+      
+      # Returns true is this node is a root or false otherwise
+      def root?
+        !parent_id
+      end
+      
+      # Returns all sibling nodes (nodes that have the same parent). If this
+      # node is a root node it returns an empty array.      
+      def siblings
+        parent ? parent.children - [self] : []
+      end
+      
+      # Returns all ancestors ordered by nearest ancestors first.      
+      def ancestors
+        _ancestors = []
+        node = self
+        while(node = node.parent)
+          _ancestors.push(node)
+        end
+        
+        _ancestors
+      end
+      
+      # Returns all descendants
+      def descendants
+        if children.present?
+          children + children.map(&:descendants).flatten
+        else
+          []
+        end    
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.extend Edge::Forest::ClassMethods

data/lib/edge/version.rb

@@ -0,0 +1,3 @@
+module Edge
+  VERSION = "0.1.0"
+end

data/spec/database.yml

@@ -0,0 +1,4 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: edge_test

data/spec/database_structure.sql

@@ -0,0 +1,7 @@
+DROP TABLE IF EXISTS locations;
+
+CREATE TABLE locations(
+  id serial PRIMARY KEY,
+  parent_id integer REFERENCES locations,
+  name varchar NOT NULL
+);

data/spec/forest_spec.rb

@@ -0,0 +1,188 @@
+require 'spec_helper'
+
+class Location < ActiveRecord::Base
+  acts_as_forest :order => "name"
+end
+
+describe "Edge::Forest" do
+  let!(:usa) { Location.create! :name => "USA" }
+  let!(:illinois) { Location.create! :parent => usa, :name => "Illinois" }
+  let!(:chicago) { Location.create! :parent => illinois, :name => "Chicago" }
+  let!(:indiana) { Location.create! :parent => usa, :name => "Indiana" }  
+  let!(:canada) { Location.create! :name => "Canada" }
+  let!(:british_columbia) { Location.create! :parent => canada, :name => "British Columbia" }
+  
+  describe "root?" do
+    context "of root node" do
+      it "should be true" do
+        usa.root?.should == true
+      end
+    end
+    
+    context "of child node" do
+      it "should be false" do
+        illinois.root?.should == false
+      end
+    end
+    
+    context "of leaf node" do
+      it "should be root node" do
+        chicago.root?.should == false
+      end
+    end    
+  end
+
+  describe "root" do
+    context "of root node" do
+      it "should be self" do
+        usa.root.should == usa
+      end
+    end
+    
+    context "of child node" do
+      it "should be root node" do
+        illinois.root.should == usa
+      end
+    end
+    
+    context "of leaf node" do
+      it "should be root node" do
+        chicago.root.should == usa
+      end
+    end
+  end
+  
+  describe "parent" do
+    context "of root node" do
+      it "should be nil" do
+        usa.parent.should == nil
+      end
+    end
+    
+    context "of child node" do
+      it "should be parent" do
+        illinois.parent.should == usa
+      end
+    end
+    
+    context "of leaf node" do
+      it "should be parent" do
+        chicago.parent.should == illinois
+      end
+    end
+  end
+  
+  describe "ancestors" do
+    context "of root node" do
+      it "should be empty" do
+        usa.ancestors.should be_empty
+      end
+    end
+    
+    context "of leaf node" do
+      it "should be ancestors ordered by ascending distance" do
+        chicago.ancestors.should == [illinois, usa]
+      end
+    end
+  end
+  
+  describe "siblings" do
+    context "of root node" do
+      it "should be empty" do
+        usa.siblings.should be_empty
+      end
+    end
+    
+    context "of child node" do
+      it "should be other children of parent" do
+        illinois.siblings.should include(indiana)
+      end
+    end
+  end
+  
+  describe "children" do
+    it "should be children" do
+      usa.children.should include(illinois, indiana)
+    end
+    
+    it "should be ordered" do
+      alabama = Location.create! :parent => usa, :name => "Alabama"
+      usa.children.should == [alabama, illinois, indiana]
+    end
+    
+    context "of leaf" do
+      it "should be empty" do
+        chicago.children.should be_empty
+      end
+    end
+  end
+  
+  describe "descendants" do
+    it "should be all descendants" do
+      usa.descendants.should include(illinois, indiana, chicago)
+    end
+    
+    context "of leaf" do
+      it "should be empty" do
+        chicago.descendants.should be_empty
+      end
+    end
+  end
+  
+  describe "root scope" do
+    it "returns only root nodes" do
+      Location.root.all.should include(usa, canada)
+    end
+  end
+  
+  describe "find_forest" do
+    it "preloads all parents and children" do
+      forest = Location.find_forest
+
+      Location.with_scope(
+        :find => Location.where("purposely fail if any Location find happens here")
+      ) do
+        forest.each do |tree|
+          tree.descendants.each do |node|
+            node.parent.should be
+            node.children.should be_kind_of(Array)
+          end
+        end
+      end
+    end
+    
+    it "works when scoped" do
+      forest = Location.where(:name => "USA").find_forest
+      forest.should include(usa)
+    end
+    
+    it "preloads children in proper order" do
+      alabama = Location.create! :parent => usa, :name => "Alabama"
+      forest = Location.find_forest
+      tree = forest.find { |l| l.id == usa.id }
+      tree.children.should == [alabama, illinois, indiana]
+    end
+  end
+  
+  describe "find_tree" do
+    it "finds by id" do
+      tree = Location.find_tree usa.id
+      tree.should == usa
+    end
+    
+    it "finds multiple trees by id" do
+      trees = Location.find_tree [indiana.id, illinois.id]
+      trees.should include(indiana, illinois)
+    end
+    
+    it "raises ActiveRecord::RecordNotFound when id is not found" do
+      expect{Location.find_tree -1}.to raise_error(ActiveRecord::RecordNotFound)
+    end
+    
+    it "raises ActiveRecord::RecordNotFound when not all ids are not found" do
+      expect{Location.find_tree [indiana.id, -1]}.to raise_error(ActiveRecord::RecordNotFound)
+    end
+    
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,41 @@
+require 'edge'
+require 'yaml'
+
+require 'rspec'
+
+database_config = YAML.load_file(File.expand_path("../database.yml", __FILE__))
+ActiveRecord::Base.establish_connection database_config["test"]
+
+
+
+# class HstoreRecord < ActiveRecord::Base
+  # serialize :properties, Surus::Hstore::Serializer.new
+# end
+
+# class TextArrayRecord < ActiveRecord::Base
+  # serialize :texts, Surus::Array::TextSerializer.new
+# end
+
+# class IntegerArrayRecord < ActiveRecord::Base
+  # serialize :integers, Surus::Array::IntegerSerializer.new
+# end
+
+# class FloatArrayRecord < ActiveRecord::Base
+  # serialize :floats, Surus::Array::FloatSerializer.new
+# end
+
+# class DecimalArrayRecord < ActiveRecord::Base
+  # serialize :decimals, Surus::Array::DecimalSerializer.new
+# end
+
+
+
+RSpec.configure do |config|
+  config.around :disable_transactions => nil do |example|
+    ActiveRecord::Base.transaction do
+      example.call
+      raise ActiveRecord::Rollback
+    end
+  end
+end
+

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: edge
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jack Christensen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &14555680 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *14555680
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: &14555260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *14555260
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &14554720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *14554720
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &14554220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *14554220
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &14553760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *14553760
+description: Graph functionality for ActiveRecord
+email:
+- jack@jackchristensen.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bench/benchmark_helper.rb
+- bench/database.yml
+- bench/database_structure.sql
+- bench/forest_find.rb
+- edge.gemspec
+- lib/edge.rb
+- lib/edge/forest.rb
+- lib/edge/version.rb
+- spec/database.yml
+- spec/database_structure.sql
+- spec/forest_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/JackC/edge
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Graph functionality for ActiveRecord. Provides tree/forest modeling structure
+  that can load entire trees in a single query.
+test_files: []