acts_as_list_with_sti_support 1.0.1 → 1.0.2

data/.specification

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_list_with_sti_support
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 0
-  version: 1.0.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
 - Coroutine
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-10 00:00:00 -05:00
+date: 2010-11-05 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 

data/Rakefile

@@ -1,28 +1,28 @@
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-require 'jeweler'
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+require "jeweler"
 
 
-desc 'Default: run tests.'
+desc "Default: run tests."
 task :default => [:test]
 
 
-desc 'Test the plugin.'
+desc "Test the gem."
 Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = true
+  t.libs    << ["lib", "test"]
+  t.pattern  = "test/**/*_test.rb"
+  t.verbose  = true
 end
 
 
-desc 'Generate documentation for the plugin.'
+desc 'Generate documentation for the gem.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'acts_as_list_with_sti_support'
-  rdoc.options << '--line-numbers --inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "acts_as_list_with_sti_support"
+  rdoc.options << "--line-numbers --inline-source"
+  rdoc.rdoc_files.include("README")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 
@@ -30,7 +30,7 @@ begin
   Jeweler::Tasks.new do |gemspec|
     gemspec.authors           = ["Coroutine", "John Dugan"]
     gemspec.description       = "This acts_as extension does everything acts_as_list does, but it also works in single table inheritance designs and accepts less brain-damaged scope syntax."
-    gemspec.email             = "jdugan@coroutine.com"
+    gemspec.email             = "gem@coroutine.com"
     gemspec.homepage          = "http://github.com/coroutine/acts_as_list_with_sti_support"
     gemspec.name              = "acts_as_list_with_sti_support"
     gemspec.summary           = "Gem version of acts_as_list_with_sti_support Rails plugin, a smarter version of acts_as_list."

data/VERSION

@@ -1 +1 @@
-1.0.1
+1.0.2

data/acts_as_list_with_sti_support.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{acts_as_list_with_sti_support}
-  s.version = "1.0.1"
+  s.version = "1.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Coroutine", "John Dugan"]
-  s.date = %q{2010-11-05}
+  s.date = %q{2010-12-13}
   s.description = %q{This acts_as extension does everything acts_as_list does, but it also works in single table inheritance designs and accepts less brain-damaged scope syntax.}
-  s.email = %q{jdugan@coroutine.com}
+  s.email = %q{gem@coroutine.com}
   s.extra_rdoc_files = [
     "README.rdoc"
   ]

data/lib/acts_as_list_with_sti_support/base.rb

@@ -69,27 +69,29 @@ module Coroutine                    #:nodoc:
             validates_numericality_of   column, :only_integer => true, :greater_than => 0, :allow_nil => true
             
             
-            # Add callbacks
-            begin
-              before_validation             :add_to_list_bottom, :on => :create     # rails 3
-            rescue
-              before_validation_on_create   :add_to_list_bottom                     # rails 2
-            end
-            before_destroy                  :remove_from_list
-            
-            
-            # if no default scoping, order by position
-            if self.default_scoping.empty?
-              default_scope :order => column.to_s
-            end
-            
-            
             # Include instance methods
             include Coroutine::ActsAsList::Base::InstanceMethods
 
+
+            # rails 3
+            if self.respond_to?(:arel_table)
+              before_validation             :add_to_list_bottom, :if => :position_blank?, :on => :create     
+              before_destroy                :remove_from_list
+            
+            # rails 2
+            else
+              before_validation_on_create   :add_to_list_bottom, :if => :position_blank? 
+              before_destroy                :remove_from_list
+              
+              if self.default_scoping.empty?
+                default_scope :order => column.to_s
+              end
+            end
+            
           end
           
         end
+         
       end
 
 
@@ -100,18 +102,21 @@ module Coroutine                    #:nodoc:
       #
       module InstanceMethods
         
-        # Return the instance's class object
+        # This method returns the instance's class object
+        #
         def acts_as_list_class
           self.class
         end
         
-        # Returns the column name that holds the position value.
+        # This method returns the column name that holds the position value.
+        #
         def position_column
           acts_as_list_column
         end
         
-        # Returns the scope condition appropriate for the specified definition. (This could probably
-        # be refactored for brevity.)
+        # This method returns the scope condition appropriate for the specified definition. (This 
+        # could probably be refactored for brevity.)
+        #
         def scope_condition
           if acts_as_list_scope_condition.nil?
             
@@ -224,20 +229,21 @@ module Coroutine                    #:nodoc:
         def higher_item
           return nil unless in_list?
           conditions = "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
-          begin
+          if self.rails_3?
             acts_as_list_class.where(conditions).first
