ranked-model 0.0.5 → 0.1.0

data/Readme.mkd

@@ -5,11 +5,13 @@ Installation
 
 To install ranked-model, just add it to your `Gemfile`:
 
-    gem 'ranked-model'
-    
-    # Or pin ranked-model to git
-    # gem 'ranked-model',
-    #   :git => 'git@github.com:harvesthq/ranked-model.git'
+``` 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`.
 
@@ -18,66 +20,83 @@ Simple Use
 
 Use of ranked-model is straight ahead.  Get some ducks:
 
-    class Duck < ActiveRecord::Base
-    end
+``` ruby
+class Duck < ActiveRecord::Base
+end
+```
 
 Put your ducks in a row:
 
-    class Duck < ActiveRecord::Base
-    
-      include RankedModel
-      ranks :row_order
-    
-    end
+``` 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:
 
-    Duck.rank(:row_order).all
+``` 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 with the position instead:
 
-    @duck.update_attribute :row_order_position, 0  # or 1, 2, 37. :first and :last are also valid
+``` ruby
+@duck.update_attribute :row_order_position, 0  # or 1, 2, 37. :first and :last are also valid
+```
+
+Position numbers begin at zero.  A position number greater than the number of records acts the
+same as :last.
 
 So using a normal json controller where `@duck.attributes = params[:duck]; @duck.save`, JS can
 look pretty elegant:
 
-    $.ajax({
-      type: 'PUT',
-      url: '/ducks',
-      dataType: 'json',
-      data: { duck: { row_order_position: 0 } },  // or whatever your new position is
-    });
+``` 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:
 
-    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
+``` 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:
 
-    Duck.rank(:row_order)
-    
-    Pond.first.ducks.rank(:swimming_order)
-    
-    Duck.walking.rank(:walking)
+``` ruby
+Duck.rank(:row_order)
+
+Pond.first.ducks.rank(:swimming_order)
+
+Duck.walking.rank(:walking)
+```
 
 Internals
 ---------
@@ -96,10 +115,13 @@ Contributing
 
 Fork, clone, write a test, write some code, commit, push, send a pull request.  Github FTW!
 
