activerecord-reputation-system 1.5.1 → 2.0.0

data/spec/reputation_system/base_spec.rb

@@ -48,15 +48,55 @@ describe ActiveRecord::Base do
 
       it "should delete reputations if target is deleted" do
         @question.add_evaluation(:total_votes, 5, @user)
-        reputation_count = RSReputation.count
-        message_count = RSReputationMessage.count
+        reputation_count = ReputationSystem::Reputation.count
+        message_count = ReputationSystem::ReputationMessage.count
         @question.destroy
-        RSReputation.count.should < reputation_count
-        RSReputationMessage.count.should < message_count
+        ReputationSystem::Reputation.count.should < reputation_count
+        ReputationSystem::ReputationMessage.count.should < message_count
       end
+    end
+  end
 
-      it "should have declared default value if any" do
-        @answer.reputation_for(:avg_rating).should == 1
+  context "Association" do
+    describe "#reputations" do
+      it "should define reputations association" do
+        @question.respond_to?(:reputations).should == true
+      end
+      it "should return all reputations for the target" do
+        @question.add_evaluation(:total_votes, 2, @user)
+        @question.add_evaluation(:difficulty, 2, @user)
+        @question.reputations.count.should == 2
+      end
+      describe "#for" do
+        it "should return empty array if there is no reputation for the target" do
+          @question.reputations.for(:total_votes).should == []
+        end
+        it "should return all reputations of the given type for the target" do
+          @question.add_evaluation(:total_votes, 2, @user)
+          @question.add_evaluation(:difficulty, 2, @user)
+          @question.reputations.for(:total_votes).count.should == 1
+        end
+      end
+    end
+
+    describe "#evaluations" do
+      it "should define evaluations association" do
+        @question.respond_to?(:evaluations).should == true
+      end
+      it "should return all evaluations for the target" do
+        @question.add_evaluation(:total_votes, 2, @user)
+        @question.add_evaluation(:difficulty, 2, @user)
+        @question.evaluations.count.should == 2
+      end
+      describe "#for" do
+        it "should return empty array if there is no evaluation for the target" do
+          @question.evaluations.for(:total_votes).should == []
+        end
+        it "should return all evaluations of the given type for the target" do
+          @question.add_evaluation(:total_votes, 2, @user)
+          @question.add_evaluation(:difficulty, 2, @user)
+          @question.evaluations.for(:total_votes).count.should == 1
+        end
       end
     end
   end

data/spec/reputation_system/{evaluation_spec.rb → evaluation_methods_spec.rb}

@@ -26,11 +26,33 @@ describe ActiveRecord::Base do
   end
 
   context "Primary Reputation" do
+    describe "#has_evaluation?" do
+      it "should return false if it has not already been evaluated by a given source" do
+        user = User.create! :name => 'katsuya'
+        @question.add_evaluation(:total_votes, 3, user)
+        @question.has_evaluation?(:total_votes, @user).should be_false
+      end
+      it "should return true if it has been evaluated by a given source" do
+        @question.add_evaluation(:total_votes, 3, @user)
+        @question.has_evaluation?(:total_votes, @user).should be_true
+      end
+      context "With Scopes" do
+        it "should return false if it has not already been evaluated by a given source" do
+          @phrase.add_evaluation(:difficulty_with_scope, 3, @user, :s1)
+          @phrase.has_evaluation?(:difficulty_with_scope, @user, :s2).should be_false
+        end
+        it "should return true if it has been evaluated by a given source" do
+          @phrase.add_evaluation(:difficulty_with_scope, 3, @user, :s1)
+          @phrase.has_evaluation?(:difficulty_with_scope, @user, :s1).should be_true
+        end
+      end
+    end
+
     describe "#evaluated_by" do
-      it "should return an empty array if it is not evaluaated by a given source" do
+      it "should return an empty array if it is not evaluated by a given source" do
         Question.evaluated_by(:total_votes, @user).should == []
       end
-      
+
       it "should return an array of targets evaluated by a given source" do
         user2 = User.create!(:name => 'katsuya')
         question2 = Question.create!(:text => 'Question 2', :author_id => @user.id)
@@ -61,13 +83,34 @@ describe ActiveRecord::Base do
           Phrase.evaluated_by(:difficulty_with_scope, @user, :s3).should == [phrase2]
           Phrase.evaluated_by(:difficulty_with_scope, user2, :s3).should == [@phrase]
         end
+      end
+    end
 
-        it "should raise exception if invalid scope is given" do
-          lambda { @phrase.add_evaluation(:difficulty_with_scope, 1, :invalid_scope) }.should raise_error(ArgumentError)
-        end
+    describe "#evaluators_for" do
+      it "should return an empty array if it is not evaluated for a given reputation" do
+        @question.evaluators_for(:total_votes).should == []
+      end
 
-        it "should raise exception if scope is not given" do
-          lambda { @phrase.add_evaluation(:difficulty_with_scope, 1) }.should raise_error(ArgumentError)
+      it "should return an array of sources evaluated the target" do
+        user2 = User.create!(:name => 'katsuya')
+        question2 = Question.create!(:text => 'Question 2', :author_id => @user.id)
+        @question.add_evaluation(:total_votes, 1, @user).should be_true
+        question2.add_evaluation(:total_votes, 1, @user).should be_true
+        question2.add_evaluation(:total_votes, 2, user2).should be_true
+        @question.evaluators_for(:total_votes).should == [@user]
+        question2.evaluators_for(:total_votes).should == [@user, user2]
+      end
+
+      context "With Scopes" do
+        it "should return an array of targets evaluated by a given source on appropriate scope" do
+          user2 = User.create!(:name => 'katsuya')
+          @phrase.add_evaluation(:difficulty_with_scope, 1, @user, :s1).should be_true
+          @phrase.add_evaluation(:difficulty_with_scope, 2, @user, :s2).should be_true
+          @phrase.add_evaluation(:difficulty_with_scope, 3, user2, :s2).should be_true
+          @phrase.add_evaluation(:difficulty_with_scope, 4, user2, :s3).should be_true
+          @phrase.evaluators_for(:difficulty_with_scope, :s1).should == [@user]
+          @phrase.evaluators_for(:difficulty_with_scope, :s2).should == [@user, user2]
+          @phrase.evaluators_for(:difficulty_with_scope, :s3).should == [user2]
         end
       end
     end
@@ -251,8 +294,8 @@ describe ActiveRecord::Base do
         lambda { @question.delete_evaluation(:invalid, @user) }.should raise_error(ArgumentError)
       end
 
-      it "should return nil if evaluation does not exist" do
-        @answer.delete_evaluation(:avg_rating, @user).should be_nil
+      it "should return false if evaluation does not exist" do
+        @answer.delete_evaluation(:avg_rating, @user).should be_false
       end
 
       context "With Scopes" do

data/spec/{models/rs_evaluation_spec.rb → reputation_system/models/evaluation_spec.rb}

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe RSEvaluation do
+describe ReputationSystem::Evaluation do
   before(:each) do
     @user = User.create!(:name => 'jack')
     @question = Question.create!(:text => 'What is Twitter?', :author_id => @user.id)
@@ -27,8 +27,8 @@ describe RSEvaluation do
       @attributes = {:reputation_name => 'total_votes', :source => @user, :target => @question, :value => 1}
     end
     it "should not be able to create an evaluation from given source if it has already evaluated the same reputation of the target" do
-      RSEvaluation.create!(@attributes)
-      lambda {RSEvaluation.create!(@attributes)}.should raise_error
+      ReputationSystem::Evaluation.create!(@attributes)
+      lambda {ReputationSystem::Evaluation.create!(@attributes)}.should raise_error
     end
   end
 
@@ -37,14 +37,14 @@ describe RSEvaluation do
       it "should assign source class name as source type if not STI" do
         question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
         question.add_evaluation(:total_votes, 5, @user)
-        evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(:total_votes, @user, question)
+        evaluation = ReputationSystem::Evaluation.find_by_reputation_name_and_source_and_target(:total_votes, @user, question)
         evaluation.source_type.should == @user.class.name
       end
       it "should assign source's ancestors class name where reputation is declared if STI" do
         designer = Designer.create! :name => 'hiro'
         programmer = Programmer.create! :name => 'katsuya'
         programmer.add_evaluation(:leadership, 1, designer)
-        evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(:leadership, designer, programmer)
+        evaluation = ReputationSystem::Evaluation.find_by_reputation_name_and_source_and_target(:leadership, designer, programmer)
         evaluation.source_type.should == Person.name
       end
     end
@@ -53,10 +53,10 @@ describe RSEvaluation do
   context "Association" do
     it "should delete associated reputation message" do
       @question.add_evaluation(:total_votes, 5, @user)
-      evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(:total_votes, @user, @question)
-      RSReputationMessage.find_by_sender_id_and_sender_type(evaluation.id, evaluation.class.name).should_not be_nil
+      evaluation = ReputationSystem::Evaluation.find_by_reputation_name_and_source_and_target(:total_votes, @user, @question)
+      ReputationSystem::ReputationMessage.find_by_sender_id_and_sender_type(evaluation.id, evaluation.class.name).should_not be_nil
       @question.delete_evaluation(:total_votes, @user)
-      RSReputationMessage.find_by_sender_id_and_sender_type(evaluation.id, evaluation.class.name).should be_nil
+      ReputationSystem::ReputationMessage.find_by_sender_id_and_sender_type(evaluation.id, evaluation.class.name).should be_nil
     end
   end
 end

data/spec/{models/rs_reputation_message_spec.rb → reputation_system/models/reputation_message_spec.rb}

@@ -16,21 +16,21 @@
 
 require 'spec_helper'
 
-describe RSReputationMessage do
+describe ReputationSystem::ReputationMessage do
   before(:each) do
     @user = User.create!(:name => 'jack')
-    @rep1 = RSReputation.create!(:reputation_name => "karma1", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum')
-    @rep2 = RSReputation.create!(:reputation_name => "karma2", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum')
+    @rep1 = ReputationSystem::Reputation.create!(:reputation_name => "karma1", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum')
+    @rep2 = ReputationSystem::Reputation.create!(:reputation_name => "karma2", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum')
   end
 
   context "Validation" do
     it "should not be able to create a message from given sender if it has already sent one to the same receiver" do
-      RSReputationMessage.create(:sender => @rep1, :receiver => @rep2).should be_valid
-      RSReputationMessage.create(:sender => @rep1, :receiver => @rep2).should_not be_valid
+      ReputationSystem::ReputationMessage.create(:sender => @rep1, :receiver => @rep2).should be_valid
+      ReputationSystem::ReputationMessage.create(:sender => @rep1, :receiver => @rep2).should_not be_valid
     end
 
-    it "should have raise error if sender is neither RSEvaluation and RSReputation" do
-      RSReputationMessage.create(:sender => @user, :receiver => @rep2).errors[:sender].should_not be_nil
+    it "should have raise error if sender is neither ReputationSystem::Evaluation and ReputationSystem::Reputation" do
+      ReputationSystem::ReputationMessage.create(:sender => @user, :receiver => @rep2).errors[:sender].should_not be_nil
     end
   end
 
@@ -38,10 +38,10 @@ describe RSReputationMessage do
     it "should delete associated sender if it is evaluation" do
       question = Question.create!(:text => 'What is Twitter?', :author_id => @user.id)
       question.add_evaluation(:total_votes, 5, @user)
-      evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(:total_votes, @user, question)
-      m = RSReputationMessage.find_by_sender_id_and_sender_type(evaluation.id, evaluation.class.name)
+      evaluation = ReputationSystem::Evaluation.find_by_reputation_name_and_source_and_target(:total_votes, @user, question)
+      m = ReputationSystem::ReputationMessage.find_by_sender_id_and_sender_type(evaluation.id, evaluation.class.name)
       m.destroy
       lambda { evaluation.reload }.should raise_error ActiveRecord::RecordNotFound
     end
   end
-end
+end

data/spec/reputation_system/models/reputation_spec.rb

@@ -0,0 +1,136 @@
+##
+#  Copyright 2012 Twitter, Inc
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#  http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+##
+
+require 'spec_helper'
+
+describe ReputationSystem::Reputation do
+  before(:each) do
+    @user = User.create!(:name => 'jack')
+  end
+
+  context "Validation" do
+    it "should have value 0 by default in case of non product process" do
+      r = ReputationSystem::Reputation.create!(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum')
+      r.value.should == 0
+    end
+
+    it "should be able to change value to 0 if process is not product process" do
+      r = ReputationSystem::Reputation.create!(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum', :value => 10)
+      r.value = 0
+      r.save!
+      r.reload
+      r.value.should == 0
+    end
+
+    it "should have value 1 by default in case of product process" do
+      r = ReputationSystem::Reputation.create!(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'product')
+      r.value.should == 1
+    end
+
+    it "should be able to create reputation with process 'sum', 'average' and 'product'" do
+      ReputationSystem::Reputation.create(:reputation_name => "karma1", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').should be_valid
+      ReputationSystem::Reputation.create(:reputation_name => "karma2", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'average').should be_valid
+      ReputationSystem::Reputation.create(:reputation_name => "karma3", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'product').should be_valid
+    end
+
+    it "should not be able to create reputation with process other than 'sum', 'average' and 'product'" do
+      ReputationSystem::Reputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'invalid').should_not be_valid
+    end
+
+    it "should not be able to create reputation of the same name for the same target" do
+      ReputationSystem::Reputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').should be_valid
+      ReputationSystem::Reputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').should_not be_valid
+    end
+  end
+
+  context "Callback" do
+    describe "#set_target_type_for_sti" do
+      it "should assign target class name as target type if not STI" do
+        question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        question.add_evaluation(:total_votes, 5, @user)
+        rep = ReputationSystem::Reputation.find_by_reputation_name_and_target(:total_votes, question)
+        rep.target_type.should == question.class.name
+      end
+      it "should assign target's ancestors class name where reputation is declared if STI" do
+        designer = Designer.create! :name => 'hiro'
+        programmer = Programmer.create! :name => 'katsuya'
+        programmer.add_evaluation(:leadership, 1, designer)
+        rep = ReputationSystem::Reputation.find_by_reputation_name_and_target(:leadership, programmer)
+        rep.target_type.should == Person.name
+      end
+    end
+  end
+
+  context "Association" do
+    before :each do
+      @question = Question.create!(:text => 'What is Twitter?', :author_id => @user.id)
+      @question.add_evaluation(:total_votes, 5, @user)
+    end
+
+    it "should delete associated received messages" do
+      rep = ReputationSystem::Reputation.find_by_target_id_and_target_type(@question.id, 'Question')
+      ReputationSystem::ReputationMessage.find_by_receiver_id(rep.id).should_not be_nil
+      rep.destroy
+      ReputationSystem::ReputationMessage.find_by_receiver_id(rep.id).should be_nil
+    end
+
+    it "should delete associated sent messages" do
+      rep = ReputationSystem::Reputation.find_by_target_id_and_target_type(@user.id, 'User')
+      ReputationSystem::ReputationMessage.find_by_sender_id_and_sender_type(rep.id, rep.class.name).should_not be_nil
+      rep.destroy
+      ReputationSystem::ReputationMessage.find_by_sender_id_and_sender_type(rep.id, rep.class.name).should be_nil
+    end
+  end
+
+  describe "#normalized_value" do
+    before :each do
+      @user2 = User.create!(:name => 'dick')
+      @user3 = User.create!(:name => 'foo')
+      question = Question.new(:text => "Does this work?", :author_id => @user.id)
+      @r1 = ReputationSystem::Reputation.create!(:reputation_name => "karma", :value => 2, :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum')
+      @r2 = ReputationSystem::Reputation.create!(:reputation_name => "karma", :value => 6, :target_id => @user2.id, :target_type => @user2.class.to_s, :aggregated_by => 'sum')
+      @r3 = ReputationSystem::Reputation.create!(:reputation_name => "karma", :value => 10, :target_id => @user3.id, :target_type => @user3.class.to_s, :aggregated_by => 'sum')
+      @r4 = ReputationSystem::Reputation.create!(:reputation_name => "karma", :value => 10, :target_id => question.id, :target_type => question.class.to_s, :aggregated_by => 'sum')
+    end
+
+    it "should return correct normalized value" do
+      @r1.normalized_value.should be_within(DELTA).of(0)
+      @r2.normalized_value.should be_within(DELTA).of(0.5)
+      @r3.normalized_value.should be_within(DELTA).of(1)
+    end
+
+    it "should return 0 if max and min are the same" do
+      @r4.normalized_value.should be_within(DELTA).of(0)
+    end
+  end
+
+  describe "value propagation with average process" do
+    it "should calculate average reputation even after evaluation is deleted" do
+      user1 = User.create! :name => 'dick'
+      user2 = User.create! :name => 'katsuya'
+      answer = Answer.create!
+      answer.add_evaluation(:avg_rating, 3, user1)
+      answer.add_evaluation(:avg_rating, 2, user2)
+      answer.reputation_for(:avg_rating).should be_within(DELTA).of(2.5)
+      answer.delete_evaluation(:avg_rating, user1)
+      answer.reputation_for(:avg_rating).should be_within(DELTA).of(2)
+      answer.delete_evaluation(:avg_rating, user2)
+      answer.reputation_for(:avg_rating).should be_within(DELTA).of(0)
+      answer.add_evaluation(:avg_rating, 3, user1)
+      answer.reputation_for(:avg_rating).should be_within(DELTA).of(3)
+    end
+  end
+end

data/spec/reputation_system/{reputation_spec.rb → reputation_methods_spec.rb}

@@ -153,9 +153,9 @@ describe ActiveRecord::Base do
         @question2.add_evaluation(:total_votes, 70, @user)
         @question.add_evaluation(:total_votes, 100, @user)
         @question.deactivate_all_reputations
-        RSReputation.maximum(:value, :conditions => {:reputation_name => 'total_votes', :active => true}).should == 70
+        ReputationSystem::Reputation.maximum(:value, :conditions => {:reputation_name => 'total_votes', :active => true}).should == 70
         @question.activate_all_reputations
-        RSReputation.maximum(:value, :conditions => {:reputation_name => 'total_votes', :active => true}).should == 100
+        ReputationSystem::Reputation.maximum(:value, :conditions => {:reputation_name => 'total_votes', :active => true}).should == 100
       end
     end
   end

data/spec/spec_helper.rb

@@ -135,7 +135,6 @@ class Question < ActiveRecord::Base
 
   has_reputation :total_votes,
     :source => :user,
-    :aggregated_by => :sum,
     :source_of => { :reputation => :question_karma, :of => :author }
 
   has_reputation :difficulty,
@@ -156,8 +155,7 @@ class Answer < ActiveRecord::Base
 
   has_reputation :avg_rating,
     :source => :user,
-    :aggregated_by => :average,
-    :init_value => 1
+    :aggregated_by => :average
 end
 
 class Phrase < ActiveRecord::Base
@@ -192,7 +190,7 @@ class Translation < ActiveRecord::Base
   has_reputation :votes,
     :source => :user,
     :aggregated_by => :sum,
-    :source_of => { :reputation => :maturity, :of => :phrase, :scope => :locale} 
+    :source_of => { :reputation => :maturity, :of => :phrase, :scope => :locale}
 end
 
 class Person < ActiveRecord::Base

metadata

@@ -2,7 +2,7 @@
 name: activerecord-reputation-system
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.5.1
+  version: 2.0.0
 platform: ruby
 authors: 
 - Katsuya Noguchi
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-10-04 00:00:00 Z
+date: 2012-10-05 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activerecord
@@ -91,6 +91,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- lib/activerecord-reputation-system.rb
 - lib/generators/reputation_system/reputation_system_generator.rb
 - lib/generators/reputation_system/templates/add_evaluations_index.rb
 - lib/generators/reputation_system/templates/add_reputation_messages_index.rb
@@ -99,28 +100,28 @@ files:
 - lib/generators/reputation_system/templates/change_reputation_messages_index_to_unique.rb
 - lib/generators/reputation_system/templates/change_reputations_index_to_unique.rb
 - lib/generators/reputation_system/templates/create_reputation_system.rb
-- lib/models/rs_evaluation.rb
-- lib/models/rs_reputation.rb
-- lib/models/rs_reputation_message.rb
 - lib/reputation_system/base.rb
-- lib/reputation_system/evaluation.rb
+- lib/reputation_system/evaluation_methods.rb
 - lib/reputation_system/finder_methods.rb
+- lib/reputation_system/models/evaluation.rb
+- lib/reputation_system/models/reputation.rb
+- lib/reputation_system/models/reputation_message.rb
 - lib/reputation_system/network.rb
 - lib/reputation_system/query_builder.rb
 - lib/reputation_system/query_methods.rb
-- lib/reputation_system/reputation.rb
-- lib/reputation_system/scope.rb
+- lib/reputation_system/reputation_methods.rb
+- lib/reputation_system/scope_methods.rb
 - lib/reputation_system/version.rb
 - lib/reputation_system.rb
-- spec/models/rs_evaluation_spec.rb
-- spec/models/rs_reputation_message_spec.rb
-- spec/models/rs_reputation_spec.rb
 - spec/reputation_system/base_spec.rb
-- spec/reputation_system/evaluation_spec.rb
+- spec/reputation_system/evaluation_methods_spec.rb
 - spec/reputation_system/finder_methods_spec.rb
+- spec/reputation_system/models/evaluation_spec.rb
+- spec/reputation_system/models/reputation_message_spec.rb
+- spec/reputation_system/models/reputation_spec.rb
 - spec/reputation_system/query_methods_spec.rb
-- spec/reputation_system/reputation_spec.rb
-- spec/reputation_system/scope_spec.rb
+- spec/reputation_system/reputation_methods_spec.rb
+- spec/reputation_system/scope_methods_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/twitter/activerecord-reputation-system
 licenses: []