dm-is-tree 0.9.9 → 0.9.10

data/History.txt

@@ -1,3 +1,7 @@
+=== 0.9.10 / 2009-01-19
+
+  * No changes this version
+
 === 0.9.9 / 2009-01-04
 
 * 1 minor enhancement:

data/Manifest.txt

@@ -7,6 +7,9 @@ TODO
 lib/dm-is-tree.rb
 lib/dm-is-tree/is/tree.rb
 lib/dm-is-tree/is/version.rb
+spec/integration/tree_spec.rb
 spec/spec.opts
+spec/spec_helper.rb
+spec/unit/tree_spec.rb
 tasks/install.rb
 tasks/spec.rb

data/README.txt

@@ -1,3 +1,35 @@
 = dm-is-tree
 
 DataMapper plugin allowing the creation of tree structures from data models.
+
+Example:
+
+class Category
+  include DataMapper::Resource
+
+  property :id, Serial
+  property :parent_id, Integer
+  property :name, String
+
+  is :tree, :order => :name
+end
+
+root
+  +- child
+    +- grandchild1
+    +- grandchild2
+
+root = Category.create(:name => "root")
+child = root.children.create(:name => "child")
+grandchild1 = child1.children.create(:name => "grandchild1")
+grandchild2 = child2.children.create(:name => "grandchild2")
+
+root.parent  # => nil
+child.parent  # => root
+root.children  # => [child]
+root.children.first.children.first  # => grandchild1
+Category.first_root  # => root
+Category.roots  # => [root]
+
+Original Author:: Timothy Bennett (http://lanaer.com)
+Current Maintainer:: Garrett Heaver (http://www.linkedin.com/pub/dir/garrett/heaver)

data/TODO

@@ -1,4 +1,4 @@
 TODO
 ====
 
- * dm-is-tree requires specs
+ * dm-is-tree requires more specs

data/lib/dm-is-tree.rb

@@ -1,7 +1,7 @@
 require 'rubygems'
 require 'pathname'
 
-gem 'dm-core', '~>0.9.9'
+gem 'dm-core', '~>0.9.10'
 require 'dm-core'
 
 require Pathname(__FILE__).dirname.expand_path / 'dm-is-tree' / 'is' / 'tree.rb'

data/lib/dm-is-tree/is/tree.rb

@@ -19,25 +19,25 @@ module DataMapper
       #     property :parent_id, Integer
       #     property :name, String
       #
-      #     is :tree :order => "name"
+      #     is :tree, :order => :name
       #   end
       #
-      #   root
-      #     +- child
+      #    root
+      #      +- child
       #          +- grandchild1
       #          +- grandchild2
       #
-      #   root        = Category.create("name" => "root")
-      #   child       = root.children.create("name" => "child")
-      #   grandchild1 = child1.children.create("name" => "grandchild1")
-      #   grandchild2 = child2.children.create("name" => "grandchild2")
+      #   root = Category.create(:name => "root")
+      #   child = root.children.create(:name => "child")
+      #   grandchild1 = child1.children.create(:name => "grandchild1")
+      #   grandchild2 = child2.children.create(:name => "grandchild2")
       #
-      #   root.parent   # => nil
+      #   root.parent  # => nil
       #   child.parent  # => root
-      #   root.children # => [child]
-      #   root.children.first.children.first # => grandchild1
+      #   root.children  # => [child]
+      #   root.children.first.children.first  # => grandchild1
       #   Category.first_root  # => root
-      #   Category.roots       # => [root]
+      #   Category.roots  # => [root]
       #
       # The following instance methods are added:
       # * <tt>children</tt> - Returns all nodes with the current node as their parent, in the order specified by
@@ -52,30 +52,24 @@ module DataMapper
       #   when called on <tt>grandchild2</tt>)
       # * <tt>root</tt> - Returns the root of the current node (<tt>root</tt> when called on <tt>grandchild2</tt>)
       #
-      # Author:: Timothy Bennett (http://lanaer.com)
+      # Original Author:: Timothy Bennett (http://lanaer.com)
+      # Current Maintainer:: Garrett Heaver (http://www.linkedin.com/pub/dir/garrett/heaver)
 
       # Configuration options are:
       #
       # * <tt>child_key</tt> - specifies the column name to use for tracking of the tree (default: +parent_id+)
       def is_tree(options = {})
-        configuration = { :child_key => :parent_id }
-        configuration.update(options) if Hash === options
-
-        belongs_to :parent, :class_name => name, :child_key => [ configuration[:child_key] ]
-        has n, :children, :class_name => name, :child_key => [ configuration[:child_key] ]
+        options = { :class_name => name, :child_key => :parent_id }.merge(options) if Hash === options
+        @tree_options = options
 
         include DataMapper::Is::Tree::InstanceMethods
         extend  DataMapper::Is::Tree::ClassMethods
 
-        class_eval <<-CLASS, __FILE__, __LINE__
-          def self.roots
-            all :#{configuration[:child_key]} => nil, :order => [#{configuration[:order].inspect}]
-          end
+        assc_options = { :class_name => options[:class_name], :child_key => Array(options[:child_key]) }
+        has_n_options = options[:order] ? { :order => Array(options[:order]) }.merge(assc_options) : assc_options
 
-          def self.first_root
-            first :#{configuration[:child_key]} => nil, :order => [#{configuration[:order].inspect}]
-          end
-        CLASS
+        belongs_to :parent, assc_options
+        has n, :children, has_n_options
 
         class << self
           alias_method :root, :first_root # for people used to the ActiveRecord acts_as_tree
@@ -89,9 +83,23 @@ module DataMapper
       alias_method :can_has_tree, :is_tree # just for fun ;)
 
       module ClassMethods
+        attr_reader :tree_options
+
+        def roots
+          options = { tree_options[:child_key] => nil }
+          options = { :order => Array(tree_options[:order]) }.merge(options) if tree_options[:order]
+          all options
+        end
+
+        def first_root
+          options = { tree_options[:child_key] => nil }
+          options = { :order => Array(tree_options[:order]) }.merge(options) if tree_options[:order]
+          first options
+        end
       end
 
       module InstanceMethods
+
         # Returns list of ancestors, starting with the root.
         #
         #   grandchild1.ancestors # => [root, child]

data/lib/dm-is-tree/is/version.rb

@@ -1,7 +1,7 @@
 module DataMapper
   module Is
     module Tree
-      VERSION = '0.9.9'
+      VERSION = '0.9.10'
     end
   end
 end

data/spec/integration/tree_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+if HAS_SQLITE3 || HAS_MYSQL || HAS_POSTGRES
+
+  describe DataMapper::Is::Tree do
+
+    class Category
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :parent_id, Integer
+      property :name, String
+    end
+
+    before(:all) do
+      Category.auto_migrate!
+
+      @root_a = Category.create(:name => 'a root')
+      @root_b = Category.create(:name => 'b root')
+
+      @child_a = Category.create(:name => 'a child', :parent_id => @root_a.id)
+      @child_b = Category.create(:name => 'b child', :parent_id => @root_a.id)
+
+      @grandchild_a = Category.create(:name => 'a grandchild', :parent_id => @child_a.id)
+      @grandchild_b = Category.create(:name => 'b grandchild', :parent_id => @child_a.id)
+    end
+
+    describe "roots class method" do
+
+      it "should return all instances where the child_key is nil" do
+        Category.is :tree
+        Category.roots.should == [@root_a, @root_b]
+      end
+
+      it "should use the order from the options if it is supplied" do
+        Category.is :tree, :order => :name.desc
+        Category.roots.should == [@root_b, @root_a]
+      end
+
+    end
+
+    describe "first_root class method" do
+
+      it "should return the first instance where the child_key is nil" do
+        Category.is :tree
+        Category.first_root.should == @root_a
+      end
+
+      it "should use the order from the options if it is supplied" do
+        Category.is :tree, :order => :name.desc
+        Category.first_root.should == @root_b
+      end
+
+    end
+
+    describe "ancestors instance method" do
+
+      it "should return the list of ancestors for the current node up to its root" do
+        Category.is :tree
+        @grandchild_a.ancestors.should == [@root_a, @child_a]
+      end
+
+    end
+
+    describe "root instance method" do
+
+      it "should return the root node for the current instance" do
+        Category.is :tree
+        @child_a.root.should == @root_a
+      end
+    end
+
+    describe "siblings instance method" do
+
+      it "should return all nodes which have the same parent as this node (excluding this node)" do
+        Category.is :tree
+        @child_a.siblings.should == [@child_b]
+      end
+
+    end
+
+    describe "generation instance method" do
+
+      it "should return all nodes which have the same parent as this node (including this node)" do
+        Category.is :tree
+        @child_a.generation.should == [@child_a, @child_b]
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,26 @@
+require 'pathname'
+require 'rubygems'
+
+gem 'rspec', '~>1.1.11'
+require 'spec'
+
+require Pathname(__FILE__).dirname.expand_path.parent + 'lib/dm-is-tree'
+
+def load_driver(name, default_uri)
+  return false if ENV['ADAPTER'] != name.to_s
+
+  begin
+    DataMapper.setup(name, ENV["#{name.to_s.upcase}_SPEC_URI"] || default_uri)
+    DataMapper::Repository.adapters[:default] =  DataMapper::Repository.adapters[name]
+    true
+  rescue LoadError => e
+    warn "Could not load do_#{name}: #{e}"
+    false
+  end
+end
+
+ENV['ADAPTER'] ||= 'sqlite3'
+
+HAS_SQLITE3  = load_driver(:sqlite3,  'sqlite3::memory:')
+HAS_MYSQL    = load_driver(:mysql,    'mysql://localhost/dm_core_test')
+HAS_POSTGRES = load_driver(:postgres, 'postgres://postgres@localhost/dm_core_test')

data/spec/unit/tree_spec.rb

@@ -0,0 +1,113 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+describe DataMapper::Is::Tree do
+
+  before do
+    class Category
+      include DataMapper::Resource
+
+      property :id, Serial
+      property :parent_id, Integer
+      property :name, String
+    end
+  end
+
+  it "should create a parent relationship" do
+    Category.is :tree
+    Category.relationships.should have_key(:parent)
+  end
+
+  it "should create a children relationship" do
+    Category.is :tree
+    Category.relationships.should have_key(:children)
+  end
+
+  it "should create a class method called roots" do
+    Category.is :tree
+    Category.should respond_to(:roots)
+  end
+
+  it "should create a class method called first_root" do
+    Category.is :tree
+    Category.should respond_to(:first_root)
+  end
+
+  it "should create an alias of class method first_root called root (ActiveRecord compatability)" do
+    Category.is :tree
+    Category.method(:first_root).should == Category.method(:root)
+  end
+
+  it "should create an instance method called ancestors" do
+    Category.is :tree
+    Category.new.should respond_to(:ancestors)
+  end
+
+  it "should create an instance method called root" do
+    Category.is :tree
+    Category.new.should respond_to(:root)
+  end
+
+  it "should create an instance method called siblings" do
+    Category.is :tree
+    Category.new.should respond_to(:siblings)
+  end
+
+  it "should create an instance method called generation" do
+    Category.is :tree
+    Category.new.should respond_to(:generation)
+  end
+
+  describe "parent relationship" do
+
+    it "should set the class_name from the current class" do
+      Category.is :tree
+      Category.relationships[:parent].options[:class_name].should == Category.name
+    end
+
+    it "should use the default child_key of :parent_id if none is supplied in the options" do
+      Category.is :tree
+      Category.relationships[:parent].options[:child_key].should == Array(:parent_id)
+    end
+
+    it "should use the child_key from the options if it is supplied" do
+      Category.is :tree, :child_key => :other_id
+      Category.relationships[:parent].options[:child_key].should == Array(:other_id)
+    end
+
+    it "should not set any order" do
+      Category.is :tree, :order => :name
+      Category.relationships[:parent].options.should_not have_key(:order)
+    end
+
+  end
+
+  describe "children relationship" do
+
+    it "should set the class_name from the current class" do
+      Category.is :tree
+      Category.relationships[:children].options[:class_name].should == Category.name
+    end
+
+    it "should use the default child_key of :parent_id if none is supplied in the options" do
+      Category.is :tree
+      Category.relationships[:children].options[:child_key].should == Array(:parent_id)
+    end
+
+    it "should use the child_key from the options if it is supplied" do
+      Category.is :tree, :child_key => :other_id
+      Category.relationships[:children].options[:child_key].should == Array(:other_id)
+    end
+
+    it "should not set any order if none is supplied in the options" do
+      Category.is :tree
+      Category.relationships[:children].options.should_not have_key(:order)
+    end
+
+    it "should use the order from the options if it is supplied" do
+      Category.is :tree, :order => :name
+      Category.relationships[:children].options[:order].should == Array(:name)
+    end
+
+  end
+
+end

data/tasks/spec.rb

@@ -8,7 +8,7 @@ begin
   desc 'Run specifications'
   Spec::Rake::SpecTask.new(:spec) do |t|
     t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
-    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s)
+    t.spec_files = Pathname.glob((ROOT + 'spec/**/*_spec.rb').to_s).map { |f| f.to_s }
 
     begin
       gem 'rcov', '~>0.8'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: dm-is-tree
 version: !ruby/object:Gem::Version 
-  version: 0.9.9
+  version: 0.9.10
 platform: ruby
 authors: 
 - Timothy Bennett
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-04 00:00:00 -08:00
+date: 2009-01-19 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.9.9
+        version: 0.9.10
     version: 
 description: DataMapper plugin allowing the creation of tree structures from data models
 email: 
@@ -44,7 +44,10 @@ files:
 - lib/dm-is-tree.rb
 - lib/dm-is-tree/is/tree.rb
 - lib/dm-is-tree/is/version.rb
+- spec/integration/tree_spec.rb
 - spec/spec.opts
+- spec/spec_helper.rb
+- spec/unit/tree_spec.rb
 - tasks/install.rb
 - tasks/spec.rb
 has_rdoc: true