rankle 0.0.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6c1c94e6dadbdd8d36db346f7767bc847d9402d4
+  data.tar.gz: 5923e83360576985bc983215e94041d6c53d2906
+SHA512:
+  metadata.gz: 513aa6cd74b4a39425e66cd19f5ed7980523dee33b4bdd15ea46d5c8dcfc3836f5c3bec7215db8249daec2cc843192d011fb4a7b2e25c74ba58bb70d38cf48a3
+  data.tar.gz: d244dd513e0a1ff12c339f32d21a9d16bb882b8002ecd452382b7bc389ec217bbd1e84a4bd00166d346a50bf4633d9a4a18aff9d86e28717f04e3385d6d6639f

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.idea
+*.sqlite3
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rankle.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 wburns84
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Wil
+
+MIT License
+
+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.md

@@ -0,0 +1,246 @@
+# Rankle (pre-release)
+
+Rankle provides multi-resource ranking.  It uses a separate join table rather than a resource specific position column.
+
+** Rankle is currently in a pre-release state.  It is not optimized for performance and should not be used in
+production applications.  Future work will be tracked with issues. **
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rankle'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rankle
+
+## Getting Started
+
+Before you can use Rankle, you'll need to generate the index table.  Rankle provides a generator to assist with this:
+
+    $ rails g rankle:install
+
+The generator only creates the migration file.  You'll still need to run the migration:
+
+    $ rake db:migrate
+
+## Default Behavior
+
+Simply including Rankle is intended to be ineffectual:
+
+```ruby
+class Fruit < ActiveRecord::Base
+end
+
+Fruit.all.to_a == Fruit.ranked.to_a # true
+```
+
+However, new records will respond to position:
+
+```ruby
+apple  = Fruit.create!
+orange = Fruit.create!
+
+apple.position  # 0
+orange.position # 1
+```
+
+The ranked method provides an ordered ActiveRecord::Relation:
+
+```ruby
+Fruit.create! name, 'apple'
+Fruit.create! name, 'orange'
+
+Fruit.ranked.map(&:name) # ['apple', 'orange']
+```
+
+## Simple Usage
+
+You can assign an explicit ranking in several ways.  The position attribute can be set directly:
+
+```ruby
+apple.update_attribute :position, 1
+
+apple.position  # 1
+orange.position # 0
+
+Fruit.ranked.map(&:name) # ['orange', 'apple']
+```
+
+When called with an integer, the rank method will assign the position:
+
+```ruby
+apple.rank 0
+
+apple.position  # 0
+orange.position # 1
+
+Fruit.ranked.map(&:name) # ['apple', 'orange']
+```
+
+You can declare a proc to maintain a functional position ranking:
+
+```ruby
+class Fruit < ActiveRecord::Base
+  ranks ->(a, b) { a.name < b.name }
+end
+
+Fruit.create! name: 'apple'
+Fruit.create! name: 'orange'
+Fruit.create! name: 'banana'
+
+Fruit.ranked.map(&:name) # ['apple', 'banana', 'orange']
+```
+
+## Named Ranking
+
+Passing a symbol to the rank method with a position will update the position to that named rank:
+
+```ruby
+  apple  = Fruit.create!
+  orange = Fruit.create!
+
+  apple.rank  :reverse, 1
+  orange.rank :reverse, 0
+
+  apple.position  # 0
+  orange.position # 1
+
+  apple.position  :reverse # 1
+  orange.position :reverse # 0
+
+  Fruit.ranked.map(&:name)           # ['apple', 'orange']
+  Fruit.ranked(:reverse).map(&:name) # ['orange', 'apple']
+```
+
+Since positions are not stored with an absolute value, the available positions increases by 1 with each call to the rank method:
+
+```ruby
+  apple = Fruit.create!
+  banana = Fruit.create!
+  orange = Fruit.create!
+
+  apple.rank  :reverse, 2 # [apple]
+  banana.rank :reverse, 1 # [banana, apple]
+  orange.rank :reverse, 0 # [orange, banana, apple]
+
+  apple.position  # 0
+  banana.position # 1
+  orange.position # 2
+
+  apple.position  :reverse # 1
+  banana.position :reverse # 2
+  orange.position :reverse # 0
+
+  Fruit.ranked.map(&:name)           # ['apple', 'banana', 'orange']
+  Fruit.ranked(:reverse).map(&:name) # ['orange', 'apple', 'banana']
+```
+
+You can bypass this issue by registering the ranking on the class:
+
+```ruby
+class Fruit < ActiveRecord::Base
+  ranks :reverse
+end
+
+apple  = Fruit.create!
+banana = Fruit.create!
+orange = Fruit.create!
+
+apple.position  # 0
+banana.position # 1
+orange.position # 2
+
+apple.position  :reverse # 0
+banana.position :reverse # 1
+orange.position :reverse # 2
+
+apple.rank  :reverse, 2 # [banana, orange, apple]
+banana.rank :reverse, 1 # [banana, orange, apple]
+orange.rank :reverse, 0 # [orange, banana, apple]
+
+apple.position  # 0
+banana.position # 1
+orange.position # 2
+
+apple.position  :reverse # 2
+banana.position :reverse # 1
+orange.position :reverse # 0
+
+Fruit.ranked.map(&:name)           # ['apple', 'banana', 'orange']
+Fruit.ranked(:reverse).map(&:name) # ['orange', 'banana', 'apple']
+```
+
+## Multiple Resources
+
+Passing a symbol to the rank method with a position will update the position to that named rank:
+
+```ruby
+class Fruit < ActiveRecord::Base
+end
+
+class Vegetable < ActiveRecord::Base
+end
+
+apple  = Fruit.create!
+carrot = Vegetable.create!
+
+apple.rank  :produce, 0
+carrot.rank :produce, 1
+
+apple.position  # 0
+carrot.position # 0
+
+apple.position  :produce # 0
+carrot.position :produce # 1
+
+Fruit.ranked.map(&:name)               # ['apple']
+Vegetable.ranked.map(&:name)           # ['carrot']
+
+Fruit.ranked(:produce).map(&:name)     # ['apple']
+Vegetable.ranked(:produce).map(&:name) # ['carrot']
+```
+
+Notice that the ranked method can't increase the scope of your query.  Multi-resource relations can be accessed through
+the Rankle class which serves as the global ranking scope.
+
+```ruby
+Rankle.ranked(:produce).map(&:name)    # ['apple', 'carrot']
+```
+
+Passing a symbol to the ranks method will register the resource to that ranking.  This will automatically assign the
+default position to new records within the shared ranking:
+
+```ruby
+class Fruit
+  ranks :produce
+end
+
+Class Vegetable
+  ranks :produce
+end
+
+apple = Fruit.create!
+carrot = Vegetable.create!
+
+apple.position  # 0
+carrot.position # 0
+
+apple.position  :produce # 0
+carrot.position :produce # 1
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rankle/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+require 'cucumber'
+require 'cucumber/rake/task'
+require 'yard'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --format pretty'
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/rankle.rb']
+end
+
+task :default => [:features, :yard]

data/features/default_ranking.feature

@@ -0,0 +1,20 @@
+Feature: Default ranking
+  In order to not surprise new customers
+  As a consumer of rankle
+  I want the default behavior to match existing behavior 
+
+  Scenario: Empty fruit model
+    Given an empty fruit model
+     Then ranking all has no effect
+      And the ranked fruit array is []
+     
+  Scenario: Fruit model with several fruits
+    Given several fruits
+     Then ranking all has no effect
+      And the ranked fruit array is [Apple, Apricot, Banana, Bilberry, Blackberry, Blackcurrant, Blueberry, Boysenberry, Cantaloupe, Currant]
+
+  Scenario: Ranked fruit
+    Given an empty fruit model
+      And an apple
+      And an orange
+     Then the ranked fruit array is [apple, orange]

data/features/get_position.feature

@@ -0,0 +1,19 @@
+Feature: Get position
+  In order to inspect a ranking
+  As a developer
+  I want to retrieve an element's position
+
+  Scenario: Default ranking
+    Given an apple
+      And an orange
+     Then the apple is in position 0
+      And the orange is in position 1
+      And the ranked fruit array is [apple, orange]
+
+  Scenario: Custom ranking
+    Given an apple
+      And an orange
+     When I assign the apple's position to 1
+     Then the apple is in position 1
+      And the orange is in position 0
+      And the ranked fruit array is [orange, apple]

data/features/multi-resource_ranking.feature

@@ -0,0 +1,37 @@
+Feature: Multi-resource ranking
+  In order to rank multiple resources
+  As a consumer of rankle
+  I want to create a multi-resource ranking
+
+  Scenario: Basic ranking
+    Given a 'fruit' model
+      And a 'vegetable' model
+      And an 'apple' fruit
+      And a 'carrot' vegetable
+     When I assign the 'apple' fruit's 'produce' rank to '0'
+      And I assign the 'carrot' vegetable's 'produce' rank to '1'
+     Then the 'apple' fruit's 'default' rank is '0'
+      And the 'carrot' vegetable's 'default' rank is '0'
+      And the 'apple' fruit's 'produce' rank is '0'
+      And the 'carrot' vegetable's 'produce' rank is '1'
+      And the default ranked fruit array is [apple]
+      And the default ranked vegetable array is [carrot]
+      And the produce ranked fruit array is [apple]
+      And the produce ranked vegetable array is [carrot]
+      And the produce ranked rankle array is [apple, carrot]
+
+
+  Scenario: Default ranking
+    Given a 'fruit' model with a 'produce' ranking
+      And a 'vegetable' model with a 'produce' ranking
+      And an 'apple' fruit
+      And a 'carrot' vegetable
+     Then the 'apple' fruit's 'default' rank is '0'
+      And the 'carrot' vegetable's 'default' rank is '0'
+      And the 'apple' fruit's 'produce' rank is '0'
+      And the 'carrot' vegetable's 'produce' rank is '1'
+      And the default ranked fruit array is [apple]
+      And the default ranked vegetable array is [carrot]
+      And the produce ranked fruit array is [apple]
+      And the produce ranked vegetable array is [carrot]
+      And the produce ranked rankle array is [apple, carrot]

data/features/named_ranking.feature

@@ -0,0 +1,49 @@
+Feature: Named ranking
+  In order to maintain multiple rankings on a single class
+  As a developer
+  I want to create named rankings
+
+  Scenario: Reverse ranking
+    Given an apple
+      And an orange
+     When I assign the 'apple' fruit's 'reverse' rank to '1'
+     When I assign the 'orange' fruit's 'reverse' rank to '0'
+     Then the 'apple' fruit's 'default' rank is '0'
+      And the 'orange' fruit's 'default' rank is '1'
+      And the 'apple' fruit's 'reverse' rank is '1'
+      And the 'orange' fruit's 'reverse' rank is '0'
+      And the default ranked fruit array is [apple, orange]
+      And the reverse ranked fruit array is [orange, apple]
+
+  Scenario: Growing ranking
+    Given an apple
+      And a banana
+      And an orange
+     When I assign the 'apple' fruit's 'reverse' rank to '2'
+      And I assign the 'banana' fruit's 'reverse' rank to '1'
+      And I assign the 'orange' fruit's 'reverse' rank to '0'
+     Then the 'apple' fruit's 'default' rank is '0'
+      And the 'banana' fruit's 'default' rank is '1'
+      And the 'orange' fruit's 'default' rank is '2'
+      And the 'apple' fruit's 'reverse' rank is '1'
+      And the 'banana' fruit's 'reverse' rank is '2'
+      And the 'orange' fruit's 'reverse' rank is '0'
+      And the default ranked fruit array is [apple, banana, orange]
+      And the reverse ranked fruit array is [orange, apple, banana]
+
+  Scenario: Registered ranking
+    Given a 'fruit' class with a 'reverse' ranking
+      And an apple
+      And a banana
+      And an orange
+     When I assign the 'apple' fruit's 'reverse' rank to '2'
+      And I assign the 'banana' fruit's 'reverse' rank to '1'
+      And I assign the 'orange' fruit's 'reverse' rank to '0'
+     Then the 'apple' fruit's 'default' rank is '0'
+      And the 'banana' fruit's 'default' rank is '1'
+      And the 'orange' fruit's 'default' rank is '2'
+      And the 'apple' fruit's 'reverse' rank is '2'
+      And the 'banana' fruit's 'reverse' rank is '1'
+      And the 'orange' fruit's 'reverse' rank is '0'
+      And the default ranked fruit array is [apple, banana, orange]
+      And the reverse ranked fruit array is [orange, banana, apple]

data/features/ranking.feature

@@ -0,0 +1,24 @@
+Feature: Ranks
+  In order to provide an explicit ordering
+  As a developer
+  I want to rank on position
+
+  Scenario: Reverse ranking
+    Given 10 rows
+     When I rank them in reverse order
+     Then ranking is equivalent to all reversed
+
+  Scenario: Update ranking
+    Given 10 rows in default order
+     When I move row 9 to row 0
+     Then ranking is equivalent to all rotated -1
+
+  Scenario: Negative rank
+    Given 10 rows in default order
+    When I move row 9 to row -10
+    Then row 9 is in position 0
+
+  Scenario: Out-of-bounds rank
+    Given 10 rows in default order
+    When I move row 0 to row 30
+    Then row 0 is in position 9

data/features/set_position.feature

@@ -0,0 +1,41 @@
+Feature: Set position
+  In order to assign a ranking
+  As a developer
+  I want to set an element's position
+
+  Scenario: Update position attribute
+    Given an empty fruit model
+      And an 'apple' fruit
+      And an 'orange' fruit
+     When I update the apple's position attribute to 1
+     Then the apple is in position 1
+      And the orange is in position 0
+     Then the ranked fruit array is [orange, apple]
+
+  Scenario: Update position attribute with rank method
+    Given an apple
+      And an orange
+     When I assign the apple's rank to 1
+     Then the apple is in position 1
+      And the orange is in position 0
+     Then the ranked fruit array is [orange, apple]
+
+
+  Scenario: Override default with stabby proc
+    Given a fruit class with a reverse alphabetical default ranking on name
+      And an apple
+      And an orange
+     Then the apple is in position 1
+      And the orange is in position 0
+     Then the ranked fruit array is [orange, apple]
+
+
+  Scenario: Override default with stabby proc (documentation)
+    Given a fruit class with an alphabetical default ranking on name
+      And an apple
+      And an orange
+      And a banana
+     Then the apple is in position 0
+      And the banana is in position 1
+      And the orange is in position 2
+     Then the ranked fruit array is [apple, banana, orange]

data/features/step_definitions/fruit_steps.rb

@@ -0,0 +1,29 @@
+Given(/^an apple$/) do
+  DatabaseCleaner.clean
+  @fruit ||= {}
+  @fruit[:apple] = create :fruit, name: 'apple'
+end
+
+Given(/^an orange$/) do
+  @fruit[:orange] = create :fruit, name: 'orange'
+end
+
+Given(/^a banana$/) do
+  @fruit[:banana] = create :fruit, name: 'banana'
+end
+
+Then(/^the apple is in position (\d+)$/) do |position|
+  expect(@fruit[:apple].position).to eq(position.to_i)
+end
+
+Then(/^the orange is in position (\d+)$/) do |position|
+  expect(@fruit[:orange].position).to eq(position.to_i)
+end
+
+Then(/^the banana is in position (\d+)$/) do |position|
+  expect(@fruit[:banana].position).to eq(position.to_i)
+end
+
+When(/^I assign the apple's position to (\d+)$/) do |position|
+  @fruit[:apple].update_attribute(:position, position.to_i)
+end

data/features/step_definitions/model_steps.rb

@@ -0,0 +1,101 @@
+Given(/^a '(.*)' model$/) do |name|
+  DatabaseCleaner.clean
+  name.classify.constantize.delete_all
+end
+
+Given(/^a '(.*)' model with a '(.*)' ranking$/) do |klass, ranking|
+  step "a '#{klass}' model"
+  klass.classify.constantize.send :ranks, ranking.to_sym
+end
+
+
+Given(/^an '(.*)' fruit$/) do |name|
+  @fruit ||= {}
+  @fruit[name.to_sym] = create :fruit, name: name
+end
+
+Given(/^a '(.*)' vegetable$/) do |name|
+  @vegetable ||= {}
+  @vegetable[name.to_sym] = create :vegetable, name: name
+end
+
+Given(/^an empty (.+) model$/) do |klass|
+  DatabaseCleaner.clean
+  klass.classify.constantize.delete_all
+end
+
+Given(/^several fruits$/) do
+  DatabaseCleaner.clean
+  @fruit ||= {}
+  10.times.each do |index|
+    fruit = create :fruit
+    @fruit[fruit.name.to_sym] = fruit
+  end
+end
+
+Given(/^several points$/) do
+  DatabaseCleaner.clean
+  10.times.each { |index| Point.create!(x: index, y: index) }
+end
+
+Given(/^(\d+) rows$/) do |count|
+  DatabaseCleaner.clean
+  count.to_i.times.each { |index| Row.create!(text: index) }
+end
+
+Given(/^(\d+) rows in default order$/) do |count|
+  DatabaseCleaner.clean
+  count.to_i.times.each { |index| Row.create!(text: index).update_attribute(:position, index) }
+end
+
+Given(/^(\d+) even and odd rows$/) do |count|
+  DatabaseCleaner.clean
+  count.to_i.times.each { |index| Row.create!(text: index.even? ? 'even' : 'odd').update_attribute(:position, index) }
+end
+
+When(/^I rank them in reverse order$/) do
+  Row.all.reverse.each_with_index { |row, index| row.update_attribute(:position, index) }
+end
+
+When(/^I move row (\d+) to row (-?\d+)$/) do |start_position, end_position|
+  Row.all[start_position.to_i].update_attribute(:position, end_position.to_i)
+end
+
+When(/^I reverse rank the even rows$/) do
+  Row.rank(:even)
+end
+
+Then(/^ranking is equivalent to all reversed$/) do
+  expect(Row.ranked.to_a).to eq(Row.all.to_a.reverse)
+end
+
+Then(/^ranking is equivalent to all rotated (\-\d+)$/) do |positions|
+  expect(Row.ranked.to_a).to eq(Row.all.to_a.rotate(positions.to_i))
+end
+
+Then(/^ranking all has no effect$/) do
+  expect(Point.ranked.to_a).to eq(Point.all.to_a)
+end
+
+Then(/^row (\d+) is in position (\d+)$/) do |row, position|
+  expect(Row.ranked[position.to_i].id).to eq(row.to_i + 1)
+end
+
+Given(/^a fruit class with an alphabetical default ranking on name$/) do
+  Fruit.send :ranks, ->(a, b) { a.name < b.name }
+end
+
+Given(/^a fruit class with a reverse alphabetical default ranking on name$/) do
+  Fruit.send :ranks, ->(a, b) { a.name > b.name }
+end
+
+Given(/^a 'fruit' class with a 'reverse' ranking$/) do
+  Fruit.send :ranks, :reverse
+end
+
+Then(/^the (.*)ranked (.*) array is \[(.*)\]$/) do |ranker, klass, names|
+  ranker = 'default' if ranker.blank?
+  expect(klass.classify.constantize.ranked(ranker.strip.to_sym).map(&:name)).to eq(names.split(',').map do |name|
+    @fruit[name.strip.to_sym].name rescue @vegetable[name.strip.to_sym].name
+  end)
+end

data/features/step_definitions/position_steps.rb

@@ -0,0 +1,24 @@
+When(/^I update the apple's position attribute to (\d+)$/) do |position|
+  @fruit[:apple].update_attribute(:position, position.to_i)
+end
+
+When(/^I assign the apple's rank to (\d+)$/) do |position|
+  @fruit[:apple].rank position.to_i
+end
+
+When(/^I assign the '(.*)' fruit's '(.*)' rank to '(\d+)'$/) do |type, name, position|
+  @fruit[type.to_sym].rank name.to_sym, position.to_i
+end
+
+When(/^I assign the '(.*)' vegetable's '(.*)' rank to '(\d+)'$/) do |type, name, position|
+  @vegetable[type.to_sym].rank name.to_sym, position.to_i
+end
+
+
+Then(/^the '(.*)' fruit's '(.*)' rank is '(\d+)'$/) do |type, name, position|
+  expect(@fruit[type.to_sym].position name).to eq(position.to_i)
+end
+
+Then(/^the '(.*)' vegetable's '(.*)' rank is '(\d+)'$/) do |type, name, position|
+  expect(@vegetable[type.to_sym].position name).to eq(position.to_i)
+end

data/features/support/env.rb

@@ -0,0 +1,15 @@
+require 'rankle'
+require 'database_cleaner'
+require 'factory_girl'
+
+DatabaseCleaner.strategy = :truncation
+
+ActiveRecord::Base.establish_connection(
+  adapter:  'sqlite3',
+  database: 'rankle.sqlite3'
+)
+
+load File.dirname(__FILE__) + '/schema.rb'
+load File.dirname(__FILE__) + '/models.rb'
+
+World FactoryGirl::Syntax::Methods

data/features/support/factories/fruit.rb

@@ -0,0 +1,16 @@
+FactoryGirl.define do
+  factory :fruit do
+    sequence(:name) { |n| FRUITS[n-1] }
+  end
+end
+
+FRUITS = ['Apple', 'Apricot', 'Banana', 'Bilberry', 'Blackberry', 'Blackcurrant', 'Blueberry', 'Boysenberry',
+          'Cantaloupe', 'Currant', 'Cherry', 'Cherimoya', 'Cloudberry', 'Coconut', 'Cranberry', 'Damson', 'Date',
+          'Dragonfruit', 'Durian', 'Elderberry', 'Feijoa', 'Fig', 'Goji berry', 'Gooseberry', 'Grape', 'Raisin',
+          'Grapefruit', 'Guava', 'Huckleberry', 'Jackfruit', 'Jambul', 'Jujube', 'Kiwi fruit', 'Kumquat', 'Lemon',
+          'Lime', 'Loquat', 'Lychee', 'Mango', 'Marion berry', 'Melon', 'Cantaloupe', 'Honeydew', 'Watermelon',
+          'Rock melon', 'Miracle fruit', 'Mulberry', 'Nectarine', 'Olive', 'Orange', 'Clementine', 'Mandarine',
+          'Tangerine', 'Papaya', 'Passionfruit', 'Peach', 'Pear', 'Williams pear', 'Bartlett pear', 'Persimmon',
+          'Physalis', 'Plum/prune (dried plum)', 'Pineapple', 'Pomegranate', 'Pomelo', 'Purple Mangosteen', 'Quince',
+          'Raspberry', 'Salmon berry', 'Black raspberry', 'Rambutan', 'Redcurrant', 'Salal berry', 'Satsuma',
+          'Star fruit', 'Strawberry', 'Tamarillo', 'Ugli fruit']

data/features/support/factories/vegetable.rb

@@ -0,0 +1,36 @@
+FactoryGirl.define do
+  factory :vegetable do
+    sequence(:name) { |n| VEGETABLES[n-1] }
+  end
+
+  #factory :legume, class: Vegetable do
+  #  sequence(:name) { |n| LEGUMES[n-1] }
+  #end
+end
+
+VEGETABLES = ['Artichoke', 'Arugula', 'Asparagus', 'Amaranth', 'Bok choy', 'Broccoflower', 'Broccoli',
+              'Brussels sprouts', 'Cabbage', 'Calabrese', 'Cannabis', 'Carrots', 'Cauliflower', 'Celery', 'Chard',
+              'Collard greens', 'Corn salad', 'Eggplant', 'Endive', 'Fiddleheads', 'Frisee', 'Kale', 'Kohlrabi',
+              'Lettuce Lactuca sativa', 'Corn', 'Mushrooms', 'Mustard greens', 'Nettles', 'New Zealand spinach', 'Okra',
+              'Parsley', 'Radicchio', 'Rhubarb', 'Salsify', 'Skirret', 'Spinach', 'Topinambur', 'Tat soi', 'Tomato',
+              'Water chestnut', 'Watercress']
+
+LEGUMES = ['Alfalfa sprouts', 'Azuki beans', 'Bean sprouts', 'Black beans', 'Black-eyed peas', 'Borlotti bean',
+           'Broad beans', 'Chickpeas', 'Green beans', 'Kidney beans', 'Lentils', 'Lima beans', 'Mung beans',
+           'Navy beans', 'Pinto beans', 'Runner beans', 'Soy beans', 'Snap peas']
+
+HERBS_AND_SPICES = ['Anise', 'Basil', 'Caraway', 'Cilantro', 'Coriander', 'Chamomile', 'Dill', 'Fennel', 'Lavender',
+                    'Lemon Grass', 'Marjoram', 'Oregano', 'Parsley', 'Rosemary', 'Sage', 'Thyme']
+
+ONIONS = ['Chives', 'Garlic', 'Leek Allium porrum', 'Onion', 'Shallot', 'Scallion']
+
+PEPPERS = ['Bell pepper', 'Chili pepper', 'Jalapeno', 'Habanero', 'Paprika', 'Tabasco pepper', 'Cayenne pepper']
+
+ROOT_VEGETABLES = ['Beet', 'Carrot', 'Celeriac', 'Daikon', 'Ginger', 'Parsnip', 'Rutabaga', 'Turnip']
+
+RADISH = ['Rutabaga', 'Turnip', 'Wasabi', 'Horseradish', 'White radish']
+
+SQUASHES = ['Acorn squash', 'Butternut squash', 'Banana squash', 'Zucchini', 'Cucumber', 'Delicata', 'Gem squash',
+            'Hubbard squash', 'Squash', 'Patty pans', 'Pumpkin', 'Spaghetti squash']
+
+TUBERS = ['Jicama', 'Jerusalem artichoke', 'Potato', 'Sweet potato', 'Taro', 'Yam']

data/features/support/models.rb

@@ -0,0 +1,19 @@
+class RankleIndex < ActiveRecord::Base
+  belongs_to :indexable, polymorphic: true
+end
+
+class Fruit < ActiveRecord::Base
+  has_many :rankle_indices, as: :indexable
+end
+
+class Vegetable < ActiveRecord::Base
+  has_many :rankle_indices, as: :indexable
+end
+
+class Point < ActiveRecord::Base
+  has_many :rankle_indices, as: :indexable
+end
+
+class Row < ActiveRecord::Base
+  has_many :rankle_indices, as: :indexable
+end

data/features/support/schema.rb

@@ -0,0 +1,37 @@
+ActiveRecord::Schema.define do
+  self.verbose = false
+
+  create_table :fruits, :force => true do |t|
+    t.string :name
+
+    t.timestamps null: false
+  end
+
+  create_table :vegetables, :force => true do |t|
+    t.string :name
+
+    t.timestamps null: false
+  end
+
+  create_table :points, :force => true do |t|
+    t.integer :x
+    t.integer :y
+
+    t.timestamps null: false
+  end
+
+  create_table :rows, :force => true do |t|
+    t.string :text
+
+    t.timestamps null: false
+  end
+
+  create_table :rankle_indices, :force => true do |t|
+    t.string  :indexable_name
+    t.integer :indexable_id
+    t.string  :indexable_type
+    t.integer :indexable_position
+
+    t.timestamps null: false
+  end
+end

data/lib/generators/rankle/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators/base'
+
+module Rankle
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates/', __FILE__)
+
+      def generate_migration
+        migration_template 'migration.rb', 'db/migrate/create_rankle_index.rb'
+      end
+
+      def self.next_migration_number(dir)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+    end
+  end
+end

data/lib/generators/rankle/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateRankleIndex < ActiveRecord::Migration
+  def change
+    create_table(:rankle_index) do |t|
+      t.string  :indexable_name
+      t.integer :indexable_id
+      t.string  :indexable_type
+      t.integer :indexable_position
+
+      t.timestamps null: false
+    end
+
+    add_index :rankle_index, :indexable_name
+    add_index :rankle_index, :indexable_id
+    add_index :rankle_index, :indexable_type
+    add_index :rankle_index, :indexable_position
+  end
+end

data/lib/rankle.rb

@@ -0,0 +1,94 @@
+require 'active_record'
+require 'rankle/ranker'
+require 'rankle/version'
+
+# Rankle provides multi-resource ranking for ActiveRecord objects.
+#
+# This top-level module provides a namespace for all Rankle code.
+#
+# @author William Burns
+module Rankle
+  # Class methods added to ActiveRecord models
+  module ClassMethods
+    # @return [ActiveRecord::Relation]
+    def ranked name = :default
+      ranked_results = joins("INNER JOIN rankle_indices ON rankle_indices.indexable_name = '#{name}' AND
+                                                           rankle_indices.indexable_id   = #{self.to_s.tableize}.id AND
+                                                           rankle_indices.indexable_type = '#{self.to_s}'")
+      if ranked_results.size == 0
+        self.all
+      else
+        ranked_results.order('rankle_indices.indexable_position')
+      end
+    end
+
+    def ranks proc
+      Ranker.put self, proc
+    end
+  end
+
+  def self.ranked name = :default
+    RankleIndex.where(indexable_name: name).order(:indexable_position).map do |duck|
+      duck.indexable_type.classify.constantize.find(duck.indexable_id)
+    end
+  end
+
+  # instance methods added to ActiveRecord models
+  module InstanceMethods
+    def set_default_position
+      if Ranker.get(self.class)
+        position = self.class.ranked.each_with_index { |record, index| break index if Ranker.get(self.class).call(self, record) }
+      end unless Ranker.get(self.class).is_a?(Symbol)
+      position = self.class.count - 1 if position.nil? || position.is_a?(Array)
+      rank position
+      if Ranker.get(self.class).is_a?(Symbol)
+        rank Ranker.get(self.class), RankleIndex.where(indexable_name: Ranker.get(self.class)).count
+      end
+    end
+
+    # Assigns an explicit position to the record
+    #
+    # @param format [Integer] the new position
+    # @return [Integer or Exception] the new position or an exception if the position could not be set
+    def position= position
+      rank position
+    end
+
+    def rank name = :default, position
+      rankle_index = RankleIndex.where(indexable_name: name.to_s, indexable_id: id, indexable_type: self.class).first_or_create!
+      rankle_index_length = if name == :default
+        RankleIndex.where(indexable_name: name.to_s, indexable_type: self.class).count
+      else
+        RankleIndex.where(indexable_name: name.to_s).count
+      end
+      position = 0 if position < 0
+      position = rankle_index_length - 1 if position >= rankle_index_length
+      rankle_index.update_attribute(:indexable_position, rankle_index_length - 1) unless rankle_index.indexable_position
+      swap_distance  = -1
+      swap_distance *= -1 if rankle_index.indexable_position < position
+      until rankle_index.indexable_position == position
+        if name == :default
+          Ranker.swap(rankle_index, RankleIndex.where(indexable_name: name.to_s, indexable_type: self.class, indexable_position: rankle_index.indexable_position + swap_distance).first)
+        else
+          Ranker.swap(rankle_index, RankleIndex.where(indexable_name: name.to_s, indexable_position: rankle_index.indexable_position + swap_distance).first)
+        end
+      end
+    end
+
+    def position name = :default
+      RankleIndex.where(indexable_name: name.to_s, indexable_id: id, indexable_type: self.class).first_or_create.indexable_position
+    end
+  end
+end
+
+ActiveRecord::Base.extend Rankle::ClassMethods
+ActiveRecord::Base.send :include, Rankle::InstanceMethods
+
+class ActiveRecord::Base
+  def self.inherited(child)
+    super
+    unless child == ActiveRecord::SchemaMigration || child == RankleIndex
+      child.send :after_create, :set_default_position
+    end
+  end
+end

data/lib/rankle/ranker.rb

@@ -0,0 +1,18 @@
+module Rankle
+  class Ranker
+    def self.put klass, proc
+      @rankers ||= {}
+      @rankers[klass] = proc
+    end
+
+    def self.get klass
+      @rankers[klass] rescue nil
+    end
+
+    def self.swap(first_index, second_index)
+      first_index_position = first_index.indexable_position
+      first_index.update_attribute(:indexable_position, second_index.indexable_position)
+      second_index.update_attribute(:indexable_position, first_index_position)
+    end
+  end
+end

data/lib/rankle/version.rb

@@ -0,0 +1,3 @@
+module Rankle
+  VERSION = '0.0.0.pre'
+end

data/rankle.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rankle/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rankle"
+  spec.version       = Rankle::VERSION
+  spec.authors       = ["Wil"]
+  spec.email         = ["rankle@william-burns.com"]
+  spec.summary       = %q{Rankle provides multi-resource ranking.}
+  spec.description   = %q{Rankle provides multi-resource ranking.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rspec-expectations"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "factory_girl_rails"
+  spec.add_development_dependency "yard"
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification
+name: rankle
+version: !ruby/object:Gem::Version
+  version: 0.0.0.pre
+platform: ruby
+authors:
+- Wil
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rankle provides multi-resource ranking.
+email:
+- rankle@william-burns.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/default_ranking.feature
+- features/get_position.feature
+- features/multi-resource_ranking.feature
+- features/named_ranking.feature
+- features/ranking.feature
+- features/set_position.feature
+- features/step_definitions/fruit_steps.rb
+- features/step_definitions/model_steps.rb
+- features/step_definitions/position_steps.rb
+- features/support/env.rb
+- features/support/factories/fruit.rb
+- features/support/factories/vegetable.rb
+- features/support/models.rb
+- features/support/schema.rb
+- lib/generators/rankle/install_generator.rb
+- lib/generators/rankle/templates/migration.rb
+- lib/rankle.rb
+- lib/rankle/ranker.rb
+- lib/rankle/version.rb
+- rankle.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Rankle provides multi-resource ranking.
+test_files:
+- features/default_ranking.feature
+- features/get_position.feature
+- features/multi-resource_ranking.feature
+- features/named_ranking.feature
+- features/ranking.feature
+- features/set_position.feature
+- features/step_definitions/fruit_steps.rb
+- features/step_definitions/model_steps.rb
+- features/step_definitions/position_steps.rb
+- features/support/env.rb
+- features/support/factories/fruit.rb
+- features/support/factories/vegetable.rb
+- features/support/models.rb
+- features/support/schema.rb
+has_rdoc: