rankable 0.1.0

data/README.markdown

@@ -0,0 +1,91 @@
+# Rankable
+
+Super-simple ActiveRecord extension module, to quickly an efficiently sort
+records. Sorts/ranks records in a single SQL query.
+
+## Installation
+
+Add this line to your Gemfile:
+
+    gem "rankable"
+
+Then, bundle:
+
+    $ bundle install
+
+## Usage Examples:
+
+In the model:
+
+    # app/models/article.rb
+    class Article < ActiveRecord::Base
+      # Include module
+      include Rankable::Model
+
+      # You default column is "rank", change it e.g. via:
+      # self.rankable_column_name = :position
+    end
+
+In your controllers:
+
+    # config/routes.rb
+    MyApp::Application.routes.draw do
+      resources :articles do
+        put :sort, :on => :collection
+      end
+    end
+
+    # app/controllers/articles_controllers.rb
+    class ArticlesController < ApplicationController
+      respond_to :html
+
+      def sort
+        Articles.rank_all(params[:article_ids])
+        head(:ok)
+      end
+    end
+
+In your views:
+
+  <script>
+  $(function() {
+    $( "#sortable" ).sortable({
+      stop: function() {
+        $.post('<%= sort_articles_path %>', '_method=put&' + $(this).sortable('serialize'));
+      }
+    });
+  });
+  </script>
+
+  <ul id="sortable">
+    <li id="article_ids_1">Article 1</li>
+    <li id="article_ids_2">Article 2</li>
+    <li id="article_ids_3">Article 3</li>
+    <li id="article_ids_4">Article 4</li>
+    <li id="article_ids_5">Article 5</li>
+  </ul>
+
+
+## License
+
+    Copyright (C) 2011 Dimitrij Denissenko
+
+  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/lib/rankable.rb

@@ -0,0 +1,5 @@
+require "active_record"
+
+module Rankable
+  autoload :Model,  "rankable/model"
+end

data/lib/rankable/model.rb

@@ -0,0 +1,50 @@
+# Includable module, for ActiveRecord::Base. By default, the "rank"
+# column is used to store the sort order. To override:
+#
+#     class Article < ActiveRecord::Base
+#       include Rankable::Model
+#       self.rankable_column_name = "position"
+#     end
+#
+module Rankable::Model
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :rankable_column_name
+    self.rankable_column_name = "rank"
+  end
+
+  module ClassMethods
+
+    # Ranks all records by given IDs. Example:
+    #
+    #   Article.rank_all([7,5,3])
+    #   Article.find(7).rank # => 1
+    #   Article.find(5).rank # => 2
+    #   Article.find(3).rank # => 3
+    #
+    # Works with scopes too. Example:
+    #
+    #   Article.unread.rank_all([2,4,3])
+    #
+    def rank_all(ids)
+      pk_col = columns_hash[primary_key]
+      rk_col = columns_hash[rankable_column_name.to_s]
+
+      raise "Ranking only works with integer primary keys" unless pk_col && pk_col.type == :integer
+      raise "Ranking is missing the '#{rankable_column_name}' column. Please add a '#{rankable_column_name}' to your database table or specify a custom column name via self.rankable_column_name = '...'" unless rk_col
+
+      ranked = Array.wrap(ids).map do |value|
+        Integer(value) rescue nil
+      end.compact
+      return 0 if ranked.empty?
+
+      clause = ranked.each_with_index.map do |id, index|
+        "WHEN #{connection.quote(id, pk_col)} THEN #{connection.quote(index + 1, rk_col)}"
+      end.join(' ')
+
+      where(primary_key.to_sym => ranked).update_all "#{connection.quote_column_name rankable_column_name} = CASE #{quoted_primary_key} #{clause} END"
+    end
+
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: rankable
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Dimitrij Denissenko
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: ActiveRecord extension for ranking/storing records
+email: dimitrij@blacksquaremedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- lib/rankable/model.rb
+- lib/rankable.rb
+homepage: https://github.com/bsm/rankable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Sort your records efficiently!
+test_files: []
+