dm-is-tree 0.9.2

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 @@
+dm-is-tree
+==========
+
+DataMapper plugin allowing the creation of tree structures from data models.

data/Rakefile

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'spec'
+require 'rake/clean'
+require 'rake/gempackagetask'
+require 'spec/rake/spectask'
+require 'pathname'
+
+CLEAN.include '{log,pkg}/'
+
+spec = Gem::Specification.new do |s|
+  s.name             = 'dm-is-tree'
+  s.version          = '0.9.2'
+  s.platform         = Gem::Platform::RUBY
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w[ README LICENSE TODO ]
+  s.summary          = 'DataMapper plugin allowing the creation of tree structures from data models'
+  s.description      = s.summary
+  s.author           = 'Timothy Bennett'
+  s.email            = 'leapord729@comcast.net'
+  s.homepage         = 'http://github.com/sam/dm-more/tree/master/dm-is-tree'
+  s.require_path     = 'lib'
+  s.files            = FileList[ '{lib,spec}/**/*.rb', 'spec/spec.opts', 'Rakefile', *s.extra_rdoc_files ]
+  s.add_dependency('dm-core', "=#{s.version}")
+end
+
+task :default => [ :spec ]
+
+WIN32 = (RUBY_PLATFORM =~ /win32|mingw|cygwin/) rescue nil
+SUDO  = WIN32 ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "Install #{spec.name} #{spec.version} (default ruby)"
+task :install => [ :package ] do
+  sh "#{SUDO} gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources", :verbose => false
+end
+
+desc "Uninstall #{spec.name} #{spec.version} (default ruby)"
+task :uninstall => [ :clobber ] do
+  sh "#{SUDO} gem uninstall #{spec.name} -v#{spec.version} -I -x", :verbose => false
+end
+
+namespace :jruby do
+  desc "Install #{spec.name} #{spec.version} with JRuby"
+  task :install => [ :package ] do
+    sh %{#{SUDO} jruby -S gem install --local pkg/#{spec.name}-#{spec.version} --no-update-sources}, :verbose => false
+  end
+end
+
+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(Pathname.new(__FILE__).dirname + 'spec/**/*_spec.rb')
+
+  begin
+    t.rcov = ENV.has_key?('NO_RCOV') ? ENV['NO_RCOV'] != 'true' : true
+    t.rcov_opts << '--exclude' << 'spec'
+    t.rcov_opts << '--text-summary'
+    t.rcov_opts << '--sort' << 'coverage' << '--sort-reverse'
+  rescue Exception
+    # rcov not installed
+  end
+end

data/TODO

@@ -0,0 +1,8 @@
+TODO
+====
+
+ * dm-is-tree requires specs
+
+---
+TODO tickets may also be found in the DataMapper Issue Tracker:
+http://wm.lighthouseapp.com/projects/4819-datamapper/overview

data/lib/dm-is-tree.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'pathname'
+
+gem 'dm-core', '=0.9.2'
+require 'dm-core'
+
+require Pathname(__FILE__).dirname.expand_path / 'dm-is-tree' / 'is' / 'tree.rb'

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

@@ -0,0 +1,134 @@
+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
+      #     include DataMapper::Resource
+      #
+      #     property :id, Integer
+      #     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]
+      #
+      # 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>)
+      #
+      # Author:: Timothy Bennett (http://lanaer.com)
+
+      # 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] ]
+
+        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
+
+          def self.first_root
+            first :#{configuration[:child_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
+
+      def is_a_tree(options = {})
+        warn('#is_a_tree is depreciated. use #is :tree instead.')
+        is :tree, options
+      end
+      alias_method :can_has_tree, :is_tree # just for fun ;)
+
+      module ClassMethods
+      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
+        alias_method :first_root, :root
+
+        # 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
+
+      Model.send(:include, self)
+    end # Tree
+  end # Is
+end # DataMapper

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--format specdoc
+--colour

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: dm-is-tree
+version: !ruby/object:Gem::Version 
+  version: 0.9.2
+platform: ruby
+authors: 
+- Timothy Bennett
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.9.2
+    version: 
+description: DataMapper plugin allowing the creation of tree structures from data models
+email: leapord729@comcast.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+- TODO
+files: 
+- lib/dm-is-tree/is/tree.rb
+- lib/dm-is-tree.rb
+- spec/spec.opts
+- Rakefile
+- README
+- LICENSE
+- TODO
+has_rdoc: true
+homepage: http://github.com/sam/dm-more/tree/master/dm-is-tree
+post_install_message: 
+rdoc_options: []
+
+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.0.1
+signing_key: 
+specification_version: 2
+summary: DataMapper plugin allowing the creation of tree structures from data models
+test_files: []
+