rankle 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d2a00ba713d656ff500838729e9ea39ed91d71c5
-  data.tar.gz: 1b07a9638a677ca8265d6a146674d222d80b0470
+  metadata.gz: 074be4978d90fa4f0456dc867138970a59d0aaf4
+  data.tar.gz: 9c6742f8b6f14098c5c62ee2748d5f46c8241f34
 SHA512:
-  metadata.gz: a48c2ed7910ffc5d4e0c8d23fcfec501e220c82ea7db87f8d88a30dbb500251b4e67dc8c2743d0380182fb75b47a4bbb204cb7440803925f375f9ecdbf0ba26a
-  data.tar.gz: 1bb2cee9412e484908a9e94d4095ecda288223b868b487259bdfa0c2d40b1cb8d2d0a4c50258d949d2ba1bc295003e987c98856134698a116e011724cf8dbc79
+  metadata.gz: 431ea786772022a565750d33713834bdb8c4f4828f8dc99f05cc70fb92fd291e5b08b90a0700368d2ff6443e2e62e97236581fc9e39e9bc5a8887b3faadb2427
+  data.tar.gz: 6797af0d99cc9aa1a85be6de905606ca84b864f9546d7cf667225f295a92db5c8adcf97528418aad01f802aa6ed2c5e09d566eff5e3fab646523fc1a39f6c089

data/lib/rankle/ranker.rb

@@ -1,36 +1,9 @@
 module Rankle
   class Ranker
-    MIN_INDEX = -2147483648
-    MAX_INDEX =  2147483647
-
     attr_accessor :strategy
 
     def initialize strategy
       @strategy = strategy
     end
-
-    def self.insert target_position, existing_elements
-      if existing_elements.count > MAX_INDEX - MIN_INDEX
-        raise IndexError
-      elsif existing_elements.empty?
-        return 0, []
-      elsif target_position <= 0
-        return (MIN_INDEX + existing_elements.first) / 2, existing_elements
-      elsif target_position >= existing_elements.count
-        return (MAX_INDEX + existing_elements.last) / 2, existing_elements
-      elsif existing_elements[target_position] - existing_elements[target_position - 1] > 1
-        return (existing_elements[target_position] + existing_elements[target_position - 1]) / 2, existing_elements
-      else
-        existing_elements = balance existing_elements
-        insert target_position, existing_elements
-      end
-    end
-
-    def self.balance indices, options = {}
-      min_index = options[:min_index] || MIN_INDEX
-      max_index = options[:max_index] || MAX_INDEX
-      offset = (max_index - min_index) / (indices.count + 1)
-      indices.count.times.map { |index| min_index + (offset * (index + 1)) + index }
-    end
   end
 end

data/lib/rankle/version.rb

@@ -1,3 +1,3 @@
 module Rankle
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/rankle_index.rb

@@ -1,4 +1,10 @@
+require 'ranked-model'
+
 class RankleIndex < ActiveRecord::Base
+  include RankedModel
+
+  ranks :row_order, column: :indexable_position, :with_same => :indexable_name
+
   belongs_to :indexable, polymorphic: true
 
   @rankers = {}
@@ -26,20 +32,16 @@ class RankleIndex < ActiveRecord::Base
                           end
     position = existing_indices.length - 1 if position > existing_indices.length
     position = 0 if position < 0
-    index = RankleIndex.where(indexable_name: name.to_s, indexable_id: instance.id, indexable_type: instance.class).first_or_initialize
-    existing_positions = existing_indices.pluck(:indexable_position).compact
-    existing_positions -= [index.indexable_position] unless index.new_record?
-    indexable_position, existing_positions = Rankle::Ranker.insert(position, existing_positions)
-    existing_positions.each_with_index do |position, index|
-      existing_indices[index].update_attribute(:indexable_position, position) unless existing_indices[index].indexable_position = position
-    end
-    index.indexable_position = indexable_position
-    index.save!
+    index = RankleIndex.where(indexable_name: name.to_s, indexable_id: instance.id, indexable_type: instance.class).first_or_create!
+    index.update_attribute(:row_order_position, position)
   end
 
   def self.position instance, name
     indexable_position = where(indexable_name: name.to_s, indexable_id: instance.id, indexable_type: instance.class).first_or_create!.indexable_position
