ranked-model 0.1.1 → 0.2.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"

data/Readme.mkd

@@ -1,5 +1,7 @@
 **ranked-model** is a modern row sorting library built for Rails 3.  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
 ------------
 
@@ -124,4 +126,6 @@ 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)
+* [AndrewRadev](https://github.com/AndrewRadev)
+* [adheerajkumar](https://github.com/adheerajkumar)
+* [mikeycgto](https://github.com/mikeycgto)

data/lib/ranked-model.rb

@@ -11,7 +11,7 @@ module RankedModel
   def self.included base
 
     base.class_eval do
-      cattr_accessor :rankers
+      class_attribute :rankers
 
       extend RankedModel::ClassMethods
 

data/lib/ranked-model/ranker.rb

@@ -4,13 +4,14 @@ module RankedModel
   class InvalidField < StandardError; end
 
   class Ranker
-    attr_accessor :name, :column, :scope, :with_same
+    attr_accessor :name, :column, :scope, :with_same, :class_name, :unless
 
     def initialize name, options={}
       self.name = name.to_sym
       self.column = options[:column] || name
+      self.class_name = options[:class_name]
 
-      [ :scope, :with_same ].each do |key|
+      [ :scope, :with_same, :unless ].each do |key|
         self.send "#{key}=", options[key]
       end
     end
@@ -30,7 +31,7 @@ module RankedModel
       end
       
       def validate_ranker_for_instance!
-        if ranker.scope && !instance.class.respond_to?(ranker.scope)
+        if ranker.scope && !instance_class.respond_to?(ranker.scope)
           raise RankedModel::InvalidScope, %Q{No scope called "#{ranker.scope}" found in model}
         end
 
@@ -49,6 +50,13 @@ module RankedModel
       end
 
       def handle_ranking
+        case ranker.unless
+        when Proc
+          return if ranker.unless.call(instance)
+        when Symbol
+          return if instance.send(ranker.unless)
+        end
+
         update_index_from_position
         assure_unique_position
       end
@@ -56,7 +64,7 @@ module RankedModel
       def update_rank! value
         # Bypass callbacks
         #
-        instance.class.where(:id => instance.id).update_all ["#{ranker.column} = ?", value]
+        instance_class.where(:id => instance.id).update_all ["#{ranker.column} = ?", value]
       end
 
       def position
@@ -75,6 +83,10 @@ module RankedModel
 
     private
 
+      def instance_class
+        ranker.class_name.nil? ? instance.class : ranker.class_name.constantize
+      end
+
       def position_at value
         instance.send "#{ranker.name}_position=", value
         update_index_from_position
@@ -140,19 +152,19 @@ module RankedModel
         _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) )
+          _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
           _scope.
-            where( instance.class.arel_table[ranker.column].lteq(rank) ).
+            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
           _scope.
-            where( instance.class.arel_table[ranker.column].gteq(rank) ).
+            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 
+        elsif current_first.rank && current_first.rank > RankedModel::MIN_RANK_VALUE && rank > current_first.rank
           _scope.
-            where( instance.class.arel_table[ranker.column].lt(rank) ).
+            where( instance_class.arel_table[ranker.column].lt(rank) ).
             update_all( "#{ranker.column} = #{ranker.column} - 1" )
           rank_at( rank - 1 )
         else
@@ -184,23 +196,23 @@ module RankedModel
 
       def finder
         @finder ||= begin
-          _finder = instance.class
+          _finder = instance_class
           if ranker.scope
             _finder = _finder.send ranker.scope
           end
           case ranker.with_same
             when Symbol
               _finder = _finder.where \
-                instance.class.arel_table[ranker.with_same].eq(instance.attributes["#{ranker.with_same}"])
+                instance_class.arel_table[ranker.with_same].eq(instance.attributes["#{ranker.with_same}"])
             when Array
               _finder = _finder.where(
                 ranker.with_same[1..-1].inject(
-                  instance.class.arel_table[ranker.with_same.first].eq(
+                  instance_class.arel_table[ranker.with_same.first].eq(
                     instance.attributes["#{ranker.with_same.first}"]
                   )
                 ) {|scoper, attr|
-                  scoper.and( 
-                    instance.class.arel_table[attr].eq(
+                  scoper.and(
+                    instance_class.arel_table[attr].eq(
                       instance.attributes["#{attr}"]
                     )
                   )
@@ -209,9 +221,9 @@ module RankedModel
           end
           if !new_record?
             _finder = _finder.where \
-              instance.class.arel_table[:id].not_eq(instance.id)
+              instance_class.arel_table[:id].not_eq(instance.id)
           end
-          _finder.order(instance.class.arel_table[ranker.column].asc).select([instance.class.arel_table[:id], instance.class.arel_table[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.1.1"
+  VERSION = "0.2.0"
 end

data/spec/ranked-model/ranker_spec.rb

@@ -5,14 +5,60 @@ describe RankedModel::Ranker, 'initialized' do
   subject {
     RankedModel::Ranker.new \
       :overview,
-      :column    => :a_sorting_column,
-      :scope     => :a_scope,
-      :with_same => :a_column
+      :column     => :a_sorting_column,
+      :scope      => :a_scope,
+      :with_same  => :a_column,
+      :class_name => 'SomeClass',
+      :unless     => :a_method
   }
 
   its(:name) { should == :overview }
   its(:column) { should == :a_sorting_column }
   its(:scope) { should == :a_scope }
   its(:with_same) { should == :a_column }
+  its(:class_name) { should == 'SomeClass' }
+  its(:unless) { should == :a_method }
+end
+
+describe RankedModel::Ranker, 'unless as Symbol' do
+  let(:receiver) { mock('model') }
+
+  subject {
+    RankedModel::Ranker.new(:overview, :unless => :a_method).with(receiver)
+  }
+
+  context 'returns true' do
+    before { receiver.expects(:a_method).once.returns(true) }
+
+    its(:handle_ranking) { should == nil }
+  end
+
+  context 'returns false' do
+    before { receiver.expects(:a_method).once.returns(false) }
+
+    it {
+      subject.expects(:update_index_from_position).once
+      subject.expects(:assure_unique_position).once
+
+      subject.handle_ranking
+    }
+  end
+end
+
+describe RankedModel::Ranker, 'unless as Proc' do
+  context 'returns true' do
+    subject { RankedModel::Ranker.new(:overview, :unless => Proc.new { true }).with(Class.new) }
+    its(:handle_ranking) { should == nil }
+  end
+
+  context 'returns false' do
+    subject { RankedModel::Ranker.new(:overview, :unless => Proc.new { false }).with(Class.new) }
+
+    it {
+      subject.expects(:update_index_from_position).once
+      subject.expects(:assure_unique_position).once
 
+      subject.handle_ranking
+    }
+  end
 end

data/spec/sti-model/element_spec.rb

@@ -30,9 +30,9 @@ describe Element do
     subject { NobleGas.rank(:combination_order) }
 
     its(:size) { should == 3 }
-    
+
     its(:first) { should == @elements[:xenon] }
-    
+
     its(:last) { should == @elements[:argon] }
 
   end
@@ -57,9 +57,9 @@ describe Element do
       subject { NobleGas.rank(:combination_order) }
 
       its(:size) { should == 3 }
-      
+
       its(:first) { should == @elements[:argon] }
-      
+
       its(:last) { should == @elements[:helium] }
 
     end
@@ -69,9 +69,9 @@ describe Element do
       subject { TransitionMetal.rank(:combination_order) }
 
       its(:size) { should == 2 }
-      
+
       its(:first) { should == @elements[:chromium] }
-      
+
       its(:last) { should == @elements[:manganese] }
 
     end
@@ -98,9 +98,9 @@ describe Element do
       subject { NobleGas.rank(:combination_order) }
 
       its(:size) { should == 3 }
-      
+
       its(:first) { should == @elements[:argon] }
-      
+
       its(:last) { should == @elements[:helium] }
 
     end
@@ -110,9 +110,9 @@ describe Element do
       subject { TransitionMetal.rank(:combination_order) }
 
       its(:size) { should == 2 }
-      
+
       its(:first) { should == @elements[:chromium] }
-      
+
       its(:last) { should == @elements[:manganese] }
 
     end

data/spec/sti-model/vehicle_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe Vehicle do
+
+  before {
+    @vehicles = {
+      :ford     => Car.create( :manufacturer => 'Ford' ),
+      :bmw      => Car.create( :manufacturer => 'BMW' ),
+      :daimler  => Truck.create( :manufacturer => 'Daimler' ),
+      :volvo    => Truck.create( :manufacturer => 'Volvo' ),
+      :kenworth => Truck.create( :manufacturer => 'Kenworth' )
+    }
+    @vehicles.each { |name, vehicle|
+      vehicle.reload
+      vehicle.update_attribute :parking_order_position, 0
+    }
+    @vehicles.each {|name, vehicle| vehicle.reload }
+  }
+
+  describe "ranking by STI parent" do
+
+    before {
+      @vehicles[:volvo].update_attribute :parking_order_position, :first
+      @vehicles[:ford].update_attribute :parking_order_position, :first
+    }
+
+    describe "Vehicle" do
+
+      subject { Vehicle.rank(:parking_order) }
+
+      its(:size) { should == 5 }
+
+      its(:first) { should == @vehicles[:ford] }
+
+      its(:second) { should == @vehicles[:volvo] }
+
+    end
+
+  end
+
+  describe "overriding parent's ranking" do
+
+    describe "Vehicle" do
+
+      it "should have one ranker object" do
+        Vehicle.rankers.count.should == 1
+      end
+
+      subject { Vehicle.rankers.first }
+
+      its(:class_name) { should == 'Vehicle' }
+
+      its(:column) { should == :parking_order }
+
+    end
+
+    describe "MotorBike" do
+
+      it "should have one ranker object" do
+        MotorBike.rankers.count.should == 1
+      end
+
+      subject { MotorBike.rankers.first }
+
+      its(:class_name) { should == 'Vehicle' }
+
+      its(:column) { should == :parking_order }
+
+      its(:with_same) { should == :color }
+
+    end
+
+  end
+
+end

data/spec/support/active_record.rb

@@ -39,6 +39,13 @@ ActiveRecord::Schema.define :version => 0 do
     t.string :type
     t.integer :combination_order
   end
+
+  create_table :vehicles, :force => true do |t|
+    t.string :color
+    t.string :manufacturer
+    t.string :type
+    t.integer :parking_order
+  end
 end
 
 class Duck < ActiveRecord::Base
@@ -47,7 +54,7 @@ class Duck < ActiveRecord::Base
   ranks :row
   ranks :size, :scope => :in_shin_pond
   ranks :age, :with_same => :pond
-  
+
   ranks :landing_order, :with_same => [:lake_id, :flock_id]
   scope :in_lake_and_flock, lambda {|lake, flock| where(:lake_id => lake, :flock_id => flock) }
 
@@ -71,6 +78,8 @@ class WrongFieldDuck < ActiveRecord::Base
 
 end
 
+# Example for STI, ranking within each child class
+
 class Element < ActiveRecord::Base
 
   include RankedModel
@@ -85,3 +94,29 @@ end
 class NobleGas < Element
 
 end
+
+# Example for STI, ranking within parent
+
+class Vehicle < ActiveRecord::Base
+
+  include RankedModel
+  ranks :parking_order, :class_name => 'Vehicle'
+
+end
+
+class Car < Vehicle
+
+end
+
+class Truck < Vehicle
+
+end
+
+# Example for STI, overriding parent's ranking
+
+class MotorBike < Vehicle
+
+  include RankedModel
+  ranks :parking_order, :class_name => 'Vehicle', :with_same => :color
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ranked-model
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-04 00:00:00.000000000 Z
+date: 2012-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -117,6 +117,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
 - Rakefile
@@ -134,6 +135,7 @@ files:
 - spec/ranked-model/version_spec.rb
 - spec/spec_helper.rb
 - spec/sti-model/element_spec.rb
+- spec/sti-model/vehicle_spec.rb
 - spec/support/active_record.rb
 - spec/support/database.yml
 - tmp/.gitignore
@@ -151,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4485783404028753486
+      hash: -3607802699364138868
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -160,10 +162,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4485783404028753486
+      hash: -3607802699364138868
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: An acts_as_sortable replacement built for Rails 3
@@ -175,5 +177,6 @@ test_files:
 - spec/ranked-model/version_spec.rb
 - spec/spec_helper.rb
 - spec/sti-model/element_spec.rb
+- spec/sti-model/vehicle_spec.rb
 - spec/support/active_record.rb
 - spec/support/database.yml