ranker 1.0.0

data/lib/ranker/version.rb

@@ -0,0 +1,3 @@
+module Ranker
+  VERSION = '1.0.0'
+end

data/spec/lib/ranker/ranking_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+
+describe Ranker::Ranking do
+  let(:klass) { Ranker::Ranking }
+  let(:strategy) { double(:strategy) }
+  let(:rankings) { Ranker::Rankings.new(strategy) }
+
+  describe :properties do
+
+    describe :percentile do
+      let(:rankables) { [1, 2, 3, 4, 5, 5, 1, 2] }
+      before {
+        rankables.each_with_index { |value, index|
+          rankings.create(index + 1, value, [value])
+        }
+      }
+
+      context '1st ranking' do
+        let(:ranking) { rankings[0] }
+        subject { ranking.percentile }
+        it { should == 100 }
+      end
+
+      context '2nd ranking' do
+        let(:ranking) { rankings[1] }
+        subject { ranking.percentile }
+        it { should == 87.5 }
+      end
+
+      context '3rd ranking' do
+        let(:ranking) { rankings[2] }
+        subject { ranking.percentile }
+        it { should == 75.0 }
+      end
+
+      context 'last ranking' do
+        let(:ranking) { rankings.last }
+        subject { ranking.percentile }
+        it { should == 12.5 }
+      end
+
+    end # percentile
+
+    describe :z_score do
+      let(:rankables) { [1, 2, 3, 4, 5, 5, 1, 2] }
+      before {
+        rankables.each_with_index { |value, index|
+          rankings.create(index + 1, value, [value])
+        }
+      }
+
+      context '1st ranking' do
+        let(:ranking) { rankings[0] }
+        subject { ranking.z_score }
+        it { should == -1.2206826881567392 }
+      end
+
+      context '2nd ranking' do
+        let(:ranking) { rankings[1] }
+        subject { ranking.z_score }
+        it { should == -0.5696519211398116 }
+      end
+
+      context '3rd ranking' do
+        let(:ranking) { rankings[2] }
+        subject { ranking.z_score }
+        it { should == 0.08137884587711594 }
+      end
+
+      context 'last ranking' do
+        let(:ranking) { rankings.last }
+        subject { ranking.z_score }
+        it { should == -0.5696519211398116 }
+      end
+
+      context 'when standard deviation is zero' do
+        let(:rankables) { [1, 1, 1, 1, 1, 1, 1] }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking.z_score }
+          it { should == 0 }
+        end
+
+      end # when standard deviation is zero
+
+    end # z_score
+
+  end # properties
+
+end

data/spec/lib/ranker/rankings_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+
+describe Ranker::Rankings do
+  let(:klass) { Ranker::Rankings }
+  let(:strategy) { double(:strategy) }
+  let(:rankings) { klass.new(strategy) }
+
+  describe :properties do
+
+    describe :mean do
+      let(:rankables) { raise NotImplementedError }
+      subject { rankings.mean }
+      before {
+        rankables.each_with_index { |value, index|
+          rankings.create(index + 1, value, [value])
+        }
+      }
+
+      context 'when there are rankables' do
+        let(:rankables) { [1, 2, 3, 4, 5, 5, 1, 2] }
+        it { should == 2.875 }
+      end
+
+      context 'when there are no rankables' do
+        let(:rankables) { [] }
+        it { should be_nan }
+      end
+
+    end # mean
+
+    describe :standard_deviation do
+      let(:rankables) { raise NotImplementedError }
+      subject { rankings.standard_deviation }
+      before {
+        rankables.each_with_index { |value, index|
+          rankings.create(index + 1, value, [value])
+        }
+      }
+
+      context 'when there are rankables' do
+        let(:rankables) { [1, 2, 3, 4, 5, 5, 1, 2] }
+        it { should == 1.5360257159305635 }
+      end
+
+      context 'when all rankables are the same' do
+        let(:rankables) { [1, 1, 1, 1, 1, 1, 1] }
+        it { should == 0 }
+      end
+
+      context 'when there are no rankables' do
+        let(:rankables) { [] }
+        it { should be_nan }
+      end
+
+    end # standard_deviation
+
+  end # properties
+
+end