-This project was open-sourced by [Harvest](http://getharvest.com/).  [We're hiring!](http://www.getharvest.com/careers)
+RankedModel is mostly the handiwork of Matthew Beale:
+
+* [madhatted.com](http://madhatted.com) is where I blog. Also [@mixonic](http://twitter.com/mixonic).
+* [Spinto](http://www.spintoapp.com) is a product I'm bootstrapping.
 
 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/ranked-model)
-

data/lib/ranked-model.rb

@@ -18,7 +18,7 @@ module RankedModel
       before_save :handle_ranking
 
       scope :rank, lambda { |name|
-        order arel_table[ ranker(name.to_sym).column ]
+        order ranker(name.to_sym).column
       }
     end
 

data/lib/ranked-model/ranker.rb

@@ -94,19 +94,19 @@ module RankedModel
 
       def update_index_from_position
         case position
-          when :first
+          when :first, 'first'
             if current_first && current_first.rank
               rank_at( ( ( RankedModel::MIN_RANK_VALUE - current_first.rank ).to_f / 2 ).ceil + current_first.rank)
             else
               position_at :middle
             end
-          when :last
+          when :last, 'last'
             if current_last && current_last.rank
               rank_at( ( ( RankedModel::MAX_RANK_VALUE - current_last.rank ).to_f / 2 ).ceil + current_last.rank )
             else
               position_at :middle
             end
-          when :middle
+          when :middle, 'middle'
             rank_at( ( ( RankedModel::MAX_RANK_VALUE - RankedModel::MIN_RANK_VALUE ).to_f / 2 ).ceil + RankedModel::MIN_RANK_VALUE )
           when String
             position_at position.to_i
@@ -137,19 +137,21 @@ module RankedModel
       end
 
       def rearrange_ranks
+        _scope = finder
+        unless instance.id.nil?
+          # Never update ourself, shift others around us.
+          _scope = _scope.where( instance.class.arel_table[:id].not_eq(instance.id) )
+        end
         if current_first.rank && current_first.rank > RankedModel::MIN_RANK_VALUE && rank == RankedModel::MAX_RANK_VALUE
-          instance.class.
-            where( instance.class.arel_table[:id].not_eq(instance.id) ).
+          _scope.
             where( instance.class.arel_table[ranker.column].lteq(rank) ).
             update_all( "#{ranker.column} = #{ranker.column} - 1" )
         elsif current_last.rank && current_last.rank < (RankedModel::MAX_RANK_VALUE - 1) && rank < current_last.rank
-          instance.class.
-            where( instance.class.arel_table[:id].not_eq(instance.id) ).
+          _scope.
             where( instance.class.arel_table[ranker.column].gteq(rank) ).
             update_all( "#{ranker.column} = #{ranker.column} + 1" )
         elsif current_first.rank && current_first.rank > RankedModel::MIN_RANK_VALUE && rank > current_first.rank 
-          instance.class.
-            where( instance.class.arel_table[:id].not_eq(instance.id) ).
+          _scope.
             where( instance.class.arel_table[ranker.column].lt(rank) ).
             update_all( "#{ranker.column} = #{ranker.column} - 1" )
           rank_at( rank - 1 )
@@ -209,7 +211,7 @@ module RankedModel
             _finder = _finder.where \
               instance.class.arel_table[:id].not_eq(instance.id)
           end
-          _finder.order(instance.class.arel_table[ranker.column].asc).select([:id, ranker.column])
+          _finder.order(instance.class.arel_table[ranker.column].asc).select([instance.class.arel_table[:id], instance.class.arel_table[ranker.column]])
         end
       end
 

data/lib/ranked-model/version.rb

@@ -1,3 +1,3 @@
 module RankedModel
-  VERSION = "0.0.5"
+  VERSION = "0.1.0"
 end

data/spec/duck-model/duck_spec.rb

@@ -286,6 +286,47 @@ describe Duck do
       }
 
     end
+    
+    describe "at the end with string" do
+
+      before {
+        @ordered = Duck.rank(:row).where(Duck.arel_table[:id].not_eq @ducks[:wingy].id).collect {|duck| duck.id }
+        @ducks[:wingy].update_attribute :row_position, 'last'
+      }
+
+      context {
+
+        subject { Duck.ranker(:row).with(Duck.new).current_at_position(@ducks.size - 1).instance }
+
+        its(:id) { should == @ducks[:wingy].id }
+
+      }
+
+      context {
+
+        subject { Duck.rank(:row).last }
+
+        its(:id) { should == @ducks[:wingy].id }
+
+      }
+
+      context {
+
+        subject { Duck.ranker(:row).with(Duck.new).instance_eval { current_last }.instance }
+
+        its(:id) { should == @ducks[:wingy].id }
+
+      }
+
+      context {
+
+        subject { Duck.rank(:row).collect {|duck| duck.id } }
+
+        it { subject[0..-2].should == @ordered }
+        
+      }
+
+    end
 
   end
 

data/spec/duck-model/lots_of_ducks_spec.rb

@@ -87,6 +87,32 @@ describe Duck do
 
     end
 
+    describe "with max value and with_same pond" do
+
+      before {
+        Duck.first(50).each_with_index do |d, index|
+          d.update_attributes :age => index % 10, :pond => "Pond #{index / 10}"
+        end
+        @duck_11 = Duck.offset(10).first
+        @duck_12 = Duck.offset(11).first
+        @ordered = Duck.where(:pond => 'Pond 1').rank(:age).where(Duck.arel_table[:id].not_in([@duck_11.id, @duck_12.id])).collect {|d| d.id }
+        @duck_11.update_attribute :age, RankedModel::MAX_RANK_VALUE
+        @duck_12.update_attribute :age, RankedModel::MAX_RANK_VALUE
+      }
+
+      context {
+        subject { Duck.where(:pond => 'Pond 1').rank(:age).collect {|d| d.id } }
+
+        it { should == (@ordered[0..-2] + [@ordered[-1], @duck_11.id, @duck_12.id]) }
+      }
+
+      context {
+        subject { Duck.first.age }
+        it { should == 0}
+      }
+      
+    end
+
     describe "with min value" do
 
       before {

metadata

@@ -1,118 +1,120 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ranked-model
-version: !ruby/object:Gem::Version 
-  hash: 21
+version: !ruby/object:Gem::Version
+  version: 0.1.0
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
 platform: ruby
-authors: 
+authors:
 - Matthew Beale
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-08-22 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 3
-        - 0
-        - 3
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 3.0.3
   type: :runtime
-  version_requirements: *id001
-  name: activerecord
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id002
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
   name: rspec
-- !ruby/object:Gem::Dependency 
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-  name: rspec-rails
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id004
-  name: sqlite3
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id005
-  name: genspec
-- !ruby/object:Gem::Dependency 
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: genspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id006
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: mocha
-description: ranked-model is a modern row sorting library built for Rails 3. It uses ARel aggressively and is better optimized than most other libraries.
-email: 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ranked-model is a modern row sorting library built for Rails 3. It uses
+  ARel aggressively and is better optimized than most other libraries.
+email:
 - matt.beale@madhatted.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
 - Gemfile
@@ -137,38 +139,35 @@ files:
 - tmp/.gitignore
 homepage: https://github.com/harvesthq/ranked-model
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+      hash: -3628524900195041491
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
       - 0
-      version: "0"
+      hash: -3628524900195041491
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.8
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: An acts_as_sortable replacement built for Rails 3
-test_files: 
+test_files:
 - spec/duck-model/duck_spec.rb
 - spec/duck-model/lots_of_ducks_spec.rb
 - spec/duck-model/wrong_ducks_spec.rb