aeonscope-acts_as_list 1.0.0

data/CHANGELOG.rdoc

@@ -0,0 +1,5 @@
+= v1.0.0
+
+* Forked the original {Acts as List}[http://github.com/rails/acts_as_list/tree/master] plugin code.
+* Converted the plugin to a gem.
+* Added the ability to accept order/position via the parameter hash during new record creation.

data/LICENSE.rdoc

@@ -0,0 +1,18 @@
+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.rdoc

@@ -0,0 +1,46 @@
+= Overview
+
+Provides 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.
+
+= License
+
+Copyright (c) 2007 David Heinemeier Hansson, released under the MIT license (see the LICENSE file).
+
+= History
+
+See the CHANGELOG file for more info.
+
+= Requirements
+
+* Rails 2.3.x or higher.
+
+= Installation
+
+Type the following from the command line to install:
+
+* *UNIX*: sudo gem install aeonscope-acts_as_list
+* *Windows*: gem install aeonscope-acts_as_list
+
+Update your environment.rb file to include the new gem:
+
+* config.gem "aeonscope-acts_as_list", :lib => "acts_as_list", :source => "http://gems.github.com"
+
+= 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
+		
+= Contact/Feedback/Issues
+
+* {Berserk Technologies}[http://www.berserktech.com] - Company web site.
+* Aeonscope[http://www.aeonscope.net] - Personal web site.
+* Twitter[http://www.twitter.com/Aeonscope] - Short bursts of insight and/or noise.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "acts_as_list"
+    gem.summary = "A fork of the original Rails plugin which allows models to be ordered."
+    gem.description = "Allows models to be ordered."
+    gem.authors = ["David Heinemeier Hansson", "Brooke Kuhlmann"]
+    gem.email = "aeonscope@gmail.com"
+    gem.homepage = "http://github.com/aeonscope/acts_as_list"
+		gem.required_ruby_version = ">= 1.8.6"
+		gem.add_dependency "rails", ">= 2.3.2"
+		gem.rdoc_options << "CHANGELOG.rdoc"
+		gem.files = FileList["[A-Z]*", "{bin,lib,generators,rails_generators,test,spec}/**/*"]
+	end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "acts_as_list #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 1
+:minor: 0
+:patch: 0

data/lib/acts_as_list.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), "class_methods.rb")
+require File.join(File.dirname(__FILE__), "instance_methods.rb")
+
+module ActsAsList
+  def self.included base
+    base.extend ClassMethods
+  end
+  include InstanceMethods
+end
+
+ActiveRecord::Base.class_eval { include ActsAsList }

data/lib/class_methods.rb

@@ -0,0 +1,65 @@
+module ActsAsList
+  # 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.
+  #
+  # Todo list example:
+  #
+  #   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
+  module ClassMethods
+    # Configuration options are:
+    #
+    # * +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 = {})
+      configuration = { :column => "position", :scope => "1 = 1" }
+      configuration.update(options) if options.is_a?(Hash)
+
+      configuration[:scope] = "#{configuration[:scope]}_id".intern if configuration[:scope].is_a?(Symbol) && configuration[:scope].to_s !~ /_id$/
+
+      if configuration[:scope].is_a?(Symbol)
+        scope_condition_method = %(
+          def scope_condition
+            if #{configuration[:scope].to_s}.nil?
+              "#{configuration[:scope].to_s} IS NULL"
+            else
+              "#{configuration[:scope].to_s} = \#{#{configuration[:scope].to_s}}"
+            end
+          end
+        )
+      else
+        scope_condition_method = "def scope_condition() \"#{configuration[:scope]}\" end"
+      end
+
+      class_eval <<-EOV
+        include ActsAsList::InstanceMethods
+
+        def acts_as_list_class
+          ::#{self.name}
+        end
+
+        def position_column
+          '#{configuration[:column]}'
+        end
+
+        #{scope_condition_method}
+
+        before_destroy :remove_from_list
+        before_create  :add_to_list_bottom
+      EOV
+    end
+  end
+end

data/lib/instance_methods.rb

@@ -0,0 +1,184 @@
+module ActsAsList
+  # 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
+    # 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
+
+      # Overwrite this method to define the scope of the list changes
+      def scope_condition() "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

data/spec/acts_as_list_spec.rb

@@ -0,0 +1,6 @@
+require File.join(File.dirname(__FILE__), "spec_helper.rb")
+
+describe "ActsAsList" do
+  it "ToDo..." do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'acts_as_list'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: aeonscope-acts_as_list
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- David Heinemeier Hansson
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-10 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.2
+    version: 
+description: Allows models to be ordered.
+email: aeonscope@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.rdoc
+- README.rdoc
+files: 
+- CHANGELOG.rdoc
+- LICENSE.rdoc
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/acts_as_list.rb
+- lib/class_methods.rb
+- lib/instance_methods.rb
+- spec/acts_as_list_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/aeonscope/acts_as_list
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+- CHANGELOG.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.6
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A fork of the original Rails plugin which allows models to be ordered.
+test_files: 
+- spec/acts_as_list_spec.rb
+- spec/spec_helper.rb