-          rescue
+          else
             acts_as_list_class.find(:first, :conditions => conditions)
           end
         end
 
-        # Return the next lower item in the list.
+        # This method returns the next lower item in the list.
+        #
         def lower_item
           return nil unless in_list?
           conditions = "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
-          begin
+          if self.rails_3?
             acts_as_list_class.where(conditions).first
-          rescue
+          else
             acts_as_list_class.find(:first, :conditions => conditions)
           end
         end
@@ -247,40 +253,55 @@ module Coroutine                    #:nodoc:
           !send(position_column).nil?
         end
 
+        # This returns whether or not the position column is blank.
+        def position_blank?
+          return self.send(position_column).blank?
+        end
+        
+        # This method indicates whether or not the gem is being used within the 
+        # rails 3 environment.
+        def rails_3?
+          return acts_as_list_class.respond_to?(:arel_table)
+        end
+        
+        
+        
         private
+          
+          # This method adds the new item to the top of the list.
           def add_to_list_top
             increment_positions_on_all_items
           end
 
+          # This method adds the new item to the bottom of the list.
           def add_to_list_bottom
             self[position_column] = bottom_position_in_list.to_i + 1
           end
 
-          # Returns the bottom position number in the list.
-          #   bottom_position_in_list    # => 2
+          # This method returns the bottom position number in the list.
           def bottom_position_in_list(except = nil)
             item = bottom_item(except)
             item ? item.send(position_column) : 0
           end
 
-          # Returns the bottom item
+          # This method returns the bottom item.
           def bottom_item(except = nil)
             conditions  = scope_condition
-            conditions  = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
+            conditions  = "#{conditions} AND #{self.class.primary_key} != #{except.id}" unless except.blank?
             order_by    = "#{position_column} DESC"
-            begin
-              acts_as_list_class.where(conditions).first.order(order_by)
-            rescue
+            if self.rails_3?
+              acts_as_list_class.where(conditions).order(order_by).first
+            else
               acts_as_list_class.find(:first, :conditions => conditions, :order => order_by)
             end
           end
 
-          # Forces item to assume the bottom position in the list.
+          # This method forces item to assume the bottom position in the list.
           def assume_bottom_position
             update_attribute(position_column, bottom_position_in_list(self).to_i + 1)
           end
 
-          # Forces item to assume the top position in the list.
+          # This method forces item to assume the top position in the list.
           def assume_top_position
             update_attribute(position_column, 1)
           end
@@ -322,6 +343,7 @@ module Coroutine                    #:nodoc:
             )
           end
 
+          # This adds the item at the specified position value.
           def insert_at_position(position)
             remove_from_list
             increment_positions_on_lower_items(position)

data/test/acts_as_list_with_sti_support_test.rb

@@ -3,7 +3,7 @@
 #---------------------------------------------------------
 
 # all generic requirements are in the helper
-require "test/test_helper"
+require "test_helper"
 
 
 
@@ -99,9 +99,9 @@ end
 
 # Contacts
 class Contact < ActiveRecord::Base
-  has_many :emails
-  has_many :phones
-  has_many :websites
+  has_many :emails,   :order => "pos"
+  has_many :phones,   :order => "position"
+  has_many :websites, :order => "position"
   
   def email_ids
     self.emails(true).map(&:id)
@@ -276,6 +276,39 @@ class ActsAsListTest < ActiveSupport::TestCase
   
   
   
+  #---------------------------------------------
+  # test default ordering
+  #---------------------------------------------
+  
+  def test_default_ordering
+  
+    # standard model
+    assert_equal 4, Contact.first.phones.size
+    
+    p3 = Phone.create!({ :contact_id => Contact.last.id,  :number => "901.555.7777" })
+    assert_equal 3, p3.position
+    
+    p5 = Phone.create!({ :contact_id => Contact.last.id,  :number => "901.555.9999", :position => 5 })
+    p4 = Phone.create!({ :contact_id => Contact.last.id,  :number => "901.555.8888", :position => 4 })
+    assert_equal 4, p4.position
+    assert_equal 5, p5.position
+    
+    
+    # sti model
+    assert_equal 0, TaxFrequency.count
+    
+    t1 = TaxFrequency.create!({ :label => "Monthly" })
+    assert_equal 1, t1.position
+    
+    t3 = TaxFrequency.create!({ :label => "Yearly",    :position => 3 })
+    t2 = TaxFrequency.create!({ :label => "Quarterly", :position => 2 }) 
+    assert_equal 2, t2.position
+    assert_equal 3, t3.position
+    
+  end
+    
+    
+    
   #---------------------------------------------
   # test ordering methods
   #---------------------------------------------
