activerecord-reputation-system 1.0.0 → 1.1.0

data/README.md

@@ -10,7 +10,19 @@ In this gem, the reputation system is described as a network of reputations wher
 
 ## Installation
 
-`gem install reputation_system && rails generator reputation_system && rake db:migrate`
+Add to Gemfile:
+
+```ruby
+gem 'activerecord-reputation-system', :require => 'reputation_system'
+```
+
+Run:
+
+```ruby
+bundle install
+rails generator reputation_system
+rake db:migrate
+```
 
 ## Usage Example
 
@@ -24,7 +36,7 @@ class User < ActiveRecord::Base
       :source => [
           { :reputation => :questioning_skill, :weight => 0.8 },
           { :reputation => :answering_skill }],
-      aggregated_by => :sum
+      :aggregated_by => :sum
 
   has_reputation :questioning_skill,
       :source => { :reputation => :votes, :of => :questions },
@@ -115,6 +127,12 @@ delete_evaluation(reputation_name, source)
 
 # Deletes an evaluation from the reputation with the specified name submitted by specified source. Raises an exception if it does not exist.
 delete_evaluation!(reputation_name, source)
+
+# Increase an evaluation value of the reputation with the specified name by given value.
+increase_evaluation(reputation_name, value, source)
+
+# Decrease an evaluation value of the reputation with the specified name by given value.
+decrease_evaluation(reputation_name, value, source)
 ```
 
 ## Reputation
@@ -173,7 +191,7 @@ has_reputation :name,
 ```
 Once scopes are defined, evaluations can be added in the context of defined scopes:
 ```ruby
-add_evaluation(:reputation_name, :scope)
+add_evaluation(:reputation_name, evaluation_value, source, :scope)
 ```
 Also, reputations can be accessed in the context of scopes:
 ```ruby

data/lib/models/rs_evaluation.rb

@@ -36,12 +36,11 @@ class RSEvaluation < ActiveRecord::Base
   end
 
   def self.create_evaluation(reputation_name, value, source, target)
-    reputation_name = reputation_name.to_sym
     RSEvaluation.create!(:reputation_name => reputation_name.to_s, :value => value,
                          :source_id => source.id, :source_type => source.class.name,
                          :target_id => target.id, :target_type => target.class.name)
   end
-   
+
   protected
 
     def source_must_be_defined_for_reputation_in_network

data/lib/models/rs_reputation.rb

@@ -26,7 +26,6 @@ class RSReputation < ActiveRecord::Base
   attr_accessible :reputation_name, :value, :aggregated_by, :active, :target, :target_id, :target_type, :received_messages
 
   before_save :change_zero_value_in_case_of_product_process
-  before_create
 
   VALID_PROCESSES = ['sum', 'average', 'product']
   validates_inclusion_of :aggregated_by, :in => VALID_PROCESSES, :message => "Value chosen for aggregated_by is not valid process"
@@ -52,7 +51,7 @@ class RSReputation < ActiveRecord::Base
   end
 
   def self.update_reputation_value_with_new_source(rep, source, weight, process)
-    weight = 1 unless weight # weight is 1 by default.
+    weight ||= 1 # weight is 1 by default.
     size = rep.received_messages.size
     valueBeforeUpdate = size > 0 ? rep.value : nil
     newValue = source.value
@@ -72,15 +71,15 @@ class RSReputation < ActiveRecord::Base
   end
 
   def self.update_reputation_value_with_updated_source(rep, source, oldValue, weight, process)
-    weight = 1 unless weight # weight is 1 by default.\
+    weight ||= 1 # weight is 1 by default.
     size = rep.received_messages.size
     valueBeforeUpdate = size > 0 ? rep.value : nil
     newValue = source.value
     case process.to_sym
     when :sum
-      rep.value = rep.value + (newValue - oldValue) * weight
+      rep.value += (newValue - oldValue) * weight
     when :average
-      rep.value = rep.value + ((newValue - oldValue) * weight) / size
+      rep.value += ((newValue - oldValue) * weight) / size
     when :product
       rep.value = (rep.value * newValue) / oldValue
     else

data/lib/reputation_system/evaluation.rb

@@ -45,7 +45,8 @@ module ReputationSystem
 
     def add_or_update_evaluation(reputation_name, value, source, *args)
       scope = args.first
-      evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(reputation_name, source, self)
+      srn = ReputationSystem::Network.get_scoped_reputation_name(self.class.name, reputation_name, scope)
+      evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(srn, source, self)
       if evaluation.nil?
         self.add_evaluation(reputation_name, value, source, scope)
       else
@@ -84,5 +85,26 @@ module ReputationSystem
         evaluation.destroy
       end
     end
+
+    def increase_evaluation(reputation_name, value, source, *args)
+      change_evaluation_value_by(reputation_name, value, source, *args)
+    end
+
+    def decrease_evaluation(reputation_name, value, source, *args)
+      change_evaluation_value_by(reputation_name, -value, source, *args)
+    end
+
+    protected
+      def change_evaluation_value_by(reputation_name, value, source, *args)
+        scope = args.first
+        srn = ReputationSystem::Network.get_scoped_reputation_name(self.class.name, reputation_name, scope)
+        evaluation = RSEvaluation.find_by_reputation_name_and_source_and_target(srn, source, self)
+        if evaluation.nil?
+          self.add_evaluation(reputation_name, value, source, scope)
+        else
+          new_value = evaluation.value + value
+          self.update_evaluation(reputation_name, new_value, source, scope)
+        end
+      end
   end
 end

data/lib/reputation_system/version.rb

@@ -15,5 +15,5 @@
 ##
 
 module ReputationSystem
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/spec/reputation_system/evaluation_spec.rb

@@ -65,6 +65,39 @@ describe ActiveRecord::Base do
       end
     end
 
+    describe "#add_or_update_evaluation" do
+      it "should create evaluation if it does not exist" do
+        @question.add_or_update_evaluation(:total_votes, 1, @user)
+        @question.reputation_value_for(:total_votes).should == 1
+      end
+
+      it "should update evaluation if it exists already" do
+        @question.add_evaluation(:total_votes, 1, @user)
+        @question.add_or_update_evaluation(:total_votes, 2, @user)
+        @question.reputation_value_for(:total_votes).should == 2
+      end
+
+      context "With Scopes" do
+        it "should add evaluation on appropriate scope if it does not exist" do
+          @phrase.add_or_update_evaluation(:difficulty_with_scope, 1, @user, :s1)
+          @phrase.add_or_update_evaluation(:difficulty_with_scope, 2, @user, :s2)
+          @phrase.reputation_value_for(:difficulty_with_scope, :s1).should == 1
+          @phrase.reputation_value_for(:difficulty_with_scope, :s2).should == 2
+          @phrase.reputation_value_for(:difficulty_with_scope, :s3).should == 0
+        end
+
+        it "should update evaluation on appropriate scope if it exists already" do
+          @phrase.add_evaluation(:difficulty_with_scope, 1, @user, :s1)
+          @phrase.add_evaluation(:difficulty_with_scope, 2, @user, :s2)
+          @phrase.add_or_update_evaluation(:difficulty_with_scope, 3, @user, :s1)
+          @phrase.add_or_update_evaluation(:difficulty_with_scope, 5, @user, :s2)
+          @phrase.reputation_value_for(:difficulty_with_scope, :s1).should == 3
+          @phrase.reputation_value_for(:difficulty_with_scope, :s2).should == 5
+          @phrase.reputation_value_for(:difficulty_with_scope, :s3).should == 0
+        end
+      end
+    end
+
     describe "#update_evaluation" do
       before :each do
         @question.add_evaluation(:total_votes, 1, @user)
@@ -192,6 +225,58 @@ describe ActiveRecord::Base do
         end
       end
     end
+
+    describe "#increase_evaluation" do
+      it "should add evaluation if it does not exist" do
+        @question.increase_evaluation(:total_votes, 2, @user)
+        @question.reputation_value_for(:total_votes).should == 2
+      end
+
+      it "should increase evaluation if it exists already" do
+        @question.add_evaluation(:total_votes, 1, @user)
+        @question.increase_evaluation(:total_votes, 2, @user)
+        @question.reputation_value_for(:total_votes).should == 3
+      end
+
+      context "With Scopes" do
+        before :each do
+          @phrase.add_evaluation(:difficulty_with_scope, 2, @user, :s2)
+        end
+
+        it "should increase evaluation on appropriate scope" do
+          @phrase.increase_evaluation(:difficulty_with_scope, 5, @user, :s2)
+          @phrase.reputation_value_for(:difficulty_with_scope, :s1).should == 0
+          @phrase.reputation_value_for(:difficulty_with_scope, :s2).should == 7
+          @phrase.reputation_value_for(:difficulty_with_scope, :s3).should == 0
+        end
+      end
+    end
+
+    describe "#decrease_evaluation" do
+      it "should add evaluation if it does not exist" do
+        @question.decrease_evaluation(:total_votes, 2, @user)
+        @question.reputation_value_for(:total_votes).should == -2
+      end
+
+      it "should increase evaluation if it exists already" do
+        @question.add_evaluation(:total_votes, 1, @user)
+        @question.decrease_evaluation(:total_votes, 2, @user)
+        @question.reputation_value_for(:total_votes).should == -1
+      end
+
+      context "With Scopes" do
+        before :each do
+          @phrase.add_evaluation(:difficulty_with_scope, 2, @user, :s2)
+        end
+
+        it "should increase evaluation on appropriate scope" do
+          @phrase.decrease_evaluation(:difficulty_with_scope, 5, @user, :s2)
+          @phrase.reputation_value_for(:difficulty_with_scope, :s1).should == 0
+          @phrase.reputation_value_for(:difficulty_with_scope, :s2).should == -3
+          @phrase.reputation_value_for(:difficulty_with_scope, :s3).should == 0
+        end
+      end
+    end
   end
 
   context "Non-Primary Reputation with Gathering Aggregation" do
@@ -286,4 +371,4 @@ describe ActiveRecord::Base do
       end
     end
   end
-end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Katsuya Noguchi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-17 00:00:00 -07:00
+date: 2012-05-22 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency