ranked-model-rails2 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 279b6761e2dd5ecf3adff73676890df2d2a16ad5
+  data.tar.gz: 296a49802a22f29242ff84159f77c20bdc809064
+SHA512: 
+  metadata.gz: 33bc41b5ac0209bd59d9220b489622a93663abd11156eeda31ccb3705b54f433f33924f1e86a28046d5024e90475fb51ef555913418052b0d284a45d9ed96ab7
+  data.tar.gz: 428bde2434df014565a085c1abcb1e6020059eb546f91fdc027c58a52ce0bcbe77d017f98a54d231799c437f307337aa709bd5383998aef91f77d2897c093fdd

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/*
+*.gem
+.bundle
+*.un~
+
+Gemfile.lock

data/.rbenv-vars

@@ -0,0 +1 @@
+JRUBY_OPTS=--1.8

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-gemset

@@ -0,0 +1 @@
+ranked-model

data/.ruby-version

@@ -0,0 +1 @@
+jruby-1.7.11

data/.travis.yml

@@ -0,0 +1,82 @@
+language: ruby
+before_script:
+  - mysql -e 'create database ranked_model_test;'
+  - psql -c 'create database ranked_model_test;' -U postgres
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+  - "jruby-19mode"
+  - "rbx"
+env:
+  - "ACTIVERECORD_VERSION=4.1.0.beta1"
+  - "ACTIVERECORD_VERSION=4.1.0.beta1 DB=mysql_travis"
+  - "ACTIVERECORD_VERSION=4.1.0.beta1 DB=postgresql_travis"
+  - "ACTIVERECORD_VERSION=4.0.2"
+  - "ACTIVERECORD_VERSION=4.0.2 DB=mysql_travis"
+  - "ACTIVERECORD_VERSION=4.0.2 DB=postgresql_travis"
+  - "ACTIVERECORD_VERSION=3.2.16"
+  - "ACTIVERECORD_VERSION=3.2.16 DB=mysql_travis"
+  - "ACTIVERECORD_VERSION=3.2.16 DB=postgresql_travis"
+  - "ACTIVERECORD_VERSION=3.1.12"
+  - "ACTIVERECORD_VERSION=3.1.12 DB=mysql_travis"
+  - "ACTIVERECORD_VERSION=3.1.12 DB=postgresql_travis"
+  - "ACTIVERECORD_VERSION=master"
+  - "ACTIVERECORD_VERSION=master DB=mysql_travis"
+  - "ACTIVERECORD_VERSION=master DB=postgresql_travis"
+matrix:
+  exclude:
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1 DB=mysql_travis"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1 DB=postgresql_travis"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1"
+      rvm: "1.9.3"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1 DB=mysql_travis"
+      rvm: "1.9.3"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1 DB=postgresql_travis"
+      rvm: "1.9.3"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1"
+      rvm: "jruby-19mode"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1 DB=mysql_travis"
+      rvm: "jruby-19mode"
+    - env: "ACTIVERECORD_VERSION=4.1.0.beta1 DB=postgresql_travis"
+      rvm: "jruby-19mode"
+    - env: "ACTIVERECORD_VERSION=master"
+      rvm: "jruby-19mode"
+    - env: "ACTIVERECORD_VERSION=master DB=mysql_travis"
+      rvm: "jruby-19mode"
+    - env: "ACTIVERECORD_VERSION=master DB=postgresql_travis"
+      rvm: "jruby-19mode"
+    - env: "ACTIVERECORD_VERSION=4.0.2"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=4.0.2 DB=mysql_travis"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=4.0.2 DB=postgresql_travis"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=master"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=master DB=mysql_travis"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=master DB=postgresql_travis"
+      rvm: "1.9.2"
+    - env: "ACTIVERECORD_VERSION=master"
+      rvm: "1.9.3"
+    - env: "ACTIVERECORD_VERSION=master DB=mysql_travis"
+      rvm: "1.9.3"
+    - env: "ACTIVERECORD_VERSION=master DB=postgresql_travis"
+      rvm: "1.9.3"
+  allow_failures:
+    # Master may or may not pass
+    - env: "ACTIVERECORD_VERSION=master"
+    - env: "ACTIVERECORD_VERSION=master DB=mysql_travis"
+    - env: "ACTIVERECORD_VERSION=master DB=postgresql_travis"
+    # Rails 3.1 is incompatible with database cleaner 1.2
+    - env: "ACTIVERECORD_VERSION=3.1.12 DB=mysql_travis"
+    - env: "ACTIVERECORD_VERSION=3.1.12 DB=postgresql_travis"
+    # Postgres is not supported before Rails 4.0.
+    - env: "ACTIVERECORD_VERSION=3.1.12 DB=postgresql_travis"
+    - env: "ACTIVERECORD_VERSION=3.2.16 DB=postgresql_travis"

data/Gemfile

@@ -0,0 +1,32 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ranked-model.gemspec
+gemspec
+
+ar_version = ENV["ACTIVERECORD_VERSION"] || "default"
+
+ar_gem_version = case ar_version
+when "master"
+  gem "activerecord", {:github => "rails/rails"}
+when "default"
+  # Allow the gemspec to specify
+else
+  gem "activerecord", "~> #{ar_version}"
+end
+
+platforms :rbx do
+  gem 'rubysl', '~> 2.0'
+  gem 'rubinius-developer_tools'
+end
+
+# SQLite
+gem "activerecord-jdbcsqlite3-adapter", ">= 1.3.0", :platforms => :jruby
+gem "sqlite3", :platforms => :ruby
+
+# Postgres
+gem "activerecord-jdbcpostgresql-adapter", :platforms => :jruby
+gem "pg", :platforms => :ruby
+
+# MySQL
+gem "activerecord-jdbcmysql-adapter", :platforms => :jruby
+gem "mysql", :platforms => :ruby

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Iridesco LLC (support@harvestapp.com)
+
+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/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+
+task :default => :spec

data/Readme.mkd

@@ -0,0 +1,205 @@
+**ranked-model** is a modern row sorting library built for Rails 3 & 4.  It uses ARel aggressively and is better optimized than most other libraries.
+
+[![Build Status](https://travis-ci.org/mixonic/ranked-model.png)](https://travis-ci.org/mixonic/ranked-model)
+
+Installation
+------------
+
+ranked-model passes specs with Rails 3.1, 3.2, 4.0, and 4.1-beta for MySQL, Postgres, and SQLite on Ruby 1.9.2, 1.9.3, 2.0, 2.1, jruby-19mode, and rubinius where Rails supports the platform. This is with the exception of Postgres before Rails 4.0 on all platforms, which is unsupported (I'd gladly accept a PR to fix this).
+
+TL;DR, if you are using Rails 4 and up you are 100% good to go. Before Rails 4, be wary of Postgres.
+
+To install ranked-model, just add it to your `Gemfile`:
+
+``` ruby
+gem 'ranked-model'
+
+# Or pin ranked-model to git
+# gem 'ranked-model',
+#   :git => 'git@github.com:mixonic/ranked-model.git'
+```
+
+Then use `bundle install` to update your `Gemfile.lock`.
+
+Simple Use
+----------
+
+Use of ranked-model is straight ahead.  Get some ducks:
+
+``` ruby
+class Duck < ActiveRecord::Base
+end
+```
+
+Put your ducks in a row:
+
+``` ruby
+class Duck < ActiveRecord::Base
+
+  include RankedModel
+  ranks :row_order
+
+end
+```
+
+This simple example assumes an integer column called `row_order`.  To order Ducks by this order:
+
+``` ruby
+Duck.rank(:row_order).all
+```
+
+The ranking integers stored in the `row_order` column will be big and spaced apart.  When you
+implement a sorting UI, just update the resource by appending the column name with `_position` and indicating the desired position:
+
+``` ruby
+@duck.update_attribute :row_order_position, 0  # or 1, 2, 37. :first, :last, :up and :down are also valid
+```
+
+Position numbers begin at zero.  A position number greater than the number of records acts the
+same as :last. :up and :down move the record up/down the ladder by one step.
+
+So using a normal json controller where `@duck.attributes = params[:duck]; @duck.save`, JS can
+look pretty elegant:
+
+``` javascript
+$.ajax({
+  type: 'PUT',
+  url: '/ducks',
+  dataType: 'json',
+  data: { duck: { row_order_position: 0 } },  // or whatever your new position is
+});
+```
+
+Complex Use
+-----------
+
+The `ranks` method takes serveral arguments:
+
+``` ruby
+class Duck < ActiveRecord::Base
+
+  include RankedModel
+
+  ranks :row_order,           # Name this ranker, used with rank()
+    :column => :sort_order    # Override the default column, which defaults to the name
+  
+  belongs_to :pond
+  ranks :swimming_order,
+    :with_same => :pond_id    # Ducks belong_to Ponds, make the ranker scoped to one pond
+  
+  scope :walking, where(:walking => true )
+  ranks :walking_order,
+    :scope => :walking        # Narrow this ranker to a scope
+
+end
+```
+
+When you make a query, add the rank:
+
+``` ruby
+Duck.rank(:row_order)
+
+Pond.first.ducks.rank(:swimming_order)
+
+Duck.walking.rank(:walking)
+```
+
+Single Table Inheritance (STI)
+------------------------------
+
+ranked-model scopes your records' positions based on the class name of the object. If you have
+a STI `type` column set in your model, ranked-model will reference that class for positioning.
+
+Consider this example:
+
+``` ruby
+class Vehicle < ActiveRecord::Base
+  ranks :row_order
+end
+
+class Car < Vehicle
+end
+
+class Truck < Vehicle
+end
+
+car = Car.create!
+truck = Truck.create!
+
+car.row_order
+=> 0
+truck.row_order
+=> 0
+```
+
+In this example, the `row_order` for both `car` and `truck` will be set to `0` because they have
+different class names (`Car` and `Truck`, respectively).
+
+If you would like for both `car` and `truck` to be ranked together based on the base `Vehicle`
+class instead, use the `class_name` option:
+
+``` ruby
+class Vehicle < ActiveRecord::Base
+  ranks :row_order, class_name: 'Vehicle'
+end
+
+class Car < Vehicle
+end
+
+class Truck < Vehicle
+end
+
+car = Car.create!
+truck = Truck.create!
+
+car.row_order
+=> 0
+truck.row_order
+=> 4194304
+```
+
+Internals
+---------
+
+This library is written using ARel from the ground-up.  This leaves the code much cleaner
+than many implementations.  ranked-model is also optimized to write to the database as little
+as possible: ranks are stored as a number between -8388607 and 8388607 (the MEDIUMINT range in MySQL).
+When an item is given a new position, it assigns itself a rank number between two neighbors.
+This allows several movements of items before no digits are available between two neighbors. When
+this occurs, ranked-model will try to shift other records out of the way. If items can't be easily
+shifted anymore, it will rebalance the distribution of rank numbers across all members
+of the ranked group.
+
+Contributing
+------------
+
+Fork, clone, write a test, write some code, commit, push, send a pull request.  Github FTW!
+
+The specs can be run with sqlite, postgres, and mysql:
+
+```
+DB=postgres bundle exec rake
+```
+
+Is no DB is specified, the tests run against sqlite.
+
+RankedModel is mostly the handiwork of Matthew Beale:
+
+* [madhatted.com](http://madhatted.com) is where I blog. Also [@mixonic](http://twitter.com/mixonic).
+
+A hearty thanks to these contributors:
+
+* [Harvest](http://getharvest.com) where this Gem started. They are great, great folks.
+* [yabawock](https://github.com/yabawock)
+* [AndrewRadev](https://github.com/AndrewRadev)
+* [adheerajkumar](https://github.com/adheerajkumar)
+* [mikeycgto](https://github.com/mikeycgto)
+* [robotex82](https://github.com/robotex82)
+* [rociiu](https://github.com/rociiu)
+* [codepodu](https://github.com/codepodu)
+* [kakra](https://github.com/kakra)
+* [metalon](https://github.com/metalon)
+* [jamesalmond](https://github.com/jamesalmond)
+* [jguyon](https://github.com/jguyon)
+* [pehrlich](https://github.com/pehrlich)
+* [petergoldstein](https://github.com/petergoldstein)

data/lib/ranked-model.rb

@@ -0,0 +1,69 @@
+require File.dirname(__FILE__)+'/ranked-model/ranker'
+require File.dirname(__FILE__)+'/ranked-model/railtie' if defined?(Rails::Railtie)
+
+require "active_record" unless defined?(ActiveRecord::Base)
+require "fake_arel"
+
+module RankedModel
+
+  # Signed MEDIUMINT in MySQL
+  #
+  MAX_RANK_VALUE = 8388607
+  MIN_RANK_VALUE = -8388607
+
+  def self.included base
+
+    base.class_eval do
+      class_attribute :rankers
+
+      extend RankedModel::ClassMethods
+
+      before_save :handle_ranking
+
+      scope :rank, lambda { |name|
+        order ranker(name.to_sym).column
+      }
+    end
+
+  end
+
+  private
+
+  def handle_ranking
+    self.class.rankers.each do |ranker|
+      ranker.with(self).handle_ranking
+    end
+  end
+
+  module ClassMethods
+
+    def q(column_name)
+      connection.quote_column_name(column_name)
+    end
+
+    def ranker name
+      rankers.find do |ranker|
+        ranker.name == name
+      end
+    end
+
+  private
+
+    def ranks *args
+      self.rankers ||= []
+      ranker = RankedModel::Ranker.new(*args)
+      self.rankers << ranker
+      attr_reader "#{ranker.name}_position"
+      define_method "#{ranker.name}_position=" do |position|
+        if position.present?
+          send "#{ranker.column}_will_change!"
+          instance_variable_set "@#{ranker.name}_position", position
+        end
+      end
+
+      public "#{ranker.name}_position", "#{ranker.name}_position="
+    end
+
+  end
+
+end