ordered_tree 0.1.1

data/.rvmrc

@@ -0,0 +1 @@
+rvm @ordered_tree

data/CHANGELOG

@@ -0,0 +1,14 @@
+
+v.1.2 - Wed May 17 2007
+  - renamed syblings to siblings
+  - renamed self_and_syblings to self_and_siblings
+  - some other minor code changes
+  - updated tests
+
+  Note:
+    I attempted to rewrite the tests using fixtures,
+    but some of the tests were failing.
+    I presume this is due to fixtures not supporting
+    nested transactions. The results of this effort
+    can be found in the fixtures_not_working/ branch.
+

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+gem "activerecord", ">= 3.0.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.6.0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+
+  gem 'sqlite3'
+  gem 'guard-rspec'
+  gem 'libnotify'
+  gem 'rb-inotify'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.7)
+      activesupport (= 3.0.7)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.7)
+      activemodel (= 3.0.7)
+      activesupport (= 3.0.7)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.7)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    ffi (1.0.9)
+    git (1.2.5)
+    guard (0.3.4)
+      thor (~> 0.14.6)
+    guard-rspec (0.3.1)
+      guard (>= 0.2.2)
+    i18n (0.5.0)
+    jeweler (1.6.2)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    libnotify (0.5.5)
+    rake (0.9.1)
+    rb-inotify (0.8.5)
+      ffi (>= 0.5.0)
+    rcov (0.9.9)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.3)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    tzinfo (0.3.27)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord (>= 3.0.0)
+  bundler (~> 1.0.0)
+  guard-rspec
+  jeweler (~> 1.6.2)
+  libnotify
+  rb-inotify
+  rcov
+  rspec (~> 2.6.0)
+  sqlite3

data/Guardfile

@@ -0,0 +1,17 @@
+# 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/(.+)\.rb})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+
+  # Rails example
+  watch('spec/spec_helper.rb')                       { "spec" }
+  watch('config/routes.rb')                          { "spec/routing" }
+  watch('app/controllers/application_controller.rb') { "spec/controllers" }
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^app/(.+)\.rb})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/(.+)\.rb})                           { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Ramon Tayag
+
+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.rdoc

@@ -0,0 +1,19 @@
+= ordered_tree
+
+Description goes here.
+
+== Contributing to ordered_tree
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Ramon Tayag. See LICENSE.txt for
+further details.
+

data/README.textile

@@ -0,0 +1,123 @@
+h1. ActsAsOrderedTree
+
+v.1.2
+
+<pre>
+                                 +----+-----------+----------+---------+
+  node_1                         | id | parent_id | position | name    |
+    \_ node_2                    +----+-----------+----------+---------+
+    \_ node_3                    |  1 |         0 |        1 | Node_1  |
+    |    \_ node_4               |  2 |         1 |        1 | Node_2  |
+    |    \_ node_5               |  3 |         1 |        2 | Node_3  |
+    |    |   \_ node_8           |  4 |         3 |        1 | Node_4  |
+    |    |   \_ node_9           |  5 |         3 |        2 | Node_5  |
+    |    \_ node_10              |  6 |         1 |        3 | Node_6  |
+    |    \_ node_11              |  7 |         1 |        4 | Node_7  |
+    \_ node_6                    |  8 |         5 |        1 | Node_8  |
+    \_ node_7                    |  9 |         5 |        2 | Node_9  |
+    |                            | 10 |         3 |        3 | Node_10 |
+    |                            | 11 |         3 |        4 | Node_11 |
+  node_12                        | 12 |         0 |        2 | Node_12 |
+    \_ node_13                   | 13 |        12 |        1 | Node_13 |
+    \_ node_14                   | 14 |        12 |        2 | Node_14 |
+    |    \_ node_15              | 15 |        14 |        1 | Node_15 |
+    |    \_ node_16              | 16 |        14 |        2 | Node_16 |
+    |    |   \_ node_19          | 17 |        12 |        3 | Node_17 |
+    |    |   \_ node_20          | 18 |        12 |        4 | Node_18 |
+    |    \_ node_21              | 19 |        16 |        1 | Node_19 |
+    |    \_ node_22              | 20 |        16 |        2 | Node_20 |
+    \_ node_17                   | 21 |        14 |        3 | Node_21 |
+    \_ node_18                   | 22 |        14 |        4 | Node_22 |
+                                 +----+-----------+----------+---------+
+</pre>
+
+<pre>
+class Person < ActiveRecord::Base
+  acts_as_ordered_tree :foreign_key => :parent_id,
+                       :order       => :position
+end
+
+class CreatePeople < ActiveRecord::Migration
+  def self.up
+    create_table :people do |t|
+      t.column :parent_id , :integer ,:null => false ,:default => 0
+      t.column :position  , :integer
+    end
+    add_index(:people, :parent_id)
+  end
+end
+</pre>
+
+Which "in effect" sets up the following:
+
+<pre>
+belongs_to :parent,
+           :class_name  => Person,
+           :foreign_key => :parent_id
+
+has_many   :children,
+           :class_name  => Person,
+           :foreign_key => :parent_id,
+           :order       => :position
+</pre>
+
+h2. Overview
+
+<pre>
+     Actions    Tree Methods                                List Method
+ --------------------------------------------------------------------------------------------------
+     Create
+                To create a child object at a specific position,
+                use one of the following:
+                  Person.create(:parent_id => parent.id, :position => 2)
+                  parent.children << Person.new(:position => 3)
+                  parent.children.create(:position => 5)
+
+                To create a new 'root', use:
+                  Person.create(:position => 2)
+
+                :position will default to the bottom of the parent's list
+                :parent_id defaults to 0 (Class.roots)
+
+     Read
+                roots (class method)                        self_and_siblings
+
+                root                                        siblings
+
+                parent                                      position_in_list
+
+                ancestors
+
+                children
+
+                descendants
+
+     Update
+                shift_to(parent = nil, position = nil)      move_above(sibling = nil)
+
+                orphan                                      move_higher
+
+                orphan_children                             move_lower
+
+                parent_adopts_children                      move_to_top
+
+                orphan_self_and_children                    move_to_bottom
+
+                orphan_self_and_parent_adopts_children
+
+     Destroy
+                destroy (deletes all descendants)
+
+                destroy_and_orphan_children
+
+                destroy_and_parent_adopts_children
+
+</pre>
+
+h2. Install
+
+gem 'ordered_tree'
+
+h2. Demo
+
+There is a drag-n-drop demo located at svn://rubyforge.org/var/svn/ordered-tree/demo

data/Rakefile

@@ -0,0 +1,53 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ordered_tree"
+  gem.homepage = "http://github.com/ramontayag/ordered_tree"
+  gem.license = "MIT"
+  gem.summary = %Q{Gem version of Wizard's ActsAsTree}
+  gem.description = %Q{Uses parent_id and position to create an ordered tree.}
+  gem.email = "ramon@tayag.net"
+  gem.authors = ["Ramon Tayag"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ordered_tree #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/ordered_tree/class_methods.rb

@@ -0,0 +1,26 @@
+module OrderedTree
+  module ClassMethods
+    extend ActiveSupport::Concern
+
+    included do
+      belongs_to :parent_node, :class_name => name, :foreign_key => ordered_tree_config[:foreign_key]
+      has_many :child_nodes, :class_name => name, :foreign_key => ordered_tree_config[:foreign_key], :order => ordered_tree_config[:order]
+      scope :roots, lambda { { :conditions => {ordered_tree_config[:foreign_key] => 0}, :order => ordered_tree_config[:order].to_s } }
+
+      def foreign_key_column
+        :"#{ordered_tree_config[:foreign_key]}"
+      end
+
+      def order_column
+        :"#{ordered_tree_config[:order]}"
+      end
+
+      before_create :add_to_list
+      before_update :check_list_changes
+      after_update :reorder_old_list
+      before_destroy :destroy_descendants
+      after_destroy :reorder_old_list
+      validate :check_parentage, :on => :update
+    end
+  end
+end

data/lib/ordered_tree/instance_methods/destroy.rb

@@ -0,0 +1,40 @@
+module OrderedTree
+  module InstanceMethods
+    module Destroy
+      ## Destroy Methods
+
+      # sends immediate children to the 'roots' list, then destroy's self
+      def destroy_and_orphan_children
+        self.class.transaction do
+          orphan_children
+          self.destroy
+        end
+      end
+
+      # hands immediate children of to it's parent, then destroy's self
+      def destroy_and_parent_adopts_children
+        self.class.transaction do
+          parent_adopts_children
+          self.destroy
+        end
+      end
+
+      def reorder_children
+        self.class.transaction do
+          children(true).each do |child|
+            new_position = children.index(child) + 1
+            child.update_attribute(order_column, new_position) if (child.position_in_list != new_position)
+          end
+        end
+      end
+
+      protected
+
+      def destroy_descendants #:nodoc:
+        # before_destroy callback (recursive)
+        @old_parent = self.class.find(self).parent || 'root'
+        self.children(true).each{|child| child.destroy}
+      end
+    end
+  end
+end

data/lib/ordered_tree/instance_methods/list.rb

@@ -0,0 +1,151 @@
+module OrderedTree
+  module InstanceMethods
+    module List
+      ## List Read Methods
+
+      # returns an array of the object's siblings, including itself
+      #
+      #   return is cached
+      #   use self_and_siblings(true) to force a reload
+      def self_and_siblings(reload = false)
+        parent(reload) ? parent.children(reload) : self.class.roots(reload)
+      end
+
+      # returns an array of the object's siblings, excluding itself
+      #
+      #   return is cached
+      #   use siblings(true) to force a reload
+      def siblings(reload = false)
+        self_and_siblings(reload) - [self]
+      end
+
+      # returns object's position in the list
+      #   the list will either be parent.children,
+      #   or self.class.roots
+      #
+      #   i.e. self.position
+      def position_in_list
+        self[order_column]
+      end
+
+      ## List Update Methods
+
+      # moves the item above sibling in the list
+      #   defaults to the top of the list
+      def move_above(sibling = nil)
+        if sibling
+          return if (!self_and_siblings(true).include?(sibling) || (sibling == self))
+          if sibling.position_in_list > position_in_list
+            move_to(sibling.position_in_list - 1)
+          else
+            move_to(sibling.position_in_list)
+          end
+        else
+          move_to_top
+        end
+      end
+
+      # move to the top of the list
+      def move_to_top
+        return if position_in_list == 1
+        move_to(1)
+      end
+
+      # swap with the node above self
+      def move_higher
+        return if position_in_list == 1
+        move_to(position_in_list - 1)
+      end
+
+      # swap with the node below self
+      def move_lower
+        return if self == self_and_siblings(true).last
+        move_to(position_in_list + 1)
+      end
+
+      # move to the bottom of the list
+      def move_to_bottom
+        return if self == self_and_siblings(true).last
+        move_to(self_and_siblings.last.position_in_list)
+      end
+
+      protected
+
+      def check_list_changes #:nodoc:
+        # before_update callback
+        #
+        # Note: to shift to another parent AND specify a position, use shift_to()
+        # i.e. don't assign the object a new position, then new_parent << obj
+        # this will end up at the bottom of the list.
+        #
+        if !self_and_siblings(true).include?(self)
+          add_to_list_bottom
+          @old_parent = self.class.find(self).parent || 'root'
+        end
+      end
+
+      def reorder_old_list #:nodoc:
+        # after_update and after_destroy callback
+        # re-order the old parent's list
+        if @old_parent == 'root'
+          reorder_roots
+        elsif @old_parent
+          @old_parent.reorder_children
+        end
+      end
+
+      private
+
+      def add_to_list
+        new_position = position_in_list if (1..self_and_siblings(true).size).include?(position_in_list.to_i)
+        add_to_list_bottom
+        move_to(new_position, true) if new_position
+      end
+
+      def add_to_list_bottom
+        self[order_column] = self_and_siblings.size + 1
+      end
+
+      def move_to(new_position, on_create = false)
+        if parent(true)
+          scope = "#{foreign_key_column} = #{parent.id}"
+        else
+          scope = "#{foreign_key_column} = 0"
+        end
+        if new_position < position_in_list
+          # moving from lower to higher, increment all in between
+          # #{order_column} >= #{new_position} AND #{order_column} < #{position_in_list}
+          self.class.transaction do
+            self.class.update_all(
+              "#{order_column} = (#{order_column} + 1)", "#{scope} AND (#{order_column} BETWEEN #{new_position} AND #{position_in_list - 1})"
+            )
+            if on_create
+              self[order_column] = new_position
+            else
+              update_attribute(order_column, new_position)
+            end
+          end
+        else
+          # moving from higher to lower, decrement all in between
+          # #{order_column} > #{position_in_list} AND #{order_column} <= #{new_position}
+          self.class.transaction do
+            self.class.update_all(
+              "#{order_column} = (#{order_column} - 1)", "#{scope} AND (#{order_column} BETWEEN #{position_in_list + 1} AND #{new_position})"
+            )
+            update_attribute(order_column, new_position)
+          end
+        end
+      end
+
+      def reorder_roots
+        self.class.transaction do
+          self.class.roots(true).each do |root|
+            new_position = self.class.roots.index(root) + 1
+            root.update_attribute(order_column, new_position) if (root.position_in_list != new_position)
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/ordered_tree/instance_methods/misc.rb

@@ -0,0 +1,15 @@
+module OrderedTree
+  module InstanceMethods
+    module Misc
+      protected
+
+      def foreign_key_column
+        :"#{ordered_tree_config[:foreign_key]}"
+      end
+
+      def order_column
+        :"#{ordered_tree_config[:order]}"
+      end
+    end
+  end
+end