data/spec/lib/ranker/strategies/dense_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Ranker::Strategies::Dense do
+  let(:klass) { Ranker::Strategies::Dense }
+
+  describe :methods do
+
+    describe :rank do
+      let(:rankables) { raise ArgumentError }
+      let(:strategy) { klass.new(rankables) }
+      let(:rankings) { strategy.rank }
+      subject { rankings }
+
+      context 'when list of rankables is large' do
+        let(:rankables) { [1, 1, 2, 3, 3, 4, 5, 6, 7, 7, 7, 1, 1, 3] }
+        it { should have(7).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [7, 7, 7] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 2 }
+          its(:rankables) { should == [6] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 3 }
+          its(:rankables) { should == [5] }
+        end
+
+        context '4th ranking' do
+          let(:ranking) { rankings[3] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:rankables) { should == [4] }
+        end
+
+        context '5th ranking' do
+          let(:ranking) { rankings[4] }
+          subject { ranking }
+          its(:rank) { should == 5 }
+          its(:rankables) { should == [3, 3, 3] }
+        end
+
+        context '6th ranking' do
+          let(:ranking) { rankings[5] }
+          subject { ranking }
+          its(:rank) { should == 6 }
+          its(:rankables) { should == [2] }
+        end
+
+        context '7th ranking' do
+          let(:ranking) { rankings[6] }
+          subject { ranking }
+          its(:rank) { should == 7 }
+          its(:rankables) { should == [1, 1, 1, 1] }
+        end
+
+      end # when list of rankables is large
+
+      context 'when list of rankables is small' do
+        let(:rankables) { [3, 2, 2, 1] }
+        it { should have(3).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [3] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 2 }
+          its(:rankables) { should == [2, 2] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 3 }
+          its(:rankables) { should == [1] }
+        end
+
+      end # list of rankables is small
+
+    end # rank
+
+  end # methods
+
+end

data/spec/lib/ranker/strategies/modified_competition_spec.rb

@@ -0,0 +1,100 @@
+require 'spec_helper'
+
+describe Ranker::Strategies::ModifiedCompetition do
+  let(:klass) { Ranker::Strategies::ModifiedCompetition }
+
+  describe :methods do
+
+    describe :rank do
+      let(:rankables) { raise ArgumentError }
+      let(:strategy) { klass.new(rankables) }
+      let(:rankings) { strategy.rank }
+      subject { rankings }
+
+      context 'when list of rankables is large' do
+        let(:rankables) { [1, 1, 2, 3, 3, 4, 5, 6, 7, 7, 7, 1, 1, 3] }
+        it { should have(7).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [7, 7, 7] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:rankables) { should == [6] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 5 }
+          its(:rankables) { should == [5] }
+        end
+
+        context '4th ranking' do
+          let(:ranking) { rankings[3] }
+          subject { ranking }
+          its(:rank) { should == 6 }
+          its(:rankables) { should == [4] }
+        end
+
+        context '5th ranking' do
+          let(:ranking) { rankings[4] }
+          subject { ranking }
+          its(:rank) { should == 9 }
+          its(:rankables) { should == [3, 3, 3] }
+        end
+
+        context '6th ranking' do
+          let(:ranking) { rankings[5] }
+          subject { ranking }
+          its(:rank) { should == 10 }
+          its(:rankables) { should == [2] }
+        end
+
+        context '7th ranking' do
+          let(:ranking) { rankings[6] }
+          subject { ranking }
+          its(:rank) { should == 14 }
+          its(:rankables) { should == [1, 1, 1, 1] }
+        end
+
+      end # when list of rankables is large
+
+      context 'when list of rankables is small' do
+        let(:rankables) { [3, 2, 2, 1] }
+        it { should have(3).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [3] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 3 }
+          its(:rankables) { should == [2, 2] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:rankables) { should == [1] }
+        end
+
+      end # list of rankables is small
+
+    end # rank
+
+  end # methods
+
+end

data/spec/lib/ranker/strategies/ordinal_spec.rb

