ranker 1.1.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ab92d39440ca181c5a9f7b0c8f0747384f6ee539
-  data.tar.gz: 39353e69dae425e89759f7f38d56c12364207c7c
+  metadata.gz: 95ba813411999220469ff0cfa6abdeb92dd80cd0
+  data.tar.gz: 7c089dfa7754a24d2f35a87dd605a8e01b0dfe11
 SHA512:
-  metadata.gz: df861f01de167e2cc07f8b956faf69b0bc5011ea53aeb12e6b5b86037a1e8ab093f27a4e6f1dd53379cfadaac9cfe7f26bd6630ab073546e6a1a874ccf2d2894
-  data.tar.gz: e3d2e2c5bcd34f4983da21422dfa13c8764529cfc57132eed8b5fac3325103ad3002813c245f12fcaf232a9ffdd4035952e85712f24ee1414f51d2db86986b36
+  metadata.gz: aaf519717eb324031eb13c5fac87b581d6b60f4135876d8f43a5d2c5dd7172e536c5a623c48f2b31f5dccd3608d29af31e4122b479ffab2ae38f71577e638ad1
+  data.tar.gz: c8fa18492eaaba497d03e57cfee32ec6d6c3f0f0ae7d1f16e140ff63fc255c72672628769cc5d93e7bd56f8fbdb114385573888f594007763b0bacd5460d7ca8

data/README.md

@@ -14,7 +14,7 @@ Installation
 With bundler, add the `ranker` gem to your `Gemfile`.
 
 ```ruby
-gem "ranker", "~> 1.0"
+gem "ranker"
 ```
 
 Require the `ranker` gem in your application.

data/lib/ranker/rankings.rb

@@ -12,6 +12,10 @@ module Ranker
 
     # Properties:
 
+    def errors
+      @errors ||= {}
+    end
+
     def mean
       @mean ||= total.to_f / num_scores
     end
@@ -34,6 +38,9 @@ module Ranker
     end
 
     def total
+      unless valid?
+        raise RankingsError.new(errors)
+      end
       @total ||= scores.reduce(:+)
     end
 
@@ -43,14 +50,54 @@ module Ranker
       }
     end
 
+    def valid?
+      validate
+      errors.empty?
+    end
+
 
     # Methods:
 
-    def create(rank, score, rankables)
+    def create_ranking(rank, score, rankables)
       scores.concat(Array.new(rankables.count, score))
-      self << Ranking.new(self, self.count, rank, score, rankables)
+      ranking = Ranking.new(self, self.count, rank, score, rankables)
+      self << ranking
+      ranking
+    end
+
+
+    protected
+
+    def validate
+      errors.clear
+      validate_scores
+    end
+
+    def validate_scores
+      if scores_have_nil_values?
+        errors['scores'] = 'contains nil values'
+      end
+    end
+
+    def scores_have_nil_values?
+      scores.any? { |score|
+        score == nil
+      }
+    end
+
+  end # Rankings class
+
+
+  class RankingsError < StandardError
+
+    def initialize(errors)
+      message = 'Rankings has errors: '
+      message << errors.map { |name, error|
+        "#{name} #{error}"
+      }.join(', ')
+      super(message)
     end
 
-  end # class
+  end # RankingError class
 
-end # module
+end # Ranker module

data/lib/ranker/strategies/strategy.rb

@@ -66,7 +66,7 @@ module Ranker::Strategies
     # Methods:
 
     def create_ranking(rank, score, rankables)
-      rankings.create(rank, score, rankables)
+      rankings.create_ranking(rank, score, rankables)
     end
 
     def execute

data/lib/ranker/version.rb

@@ -1,3 +1,3 @@
 module Ranker
-  VERSION = '1.1.1'
+  VERSION = '1.1.2'
 end

data/spec/lib/ranker/ranking_spec.rb

@@ -11,7 +11,7 @@ describe Ranker::Ranking do
       let(:rankables) { [1, 2, 3, 4, 5, 5, 1, 2] }
       before {
         rankables.each_with_index { |value, index|
-          rankings.create(index + 1, value, [value])
+          rankings.create_ranking(index + 1, value, [value])
         }
       }
 
@@ -45,7 +45,7 @@ describe Ranker::Ranking do
       let(:rankables) { [1, 2, 3, 4, 5, 5, 1, 2] }
       before {
         rankables.each_with_index { |value, index|
-          rankings.create(index + 1, value, [value])
+          rankings.create_ranking(index + 1, value, [value])
         }
       }
 

data/spec/lib/ranker/rankings_spec.rb

@@ -12,7 +12,7 @@ describe Ranker::Rankings do
       subject { rankings.mean }
       before {
         rankables.each_with_index { |value, index|
-          rankings.create(index + 1, value, [value])
+          rankings.create_ranking(index + 1, value, [value])
         }
       }
 
@@ -26,6 +26,13 @@ describe Ranker::Rankings do
         it { should be_nan }
       end
 
+      context 'when rankables contain nil values' do
+        let(:rankables) { [1, 2, 3, nil, 5, 6, 7] }
+        it 'should raise an error' do
+          lambda { rankings.mean }.should raise_error(Ranker::RankingsError)
+        end
+      end
+
     end # mean
 
     describe :standard_deviation do
@@ -33,7 +40,7 @@ describe Ranker::Rankings do
       subject { rankings.standard_deviation }
       before {
         rankables.each_with_index { |value, index|
-          rankings.create(index + 1, value, [value])
+          rankings.create_ranking(index + 1, value, [value])
         }
       }
 
@@ -52,8 +59,43 @@ describe Ranker::Rankings do
         it { should be_nan }
       end
 
+      context 'when rankables contain nil values' do
+        let(:rankables) { [1, 2, 3, nil, 5, 6, 7] }
+        it 'should raise an error' do
+          lambda { rankings.standard_deviation }.should raise_error(Ranker::RankingsError)
+        end
+      end
+
     end # standard_deviation
 
+    describe :valid? do
+      let(:rankables) { raise NotImplementedError }
+      let(:valid) { rankings.valid? }
+      subject { valid }
+      before {
+        rankables.each_with_index { |value, index|
+          rankings.create_ranking(index + 1, value, [value])
+        }
+        valid
+      }
+
+      context 'when rankables are not nil' do
+        let(:rankables) { [1, 2, 3, 4, 5, 6, 7] }
+        it { should == true }
+      end
+
+      context 'when rankables contain nil values' do
+        let(:rankables) { [1, 2, 3, nil, 5, 6, 7] }
+        it { should == false }
+
+        context 'errors' do
+          subject { rankings.errors['scores'] }
+          it { should == 'contains nil values' }
+        end
+      end
+
+    end # valid?
+
   end # properties
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ranker
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Ilya Scharrenbroich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-10 00:00:00.000000000 Z
+date: 2014-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls