dm_is_a_tree 0.2.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007 Timothy Bennett
+
+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

@@ -0,0 +1,4 @@
+templates
+=================
+
+A plugin for DataMapper that provides acts_as_tree functionality similar to that in AR.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+
+GEM = "dm_is_a_tree"
+VERSION = "0.2.0"
+AUTHOR = "Timothy Bennett"
+EMAIL = "lanaer@lanaer.com"
+HOMEPAGE = "http://lanaer.com/"
+SUMMARY = "A plugin for DataMapper that allows model objects to be a part of a heirarchal tree structure.  Based on the acts_as_tree plugin for ActiveRecord."
+
+spec = Gem::Specification.new do |s|
+  s.name = GEM
+  s.version = VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE", 'TODO']
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+
+  s.add_dependency "datamapper", ">=0.2.3"
+
+  s.require_path = 'lib'
+  s.autorequire = GEM
+  s.files = %w(LICENSE README Rakefile TODO) + Dir.glob("{lib,specs}/**/*")
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{VERSION}}
+end
+
+desc "Run all specs"
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end
+
+desc "Run all specs output html"
+Spec::Rake::SpecTask.new('specs_html') do |t|
+  t.spec_opts = ["--format", "html"]
+  t.libs = ['lib', 'server/lib' ]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end
+
+desc "RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+  t.libs = ['lib', 'server/lib' ]
+  t.rcov = true
+end

data/TODO

@@ -0,0 +1,4 @@
+TODO:
+Fix LICENSE with your name
+Fix Rakefile with your name and contact info
+Add your code to lib/<%= name %>.rb

data/lib/dm_is_a_tree.rb

@@ -0,0 +1,123 @@
+require 'data_mapper'
+
+module DataMapper
+	module Is
+		module Tree
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      # An extension to DataMapper to easily allow the creation of tree structures from your DataMapper Models.
+      # This requires a foreign key property for your model, which by default would be called :parent_id.
+      #
+			#   Example:
+			#
+      #   class Category < DataMapper::Base
+			#			property :parent_id, :integer
+			#			property :name, :string
+			#
+      #     is_a_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]
+      #
+			# The following instance methods are added:
+			# * <tt>children</tt> - Returns all nodes with the current node as their parent, in the order specified by
+			#   <tt>:order</tt> (<tt>[grandchild1, grandchild2]</tt> when called on <tt>child</tt>)
+			# * <tt>parent</tt> - Returns the node referenced by the foreign key (<tt>:parent_id</tt> by
+			#   default) (<tt>root</tt> when called on <tt>child</tt>)
+      # * <tt>siblings</tt> - Returns all the children of the parent, excluding the current node
+			#   (<tt>[grandchild2]</tt> when called on <tt>grandchild1</tt>)
+      # * <tt>generation</tt> - Returns all the children of the parent, including the current node (<tt>
+			#   [grandchild1, grandchild2]</tt> when called on <tt>grandchild1</tt>)
+      # * <tt>ancestors</tt> - Returns all the ancestors of the current node (<tt>[root, child1]</tt>
+			#   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>)
+			module ClassMethods
+        # Configuration options are:
+        #
+        # * <tt>foreign_key</tt> - specifies the column name to use for tracking of the tree (default: +parent_id+)
+        # * <tt>order</tt> - makes it possible to sort the children according to this SQL snippet.
+        # * <tt>counter_cache</tt> - keeps a count in a +children_count+ column if set to +true+ (default: +false+).
+        def is_a_tree(options = {})
+          configuration = { :foreign_key => "parent_id" }
+          configuration.update(options) if options.is_a?(Hash)
+
+          belongs_to :parent, :class_name => name, :foreign_key => configuration[:foreign_key], :counter_cache => configuration[:counter_cache]
+          has_many :children, :class_name => name, :foreign_key => configuration[:foreign_key], :order => configuration[:order]
+
+					include DataMapper::Is::Tree::InstanceMethods
+
+					class_eval <<-CLASS
+						def self.roots
+							self.all :#{configuration[:foreign_key]} => nil, :order => #{configuration[:order].inspect}
+						end
+
+						def self.first_root
+							self.first :#{configuration[:foreign_key]} => nil, :order => #{configuration[:order].inspect}
+						end
+					CLASS
+
+					class << self
+						alias_method :root, :first_root # for people used to the ActiveRecord acts_as_tree
+					end
+        end
+
+				alias_method :can_has_tree, :is_a_tree # just for fun ;)
+      end
+
+      module InstanceMethods
+        # Returns list of ancestors, starting with the root.
+        #
+        #   grandchild1.ancestors # => [root, child]
+        def ancestors
+          node, nodes = self, []
+          nodes << node = node.parent while node.parent
+          nodes.reverse
+        end
+
+        # Returns the root node of the current node’s tree.
+				#
+				#		grandchild1.root # => root
+        def root
+          node = self
+          node = node.parent while node.parent
+          node
+        end
+
+        # Returns all siblings of the current node.
+        #
+        #   grandchild1.siblings # => [grandchild2]
+        def siblings
+          generation - [self]
+        end
+
+        # Returns all children of the current node’s parent.
+        #
+        #   grandchild1.generation # => [grandchild1, grandchild2]
+        def generation
+          parent ? parent.children : self.class.roots
+        end
+
+				alias_method :self_and_siblings, :generation # for those used to the ActiveRecord acts_as_tree
+      end
+		end
+	end
+end
+
+DataMapper::Base.send(:include, DataMapper::Is::Tree)

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.4
+specification_version: 1
+name: dm_is_a_tree
+version: !ruby/object:Gem::Version 
+  version: 0.2.0
+date: 2007-12-06 00:00:00 -08:00
+summary: A plugin for DataMapper that allows model objects to be a part of a heirarchal tree structure.  Based on the acts_as_tree plugin for ActiveRecord.
+require_paths: 
+- lib
+email: lanaer@lanaer.com
+homepage: http://lanaer.com/
+rubyforge_project: 
+description: A plugin for DataMapper that allows model objects to be a part of a heirarchal tree structure.  Based on the acts_as_tree plugin for ActiveRecord.
+autorequire: dm_is_a_tree
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Timothy Bennett
+files: 
+- LICENSE
+- README
+- Rakefile
+- TODO
+- lib/dm_is_a_tree.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: datamapper
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: