acts_as_list_with_sti_support 0.1.0 → 0.1.1

data/.specification

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: acts_as_list_with_sti_support
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Coroutine
+- John Dugan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-10 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: This acts_as extension provides the capabilities for sorting and reordering a number of objects in a list. The class that has this specified needs to have a position column defined as an integer on the mapped database table.
+email: jdugan@coroutine.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/coroutine/acts_as_label_with_sti_support
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Gem version of acts_as_list_with_sti_support Rails plugin, a smarter version of acts_as_list.
+test_files: 
+- test/acts_as_list_with_sti_support_test.rb
+- test/test_helper.rb
+

data/README.rdoc

@@ -38,9 +38,17 @@ The plugin accepts two optional parameters.
 The +scope+ option can be supplied as a symbol or as a lambda.  The generated scope condition
 will differ depending on the value's Type and the schema of the associated table.
 
-+scope => type_symbol+:: yields "type_id = '99'", if type_id is defined on the table
-+scope => type_symbol+:: yields "type = '99'", if type_id is not defined on the table 
-+scope => lambda { |instance| "type_id = '#{instance.type_id}'"}+:: yields "type_id = '99'"
+  # yields "type_id = '99'", if type_id is defined on the table
+  # yields "type = '99'", if type_id is not defined on the table 
+  class MyListItem < ActiveRecord::Base
+    acts_as_list :scope => :type									
+  end
+
+  # yields "type_id = '99'"
+  class MyListItem < ActiveRecord::Base
+    acts_as_list :scope => lambda { |instance| "type_id = '#{instance.type_id}'" }
+  end
+
 
 If you use the plugin within a single table inheritance (STI) design, no extra configuration is needed
 to cause the position values to be scoped by type.

data/Rakefile

@@ -32,7 +32,7 @@ begin
     gemspec.summary           = "Gem version of acts_as_list_with_sti_support Rails plugin, a smarter version of acts_as_list."
     gemspec.description       = "This acts_as extension provides the capabilities for sorting and reordering a number of objects in a list. The class that has this specified needs to have a position column defined as an integer on the mapped database table."
     gemspec.email             = "jdugan@coroutine.com"
-    gemspec.homepage          = "http://github.com/coroutine/acts_as_label_with_sti_support"
+    gemspec.homepage          = "http://github.com/coroutine/acts_as_list_with_sti_support"
     gemspec.authors           = ["Coroutine", "John Dugan"]
     gemspec.add_dependency "activesupport"
   end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/acts_as_list_with_sti_support.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{acts_as_list_with_sti_support}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Coroutine", "John Dugan"]
+  s.date = %q{2010-03-10}
+  s.description = %q{This acts_as extension provides the capabilities for sorting and reordering a number of objects in a list. The class that has this specified needs to have a position column defined as an integer on the mapped database table.}
+  s.email = %q{jdugan@coroutine.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    ".specification",
+     "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "acts_as_list_with_sti_support-0.1.0.gem",
+     "acts_as_list_with_sti_support.gemspec",
+     "init.rb",
+     "lib/acts_as_list_with_sti_support.rb",
+     "test/acts_as_list_with_sti_support_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/coroutine/acts_as_list_with_sti_support}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Gem version of acts_as_list_with_sti_support Rails plugin, a smarter version of acts_as_list.}
+  s.test_files = [
+    "test/acts_as_list_with_sti_support_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, [">= 0"])
+  end
+end
+

data/lib/acts_as_list_with_sti_support.rb

@@ -0,0 +1,319 @@
+module Coroutine                    #:nodoc:
+  module Acts                       #:nodoc:
+    module List                     #:nodoc:
+      
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      
+      module ClassMethods
+        
+        # = Description
+        #
+        # This +acts_as+ extension provides the capabilities for sorting and reordering a number of objects in a list.
+        # The class that has this specified needs to have a +position+ column defined as an integer on
+        # the mapped database table.
+        #
+        #
+        # = Usage
+        #
+        #   class TodoList < ActiveRecord::Base
+        #     has_many :todo_items, :order => "position"
+        #   end
+        #
+        #   class TodoItem < ActiveRecord::Base
+        #     belongs_to :todo_list
+        #     acts_as_list :scope => :todo_list
+        #   end
+        #
+        #   todo_list.first.move_to_bottom
+        #   todo_list.last.move_higher
+        #
+        #
+        # = Configuration
+        #
+        # * +column+ - specifies the column name to use for keeping the position integer (default: +position+)
+        # * +scope+ - restricts what is to be considered a list. Given a symbol, it'll attach <tt>_id</tt> 
+        #   (if it hasn't already been added) and use that as the foreign key restriction. It's also possible 
+        #   to give it an entire string that is interpolated if you need a tighter scope than just a foreign key.
+        #   Example: <tt>acts_as_list :scope => 'todo_list_id = #{todo_list_id} AND completed = 0'</tt>
+        #
+        def acts_as_list(options = {})
+          
+          #-------------------------------------------
+          # scrub options
+          #-------------------------------------------
+          options       = {} if !options.is_a?(Hash)
+          column        = options.key?(:column) ? options[:column]  : :position
+          scope         = options.key?(:scope)  ? options[:scope]   : "1 = 1"
+                    
+
+          #--------------------------------------------
+          # mix methods into class definition
+          #--------------------------------------------
+          class_eval do
+            
+            # Add inheritable accessors
+            write_inheritable_attribute :acts_as_list_column,           column
+            class_inheritable_reader    :acts_as_list_column
+            write_inheritable_attribute :acts_as_list_scope,            scope
+            class_inheritable_reader    :acts_as_list_scope
+            write_inheritable_attribute :acts_as_list_default_scope,    "1 = 1"
+            class_inheritable_reader    :acts_as_list_default_scope
+            write_inheritable_attribute :acts_as_list_scope_condition,  nil
+            class_inheritable_reader    :acts_as_list_scope_condition
+            
+            
+            # Add validations (column is allowed to be nil to support soft deletes)
+            validates_numericality_of   column, :only_integer => true, :greater_than => 0, :allow_nil => true
+            
+            
+            # Add callbacks
+            before_validation_on_create   :add_to_list_bottom
+            before_destroy                :remove_from_list
+            
+            
+            # if no default scoping, order by position
+            if self.default_scoping.empty?
+              default_scope :order => column
+            end
+            
+            
+            # Include instance methods
+            include Coroutine::Acts::List::InstanceMethods
+
+          end
+          
+        end
+      end
+
+
+      # All the methods available to a record that has had <tt>acts_as_list</tt> specified. Each method works
+      # by assuming the object to be the item in the list, so <tt>chapter.move_lower</tt> would move that chapter
+      # lower in the list of all chapters. Likewise, <tt>chapter.first?</tt> would return +true+ if that chapter is
+      # the first in the list of all chapters.
+      #
+      module InstanceMethods
+        
+        # Return the instance's class object
+        def acts_as_list_class
+          self.class
+        end
+        
+        # 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.)
+        def scope_condition
+          if acts_as_list_scope_condition.nil?
+            
+            # if symbol, do convenience conversions
+            if acts_as_list_scope.is_a?(Symbol)
+              scope_as_sym  = acts_as_list_scope
+              scope_as_str  = acts_as_list_scope.to_s
+              if scope_as_str.nil?
+                acts_as_list_scope_condition = "#{scope_as_str} IS NULL"
+              else
+                scope_with_id = scope_as_str + "_id"
+                if scope_as_str !~ /_id$/ && acts_as_list_class.column_names.include?("#{scope_with_id}")
+                  scope_as_sym = scope_with_id.to_sym
+                  scope_as_str = scope_as_sym.to_s
+                end
+                acts_as_list_scope_condition = "#{scope_as_str} = \'#{self[scope_as_sym]}\'"
+              end
+            
+            # if lambda, execute in scope of instance
+            elsif acts_as_list_scope.is_a?(Proc)
+              acts_as_list_scope_condition = acts_as_list_scope.call(self)
+              
+            # else, return string as is  
+            else
+             acts_as_list_scope_condition = !acts_as_list_scope.blank? ? acts_as_list_scope.to_s : acts_as_list_default_scope.to_s
+            end
+          end
+          
+          acts_as_list_scope_condition
+        end
+                
+        # Insert the item at the given position (defaults to the top position of 1).
+        def insert_at(position = 1)
+          insert_at_position(position)
+        end
+
+        # Swap positions with the next lower item, if one exists.
+        def move_lower
+          return unless lower_item
+          
+          acts_as_list_class.transaction do
+            lower_item.decrement_position
+            increment_position
+          end
+        end
+
+        # Swap positions with the next higher item, if one exists.
+        def move_higher
+          return unless higher_item
+
+          acts_as_list_class.transaction do
+            higher_item.increment_position
+            decrement_position
+          end
+        end
+
+        # Move to the bottom of the list. If the item is already in the list, the items below it have their
+        # position adjusted accordingly.
+        def move_to_bottom
+          return unless in_list?
+          acts_as_list_class.transaction do
+            decrement_positions_on_lower_items
+            assume_bottom_position
+          end
+        end
+
+        # Move to the top of the list. If the item is already in the list, the items above it have their
+        # position adjusted accordingly.
+        def move_to_top
+          return unless in_list?
+          acts_as_list_class.transaction do
+            increment_positions_on_higher_items
+            assume_top_position
+          end
+        end
+
+        # Removes the item from the list.
+        def remove_from_list
+          if in_list?
+            decrement_positions_on_lower_items
+            update_attribute position_column, nil
+          end
+        end
+
+        # Increase the position of this item without adjusting the rest of the list.
+        def increment_position
+          return unless in_list?
+          update_attribute position_column, self.send(position_column).to_i + 1
+        end
+
+        # Decrease the position of this item without adjusting the rest of the list.
+        def decrement_position
+          return unless in_list?
+          update_attribute position_column, self.send(position_column).to_i - 1
+        end
+
+        # Return +true+ if this object is the first in the list.
+        def first?
+          return false unless in_list?
+          self.send(position_column) == 1
+        end
+
+        # Return +true+ if this object is the last in the list.
+        def last?
+          return false unless in_list?
+          self.send(position_column) == bottom_position_in_list
+        end
+
+        # Return the next higher item in the list.
+        def higher_item
+          return nil unless in_list?
+          acts_as_list_class.find(:first, :conditions =>
+            "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i - 1).to_s}"
+          )
+        end
+
+        # Return the next lower item in the list.
+        def lower_item
+          return nil unless in_list?
+          acts_as_list_class.find(:first, :conditions =>
+            "#{scope_condition} AND #{position_column} = #{(send(position_column).to_i + 1).to_s}"
+          )
+        end
+
+        # Test if this record is in a list
+        def in_list?
+          !send(position_column).nil?
+        end
+
+        private
+          def add_to_list_top
+            increment_positions_on_all_items
+          end
+
+          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
+          def bottom_position_in_list(except = nil)
+            item = bottom_item(except)
+            item ? item.send(position_column) : 0
+          end
+
+          # Returns the bottom item
+          def bottom_item(except = nil)
+            conditions = scope_condition
+            conditions = "#{conditions} AND #{self.class.primary_key} != #{except.id}" if except
+            acts_as_list_class.find(:first, :conditions => conditions, :order => "#{position_column} DESC")
+          end
+
+          # 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.
+          def assume_top_position
+            update_attribute(position_column, 1)
+          end
+
+          # This has the effect of moving all the higher items up one.
+          def decrement_positions_on_higher_items(position)
+            acts_as_list_class.update_all(
+              "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} <= #{position}"
+            )
+          end
+
+          # This has the effect of moving all the lower items up one.
+          def decrement_positions_on_lower_items
+            return unless in_list?
+            acts_as_list_class.update_all(
+              "#{position_column} = (#{position_column} - 1)", "#{scope_condition} AND #{position_column} > #{send(position_column).to_i}"
+            )
+          end
+
+          # This has the effect of moving all the higher items down one.
+          def increment_positions_on_higher_items
+            return unless in_list?
+            acts_as_list_class.update_all(
+              "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} < #{send(position_column).to_i}"
+            )
+          end
+
+          # This has the effect of moving all the lower items down one.
+          def increment_positions_on_lower_items(position)
+            acts_as_list_class.update_all(
+              "#{position_column} = (#{position_column} + 1)", "#{scope_condition} AND #{position_column} >= #{position}"
+           )
+          end
+
+          # Increments position (<tt>position_column</tt>) of all items in the list.
+          def increment_positions_on_all_items
+            acts_as_list_class.update_all(
+              "#{position_column} = (#{position_column} + 1)",  "#{scope_condition}"
+            )
+          end
+
+          def insert_at_position(position)
+            remove_from_list
+            increment_positions_on_lower_items(position)
+            self.update_attribute(position_column, position)
+          end
+          
+      end 
+    end
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Coroutine
@@ -39,14 +39,19 @@ extensions: []
 extra_rdoc_files: 
 - README.rdoc
 files: 
+- .specification
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
 - VERSION
+- acts_as_list_with_sti_support-0.1.0.gem
+- acts_as_list_with_sti_support.gemspec
 - init.rb
+- lib/acts_as_list_with_sti_support.rb
+- test/acts_as_list_with_sti_support_test.rb
 - test/test_helper.rb
 has_rdoc: true
-homepage: http://github.com/coroutine/acts_as_label_with_sti_support
+homepage: http://github.com/coroutine/acts_as_list_with_sti_support
 licenses: []
 
 post_install_message: