nested_set 1.5.4 → 1.6.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nested_set (1.5.2)
+    nested_set (1.5.4)
       activerecord (>= 3.0.0)
       railties (>= 3.0.0)
 
@@ -31,11 +31,20 @@ GEM
     activesupport (3.0.0)
     arel (1.0.1)
       activesupport (~> 3.0.0)
+    bench_press (0.3.1)
+      activesupport (>= 2.3.5)
+      facter (>= 1.5.7)
+      httparty (>= 0.6.1)
+      jeweler (>= 1.4.0)
     builder (2.1.2)
+    crack (0.1.8)
     erubis (2.6.6)
       abstract (>= 1.0.0)
+    facter (1.5.8)
     gemcutter (0.6.1)
     git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
     i18n (0.4.1)
     jeweler (1.4.0)
       gemcutter (>= 0.1.0)
@@ -66,6 +75,7 @@ DEPENDENCIES
   actionpack (>= 3.0.0)
   activerecord (>= 3.0.0)
   activesupport (>= 3.0.0)
+  bench_press (>= 0.3.1)
   jeweler
   nested_set!
   railties (>= 3.0.0)

data/README.md

@@ -0,0 +1,113 @@
+# NestedSet
+
+Nested Set is an implementation of the nested set pattern for ActiveRecord models. It is replacement for acts_as_nested_set and BetterNestedSet, but awesomer. It supports Rails 3.0 and later.
+
+## See, it's Rails 3 only.
+
+## Installation
+
+The plugin is available as a gem:
+
+    gem 'nested_set'
+
+Or install as a plugin:
+
+    rails plugin install git://github.com/skyeagle/nested_set.git
+
+## Usage
+
+To make use of nested_set, your model needs to have 3 fields: lft, rgt, and parent_id:
+
+    class CreateCategories < ActiveRecord::Migration
+      def self.up
+        create_table :categories do |t|
+          t.string :name
+          t.integer :parent_id
+          t.integer :lft
+          t.integer :rgt
+
+          # Uncomment it to store item level
+          # t.integer :depth
+        end
+      end
+
+      def self.down
+        drop_table :categories
+      end
+    end
+
+Enable the nested set functionality by declaring acts_as_nested_set on your model
+
+    class Category < ActiveRecord::Base
+      acts_as_nested_set
+    end
+
+Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet::Base::SingletonMethods for more info.
+
+### Conversion from other trees
+
+Coming from acts_as_tree or another system where you only have a parent_id? No problem. Simply add the lft & rgt fields as above, and then run
+
+    Category.rebuild!
+
+Your tree be converted to a valid nested set.
+
+## View Helper
+
+The view helper is called #nested_set_options. 
+
+Example usage:
+
+    <%= f.select :parent_id, nested_set_options(Category, @category) {|i, level| "#{'-' * level} #{i.name}" } %>
+
+    <%= select_tag 'parent_id', options_for_select(nested_set_options(Category) {|i, level| "#{'-' * level} #{i.name}" } ) %>
+
+or sorted select:
+
+    <%= f.select :parent_id, sorted_nested_set_options(Category, lambda(&:name)) {|i, level| "#{'-' * level} #{i.name}" } %>
+
+    <% sort_method = lambda{|x, y| x.name.downcase <=> y.name.downcase} %>
+
+NOTE: to sort UTF-8 strings you should use `x.name.mb_chars.downcase`
+
+    <%= select_tag 'parent_id', options_for_select(sorted_nested_set_options(Category, sort_method){|i, level| "#{'-' * level} #{i.name}" } ) %>
+
+See CollectiveIdea::Acts::NestedSet::Helper for more information about the helpers.
+
+## Development
+
+    bundle install
+
+Running tests
+
+    bundle exec rake test
+
+Benchmark tests
+
+    bundle exec ruby test/benchmark.rb
+
+### References
+
+You can learn more about nested sets at:
+
+  [1](http://www.dbmsmag.com/9603d06.html)
+  [2](http://threebit.net/tutorials/nestedset/tutorial1.html)
+  [3](http://api.rubyonrails.com/classes/ActiveRecord/Acts/NestedSet/ClassMethods.html)
+  [4](http://opensource.symetrie.com/trac/better_nested_set/)
+
+## How to contribute
+
+If you find what you might think is a bug:
+
+1. Check the GitHub issue tracker to see if anyone else has had the same issue.
+   [Issues tracker](http://github.com/skyeagle/nested_set/issues)
+2. If you don't see anything, create an issue with information on how to reproduce it.
+
+If you want to contribute an enhancement or a fix:
+
+1. Fork the project on github. [http://github.com/skyeagle/nested_set](http://github.com/skyeagle/nested_set)
+2. Make your changes with tests.
+3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
+4. Send a pull request.
+
+Copyright ©2010 Collective Idea, released under the MIT license

data/Rakefile

@@ -16,6 +16,7 @@ begin
     gem.add_development_dependency "sqlite3-ruby"
     gem.add_development_dependency "actionpack", ['>= 3.0.0']
     gem.add_development_dependency "activesupport", ['>= 3.0.0']
+    gem.add_development_dependency "bench_press", ['>= 0.3.1']
     gem.add_development_dependency "jeweler"
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-1.5.4
+1.6.0

data/lib/nested_set/base.rb

@@ -99,7 +99,7 @@ module CollectiveIdea #:nodoc:
                 where("#{quoted_right_column_name} - #{quoted_left_column_name} = 1").
                 order(quoted_left_column_name) 
               }
-              scope :with_depth, proc {|level| where(:depth => level).order("lft") }
+              scope :with_depth, proc {|level| where(:depth => level).order(quoted_left_column_name) }
 
               define_callbacks :move, :terminator => "result == false"
             end
@@ -113,6 +113,42 @@ module CollectiveIdea #:nodoc:
             roots.first
           end
 
+          # Returns arranged nodes hash.
+          # I.e. you have this tree:
+          #
+          #   1
+          #     2
+          #     3
+          #       4
+          #         5
+          #       6
+          #   7
+          #
+          # Hash will looks like:
+          #
+          #   {1 => {2 => {}, 3 => {4 => {5 => {}}, 6 => {}}}, 7 => {}}
+          #
+          # == Usage:
+          #
+          #   Categories.arrange
+          #   Categories.find(42).children.arrange
+          #   Categories.find(42).descendants.arrange
+          #   Categories.find(42).self_and_descendants.arrange
+          #
+          # This arranged hash can be rendered with recursive render_tree helper
+          def arrange
+            arranged = ActiveSupport::OrderedHash.new
+            insertion_points = [arranged]
+            depth = 0
+            order(quoted_left_column_name).each_with_level do |node, level|
+              insertion_points.push insertion_points.last.values.last if level > depth
+              (depth - level).times { insertion_points.pop } if level < depth
+              insertion_points.last.merge! node => ActiveSupport::OrderedHash.new
+              depth = level
+            end
+            arranged
+          end
+
           def valid?
             left_and_rights_valid? && no_duplicates_for_columns? && all_roots_valid?
           end
@@ -210,19 +246,17 @@ module CollectiveIdea #:nodoc:
           # Example:
           #    Category.each_with_level(Category.root.self_and_descendants) do |o, level|
           #
-          def each_with_level(objects)
-            path = [nil]
-            objects.each do |o|
-              if o.parent_id != path.last
-                # we are on a new level, did we decent or ascent?
-                if path.include?(o.parent_id)
-                  # remove wrong wrong tailing paths elements
-                  path.pop while path.last != o.parent_id
-                else
-                  path << o.parent_id
-                end
+
+          def each_with_level(objects = nil)
+            levels = []
+            (objects || scoped).each do |i|
+              if level = levels.index(i.parent_id)
+                levels.slice!((level + 1)..-1)
+              else
+                levels << i.parent_id
+                level = levels.size - 1
               end
-              yield(o, path.length - 1)
+              yield(i, level)
             end
           end
 

data/lib/nested_set/helper.rb

@@ -25,19 +25,13 @@ module CollectiveIdea #:nodoc:
           class_or_item = class_or_item.roots if class_or_item.is_a?(Class)
           items = Array(class_or_item)
           result = []
-          items.each do |root|
+          items.each do |item|
             levels = []
-            result += root.self_and_descendants.map do |i|
-              if level = levels.index(i.parent_id)
-                levels.slice!((level + 1)..-1)
-              else
-                levels << i.parent_id
-                level = levels.size - 1
-              end
+            item.self_and_descendants.each_with_level do |i, level|
               if mover.nil? || mover.new_record? || mover.move_possible?(i)
-                [yield(i, level), i.id]
+                result.push([yield(i, level), i.id])
               end
-            end.compact
+            end
           end
           result
         end
@@ -61,7 +55,7 @@ module CollectiveIdea #:nodoc:
         #
         #   OR
         #
-        #   sort_method = lambda{|x,y| x.name.downcase <=> y.name.downcase}
+        #   sort_method = lambda{|x,y| x.name.mb_chars.downcase <=> y.name.mb_chars.downcase}
         #
         #   <%= f.select :parent_id, nested_set_options(Category, sort_method) {|i, level|
         #       "#{'–' * level} #{i.name}"
@@ -71,25 +65,51 @@ module CollectiveIdea #:nodoc:
           class_or_item = class_or_item.roots if class_or_item.is_a?(Class)
           items = Array(class_or_item)
           result = []
-          items.sort_by(&sort_proc).each do |root|
-            set = root.self_and_descendants
-            result += build_node(set[0], set, sort_proc, mover, level){|x, level| yield(x, level)}
+          items.sort_by(&sort_proc).each do |item|
+            hash = item.self_and_descendants.arrange
+            result += build_node(hash, sort_proc, mover, level){|x, lvl| yield(x, lvl)}
           end
           result
         end
 
-        def build_node(node, set, sort_proc, mover = nil, level = nil)
+        def build_node(hash, sort_proc, mover = nil, level = nil)
           result ||= []
-          if mover.nil? || mover.new_record? || mover.move_possible?(i)
-            result << [yield(node, level), node.id]
-            unless node.leaf?
-              set.select{|i| i.parent_id == node.id}.sort_by(&sort_proc).map{ |i|
-                result.push(*build_node(i, set, sort_proc, mover, level.to_i + 1){|x, level| yield(x, level)})
-              }
+          hash.keys.sort_by(&sort_proc).each do |node|
+            if mover.nil? || mover.new_record? || mover.move_possible?(node)
+              result << [yield(node, level.to_i), node.id]
+              result.push(*build_node(hash[node], sort_proc, mover, level.to_i + 1){|x, lvl| yield(x, lvl)})
             end
-          end
+          end if hash.present?
           result
         end
+
+        # Recursively render arranged nodes hash
+        #
+        # == Params
+        #  * +hash+ - Hash or arranged nodes, i.e. Category.arranged
+        #  * +options+ - HTML options for root ul node.
+        #    Given options with ex. :sort => lambda{|x| x.name}
+        #    you allow node sorting by analogy with sorted_nested_set_options helper method
+        #  * +&block+ - A block that will be used to display node
+        #
+        # == Usage
+        #
+        #   arranged_nodes = Category.arranged
+        #
+        #   <%= render_tree arranged_nodes do |node, child| %>
+        #     <li><%= node.name %></li>
+        #     <%= child %>
+        #   <% end %>
+        #
+        def render_tree hash, options = {}, &block
+          sort_proc = options.delete :sort
+          content_tag :ul, options do
+            hash.keys.sort_by(&sort_proc).each do |node|
+              block.call node, render_tree(hash[node], :sort => sort_proc, &block)
+            end
+          end if hash.present?
+        end
+
       end
     end
   end

data/nested_set.gemspec

@@ -5,55 +5,55 @@
 
 Gem::Specification.new do |s|
   s.name = %q{nested_set}
-  s.version = "1.5.4"
+  s.version = "1.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Brandon Keepers", "Daniel Morrison"]
-  s.date = %q{2010-11-12}
+  s.date = %q{2010-12-11}
   s.description = %q{An awesome nested set implementation for Active Record}
   s.email = %q{info@collectiveidea.com}
   s.extra_rdoc_files = [
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".autotest",
-     ".gitignore",
-     "Gemfile",
-     "Gemfile.lock",
-     "MIT-LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "init.rb",
-     "lib/nested_set.rb",
-     "lib/nested_set/base.rb",
-     "lib/nested_set/depth.rb",
-     "lib/nested_set/descendants.rb",
-     "lib/nested_set/helper.rb",
-     "lib/nested_set/railtie.rb",
-     "nested_set.gemspec",
-     "rails/init.rb",
-     "test/db/database.yml",
-     "test/db/schema.rb",
-     "test/fixtures/categories.yml",
-     "test/fixtures/category.rb",
-     "test/fixtures/departments.yml",
-     "test/fixtures/notes.yml",
-     "test/nested_set/helper_test.rb",
-     "test/nested_set_test.rb",
-     "test/test_helper.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "MIT-LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "init.rb",
+    "lib/nested_set.rb",
+    "lib/nested_set/base.rb",
+    "lib/nested_set/depth.rb",
+    "lib/nested_set/descendants.rb",
+    "lib/nested_set/helper.rb",
+    "lib/nested_set/railtie.rb",
+    "nested_set.gemspec",
+    "rails/init.rb",
+    "test/benchmarks.rb",
+    "test/db/database.yml",
+    "test/db/schema.rb",
+    "test/fixtures/categories.yml",
+    "test/fixtures/category.rb",
+    "test/fixtures/departments.yml",
+    "test/fixtures/notes.yml",
+    "test/nested_set/helper_test.rb",
+    "test/nested_set_test.rb",
+    "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/skyeagle/nested_set}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{An awesome nested set implementation for Active Record}
   s.test_files = [
+    "test/benchmarks.rb",
+    "test/db/schema.rb",
+    "test/fixtures/category.rb",
+    "test/nested_set/helper_test.rb",
     "test/nested_set_test.rb",
-     "test/nested_set/helper_test.rb",
-     "test/test_helper.rb",
-     "test/fixtures/category.rb",
-     "test/db/schema.rb"
+    "test/test_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -61,26 +61,53 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<nested_set>, [">= 0"])
+      s.add_runtime_dependency(%q<railties>, [">= 3.0.0"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_development_dependency(%q<actionpack>, [">= 3.0.0"])
+      s.add_development_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_development_dependency(%q<bench_press>, [">= 0.3.1"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
       s.add_runtime_dependency(%q<railties>, [">= 3.0.0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 3.0.0"])
       s.add_development_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_development_dependency(%q<actionpack>, [">= 3.0.0"])
       s.add_development_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_development_dependency(%q<bench_press>, [">= 0.3.1"])
       s.add_development_dependency(%q<jeweler>, [">= 0"])
     else
+      s.add_dependency(%q<nested_set>, [">= 0"])
       s.add_dependency(%q<railties>, [">= 3.0.0"])
       s.add_dependency(%q<activerecord>, [">= 3.0.0"])
       s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
       s.add_dependency(%q<actionpack>, [">= 3.0.0"])
       s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<bench_press>, [">= 0.3.1"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<railties>, [">= 3.0.0"])
+      s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+      s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+      s.add_dependency(%q<actionpack>, [">= 3.0.0"])
+      s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+      s.add_dependency(%q<bench_press>, [">= 0.3.1"])
       s.add_dependency(%q<jeweler>, [">= 0"])
     end
   else
+    s.add_dependency(%q<nested_set>, [">= 0"])
+    s.add_dependency(%q<railties>, [">= 3.0.0"])
+    s.add_dependency(%q<activerecord>, [">= 3.0.0"])
+    s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
+    s.add_dependency(%q<actionpack>, [">= 3.0.0"])
+    s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<bench_press>, [">= 0.3.1"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
     s.add_dependency(%q<railties>, [">= 3.0.0"])
     s.add_dependency(%q<activerecord>, [">= 3.0.0"])
     s.add_dependency(%q<sqlite3-ruby>, [">= 0"])
     s.add_dependency(%q<actionpack>, [">= 3.0.0"])
     s.add_dependency(%q<activesupport>, [">= 3.0.0"])
+    s.add_dependency(%q<bench_press>, [">= 0.3.1"])
     s.add_dependency(%q<jeweler>, [">= 0"])
   end
 end

data/test/benchmarks.rb

@@ -0,0 +1,55 @@
+if $0 == __FILE__
+
+  plugin_test_dir = File.dirname(__FILE__)
+
+  $:.unshift(plugin_test_dir + '/../lib')
+
+  #require 'logger'
+  require 'active_support'
+  require 'active_record'
+  require 'nested_set'
+  require 'bench_press'
+
+
+  CollectiveIdea::Acts::NestedSet::Railtie.extend_active_record
+  #ActiveRecord::Base.logger = Logger.new(plugin_test_dir + "/debug.log")
+  ActiveRecord::Base.configurations = YAML::load(IO.read(plugin_test_dir + "/db/database.yml"))
+  ActiveRecord::Base.establish_connection(ENV["DB"] || "sqlite3mem")
+  ActiveRecord::Migration.verbose = false
+  ActiveRecord::Schema.define(:version => 0) do
+    create_table :categories, :force => true do |t|
+      t.column :name, :string
+      t.column :parent_id, :integer
+      t.column :lft, :integer
+      t.column :rgt, :integer
+    end
+  end
+
+  class Category < ActiveRecord::Base
+    acts_as_nested_set
+  end
+
+  Category.delete_all
+  Category.create(:name => "Root Node 1")
+  Category.create(:name => "Root Node 2")
+  50.times do |i|
+    node = Category.create(:name => "Node #{i}")
+    set = Category.roots.map{|root| root.self_and_descendants}.flatten
+    random_node = set[rand(set.size-1)]
+    node.move_to_child_of(random_node)
+  end
+
+  include CollectiveIdea::Acts::NestedSet::Helper
+  extend BenchPress
+
+  reps 100
+
+  measure "nested_set_options" do
+    nested_set_options(Category){|i, level| "#{'-' * level} #{i.name}" }
+  end
+
+  measure "sorted_nested_set_options" do
+    sorted_nested_set_options(Category, lambda(&:name)){|i, level| "#{'-' * level} #{i.name}" }
+  end
+
+end

data/test/db/schema.rb

@@ -5,6 +5,7 @@ ActiveRecord::Schema.define(:version => 0) do
     t.column :parent_id, :integer
     t.column :lft, :integer
     t.column :rgt, :integer
+    t.column :depth, :integer, :default => 0
     t.column :organization_id, :integer
   end
 

data/test/fixtures/category.rb

@@ -12,4 +12,5 @@ class Category < ActiveRecord::Base
       end
     }
   end
-end
+
+end

data/test/nested_set/helper_test.rb

@@ -1,77 +1,103 @@
 require 'test_helper'
 
-module CollectiveIdea
-  module Acts #:nodoc:
-    module NestedSet #:nodoc:
-      class NestedSetTest < ActiveSupport::TestCase
-        include Helper
-        fixtures :categories
+class HelperTest < ActionView::TestCase
+  include CollectiveIdea::Acts::NestedSet::Helper
+  fixtures :categories
 
-        def test_nested_set_options
-          expected = [
-            [" Top Level", 1],
-            ["- Child 1", 2],
-            ['- Child 2', 3],
-            ['-- Child 2.1', 4],
-            ['- Child 3', 5],
-            [" Top Level 2", 6]
-          ]
-          actual = nested_set_options(Category) do |c, level|
-            "#{'-' * level} #{c.name}"
-          end
-          assert_equal expected, actual
-        end
+  def test_nested_set_options
+    expected = [
+      [" Top Level", 1],
+      ["- Child 1", 2],
+      ['- Child 2', 3],
+      ['-- Child 2.1', 4],
+      ['- Child 3', 5],
+      [" Top Level 2", 6]
+    ]
+    actual = nested_set_options(Category) do |c, level|
+      "#{'-' * level} #{c.name}"
+    end
+    assert_equal expected, actual
+  end
 
-        def test_nested_set_options_with_mover
-          expected = [
-            [" Top Level", 1],
-            ["- Child 1", 2],
-            ['- Child 3', 5],
-            [" Top Level 2", 6]
-          ]
-          actual = nested_set_options(Category, categories(:child_2)) do |c, level|
-            "#{'-' * level} #{c.name}"
-          end
-          assert_equal expected, actual
-        end
+  def test_nested_set_options_with_mover
+    expected = [
+      [" Top Level", 1],
+      ["- Child 1", 2],
+      ['- Child 3', 5],
+      [" Top Level 2", 6]
+    ]
+    actual = nested_set_options(Category, categories(:child_2)) do |c, level|
+      "#{'-' * level} #{c.name}"
+    end
+    assert_equal expected, actual
+  end
 
-        def test_build_node
-          set = categories(:top_level).self_and_descendants
-          expected = set.map{|i| [i.name, i.id]}
-          actual = build_node(set[0], set, lambda(&:lft)){|i, level| i.name }
-          assert_equal expected, actual
-        end
+  def test_build_node
+    set = categories(:top_level).self_and_descendants
+    expected = set.map{|i| [i.name, i.id]}
 
-        def test_build_node_with_back_id_order
-          set = categories(:top_level).self_and_descendants
-          expected = [
-            ["Top Level", 1],
-            ["Child 3", 5],
-            ["Child 2", 3],
-            ["Child 2.1", 4],
-            ["Child 1", 2]
-          ]
-          actual = build_node(set[0], set, lambda{|x| -x.id}){|i, level| i.name }
-          assert_equal expected, actual
-        end
+    hash = set.arrange
+    actual = build_node(hash, lambda(&:lft)){|i, level| i.name }
+    assert_equal expected, actual
+  end
 
-        def test_sorted_nested_set
-          expected = [
-            [" Top Level 2", 6],
-            [" Top Level", 1],
-            ['- Child 3', 5],
-            ['- Child 2', 3],
-            ['-- Child 2.1', 4],
-            ["- Child 1", 2]
-          ]
+  def test_build_node_with_back_id_order
+    expected = [
+      ["Top Level", 1],
+      ["Child 3", 5],
+      ["Child 2", 3],
+      ["Child 2.1", 4],
+      ["Child 1", 2]
+    ]
 
-          actual = sorted_nested_set_options(Category, lambda{|x| -x.id}) do |c, level|
-            "#{'-' * level} #{c.name}"
-          end
-          assert_equal expected, actual
-        end
+    hash = categories(:top_level).self_and_descendants.arrange
+    actual = build_node(hash, lambda{|x| -x.id}){|i, level| i.name }
+    assert_equal expected, actual
+  end
+
+  def test_sorted_nested_set
+    expected = [
+      [" Top Level 2", 6],
+      [" Top Level", 1],
+      ['- Child 3', 5],
+      ['- Child 2', 3],
+      ['-- Child 2.1', 4],
+      ["- Child 1", 2]
+    ]
 
-      end
+    actual = sorted_nested_set_options(Category, lambda{|x| -x.id}) do |c, level|
+      "#{'-' * level} #{c.name}"
     end
+    assert_equal expected, actual
   end
+
+  def test_sorted_nested_set_with_mover
+    expected = [
+      [" Top Level 2", 6],
+      [" Top Level", 1],
+      ['- Child 3', 5],
+      ["- Child 1", 2]
+    ]
+
+    actual = sorted_nested_set_options(Category, lambda{|x| -x.id}, categories(:child_2)) do |c, level|
+      "#{'-' * level} #{c.name}"
+    end
+    assert_equal expected, actual
+  end
+  def test_render_tree
+    html = render_tree(Category.arrange) do |category, child|
+      concat content_tag(:li, category)
+      concat child
+    end
+    assert_equal html, "<ul><li>Top Level</li><ul><li>Child 1</li><li>Child 2</li><ul><li>Child 2.1</li></ul><li>Child 3</li></ul><li>Top Level 2</li></ul>"
+  end
+
+  def test_sorted_render_tree
+    html = render_tree(Category.arrange, :sort => lambda{|x| -x.id}) do |category, child|
+      concat content_tag(:li, category)
+      concat child
+    end
+    assert_equal html, "<ul><li>Top Level 2</li><li>Top Level</li><ul><li>Child 3</li><li>Child 2</li><ul><li>Child 2.1</li></ul><li>Child 1</li></ul></ul>"
+  end
+
 end

data/test/nested_set_test.rb

@@ -712,6 +712,15 @@ class NestedSetTest < ActiveSupport::TestCase
     end
   end
 
+  def check_scoped_structure(entries, structure)
+    structure = structure.dup
+    entries.each_with_level do |category, level|
+      expected_level, expected_name = structure.shift
+      assert_equal expected_name, category.name, "wrong category"
+      assert_equal expected_level, level, "wrong level for #{category.name}"
+    end
+  end
+
   def test_each_with_level
     levels = [
       [0, "Top Level"],
@@ -721,6 +730,7 @@ class NestedSetTest < ActiveSupport::TestCase
       [1, "Child 3" ]]
 
     check_structure(Category.root.self_and_descendants, levels)
+    check_scoped_structure(Category.root.self_and_descendants, levels)
 
     # test some deeper structures
     category = Category.find_by_name("Child 1")
@@ -746,7 +756,7 @@ class NestedSetTest < ActiveSupport::TestCase
       [2, "Child 2.1"],
       [1, "Child 3" ]]
 
-      check_structure(Category.root.self_and_descendants, levels)
+    check_scoped_structure(Category.root.self_and_descendants, levels)
   end
 
   def test_model_with_attr_accessible
@@ -801,4 +811,55 @@ class NestedSetTest < ActiveSupport::TestCase
   ensure
     Category.class_eval { reset_callbacks :move }
   end
+
+  # helper to turn arranged hash to levels array
+  def hash_to_array hash, level = 0
+    array = []
+    hash.each do |key, value|
+      array.push [level, "#{key}"]
+      array += hash_to_array(value, level.next)
+    end
+    array
+  end
+
+  def test_arrangement
+    levels = [
+      [0, "Top Level"],
+      [1, "Child 1"],
+      [1, "Child 2"],
+      [2, "Child 2.1"],
+      [1, "Child 3"],
+      [0, "Top Level 2"]]
+
+    assert_equal hash_to_array(Category.arrange), levels
+
+    # some deeper structure
+
+    category = Category.find_by_name("Child 1")
+    c1 = Category.new(:name => "Child 1.1")
+    c2 = Category.new(:name => "Child 1.1.1")
+    c3 = Category.new(:name => "Child 1.1.1.1")
+    c4 = Category.new(:name => "Child 1.2")
+    [c1, c2, c3, c4].each(&:save!)
+
+    c1.move_to_child_of(category)
+    c2.move_to_child_of(c1)
+    c3.move_to_child_of(c2)
+    c4.move_to_child_of(category)
+
+    levels = [
+      [0, "Top Level"],
+      [1, "Child 1"],
+      [2, "Child 1.1"],
+      [3, "Child 1.1.1"],
+      [4, "Child 1.1.1.1"],
+      [2, "Child 1.2"],
+      [1, "Child 2"],
+      [2, "Child 2.1"],
+      [1, "Child 3" ],
+      [0, "Top Level 2"]]
+
+    assert_equal hash_to_array(Category.arrange), levels
+  end
+
 end

data/test/test_helper.rb

@@ -9,6 +9,10 @@ require 'active_support'
 require 'active_support/test_case'
 require 'active_record'
 require 'action_pack'
+require 'action_view'
+require 'action_view/base'
+require 'action_view/template/handlers/erb'
+require 'action_view/test_case'
 require 'nested_set'
 
 CollectiveIdea::Acts::NestedSet::Railtie.extend_active_record

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 5
-  - 4
-  version: 1.5.4
+  - 6
+  - 0
+  version: 1.6.0
 platform: ruby
 authors: 
 - Brandon Keepers
@@ -15,13 +15,25 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-12 00:00:00 +03:00
+date: 2010-12-11 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: railties
-  prerelease: false
+  name: nested_set
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: railties
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,11 +44,11 @@ dependencies:
         - 0
         version: 3.0.0
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activerecord
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,11 +59,11 @@ dependencies:
         - 0
         version: 3.0.0
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: sqlite3-ruby
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,11 +72,11 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id003
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: actionpack
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -75,11 +87,11 @@ dependencies:
         - 0
         version: 3.0.0
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,11 +102,69 @@ dependencies:
         - 0
         version: 3.0.0
   type: :development
-  version_requirements: *id005
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: bench_press
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   name: jeweler
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: railties
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: sqlite3-ruby
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -103,7 +173,66 @@ dependencies:
         - 0
         version: "0"
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: bench_press
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 1
+        version: 0.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *id014
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id015 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id015
 description: An awesome nested set implementation for Active Record
 email: info@collectiveidea.com
 executables: []
@@ -111,14 +240,13 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- README.md
 files: 
 - .autotest
-- .gitignore
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - init.rb
@@ -130,6 +258,7 @@ files:
 - lib/nested_set/railtie.rb
 - nested_set.gemspec
 - rails/init.rb
+- test/benchmarks.rb
 - test/db/database.yml
 - test/db/schema.rb
 - test/fixtures/categories.yml
@@ -144,8 +273,8 @@ homepage: http://github.com/skyeagle/nested_set
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -172,8 +301,9 @@ signing_key:
 specification_version: 3
 summary: An awesome nested set implementation for Active Record
 test_files: 
-- test/nested_set_test.rb
+- test/benchmarks.rb
+- test/db/schema.rb
+- test/fixtures/category.rb
 - test/nested_set/helper_test.rb
+- test/nested_set_test.rb
 - test/test_helper.rb
-- test/fixtures/category.rb
-- test/db/schema.rb

data/.gitignore

@@ -1,26 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-rdoc
-pkg
-
-# PROJECT::SPECIFIC
-awesome_nested_set.sqlite3.db
-test/debug.log
-rdoc
-*.sw?
-.bundle

data/README.rdoc

@@ -1,99 +0,0 @@
-= NestedSet
-
-Nested Set is an implementation of the nested set pattern for ActiveRecord models. It is replacement for acts_as_nested_set and BetterNestedSet, but awesomer. It supports Rails 3.0 and later.
-
-=== See, it's Rails 3 only.
-
-== Installation
-
-The plugin is available as a gem:
-
-  gem 'nested_set'
-
-Or install as a plugin:
-
-  rails plugin install git://github.com/skyeagle/nested_set.git
-
-== Usage
-
-To make use of nested_set, your model needs to have 3 fields: lft, rgt, and parent_id:
-
-  class CreateCategories < ActiveRecord::Migration
-    def self.up
-      create_table :categories do |t|
-        t.string :name
-        t.integer :parent_id
-        t.integer :lft
-        t.integer :rgt
-
-        # Uncomment it to store item level
-        # t.integer :depth
-      end
-    end
-
-    def self.down
-      drop_table :categories
-    end
-  end
-
-Enable the nested set functionality by declaring acts_as_nested_set on your model
-
-  class Category < ActiveRecord::Base
-    acts_as_nested_set
-  end
-
-Run `rake rdoc` to generate the API docs and see CollectiveIdea::Acts::NestedSet::Base::SingletonMethods for more info.
-
-== Conversion from other trees
-
-Coming from acts_as_tree or another system where you only have a parent_id? No problem. Simply add the lft & rgt fields as above, and then run
-
-  Category.rebuild!
-
-Your tree be converted to a valid nested set.
-
-== View Helper
-
-The view helper is called #nested_set_options. 
-
-Example usage:
-
-  <%= f.select :parent_id, nested_set_options(Category, @category) {|i| "#{'-' * i.level} #{i.name}" } %>
-
-  <%= select_tag 'parent_id', options_for_select(nested_set_options(Category) {|i| "#{'-' * i.level} #{i.name}" } ) %>
-
-or sorted select:
-
-  <%= f.select :parent_id, sorted_nested_set_options(Category, lambda(&:name)) {|i| "#{'-' * i.level} #{i.name}" } %>
-
-  <% sort_method = lambda{|x, y| x.name.downcase <=> y.name.downcase} %>
-  <%= select_tag 'parent_id', options_for_select(sorted_nested_set_options(Category, sort_method){|i| "#{'-' * i.level} #{i.name}" } ) %>
-
-See CollectiveIdea::Acts::NestedSet::Helper for more information about the helpers.
-
-== References
-
-You can learn more about nested sets at:
-
-  http://www.dbmsmag.com/9603d06.html
-  http://threebit.net/tutorials/nestedset/tutorial1.html
-  http://api.rubyonrails.com/classes/ActiveRecord/Acts/NestedSet/ClassMethods.html
-  http://opensource.symetrie.com/trac/better_nested_set/
-
-== How to contribute
-
-If you find what you might think is a bug:
-
-1. Check the GitHub issue tracker to see if anyone else has had the same issue.
-   http://github.com/skyeagle/nested_set/issues/
-2. If you don't see anything, create an issue with information on how to reproduce it.
-
-If you want to contribute an enhancement or a fix:
-
-1. Fork the project on github.
-   http://github.com/skyeagle/nested_set/
-2. Make your changes with tests.
-3. Commit the changes without making changes to the Rakefile, VERSION, or any other files that aren't related to your enhancement or fix
-4. Send a pull request.
-
-Copyright ©2010 Collective Idea, released under the MIT license