ordered_tree 0.1.1 → 0.1.2

data/README.textile

@@ -33,8 +33,8 @@ v.1.2
 
 <pre>
 class Person < ActiveRecord::Base
-  acts_as_ordered_tree :foreign_key => :parent_id,
-                       :order       => :position
+  ordered_tree :foreign_key => :parent_id,
+               :order       => :position
 end
 
 class CreatePeople < ActiveRecord::Migration
@@ -61,6 +61,8 @@ has_many   :children,
            :order       => :position
 </pre>
 
+_Note: @:parent_id@ and @:position@ are default values for the @foreign_key@ and @order@, respectively._
+
 h2. Overview
 
 <pre>
@@ -111,13 +113,47 @@ h2. Overview
                 destroy_and_orphan_children
 
                 destroy_and_parent_adopts_children
-
 </pre>
 
-h2. Install
+h2. Setting the scope
 
-gem 'ordered_tree'
+If you want to have multiple trees in the same database (let's say you want to have multiple sets of pages for the different tenants on your database), you should set a scope. A scope basically says: "work within this scope when possible".
+
+How does it work?
+
+Let's say I have a multi-tenant CMS app. I want each site to have their own Page tree. So Page uses @ordered_tree :scope => :site@ so that when I do this:
+
+pre. @site_1 = Site.create :name => "First site"
+@site_2 = Site.create :name => "Second site"
+Page.create(:site => @site_1).position # returns 1
+Page.create(:site => @site_2).position # returns 1
+Page.create(:site => @site_2).position # returns 2
+Page.create(:site => @site_1).position # returns 2
+
+Warning: @Page.roots@ will always return all the root pages (all pages with parent_id of 0). That's because there's no way to know which pages you want to see. That means, when you want to get a site's root pages, go through the site: @@site.pages.roots@
+
+Here are all the ways to define the scope:
+
+h3. Give a symbol without _id:
+
+@ordered_tree :scope => :site@
 
-h2. Demo
+@ordered_tree@ will add @_id@ to @:site@ so it becomes: @:site_id@
 
-There is a drag-n-drop demo located at svn://rubyforge.org/var/svn/ordered-tree/demo
+Thus, you can also pass:
+
+h3. Give a symbol with _id
+
+@ordered_tree :scope => :site_id@
+
+h3. Override the scope_condition method
+
+For more complex stuff, in the model that has @ordered_tree@, define a method like this:
+
+pre. def scope_condition
+  "site_id = #{site_id} AND user_login = '#{user_login}'"
+end
+
+h2. Install
+
+gem 'ordered_tree'

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ordered_tree/class_methods.rb

@@ -1,12 +1,7 @@
 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

data/lib/ordered_tree/instance_methods/list.rb

@@ -8,7 +8,8 @@ module OrderedTree
       #   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)
+        #parent(reload) ? parent.children(reload) : self.class.roots(scope_condition)
+        parent(reload) ? parent.children(reload) : self.class.roots(scope_condition)
       end
 
       # returns an array of the object's siblings, excluding itself

data/lib/ordered_tree/instance_methods/misc.rb

@@ -10,6 +10,13 @@ module OrderedTree
       def order_column
         :"#{ordered_tree_config[:order]}"
       end
+
+      private
+
+      # Overwrite this method to define the scope of the list changes
+      def scope_condition
+        "1"
+      end
     end
   end
 end

data/lib/ordered_tree.rb

@@ -25,6 +25,25 @@ module OrderedTree #:nodoc:
     self.ordered_tree_config[:foreign_key] ||= :parent_id
     self.ordered_tree_config[:order] ||= :position
     self.ordered_tree_config.update(options) if options.is_a?(Hash)
+
+    belongs_to :parent_node, :class_name => self.name, :foreign_key => ordered_tree_config[:foreign_key]
+    has_many :child_nodes, :class_name => self.name, :foreign_key => ordered_tree_config[:foreign_key], :order => ordered_tree_config[:order]
+    scope :roots, lambda { |*args|
+      scope_condition = args[0]
+      where(self.ordered_tree_config[:foreign_key].to_sym => 0).where(scope_condition).order(self.ordered_tree_config[:order])
+    }
+
+    # If the scope is something like :person, then turn it into :person_id
+    if self.ordered_tree_config[:scope].is_a?(Symbol) && self.ordered_tree_config[:scope].to_s !~ /_id$/
+      self.ordered_tree_config[:scope] = "#{self.ordered_tree_config[:scope]}_id".intern
+    end
+
+    if self.ordered_tree_config[:scope].is_a?(Symbol) # ie :person_id
+      define_method "scope_condition" do
+        self.class.send(:sanitize_sql_hash_for_conditions, {self.class.ordered_tree_config[:scope].to_sym => send(self.class.ordered_tree_config[:scope].to_sym)})
+      end
+    end
+
     include OrderedTree::ClassMethods
     include OrderedTree::InstanceMethods
   end #ordered_tree

data/ordered_tree.gemspec

@@ -5,16 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ordered_tree}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ramon Tayag"]
-  s.date = %q{2011-06-03}
+  s.date = %q{2011-06-13}
   s.description = %q{Uses parent_id and position to create an ordered tree.}
   s.email = %q{ramon@tayag.net}
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc",
     "README.textile"
   ]
   s.files = [
@@ -24,7 +23,6 @@ Gem::Specification.new do |s|
     "Gemfile.lock",
     "Guardfile",
     "LICENSE.txt",
-    "README.rdoc",
     "README.textile",
     "Rakefile",
     "VERSION",
@@ -36,6 +34,7 @@ Gem::Specification.new do |s|
     "lib/ordered_tree/instance_methods/misc.rb",
     "lib/ordered_tree/instance_methods/tree.rb",
     "ordered_tree.gemspec",
+    "spec/fixtures/page.rb",
     "spec/fixtures/person.rb",
     "spec/ordered_tree_spec.rb",
     "spec/spec_helper.rb"

data/spec/fixtures/page.rb

@@ -0,0 +1,4 @@
+class Page < ActiveRecord::Base
+  belongs_to :person
+  ordered_tree
+end

data/spec/fixtures/person.rb

@@ -1,3 +1,4 @@
 class Person < ActiveRecord::Base
+  has_many :pages
   ordered_tree
 end

data/spec/ordered_tree_spec.rb

@@ -6,6 +6,37 @@ describe OrderedTree do
     @people = Person.all
   end
 
+  describe "when a scope is supplied" do
+    # This is especially important for working with root items that may belong to different accounts
+    it "should only work within that scope" do
+      # when the scope is an association
+      ordered_tree Page, :scope => :person do
+        Page.create(:person => @people[0]).position.should == 1
+        Page.create(:person => @people[2]).position.should == 1
+        Page.create(:person => @people[0]).position.should == 2
+        Page.create(:person => @people[1]).position.should == 1
+      end
+
+      # when the scope is an association id
+      ordered_tree Page, :scope => :person_id do
+        Page.create(:person => @people[0]).position.should == 3
+        Page.create(:person => @people[2]).position.should == 2
+        Page.create(:person => @people[0]).position.should == 4
+        Page.create(:person => @people[1]).position.should == 2
+      end
+
+      # when the scope_condition method is overridden
+      Page.class_eval do
+        def scope_condition
+          "person_id = #{person_id} AND name = '#{name}'"
+        end
+      end
+      Page.create(:person => @people[3], :name => "frankenstein").position.should == 1
+      Page.create(:person => @people[3], :name => "steiners").position.should == 1
+      Page.create(:person => @people[3], :name => "frankenstein").position.should == 2
+    end
+  end
+
   describe "when assigning parent" do
     it "should do a bunch of tests on validation" do
       # "should not allow an ancestor of a node to be a child of that node"

data/spec/spec_helper.rb

@@ -5,6 +5,7 @@ require 'active_record'
 require 'rspec'
 require 'ordered_tree'
 require 'spec/fixtures/person'
+require 'spec/fixtures/page'
 
 #Allow to connect to SQLite
 ActiveRecord::Base.establish_connection(
@@ -20,7 +21,7 @@ RSpec.configure do |config|
 end
 
 def reset_database
-  %W(people).each do |table_name|
+  %W(people pages).each do |table_name|
     ActiveRecord::Base.connection.execute("DROP TABLE IF EXISTS '#{table_name}'")
   end
   ActiveRecord::Base.connection.create_table(:people) do |t|
@@ -29,6 +30,12 @@ def reset_database
     t.string :name
     #add_index :people, [:parent_id], :name => "index_people_on_parent_id"
   end
+  ActiveRecord::Base.connection.create_table(:pages) do |t|
+    t.integer :parent_id, :null => false, :default => 0
+    t.integer :position
+    t.string :name
+    t.integer :person_id
+  end
 end
 
 def ordered_tree(klass, *opts)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ordered_tree
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: 
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Ramon Tayag
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-03 00:00:00 +08:00
+date: 2011-06-13 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -160,7 +160,6 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE.txt
-- README.rdoc
 - README.textile
 files: 
 - .rvmrc
@@ -169,7 +168,6 @@ files:
 - Gemfile.lock
 - Guardfile
 - LICENSE.txt
-- README.rdoc
 - README.textile
 - Rakefile
 - VERSION
@@ -181,6 +179,7 @@ files:
 - lib/ordered_tree/instance_methods/misc.rb
 - lib/ordered_tree/instance_methods/tree.rb
 - ordered_tree.gemspec
+- spec/fixtures/page.rb
 - spec/fixtures/person.rb
 - spec/ordered_tree_spec.rb
 - spec/spec_helper.rb

data/README.rdoc

@@ -1,19 +0,0 @@
-= 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.
-