@@ -0,0 +1,86 @@
+require 'spec_helper'
+
+describe Ranker::Strategies::Ordinal do
+  let(:klass) { Ranker::Strategies::Ordinal }
+
+  describe :methods do
+
+    describe :rank do
+      let(:rankables) { raise ArgumentError }
+      let(:strategy) { klass.new(rankables) }
+      let(:rankings) { strategy.rank }
+      subject { rankings }
+
+      context 'when list of rankables is large' do
+        let(:rankables) { [1, 1, 2, 3, 3, 4, 5, 6, 7, 7, 7, 1, 1, 3] }
+        it { should have(14).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [7] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 2 }
+          its(:rankables) { should == [7] }
+        end
+
+        context '2nd to last ranking' do
+          let(:ranking) { rankings[-2] }
+          subject { ranking }
+          its(:rank) { should == 13 }
+          its(:rankables) { should == [1] }
+        end
+
+        context 'last ranking' do
+          let(:ranking) { rankings[-1] }
+          subject { ranking }
+          its(:rank) { should == 14 }
+          its(:rankables) { should == [1] }
+        end
+
+      end # when list of rankables is large
+
+      context 'when list of rankables is small' do
+        let(:rankables) { [3, 2, 2, 1] }
+        it { should have(4).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [3] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 2 }
+          its(:rankables) { should == [2] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 3 }
+          its(:rankables) { should == [2] }
+        end
+
+        context '4th ranking' do
+          let(:ranking) { rankings[3] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:rankables) { should == [1] }
+        end
+
+      end # list of rankables is small
+
+    end # rank
+
+  end # methods
+
+end

data/spec/lib/ranker/strategies/standard_competition_spec.rb

@@ -0,0 +1,139 @@
+require 'spec_helper'
+
+describe Ranker::Strategies::StandardCompetition do
+  let(:klass) { Ranker::Strategies::StandardCompetition }
+
+  describe :methods do
+
+    describe :rank do
+      let(:rankables) { raise ArgumentError }
+      let(:strategy) { klass.new(rankables) }
+      let(:rankings) { strategy.rank }
+      subject { rankings }
+
+      context 'when list of rankables is large' do
+        let(:rankables) { [1, 1, 2, 3, 3, 4, 5, 6, 7, 7, 7, 1, 1, 3] }
+        it { should have(7).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:score) { should == 7 }
+          its(:rankables) { should == [7, 7, 7] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:score) { should == 6 }
+          its(:rankables) { should == [6] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 5 }
+          its(:score) { should == 5 }
+          its(:rankables) { should == [5] }
+        end
+
+        context '4th ranking' do
+          let(:ranking) { rankings[3] }
+          subject { ranking }
+          its(:rank) { should == 6 }
+          its(:score) { should == 4 }
+          its(:rankables) { should == [4] }
+        end
+
+        context '5th ranking' do
+          let(:ranking) { rankings[4] }
+          subject { ranking }
+          its(:rank) { should == 7 }
+          its(:score) { should == 3 }
+          its(:rankables) { should == [3, 3, 3] }
+        end
+
+        context '6th ranking' do
+          let(:ranking) { rankings[5] }
+          subject { ranking }
+          its(:rank) { should == 10 }
+          its(:score) { should == 2 }
+          its(:rankables) { should == [2] }
+        end
+
+        context '7th ranking' do
+          let(:ranking) { rankings[6] }
+          subject { ranking }
+          its(:rank) { should == 11 }
+          its(:score) { should == 1 }
+          its(:rankables) { should == [1, 1, 1, 1] }
+        end
+
+      end # list of rankables is large
+
+      context 'when list of rankables is small' do
+        let(:rankables) { [3, 2, 2, 1] }
+        it { should have(3).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [3] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 2 }
+          its(:rankables) { should == [2, 2] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:rankables) { should == [1] }
+        end
+
+      end # list of rankables is small
+
+      context 'when ranking with a non-default score lambda' do
+        let(:value_1) { {:score => 3} }
+        let(:value_2) { {:score => 2} }
+        let(:value_3) { {:score => 2} }
+        let(:value_4) { {:score => 1} }
+        let(:rankables) { [value_1, value_2, value_3, value_4] }
+        let(:strategy) { klass.new(rankables, :by => lambda { |scorable| scorable[:score] }) }
+        it { should have(3).items }
+
+        context '1st ranking' do
+          let(:ranking) { rankings[0] }
+          subject { ranking }
+          its(:rank) { should == 1 }
+          its(:rankables) { should == [value_1] }
+        end
+
+        context '2nd ranking' do
+          let(:ranking) { rankings[1] }
+          subject { ranking }
+          its(:rank) { should == 2 }
+          its(:rankables) { should == [value_2, value_3] }
+        end
+
+        context '3rd ranking' do
+          let(:ranking) { rankings[2] }
+          subject { ranking }
+          its(:rank) { should == 4 }
+          its(:rankables) { should == [value_4] }
+        end
+
+      end # when ranking with a block
+
+    end # rank
+
+  end # methods
+
+end