is_positionable 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Michael van Rooijen | Meskyanichi
+
+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,18 @@
+= ip
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 meskyanichi. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,61 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "is_positionable"
+    gem.summary = %Q{Handles positioning (ordering) your ActiveRecord Objects.}
+    gem.description = %Q{
+                          Handles positioning (ordering) your ActiveRecord Objects.
+                          Makes use of the "Acts As List" plugin for the optimized background handling of the positioning.
+                          "Is Positionable" is a front-end that dynamically generates buttons for moving ActiveRecord Objects
+                          "up", "down", to the "top" and to the "bottom". Setting it up takes just 1 word: "is_positionable".
+                        }
+    gem.email = "meskyan@gmail.com"
+    gem.homepage = "http://github.com/meskyanichi/is_positionable"
+    gem.authors = ["meskyanichi"]
+    gem.add_dependency "acts_as_list"
+#    gem.files.include 'lib/**/*'
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ip #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "lib", "is_positionable")

data/is_positionable.gemspec

@@ -0,0 +1,56 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{is_positionable}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["meskyanichi"]
+  s.date = %q{2009-10-05}
+  s.description = %q{
+                          Handles positioning (ordering) your ActiveRecord Objects.
+                          Makes use of the "Acts As List" plugin for the optimized background handling of the positioning.
+                          "Is Positionable" is a front-end that dynamically generates buttons for moving ActiveRecord Objects
+                          "up", "down", to the "top" and to the "bottom". Setting it up takes just 1 word: "is_positionable".
+                        }
+  s.email = %q{meskyan@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "is_positionable.gemspec",
+     "lib/is_positionable.rb",
+     "lib/is_positionable/base.rb",
+     "lib/is_positionable/errors/no_method_error/acts_as_list.rb",
+     "lib/is_positionable/interface.rb"
+  ]
+  s.homepage = %q{http://github.com/meskyanichi/is_positionable}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Handles positioning (ordering) your ActiveRecord Objects.}
+
+  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<acts_as_list>, [">= 0"])
+    else
+      s.add_dependency(%q<acts_as_list>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<acts_as_list>, [">= 0"])
+  end
+end

data/lib/is_positionable/base.rb

@@ -0,0 +1,11 @@
+module IsPositionable
+  class Base
+    
+    attr_accessor :options
+    
+    def initialize(options = {})
+      self.options = options
+    end
+    
+  end
+end

data/lib/is_positionable/errors/no_method_error/acts_as_list.rb

@@ -0,0 +1,24 @@
+module IsPositionable
+  module Errors
+    module NoMethodError
+      class ActsAsList
+        def initialize
+          raise <<-MSG
+The Acts As List Gem / Plugin has not been installed!
+
+To install the gem:
+sudo gem install acts_as_list
+
+To install the plugin:
+./script/plugin install git://github.com/rails/acts_as_list.git
+
+
+Although this is not "required", I do recommend you (if using the GEM version)
+to add the following line inside of your config/environment.rb file:
+config.gem "acts_as_list"
+          MSG
+        end
+      end
+    end
+  end
+end

data/lib/is_positionable/interface.rb

@@ -0,0 +1,117 @@
+module IsPositionable
+  class Interface < IsPositionable::Base
+    
+    def initialize(options, controller_name)
+      super({
+        :column             => :position,
+        :controller         => options[:controller] || controller_name,
+        :model              => options[:controller] || controller_name,
+        :action             => :positionable,
+        :scope              => nil,
+        :redirect_to        => :back,
+        :param              => :move,
+        :set_default_scope  => true
+      }.update(options))
+    end
+    
+    def build
+      self
+    end
+    
+    # Finds a single record by id
+    # It will determine whether to use a plain find
+    # or whether to use a find through an association
+    def find(id)
+      if scope.nil?
+        model.find(id)
+      else
+        scope.send(model_association_name).find(id)
+      end
+    end
+    
+    # Finds the last id of a list of records
+    # It will determine whether to use a plain find
+    # or whether to use a find through an association
+    def find_last_id
+      if scope.nil?
+        model.all.last.id 
+      else
+        scope.send(model_association_name).last.id
+      end
+    end
+    
+    # Returns the value of the :redirect_to attribute
+    def redirect
+      options[:redirect_to]
+    end
+    
+    # Returns the value of the :scope attribute
+    def scope
+      options[:scope]
+    end
+    
+    # Returns the model Class which can be invoked using class methods    
+    def model
+      Kernel.const_get(options[:model].singularize.camelize)
+    end
+    
+    # Returns the controller Class which can be invoked using class methods
+    def controller
+      Kernel.const_get("#{controller_name.camelize.pluralize}Controller")
+    end
+    
+    # Returns the action name of the :action attribute
+    def action_name
+      options[:action]
+    end
+    
+    # Returns the model name of the :model attribute
+    # The value will be singularize'd and camelize'd to
+    # return the exact name as it is written inside a Ruby file
+    def model_name
+      options[:model].singularize.camelize
+    end
+    
+    # Returns the model name in the form of an association
+    # This is the model name, pluralize'd and underscore'd
+    def model_association_name
+      options[:model].pluralize.underscore
+    end
+    
+    # Returns the controller name of the :controller attribute
+    def controller_name
+      options[:controller]
+    end
+    
+    # Returns the param of the :param attribute
+    def param
+      options[:param]
+    end
+    
+    # Returns the column of the :column attribute
+    def column
+      options[:column]
+    end
+    
+    # Returns a boolean
+    # Determines whether the :set_default_scope attribute was set
+    def set_default_scope?
+      true if options[:set_default_scope].eql?(true)
+    end
+    
+    # Require additional gems
+    # When the "ignore_error" argument is set to "true" (default)
+    # an error will not be raised if the gem cannot be found
+    def require_gem(gem, ignore_error = true)
+      if ignore_error.eql?(true)
+        begin
+          require "#{gem}"
+        rescue MissingSourceFile
+        end
+      else
+        require "#{gem}"
+      end
+    end
+
+  end
+end

data/lib/is_positionable.rb

@@ -0,0 +1,231 @@
+require 'is_positionable/base'
+require 'is_positionable/interface'
+require 'is_positionable/errors/no_method_error/acts_as_list'
+
+module IsPositionable
+ 
+  def self.included(base)
+    base.extend(ClassMethods)
+  end
+  
+  module ClassMethods
+    
+    # Is Positionable
+    def is_positionable(options = {})
+      
+      # Initialize the interface builer class
+      # Passes in the options hash and the controller_name and builds the methods for it
+      # Interface will convert ugly multi-dot-syntax to a single object.method wrapper
+      interface = IsPositionable::Interface.new(options, controller_name).build
+
+      # ControllerAction
+      
+      # Requires the acts_as_list gem
+      # Ignores "MissingSourceFile" error so that a "nice" error message can be
+      # displayed in the browser.
+      interface.require_gem('acts_as_list')
+
+      # Initializes Acts As List on the model
+      # Will set up the column, the same that is used by Is Positionable
+      # The Acts As List Gem will be provided with the same scope as the Is Positionable Gem uses
+      # The default_scope will be set to always sort the items by the specified column (default = :position)
+      interface.model.class_eval do
+        
+        # Initializes the Acts As List gem
+        # Sets the :column to the specified column attribute, default => :position
+        # Sets the :scope attribute to the specified attribute, default => '1 = 1' (like Acts As List)
+        # Will display a helpful error when the Acts As List Gem has either not been installed or loaded
+        begin
+          acts_as_list  :column => interface.column,
+                        :scope  => interface.scope || '1 = 1'
+        rescue NoMethodError
+          raise IsPositionable::Errors::NoMethodError::ActsAsList.new
+        end
+        
+        # Sets the default scope to order by the specified column
+        default_scope :order => interface.column if interface.set_default_scope?
+                
+      end
+      
+      # Defines the action which will be used to move objects around
+      define_method(interface.action_name) do
+        
+        # Finds the object that will be re-positioned    
+        object = interface.find(params[:id])
+        
+        # Move Object Up 1 Position
+        if params[interface.param].eql?('higher')
+          object.move_higher
+        end
+        
+        # Move Object Down 1 Position
+        if params[interface.param].eql?('lower')
+          object.move_lower
+        end
+        
+        # Move Object To Top Of List
+        if params[interface.param].eql?('to_top')
+          object.move_to_top
+        end
+        
+        # Move Object To Bottom Of List
+        if params[interface.param].eql?('to_bottom')
+          object.move_to_bottom
+        end
+        
+        # Redirects if this is a simple HTML POST request
+        # Will do nothing if this is an AJAX request
+        respond_to do |format|
+          format.html do
+            
+            # If the redirect path has not been set, it will default to :back.
+            # If the default is set, but there is no "Referer", it will by default redirect
+            # the user to the index action of the current controller.
+            # If the :redirect_to attribute was manually set, this will be used.
+            # If the :redirect_to attribute was set to :back, it will not change the default attribute
+            if interface.redirect.eql?(:back)
+              if request.headers["Referer"]
+                redirect_to(interface.redirect)
+              else
+                redirect_to(:action => :index) 
+              end
+            else
+              redirect_to(interface.redirect) 
+            end
+          end
+          
+          # If the positioning action was triggered by a AJAX call
+          # then do nothing. Only optionally render the RJS file if present.
+          format.js do
+            # => Nothing
+          end
+        end
+      end # => define_method(interface.action_name)
+      
+      
+      
+      # HelperMethods
+    
+      # Include the ActionView::Helpers inside of ActionController::Base
+      # This will enable html button parsing
+      ActionController::Base.send(:include, ActionView::Helpers)
+    
+      # Injects the "UP" button for the view helpers into the controller
+      # This will be available to all views within the specified controller
+      define_method "up_button_for_#{interface.controller_name}" do |object, *options|
+      
+        # Set default options and overwrite the existing ones with
+        # possible user input
+        options = {
+          :name             => "up",
+          :attribute        => :id,
+          :url              => {
+            :controller     => interface.controller_name,
+            :action         => interface.action_name,
+            :id             => object,
+            interface.param => "higher" },
+          :html             => {
+            :id             => "up_button_for_#{interface.controller_name.singularize}_#{object.id}",
+            :class          => "up_button_for_#{interface.controller_name}" }
+        }.update(options.empty? ? {} : options.first)
+      
+        button_to(options[:name], options[:url], options[:html]) unless object.first?
+      end
+      
+      # Injects the "DOWN" button for the view helpers into the controller
+      # This will be available to all views within the specified controller
+      define_method "down_button_for_#{interface.controller_name}" do |object, *options|
+      
+        # Set default options and overwrite the existing ones with
+        # possible user input
+        options = {
+          :name             => "down",
+          :attribute        => :id,
+          :url              => {
+            :controller     => interface.controller_name,
+            :action         => interface.action_name,
+            :id             => object,
+            interface.param => "lower" },
+          :html             => {
+            :id             => "down_button_for_#{interface.controller_name.singularize}_#{object.id}",
+            :class          => "down_button_for_#{interface.controller_name}" }
+        }.update(options.empty? ? {} : options.first)
+        
+        # Ensures that the last id will only be found once
+        # and not for each object that comes through the loop
+        unless defined?(@ip_last)
+          @ip_last = interface.find_last_id
+        end
+        
+        # Ensures that the last "Down" button will not be displayed
+        # since you can't go lower than the lowest position
+        unless @ip_last.eql?(object.id)
+          button_to(options[:name], options[:url], options[:html])
+        end
+      end
+    
+      # Injects the "TOP" button for the view helpers into the controller
+      # This will be available to all views within the specified controller
+      define_method "top_button_for_#{interface.controller_name}" do |object, *options|
+      
+        # Set default options and overwrite the existing ones with
+        # possible user input
+        options = {
+          :name             => "top",
+          :attribute        => :id,
+          :url              => {
+            :controller     => interface.controller_name,
+            :action         => interface.action_name,
+            :id             => object,
+            interface.param => "to_top" },
+          :html             => {
+            :id             => "top_button_for_#{interface.controller_name.singularize}_#{object.id}",
+            :class          => "top_button_for_#{interface.controller_name}" }
+        }.update(options.empty? ? {} : options.first)
+      
+        button_to(options[:name], options[:url], options[:html]) unless object.first?
+      end
+           
+      # Injects the "BOTTOM" button for the view helpers into the controller
+      # This will be available to all views within the specified controller
+      define_method "bottom_button_for_#{interface.controller_name}" do |object, *options|
+      
+        # Set default options and overwrite the existing ones with
+        # possible user input
+        options = {
+          :name             => "bottom",
+          :attribute        => :id,
+          :url              => {
+            :controller     => interface.controller_name,
+            :action         => interface.action_name,
+            :id             => object,
+            interface.param => "to_bottom" },
+          :html             => {
+            :id             => "bottom_button_for_#{interface.controller_name.singularize}_#{object.id}",
+            :class          => "bottom_button_for_#{interface.controller_name}" }
+        }.update(options.empty? ? {} : options.first)
+        
+        # Ensures that the last id will only be found once
+        # and not for each object that comes through the loop
+        unless defined?(@ip_last)
+          @ip_last = interface.find_last_id
+        end
+        
+        # Ensures that the last "Down" button will not be displayed
+        # since you can't go lower than the lowest position
+        unless @ip_last.eql?(object.id)
+          button_to(options[:name], options[:url], options[:html])
+        end
+      end
+      
+      # Makes the buttons available to the views that belong to the
+      # controller that Is Positional was invoked from
+      helper_method "up_button_for_#{interface.controller_name}",
+                    "down_button_for_#{interface.controller_name}",
+                    "top_button_for_#{interface.controller_name}",
+                    "bottom_button_for_#{interface.controller_name}"
+    end
+  end
+end
+
+ActionController::Base.send(:include, IsPositionable)

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: is_positionable
+version: !ruby/object:Gem::Version 
+  version: 0.0.0
+platform: ruby
+authors: 
+- meskyanichi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-05 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: acts_as_list
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "\n                          Handles positioning (ordering) your ActiveRecord Objects.\n                          Makes use of the \"Acts As List\" plugin for the optimized background handling of the positioning.\n                          \"Is Positionable\" is a front-end that dynamically generates buttons for moving ActiveRecord Objects\n                          \"up\", \"down\", to the \"top\" and to the \"bottom\". Setting it up takes just 1 word: \"is_positionable\".\n                        "
+email: meskyan@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- is_positionable.gemspec
+- lib/is_positionable.rb
+- lib/is_positionable/base.rb
+- lib/is_positionable/errors/no_method_error/acts_as_list.rb
+- lib/is_positionable/interface.rb
+has_rdoc: true
+homepage: http://github.com/meskyanichi/is_positionable
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Handles positioning (ordering) your ActiveRecord Objects.
+test_files: []
+