sequel_plus 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright 2009 Michael Lang.  All rights reserved.
+
+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,35 @@
+# sequel_plus
+
+This library starts the collection of plugins and possibly extension I assemble for the Ruby Sequel 
+ORM.  
+
+Currently, it only contains a plugin for Trees to mimic the Rails acts_as_tree plugin.
+
+NOTE:  Authors of other plugins and extensions for Sequel are welcome to contact me for inclusion
+of your plugin and extension to this project.
+
+Released under MIT license.
+
+# For the Impatient
+
+This gem is released to gemcutter.  Rubyforge is not utilized. 
+
+	gem install sequel_plus
+
+And then, in your project:
+
+	require 'sequel'
+	require 'sequel_plus'
+
+	class Node < Sequel::Model
+		plugin :tree
+	end
+  
+# Note on Patches/Pull Requests
+ 
+* First release!
+
+# Copyright
+
+Copyright 2009 Michael Lang.  All rights reserved.
+Released under MIT license.  See LICENSE for details.

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "sequel_plus"
+    gem.summary = "provides plugins and extensions for Sequel"
+    gem.description = "Provides plugins and extensions for Sequel"
+    gem.email = "mwlang@cybrains.net"
+    gem.homepage = "http://github.com/mwlang/sequel_plus"
+    gem.authors = ["Michael Lang"]
+    gem.files = [
+       "LICENSE",
+       "README.md",
+       "Rakefile",
+       "lib/sequel_plus.rb",
+       "lib/**/*",
+       "test/*"
+    ]
+    
+    gem.add_development_dependency "bacon", ">= 1.0.0"
+    gem.add_dependency "sequel", ">= 3.0.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "sequel_plus #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/sequel_plus/sequel_tree.rb

@@ -0,0 +1,90 @@
+module Sequel
+  module Plugins
+    # The Tree plugin adds additional associations and methods that allow you to 
+    # treat a Model as a tree.  
+    #
+    # A column for holding the parent key is required and is :parent_id by default.  
+    # This may be overridden by passing column name via :key
+    #
+    # Optionally, a column to control order of nodes returned can be specified
+    # by passing column name via :order.
+    # 
+    # Examples:
+    #
+    #   class Node < Sequel::Model
+    #     plugin :tree
+    #   end
+    #  
+    #   class OrderedNode < Sequel::Model(:nodes)
+    #     plugin :tree, :order => :position
+    #   end
+    #
+    module Tree
+      def self.configure(model, opts = {})
+        model.instance_eval do 
+          @parent_column = opts[:key] || :parent_id
+          @order_column = opts[:order]
+          
+          many_to_one :parent, :class => self, :key => @parent_column
+          one_to_many :children, :class => self, :key => @parent_column, :order => @order_column
+        end
+      end
+      
+      module ClassMethods
+        # Returns list of all root nodes (those with no parent nodes).
+        #
+        #   TreeClass.roots # => [root1, root2]
+        def roots
+          roots_dataset.all
+        end
+        
+        # Returns the dataset for retrieval of all root nodes
+        #
+        #   TreeClass.roots_dataset => Sequel#Dataset
+        def roots_dataset
+          filter(@parent_column => nil).order(@order_column)
+        end
+      end
+      
+      module InstanceMethods
+        # Returns list of ancestors, starting from parent until root.
+        #
+        #   subchild1.ancestors # => [child1, root]
+        def ancestors
+          node, nodes = self, []
+          nodes << node = node.parent while node.parent
+          nodes
+        end
+
+        # Returns list of ancestors, starting from parent until root.
+        #
+        #   subchild1.ancestors # => [child1, root]
+        def descendants
+          nodes = self.children
+          self.children.each{|c| nodes + c.descendants}
+          nodes 
+        end
+
+        # Returns the root node of the tree that this node descends from
+        # This node is returned if it is a root node itself.
+        def root
+          ancestors.last || self
+        end
+
+        # Returns all siblings of the current node.
+        #
+        #   subchild1.siblings # => [subchild2]
+        def siblings
+          self_and_siblings - [self]
+        end
+
+        # Returns all siblings and a reference to the current node.
+        #
+        #   subchild1.self_and_siblings # => [subchild1, subchild2]
+        def self_and_siblings
+          parent ? parent.children : model.roots
+        end
+      end
+    end
+  end
+end

data/lib/sequel_plus.rb

@@ -0,0 +1 @@
+require 'sequel_plus/sequel_tree'

data/test/helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'sequel'
+require 'bacon'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'sequel_plus'

data/test/test_sequel_tree.rb

@@ -0,0 +1,157 @@
+require 'helper'
+
+DB = Sequel.sqlite
+
+DB.create_table :nodes do
+  primary_key :id
+  String :name
+  Integer :parent_id
+  Integer :position 
+end
+
+NODES = [
+  {:id => 1, :name => 'one', :parent_id => nil, :position => 1}, 
+  {:id => 2, :name => 'two', :parent_id => nil, :position => 2}, 
+  {:id => 3, :name => 'three', :parent_id => nil, :position => 3}, 
+  {:id => 4, :name => "two.one", :parent_id => 2, :position => 1},
+  {:id => 5, :name => "two.two", :parent_id => 2, :position => 2},
+  {:id => 6, :name => "two.two.one", :parent_id => 5, :position => 1},
+  {:id => 7, :name => "one.two", :parent_id => 1, :position => 2},
+  {:id => 8, :name => "one.one", :parent_id => 1, :position => 1},
+  {:id => 9, :name => "five", :parent_id => nil, :position => 5},
+  {:id => 10, :name => "four", :parent_id => nil, :position => 4},
+  {:id => 11, :name => "five.one", :parent_id => 9, :position => 1},
+  {:id => 12, :name => "two.three", :parent_id => 2, :position => 3},
+]
+
+DB.create_table :lorems do
+  primary_key :id
+  String :name
+  Integer :ipsum_id
+  Integer :neque
+end
+
+LOREMS = [
+  {:id => 1, :name => 'Lorem', :ipsum_id => nil, :neque => 4}, 
+  {:id => 2, :name => 'Ipsum', :ipsum_id => nil, :neque => 3}, 
+  {:id => 4, :name => "Neque", :ipsum_id => 2, :neque => 2},
+  {:id => 5, :name => "Porro", :ipsum_id => 2, :neque => 1},
+]  
+
+NODES.each{|node| DB[:nodes].insert(node)}
+LOREMS.each{|lorem| DB[:lorems].insert(lorem)}
+
+class Node < Sequel::Model
+  plugin :tree
+end
+
+class NaturalNode < Sequel::Model(:nodes)
+  plugin :tree
+end
+
+class OrderedNode < Sequel::Model(:nodes)
+  plugin :tree, :order => :position
+end
+
+class Lorem < Sequel::Model
+  plugin :tree, :key => :ipsum_id, :order => :neque
+end
+
+describe Sequel::Plugins::Tree do
+  
+  it "should instantiate" do
+    Node.all.size.should == 12
+  end
+  
+  it "should find top level nodes" do
+    Node.roots.count.should == 5
+  end
+  
+  it "should find all descendants of a node" do 
+    two = Node.find(:id => 2)
+    two.name.should == "two"
+    two.descendants.map{|m| m[:id]}.should == [4, 5, 12]
+  end
+  
+  it "should find all ancestors of a node" do 
+    twotwoone = Node.find(:id => 6)
+    twotwoone.name.should == "two.two.one"
+    twotwoone.ancestors.map{|m| m[:id]}.should == [5, 2]
+  end
+    
+  it "should find all siblings of a node, excepting self" do 
+    twoone = Node.find(:id => 4)
+    twoone.name.should == "two.one"
+    twoone.siblings.map{|m| m[:id]}.should == [5, 12]
+  end
+  
+  it "should find all siblings of a node, including self" do 
+    twoone = Node.find(:id => 4)
+    twoone.name.should == "two.one"
+    twoone.self_and_siblings.map{|m| m[:id]}.should == [4, 5, 12]
+  end
+  
+  it "should find siblings for root nodes" do 
+    three = Node.find(:id => 3)
+    three.name.should == "three"
+    three.self_and_siblings.map{|m| m[:id]}.should == [1, 2, 3, 9, 10]
+  end
+  
+  it "should find correct root for a node" do
+    twotwoone = Node.find(:id => 6)
+    twotwoone.name.should == "two.two.one"
+    twotwoone.root[:id].should == 2
+    
+    three = Node.find(:id => 3)
+    three.name.should == "three"
+    three.root[:id].should == 3
+    
+    fiveone = Node.find(:id => 11)
+    fiveone.name.should == "five.one"
+    fiveone.root[:id].should == 9
+  end
+  
+  describe "Nodes in natural database order" do
+    it "iterate top-level nodes in natural database order" do
+      NaturalNode.roots.count.should == 5
+      NaturalNode.roots.inject([]){|ids, p| ids << p.position}.should == [1, 2, 3, 5, 4]
+    end
+    
+    it "should have children" do
+      one = NaturalNode.find(:id => 1)
+      one.name.should == "one"
+      one.children.count.should == 2
+    end
+    
+    it "children should be natural database order" do 
+      one = NaturalNode.find(:id => 1)
+      one.name.should == "one"
+      one.children.map{|m| m[:position]}.should == [2, 1]
+    end
+  end
+
+  describe "Nodes in specified order" do
+    it "iterate top-level nodes in order by position" do
+      OrderedNode.roots.count.should == 5
+      OrderedNode.roots.inject([]){|ids, p| ids << p.position}.should == [1, 2, 3, 4, 5]
+    end
+
+    it "children should be in specified order" do 
+      one = OrderedNode.find(:id => 1)
+      one.name.should == "one"
+      one.children.map{|m| m[:position]}.should == [1, 2]
+    end
+  end
+  
+  describe "Lorems in specified order" do
+    it "iterate top-level nodes in order by position" do
+      Lorem.roots.count.should == 2
+      Lorem.roots.inject([]){|ids, p| ids << p.neque}.should == [3, 4]
+    end
+
+    it "children should be specified order" do 
+      one = Lorem.find(:id => 2)
+      one.children.map{|m| m[:neque]}.should == [1, 2]
+    end
+  end
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_plus
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Michael Lang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-12 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bacon
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.0.0
+    version: 
+description: Provides plugins and extensions for Sequel
+email: mwlang@cybrains.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- LICENSE
+- README.md
+- Rakefile
+- lib/sequel_plus.rb
+- lib/sequel_plus/sequel_tree.rb
+- test/helper.rb
+- test/test_sequel_tree.rb
+has_rdoc: true
+homepage: http://github.com/mwlang/sequel_plus
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: provides plugins and extensions for Sequel
+test_files: 
+- test/helper.rb
+- test/test_sequel_tree.rb