@@ -285,51 +318,51 @@ class ActsAsListTest < ActiveSupport::TestCase
     # standard model
     contact = Contact.first
     assert_equal [1, 2, 3, 4], contact.phone_ids
-
+  
     Phone.find(2).move_lower
     assert_equal [1, 3, 2, 4], contact.phone_ids
-
+  
     Phone.find(2).move_higher
     assert_equal [1, 2, 3, 4], contact.phone_ids
-
+  
     Phone.find(1).move_to_bottom
     assert_equal [2, 3, 4, 1], contact.phone_ids
-
+  
     Phone.find(1).move_to_top
     assert_equal [1, 2, 3, 4], contact.phone_ids
-
+  
     Phone.find(2).move_to_bottom
     assert_equal [1, 3, 4, 2], contact.phone_ids
-
+  
     Phone.find(4).move_to_top
     assert_equal [4, 1, 3, 2], contact.phone_ids
     
     
     # sti model
     assert_equal [1, 2, 3, 4], BillingFrequency.ids
-
+  
     BillingFrequency.find(2).move_lower
     assert_equal [1, 3, 2, 4], BillingFrequency.ids
-
+  
     BillingFrequency.find(2).move_higher
     assert_equal [1, 2, 3, 4], BillingFrequency.ids
-
+  
     BillingFrequency.find(1).move_to_bottom
     assert_equal [2, 3, 4, 1], BillingFrequency.ids
-
+  
     BillingFrequency.find(1).move_to_top
     assert_equal [1, 2, 3, 4], BillingFrequency.ids
-
+  
     BillingFrequency.find(2).move_to_bottom
     assert_equal [1, 3, 4, 2], BillingFrequency.ids
-
+  
     BillingFrequency.find(4).move_to_top
     assert_equal [4, 1, 3, 2], BillingFrequency.ids
   end
-
-
+  
+  
   def test_move_to_bottom_with_next_to_last_item
-
+  
     # standard model
     contact = Contact.first
     assert_equal [1, 2, 3, 4], contact.phone_ids
@@ -360,8 +393,8 @@ class ActsAsListTest < ActiveSupport::TestCase
     assert_equal BillingFrequency.find(3), BillingFrequency.find(4).higher_item
     assert_nil BillingFrequency.find(4).lower_item
   end
- 
- 
+   
+   
   def test_insert
     
     # standard model
@@ -369,17 +402,17 @@ class ActsAsListTest < ActiveSupport::TestCase
     assert_equal 1, new.position
     assert new.first?
     assert new.last?
-
+  
     new = Phone.create(:contact_id => 3, :number => "901.555.8888")
     assert_equal 2, new.position
     assert !new.first?
     assert new.last?
-
+  
     new = Phone.create(:contact_id => 3, :number => "901.555.9999")
     assert_equal 3, new.position
     assert !new.first?
     assert new.last?
-
+  
     new = Phone.create(:contact_id => 4, :number => "901.555.0000")
     assert_equal 1, new.position
     assert new.first?
@@ -391,17 +424,17 @@ class ActsAsListTest < ActiveSupport::TestCase
     assert_equal 1, new.position
     assert new.first?
     assert new.last?
-
+  
     new = TaxFrequency.create(:label => "Quarterly")
     assert_equal 2, new.position
     assert !new.first?
     assert new.last?
-
+  
     new = TaxFrequency.create(:label => "Yearly")
     assert_equal 3, new.position
     assert !new.first?
     assert new.last?
-
+  
     new = PaymentFrequency.create(:label => "Monthly")
     assert_equal 1, new.position
     assert new.first?
@@ -414,34 +447,34 @@ class ActsAsListTest < ActiveSupport::TestCase
     # stadard model
     new = Phone.create(:contact_id => 3, :number => "615.555.1111")
     assert_equal 1, new.position
-
+  
     new = Phone.create(:contact_id => 3, :number => "615.555.2222")
     assert_equal 2, new.position
-
+  
     new = Phone.create(:contact_id => 3, :number => "615.555.3333")
     assert_equal 3, new.position
-
+  
     new4 = Phone.create(:contact_id => 3, :number => "615.555.4444")
     assert_equal 4, new4.position
-
+  
     new4.insert_at(3)
     assert_equal 3, new4.position
-
+  
     new.reload
     assert_equal 4, new.position
-
+  
     new.insert_at(2)
     assert_equal 2, new.position
-
+  
     new4.reload
     assert_equal 4, new4.position
-
+  
     new5 = Phone.create(:contact_id => 3, :number => "615.555.5555")
     assert_equal 5, new5.position
-
+  
     new5.insert_at(1)
     assert_equal 1, new5.position
-
+  
     new4.reload
     assert_equal 5, new4.position
     
@@ -449,45 +482,45 @@ class ActsAsListTest < ActiveSupport::TestCase
     # sti model
     new = TaxFrequency.create(:label => "Weekly")
     assert_equal 1, new.position
-
+  
     new = TaxFrequency.create(:label => "Monthly")
     assert_equal 2, new.position
-
+  
     new = TaxFrequency.create(:label => "Quarterly")
     assert_equal 3, new.position
-
+  
     new4 = TaxFrequency.create(:label => "Yearly")
     assert_equal 4, new4.position
-
+  
     new4.insert_at(3)
     assert_equal 3, new4.position
-
+  
     new.reload
     assert_equal 4, new.position
-
+  
     new.insert_at(2)
     assert_equal 2, new.position
-
+  
     new4.reload
     assert_equal 4, new4.position
-
+  
     new5 = TaxFrequency.create(:label => "Daily")
     assert_equal 5, new5.position
-
+  
     new5.insert_at(1)
     assert_equal 1, new5.position
-
+  
     new4.reload
     assert_equal 5, new4.position
   end
-
-
+  
+  
   def test_delete_middle
     
     # standard model
     contact = Contact.first
     assert_equal [1, 2, 3, 4], contact.phone_ids
-
+  
     Phone.find(2).destroy
     assert_equal [1, 3, 4], contact.phone_ids
     
@@ -498,8 +531,8 @@ class ActsAsListTest < ActiveSupport::TestCase
     Phone.find(1).destroy
     assert_equal [3, 4], contact.phone_ids
     
-    # assert_equal 1, Phone.find(3).position
-    # assert_equal 2, Phone.find(4).position
+    assert_equal 1, Phone.find(3).position
+    assert_equal 2, Phone.find(4).position
     
     
     # sti model
@@ -518,8 +551,8 @@ class ActsAsListTest < ActiveSupport::TestCase
     assert_equal 1, BillingFrequency.find(3).position
     assert_equal 2, BillingFrequency.find(4).position
   end
-
-
+  
+  
   def test_remove_from_list_should_then_fail_in_list? 
     
     # standard model
@@ -535,7 +568,7 @@ class ActsAsListTest < ActiveSupport::TestCase
     BillingFrequency.find(1).remove_from_list
     assert_equal false, BillingFrequency.find(1).in_list?
   end 
-
+  
    
   def test_remove_from_list_should_set_position_to_nil 
     
@@ -563,8 +596,8 @@ class ActsAsListTest < ActiveSupport::TestCase
     assert_equal 2,   BillingFrequency.find(3).position
     assert_equal 3,   BillingFrequency.find(4).position
   end 
-
-
+  
+  
   def test_remove_before_destroy_does_not_shift_lower_items_twice 
     
     # standard model

data/test/test_helper.rb

@@ -13,13 +13,33 @@ require "#{File.dirname(__FILE__)}/../init"
 # Define global methods
 #----------------------------------------------------------
 
+def puts_debug(*args)
+  objs = args.flatten
+  
+  puts ""
+  puts "======================================"
+  objs.each_with_index do |obj, index|
+    puts "--------------------------------------" unless index == 0
+    puts "DEBUG: #{obj.inspect}"
+  end
+  puts "======================================"
+  puts ""
+end
+
+
+
+#----------------------------------------------------------
+# Extend test class
+#----------------------------------------------------------
+
 class ActiveSupport::TestCase
   
   # This method allows us to use a convenient notation for testing
   # model validations.
+  #
   def assert_not_valid(object, msg="Object is valid when it should be invalid")
     assert(!object.valid?, msg)
   end
   alias :assert_invalid :assert_not_valid
-
+  
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: acts_as_list_with_sti_support
 version: !ruby/object:Gem::Version 
-  hash: 21
   prerelease: false
   segments: 
   - 1
   - 0
-  - 1
-  version: 1.0.1
+  - 2
+  version: 1.0.2
 platform: ruby
 authors: 
 - Coroutine
@@ -16,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 -05:00
+date: 2010-12-13 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -27,7 +26,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 2
         - 3
@@ -43,7 +41,6 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 11
         segments: 
         - 2
         - 3
@@ -52,7 +49,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 description: This acts_as extension does everything acts_as_list does, but it also works in single table inheritance designs and accepts less brain-damaged scope syntax.
-email: jdugan@coroutine.com
+email: gem@coroutine.com
 executables: []
 
 extensions: []
@@ -87,7 +84,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -96,7 +92,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"