-    where(indexable_name: name.to_s).where('indexable_position < ?', indexable_position).count
+    indexable_scope = where(indexable_name: name.to_s)
+    indexable_scope = indexable_scope.where(indexable_type: instance.class) if name == :default
+    indexable_scope = indexable_scope.where('indexable_position < ?', indexable_position)
+    indexable_scope.count
   end
 
   def self.ranked name
@@ -47,10 +49,4 @@ class RankleIndex < ActiveRecord::Base
       duck.indexable_type.classify.constantize.find(duck.indexable_id)
     end
   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

data/rankle.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activerecord"
+  spec.add_dependency "ranked-model"
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "sqlite3"

data/test/{performance → benchmark}/rank_benchmark.rb

@@ -30,9 +30,5 @@ class BenchmarkRank < Minitest::Benchmark
         n.times { |name| Fruit.create! name: name }
       end
     end
-
-    # FIXME: This unfortunate hack reaches into the internals of RankleIndex to reset the test state
-    RankleIndex.instance_variable_set(:@rankers, {})
-    DatabaseCleaner.clean
   end
 end

data/test/multiple_resources_test.rb

@@ -63,8 +63,5 @@ class TestNamedRanking < Minitest::Test
 
     assert_equal 0, apple.position(:produce)
     assert_equal 1, carrot.position(:produce)
-
-    # FIXME: This unfortunate hack reaches into the internals of RankleIndex to reset the test state
-    RankleIndex.instance_variable_set(:@rankers, {})
   end
 end

data/test/named_ranking_test.rb

@@ -68,8 +68,5 @@ class TestNamedRanking < Minitest::Test
 
     assert_equal ['apple', 'banana', 'orange'], Fruit.ranked.map(&:name)
     assert_equal ['orange', 'banana', 'apple'], Fruit.ranked(:reverse).map(&:name)
-
-    # FIXME: This unfortunate hack reaches into the internals of RankleIndex to reset the test state
-    RankleIndex.instance_variable_set(:@rankers, {})
   end
 end

data/test/performance/get_position_test.rb

@@ -0,0 +1,11 @@
+require_relative '../support/test_helper'
+
+class TestGetPosition < Minitest::Test
+  def test_retrieving_position_makes_only_one_query
+    apple  = Fruit.create! name: 'apple'
+
+    assert_queries(2) do
+      apple.position
+    end
+  end
+end

data/test/performance/set_position_test.rb

@@ -0,0 +1,33 @@
+require_relative '../support/test_helper'
+
+class TestSetPosition < Minitest::Test
+  def test_initializing_position_makes_six_queries
+    assert_queries(8) do
+      apple  = Fruit.create! name: 'apple'
+    end
+  end
+
+  def test_update_position_makes_three_queries
+    apple  = Fruit.create! name: 'apple'
+
+    assert_queries(4) do
+      apple.update_attribute :position, 1
+    end
+  end
+
+  def test_update_rank_makes_three_queries
+    apple  = Fruit.create! name: 'apple'
+
+    assert_queries(4) do
+      apple.rank 1
+    end
+  end
+
+  def test_initializing_position_with_a_proc_makes_eight_queries
+    Fruit.send :ranks, ->(a, b) { a.name < b.name }
+
+    assert_queries(10) do
+      Fruit.create! name: 'apple'
+    end
+  end
+end

data/test/simple_usage_test.rb

@@ -33,8 +33,5 @@ class TestSimpleUsage < Minitest::Test
     Fruit.create! name: 'banana'
 
     assert_equal ['apple', 'banana', 'orange'], Fruit.ranked.map(&:name)
-
-    # FIXME: This unfortunate hack reaches into the internals of RankleIndex to reset the test state
-    RankleIndex.instance_variable_set(:@rankers, {})
   end
 end

data/test/support/test_helper.rb

@@ -6,8 +6,8 @@ require 'rails/generators'
 require 'rake'
 
 ActiveRecord::Base.establish_connection(
-    adapter:  'sqlite3',
-    database: 'rankle.sqlite3'
+  adapter:  'sqlite3',
+  database: 'rankle.sqlite3'
 )
 
 rake = Rake.application
@@ -32,4 +32,20 @@ class Minitest::Test
   def setup
     DatabaseCleaner.clean
   end
+
+  def teardown
+    # FIXME: This unfortunate hack reaches into the internals of RankleIndex to reset the test state
+    RankleIndex.instance_variable_set(:@rankers, {})
+  end
+end
+
+def assert_queries(num = 1, &block)
+  queries  = []
+  callback = lambda { |name, start, finish, id, payload|
+    queries << payload[:sql] if payload[:sql] =~ /^SELECT|UPDATE|INSERT/
+  }
+
+  ActiveSupport::Notifications.subscribed(callback, "sql.active_record", &block)
+ensure
+  assert_equal num, queries.size, "#{queries.size} instead of #{num} queries were executed.#{queries.size == 0 ? '' : "\nQueries:\n#{queries.join("\n")}"}"
 end

metadata

@@ -1,125 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: rankle
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wil
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-06-22 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: ranked-model
+  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: 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.
@@ -129,7 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - LICENSE.txt
@@ -142,13 +156,14 @@ files:
 - lib/rankle/version.rb
 - lib/rankle_index.rb
 - rankle.gemspec
+- test/benchmark/rank_benchmark.rb
 - test/default_behavior_test.rb
 - test/multiple_resources_test.rb
 - test/named_ranking_test.rb
-- test/performance/rank_benchmark.rb
+- test/performance/get_position_test.rb
+- test/performance/set_position_test.rb
 - test/scoped_ranking_test.rb
 - test/simple_usage_test.rb
-- test/spec/ranker_test.rb
 - test/spec/rankle_index_test.rb
 - test/support/models.rb
 - test/support/schema.rb
@@ -163,12 +178,12 @@ 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: '0'
 requirements: []
@@ -178,13 +193,14 @@ signing_key:
 specification_version: 4
 summary: Rankle provides multi-resource ranking.
 test_files:
+- test/benchmark/rank_benchmark.rb
 - test/default_behavior_test.rb
 - test/multiple_resources_test.rb
 - test/named_ranking_test.rb
-- test/performance/rank_benchmark.rb
+- test/performance/get_position_test.rb
+- test/performance/set_position_test.rb
 - test/scoped_ranking_test.rb
 - test/simple_usage_test.rb
-- test/spec/ranker_test.rb
 - test/spec/rankle_index_test.rb
 - test/support/models.rb
 - test/support/schema.rb

data/test/spec/ranker_test.rb

@@ -1,115 +0,0 @@
-require_relative '../support/test_helper'
-
-describe Rankle::Ranker do
-  describe '.insert into' do
-    describe 'empty array' do
-      describe 'at position 0' do
-        it{ assert_equal [0, []], Rankle::Ranker.insert(0, []) }
-      end
-
-      describe 'at position -100' do
-        it{ assert_equal [0, []], Rankle::Ranker.insert(-100, []) }
-      end
-
-      describe 'at position 100' do
-        it{ assert_equal [0, []], Rankle::Ranker.insert(100, []) }
-      end
-    end
-
-    describe 'singleton array' do
-      describe 'at position 0' do
-        it{ assert_equal [-1073741824, [0]], Rankle::Ranker.insert(0, [0]) }
-      end
-
-      describe 'at position 1' do
-        it{ assert_equal [1073741823, [0]], Rankle::Ranker.insert(1, [0]) }
-      end
-
-      describe 'at position -100' do
-        it{ assert_equal [-1073741824, [0]], Rankle::Ranker.insert(-100, [0]) }
-      end
-
-      describe 'at position 100' do
-        it{ assert_equal [1073741823, [0]], Rankle::Ranker.insert(100, [0]) }
-      end
-    end
-
-    describe 'between non-adjacent elements' do
-      it{ assert_equal [0, [-1, 1]], Rankle::Ranker.insert(1, [-1, 1]) }
-      it{ assert_equal [0, [-1, 2]], Rankle::Ranker.insert(1, [-1, 2]) }
-    end
-
-    describe 'saturated' do
-      before do
-        @min_index = Rankle::Ranker::MIN_INDEX
-        @max_index = Rankle::Ranker::MAX_INDEX
-        Rankle::Ranker.send :remove_const, :MIN_INDEX
-        Rankle::Ranker.send :remove_const, :MAX_INDEX
-        Rankle::Ranker::MIN_INDEX = -2
-        Rankle::Ranker::MAX_INDEX = 2
-      end
-
-      it{ assert_raises(IndexError) { Rankle::Ranker.insert(0, [-2, -1, 0, 1, 2]) } }
-
-      after do
-        Rankle::Ranker.send :remove_const, :MIN_INDEX
-        Rankle::Ranker.send :remove_const, :MAX_INDEX
-        Rankle::Ranker::MIN_INDEX = @min_index
-        Rankle::Ranker::MAX_INDEX = @max_index
-      end
-    end
-
-    describe 'collision' do
-      it{ assert_equal [0, [-715827883, 715827883]], Rankle::Ranker.insert(1, [-1, 0]) }
-      it{ assert_equal [0, [-715827883, 715827883]], Rankle::Ranker.insert(1, [ 0, 1]) }
-    end
-
-    describe 'cascading collision' do
-      it{ assert_equal [-858993459, [-1288490189, -429496729, 429496731, 1288490191]], Rankle::Ranker.insert(1, [-2, -1, 0, 1]) }
-      it{ assert_equal [-858993459, [-1288490189, -429496729, 429496731, 1288490191]], Rankle::Ranker.insert(1, [-1,  0, 1, 2]) }
-    end
-
-    describe 'half-saturated' do
-      before do
-        @min_index = Rankle::Ranker::MIN_INDEX
-        @max_index = Rankle::Ranker::MAX_INDEX
-        Rankle::Ranker.send :remove_const, :MIN_INDEX
-        Rankle::Ranker.send :remove_const, :MAX_INDEX
-        Rankle::Ranker::MIN_INDEX = -2
-        Rankle::Ranker::MAX_INDEX = 2
-      end
-
-      it{ assert_equal [-1, [-2, 0, 2]], Rankle::Ranker.insert(1, [-2, 0, 2]) }
-      it{ assert_equal [1, [-2, 0, 2]], Rankle::Ranker.insert(2, [-2, 0, 2]) }
-
-      after do
-        Rankle::Ranker.send :remove_const, :MIN_INDEX
-        Rankle::Ranker.send :remove_const, :MAX_INDEX
-        Rankle::Ranker::MIN_INDEX = @min_index
-        Rankle::Ranker::MAX_INDEX = @max_index
-      end
-    end
-  end
-
-  describe '.balance' do
-    describe 'with default range' do
-      before do
-        @indices = {
-          [-1073741824] => [-1],
-          [1073741823]  => [-1],
-          [-1, 1]       => [-715827883, 715827883]
-        }
-      end
-
-      it do
-        @indices.each do |indices, expected|
-          assert_equal expected, Rankle::Ranker.balance(indices)
-        end
-      end
-    end
-
-    describe 'with custom range' do
-      it{ assert_equal [3, 7], Rankle::Ranker.balance([0, 1], min_index: 0, max_index: 10) }
-    end
-  end
-end