loyal_awesome_nested_set 0.0.1

data/CHANGELOG

@@ -0,0 +1,57 @@
+2.1.6
+* Fixed rebuild! when there is a default_scope with order [Adrian Serafin]
+* Testing with stable bundler, ruby 2.0, MySQL and PostgreSQL [Philip Arndt]
+* Optimized move_to for large trees [ericsmith66]
+
+2.1.5
+* Worked around issues where AR#association wasn't present on Rails 3.0.x. [Philip Arndt]
+* Adds option 'order_column' which defaults to 'left_column_name'. [gudata]
+* Added moving with order functionality. [Sytse Sijbrandij]
+* Use tablename in all select queries. [Mikhail Dieterle]
+* Made sure all descendants' depths are updated when moving parent, not just immediate child. [Phil Thompson]
+* Add documentation of the callbacks. [Tobias Maier]
+
+2.1.4
+* nested_set_options accept both Class & AR Relation. [Semyon Perepelitsa]
+* Reduce the number of queries triggered by the canonical usage of `i.level` in the `nested_set` helpers. [thedarkone]
+* Specifically require active_record [Bogdan Gusiev]
+* compute_level now checks for a non nil association target. [Joel Nimety]
+
+2.1.3
+* Update child depth when parent node is moved. [Amanda Wagener]
+* Added move_to_child_with_index. [Ben Zhang]
+* Optimised self_and_descendants for when there's an index on lft. [Mark Torrance]
+* Added support for an unsaved record to return the right 'root'. [Philip Arndt]
+
+2.1.2
+* Fixed regressions introduced. [Philip Arndt]
+
+2.1.1
+* Added 'depth' which indicates how many levels deep the node is.
+  This only works when you have a column called 'depth' in your table,
+  otherwise it doesn't set itself. [Philip Arndt]
+* Rails 3.2 support added. [Gabriel Sobrinho]
+* Oracle compatibility added. [Pikender Sharma]
+* Adding row locking to deletion, locking source of pivot values, and adding retry on collisions. [Markus J. Q. Roberts]
+* Added method and helper for sorting children by column. [bluegod]
+* Fixed .all_roots_valid? to work with Postgres. [Joshua Clayton]
+* Made compatible with polymorphic belongs_to. [Graham Randall]
+* Added in the association callbacks to the children :has_many association. [Michael Deering]
+* Modified helper to allow using array of objects as argument. [Rahmat Budiharso]
+* Fixed cases where we were calling attr_protected. [Jacob Swanner]
+* Fixed nil cases involving lft and rgt. [Stuart Coyle] and [Patrick Morgan]
+
+2.0.2
+* Fixed deprecation warning under Rails 3.1 [Philip Arndt]
+* Converted Test::Unit matchers to RSpec. [Uģis Ozols]
+* Added inverse_of to associations to improve performance rendering trees. [Sergio Cambra]
+* Added row locking and fixed some race conditions. [Markus J. Q. Roberts]
+
+2.0.1
+* Fixed a bug with move_to not using nested_set_scope [Andreas Sekine]
+
+2.0.0.pre
+* Expect Rails 3
+* Changed how callbacks work. Returning false in a before_move action does not block save operations. Use a validation or exception in the callback if you need that.
+* Switched to RSpec
+* Remove use of Comparable

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2007-2011 Collective Idea
+
+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.md

@@ -0,0 +1,163 @@
+# AwesomeNestedSet
+
+Awesome Nested Set is an implementation of the nested set pattern for ActiveRecord models.
+It is a replacement for acts_as_nested_set and BetterNestedSet, but more awesome.
+
+Version 2 supports Rails 3. Gem versions prior to 2.0 support Rails 2.
+
+## What makes this so awesome?
+
+This is a new implementation of nested set based off of BetterNestedSet that fixes some bugs, removes tons of duplication, adds a few useful methods, and adds STI support.
+
+[![Code Climate](https://codeclimate.com/github/collectiveidea/awesome_nested_set.png)](https://codeclimate.com/github/collectiveidea/awesome_nested_set)
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'awesome_nested_set'
+```
+
+## Usage
+
+To make use of `awesome_nested_set`, your model needs to have 3 fields:
+`lft`, `rgt`, and `parent_id`. The names of these fields are configurable.
+You can also have an optional field, `depth`:
+
+```ruby
+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
+      t.integer :depth # this is optional.
+    end
+  end
+
+  def self.down
+    drop_table :categories
+  end
+end
+```
+
+Enable the nested set functionality by declaring `acts_as_nested_set` on your model
+
+```ruby
+class Category < ActiveRecord::Base
+  acts_as_nested_set
+end
+```
+
+Run `rake rdoc` to generate the API docs and see [CollectiveIdea::Acts::NestedSet](lib/awesome_nested_set/awesome_nested_set.rb) for more information.
+
+## Callbacks
+
+There are three callbacks called when moving a node:
+`before_move`, `after_move` and `around_move`.
+
+```ruby
+class Category < ActiveRecord::Base
+  acts_as_nested_set
+
+  after_move :rebuild_slug
+  around_move :da_fancy_things_around
+
+  private
+
+  def rebuild_slug
+    # do whatever
+  end
+
+  def da_fancy_things_around
+    # do something...
+    yield # actually moves
+    # do something else...
+  end
+end
+```
+
+Beside this there are also hooks to act on the newly added or removed children.
+
+```ruby
+class Category < ActiveRecord::Base
+  acts_as_nested_set  :before_add     => :do_before_add_stuff,
+                      :after_add      => :do_after_add_stuff,
+                      :before_remove  => :do_before_remove_stuff,
+                      :after_remove   => :do_after_remove_stuff
+
+  private
+
+  def do_before_add_stuff(child_node)
+    # do whatever with the child
+  end
+
+  def do_after_add_stuff(child_node)
+    # do whatever with the child
+  end
+
+  def do_before_remove_stuff(child_node)
+    # do whatever with the child
+  end
+
+  def do_after_remove_stuff(child_node)
+    # do whatever with the child
+  end
+end
+```
+
+## Protecting attributes from mass assignment
+
+It's generally best to "whitelist" the attributes that can be used in mass assignment:
+
+```ruby
+class Category < ActiveRecord::Base
+  acts_as_nested_set
+  attr_accessible :name, :parent_id
+end
+```
+
+If for some reason that is not possible, you will probably want to protect the `lft` and `rgt` attributes:
+
+```ruby
+class Category < ActiveRecord::Base
+  acts_as_nested_set
+  attr_protected :lft, :rgt
+end
+```
+
+## 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:
+
+```ruby
+Category.rebuild!
+```
+
+Your tree will be converted to a valid nested set. Awesome!
+
+## View Helper
+
+The view helper is called #nested_set_options.
+
+Example usage:
+
+```erb
+<%= 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}" } ) %>
+```
+
+See [CollectiveIdea::Acts::NestedSet::Helper](lib/awesome_nested_set/helper.rb) for more information about the helpers.
+
+## References
+
+You can learn more about nested sets at: http://threebit.net/tutorials/nestedset/tutorial1.html
+
+## How to contribute
+
+Please see the ['Contributing' document](CONTRIBUTING.md).
+
+Copyright © 2008 - 2013 Collective Idea, released under the MIT license

data/lib/awesome_nested_set.rb

@@ -0,0 +1,8 @@
+require 'awesome_nested_set/awesome_nested_set'
+require 'active_record'
+ActiveRecord::Base.send :extend, CollectiveIdea::Acts::NestedSet
+
+if defined?(ActionView)
+  require 'awesome_nested_set/helper'
+  ActionView::Base.send :include, CollectiveIdea::Acts::NestedSet::Helper
+end

data/lib/awesome_nested_set/awesome_nested_set.rb

@@ -0,0 +1,134 @@
+require 'awesome_nested_set/columns'
+require 'awesome_nested_set/model'
+
+module CollectiveIdea #:nodoc:
+  module Acts #:nodoc:
+    module NestedSet #:nodoc:
+
+      # This acts provides Nested Set functionality. Nested Set is a smart way to implement
+      # an _ordered_ tree, with the added feature that you can select the children and all of their
+      # descendants with a single query. The drawback is that insertion or move need some complex
+      # sql queries. But everything is done here by this module!
+      #
+      # Nested sets are appropriate each time you want either an orderd tree (menus,
+      # commercial categories) or an efficient way of querying big trees (threaded posts).
+      #
+      # == API
+      #
+      # Methods names are aligned with acts_as_tree as much as possible to make replacment from one
+      # by another easier.
+      #
+      #   item.children.create(:name => "child1")
+      #
+
+      # Configuration options are:
+      #
+      # * +:parent_column+ - specifies the column name to use for keeping the position integer (default: parent_id)
+      # * +:left_column+ - column name for left boundry data, default "lft"
+      # * +:right_column+ - column name for right boundry data, default "rgt"
+      # * +:depth_column+ - column name for the depth data, default "depth"
+      # * +:scope+ - restricts what is to be considered a list. Given a symbol, it'll attach "_id"
+      #   (if it hasn't been already) and use that as the foreign key restriction. You
+      #   can also pass an array to scope by multiple attributes.
+      #   Example: <tt>acts_as_nested_set :scope => [:notable_id, :notable_type]</tt>
+      # * +:dependent+ - behavior for cascading destroy. If set to :destroy, all the
+      #   child objects are destroyed alongside this object by calling their destroy
+      #   method. If set to :delete_all (default), all the child objects are deleted
+      #   without calling their destroy method.
+      # * +:counter_cache+ adds a counter cache for the number of children.
+      #   defaults to false.
+      #   Example: <tt>acts_as_nested_set :counter_cache => :children_count</tt>
+      # * +:order_column+ on which column to do sorting, by default it is the left_column_name
+      #   Example: <tt>acts_as_nested_set :order_column => :position</tt>
+      #
+      # See CollectiveIdea::Acts::NestedSet::Model::ClassMethods for a list of class methods and
+      # CollectiveIdea::Acts::NestedSet::Model for a list of instance methods added
+      # to acts_as_nested_set models
+      def acts_as_nested_set(options = {})
+        acts_as_nested_set_parse_options! options
+
+        include Model
+        include Columns
+        extend Columns
+
+        acts_as_nested_set_relate_parent!
+        acts_as_nested_set_relate_children!
+
+        attr_accessor :skip_before_destroy
+
+        acts_as_nested_set_prevent_assignment_to_reserved_columns!
+        acts_as_nested_set_define_callbacks!
+      end
+
+      private
+      def acts_as_nested_set_define_callbacks!
+        # on creation, set automatically lft and rgt to the end of the tree
+        before_create  :set_default_left_and_right
+        before_save    :store_new_parent
+        after_save     :move_to_new_parent, :set_depth!
+        before_destroy :destroy_descendants
+
+        define_model_callbacks :move
+      end
+
+      def acts_as_nested_set_relate_children!
+        has_many_children_options = {
+          :class_name => self.base_class.to_s,
+          :foreign_key => parent_column_name,
+          :order => quoted_order_column_name,
+          :inverse_of => (:parent unless acts_as_nested_set_options[:polymorphic]),
+        }
+
+        # Add callbacks, if they were supplied.. otherwise, we don't want them.
+        [:before_add, :after_add, :before_remove, :after_remove].each do |ar_callback|
+          has_many_children_options.update(ar_callback => acts_as_nested_set_options[ar_callback]) if acts_as_nested_set_options[ar_callback]
+        end
+
+        order_condition = has_many_children_options.delete(:order)
+        has_many :children, -> { order(order_condition) }, has_many_children_options
+      end
+
+      def acts_as_nested_set_relate_parent!
+        belongs_to :parent, :class_name => self.base_class.to_s,
+                            :foreign_key => parent_column_name,
+                            :counter_cache => acts_as_nested_set_options[:counter_cache],
+                            :inverse_of => (:children unless acts_as_nested_set_options[:polymorphic]),
+                            :polymorphic => acts_as_nested_set_options[:polymorphic]
+      end
+
+      def acts_as_nested_set_default_options
+        {
+          :parent_column => 'parent_id',
+          :left_column => 'lft',
+          :right_column => 'rgt',
+          :depth_column => 'depth',
+          :dependent => :delete_all, # or :destroy
+          :polymorphic => false,
+          :counter_cache => false
+        }.freeze
+      end
+
+      def acts_as_nested_set_parse_options!(options)
+        options = acts_as_nested_set_default_options.merge(options)
+
+        if options[:scope].is_a?(Symbol) && options[:scope].to_s !~ /_id$/
+          options[:scope] = "#{options[:scope]}_id".intern
+        end
+
+        class_attribute :acts_as_nested_set_options
+        self.acts_as_nested_set_options = options
+      end
+
+      def acts_as_nested_set_prevent_assignment_to_reserved_columns!
+        # no assignment to structure fields
+        [left_column_name, right_column_name, depth_column_name].each do |column|
+          module_eval <<-"end_eval", __FILE__, __LINE__
+            def #{column}=(x)
+              raise ActiveRecord::ActiveRecordError, "Unauthorized assignment to #{column}: it's an internal field handled by acts_as_nested_set code, use move_to_* methods instead."
+            end
+          end_eval
+        end
+      end
+    end
+  end
+end

data/lib/awesome_nested_set/columns.rb

@@ -0,0 +1,72 @@
+# Mixed into both classes and instances to provide easy access to the column names
+module CollectiveIdea #:nodoc:
+  module Acts #:nodoc:
+    module NestedSet #:nodoc:
+      module Columns
+        def left_column_name
+          acts_as_nested_set_options[:left_column]
+        end
+
+        def right_column_name
+          acts_as_nested_set_options[:right_column]
+        end
+
+        def depth_column_name
+          acts_as_nested_set_options[:depth_column]
+        end
+
+        def parent_column_name
+          acts_as_nested_set_options[:parent_column]
+        end
+
+        def order_column
+          acts_as_nested_set_options[:order_column] || left_column_name
+        end
+
+        def scope_column_names
+          Array(acts_as_nested_set_options[:scope])
+        end
+
+        def quoted_left_column_name
+          ActiveRecord::Base.connection.quote_column_name(left_column_name)
+        end
+
+        def quoted_right_column_name
+          ActiveRecord::Base.connection.quote_column_name(right_column_name)
+        end
+
+        def quoted_depth_column_name
+          ActiveRecord::Base.connection.quote_column_name(depth_column_name)
+        end
+
+        def quoted_parent_column_name
+          ActiveRecord::Base.connection.quote_column_name(parent_column_name)
+        end
+
+        def quoted_scope_column_names
+          scope_column_names.collect {|column_name| connection.quote_column_name(column_name) }
+        end
+
+        def quoted_order_column_name
+          ActiveRecord::Base.connection.quote_column_name(order_column)
+        end
+
+        def quoted_primary_key_column_full_name
+          "#{quoted_table_name}.#{ActiveRecord::Base.connection.quote_column_name('id')}"
+        end
+
+        def quoted_left_column_full_name
+          "#{quoted_table_name}.#{quoted_left_column_name}"
+        end
+
+        def quoted_right_column_full_name
+          "#{quoted_table_name}.#{quoted_right_column_name}"
+        end
+
+        def quoted_parent_column_full_name
+          "#{quoted_table_name}.#{quoted_parent_column_name}"
+        end
+      end
+    end
+  end
+end