activerecord-reputation-system 1.1.0 → 1.2.0

data/README.md

@@ -20,10 +20,12 @@ Run:
 
 ```ruby
 bundle install
-rails generator reputation_system
+rails generate reputation_system
 rake db:migrate
 ```
 
+* Please do the installation on every upgrade as it may include new migration files.
+
 ## Usage Example
 
 Let's say we want to keep track of user karma in Q&A site where user karma is sum of questioning skill and answering skill. Questioning skill is sum of votes for user's questions and Answering skill is sum of average rating of user's answers. This can be defined as follow:

data/lib/generators/reputation_system/reputation_system_generator.rb

@@ -30,6 +30,17 @@ class ReputationSystemGenerator < Rails::Generators::Base
   end
 
   def create_migration_files
-    migration_template 'create_reputation_system.rb', 'db/migrate/create_reputation_system.rb'
+    create_migration_file_if_not_exist 'create_reputation_system'
+    create_migration_file_if_not_exist 'add_reputations_index'
+    create_migration_file_if_not_exist 'add_evaluations_index'
+    create_migration_file_if_not_exist 'add_reputation_messages_index'
   end
-end
+
+  private
+
+    def create_migration_file_if_not_exist(file_name)
+      unless self.class.migration_exists?(File.dirname(File.expand_path("db/migrate/#{file_name}")), file_name)
+        migration_template "#{file_name}.rb", "db/migrate/#{file_name}.rb"
+      end
+    end
+end

data/lib/generators/reputation_system/templates/add_evaluations_index.rb

@@ -0,0 +1,25 @@
+##
+#  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.
+##
+
+class AddEvaluationsIndex < ActiveRecord::Migration
+  def self.up
+    add_index :rs_evaluations, [:reputation_name, :source_id, :source_type, :target_id, :target_type], :name => "index_rs_evaluations_on_reputation_name_and_source_and_target"
+  end
+
+  def self.down
+    remove_index :rs_evaluations, :column => [:reputation_name, :source_id, :source_type, :target_id, :target_type]
+  end
+end

data/lib/generators/reputation_system/templates/add_reputation_messages_index.rb

@@ -0,0 +1,25 @@
+##
+#  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.
+##
+
+class AddReputationMessagesIndex < ActiveRecord::Migration
+  def self.up
+    add_index :rs_reputation_messages, [:receiver_id, :sender_id, :sender_type], :name => "index_rs_reputation_messages_on_receiver_id_and_sender"
+  end
+
+  def self.down
+    remove_index :rs_reputation_messages, :column => [:receiver_id, :sender_id, :sender_type]
+  end
+end

data/lib/generators/reputation_system/templates/add_reputations_index.rb

@@ -0,0 +1,25 @@
+##
+#  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.
+##
+
+class AddReputationsIndex < ActiveRecord::Migration
+  def self.up
+    add_index :rs_reputations, [:reputation_name, :target_id, :target_type], :name => "index_rs_reputations_on_reputation_name_and_target"
+  end
+
+  def self.down
+    remove_index :rs_reputations, :column => [:reputation_name, :target_id, :target_type]
+  end
+end

data/lib/reputation_system/network.rb

@@ -23,20 +23,18 @@ module ReputationSystem
       end
 
       def get_reputation_defs(class_name)
-        network[class_name.to_sym] = {} unless network[class_name.to_sym]
-        network[class_name.to_sym]
+        network[class_name.to_sym] ||= {}
       end
 
       def get_reputation_def(class_name, reputation_name)
         reputation_defs = get_reputation_defs(class_name)
-        reputation_defs[reputation_name.to_sym] = {} unless reputation_defs[reputation_name.to_sym]
-        reputation_defs[reputation_name.to_sym]
+        reputation_defs[reputation_name.to_sym] ||= {}
       end
 
       def add_reputation_def(class_name, reputation_name, options)
         reputation_defs = get_reputation_defs(class_name)
         options[:source] = convert_to_array_if_hash(options[:source])
-        options[:source_of] = [] unless options[:source_of]
+        options[:source_of] ||= []
         options[:source_of] = convert_to_array_if_hash(options[:source_of])
         assign_self_as_default_value_for_of_attr(options[:source])
         assign_self_as_default_value_for_of_attr(options[:source_of])
@@ -67,7 +65,7 @@ module ReputationSystem
       def add_scope_for(class_name, reputation_name, scope)
         options = get_reputation_def(class_name, reputation_name)
         if has_scope?(class_name, reputation_name, scope)
-          raise ArgumentError, "#{scope.to_s} is already defined for #{reputation_name.to_s}"
+          raise ArgumentError, "#{scope} is already defined for #{reputation_name}"
         else
           options[:scopes].push scope.to_sym if options[:scopes]
           create_scoped_reputation_def(class_name, reputation_name, scope, options)
@@ -87,7 +85,7 @@ module ReputationSystem
         scope = scope.to_sym if scope
         validate_scope_necessity(class_name, reputation_name, scope)
         validate_scope_existence(class_name, reputation_name, scope)
-        "#{reputation_name.to_s}#{"_#{scope.to_s}" if scope}"
+        "#{reputation_name}#{"_#{scope}" if scope}"
       end
 
       def get_weight_of_source_from_reputation_name_of_target(target, source_name, reputation_name)
@@ -106,17 +104,15 @@ module ReputationSystem
       protected
 
         def network
-          @network = {} unless @network
-          @network
+          @network ||= {}
         end
 
         def data_for_derive_later
-          @data_for_derive_later = {} unless @data_for_derive_later
-          @data_for_derive_later
+          @data_for_derive_later ||= {}
         end
 
         def create_scoped_reputation_def(class_name, reputation_name, scope, options)
-          raise ArgumentError, "#{reputation_name.to_s} does not have scope." unless has_scopes?(class_name, reputation_name)
+          raise ArgumentError, "#{reputation_name} does not have scope." unless has_scopes?(class_name, reputation_name)
           scope_options = {}
           reputation_def = get_reputation_def(class_name, reputation_name)
           if is_primary_reputation?(class_name, reputation_name)
@@ -198,12 +194,11 @@ module ReputationSystem
         end
 
         def convert_to_array_if_hash(tar)
-          tar = [tar] if tar.is_a? Hash
-          tar
+          tar.is_a?(Hash) ? [tar] : tar
         end
 
         def assign_self_as_default_value_for_of_attr(tar)
-          tar = tar.each { |s| s[:of] = :self unless s[:of] } if tar.is_a? Array
+          tar.each { |s| s[:of] = :self unless s[:of] } if tar.is_a? Array
         end
 
         def validate_scope_necessity(class_name, reputation_name, scope)

data/lib/reputation_system/version.rb

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

data/spec/models/rs_evaluation_spec.rb

@@ -26,7 +26,7 @@ describe RSEvaluation do
     before :each 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 alredy evaluated the same reputation of the target" do
+    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
     end

data/spec/models/rs_reputation_message_spec.rb

@@ -24,14 +24,14 @@ describe RSReputationMessage do
   end
 
   context "Validation" do
-    it "should not be able to create a message from given sender if it has alredy sent one to the same receiver" do
-      RSReputationMessage.create(:sender => @rep1, :receiver => @rep2).valid?.should == true
-      RSReputationMessage.create(:sender => @rep1, :receiver => @rep2).valid?.should == false
+    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
     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
-    end 
+    end
   end
 
   context "Association" do

data/spec/models/rs_reputation_spec.rb

@@ -41,18 +41,18 @@ describe RSReputation do
     end
 
     it "should be able to create reputation with process 'sum', 'average' and 'product'" do
-      RSReputation.create(:reputation_name => "karma1", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').valid?.should == true
-      RSReputation.create(:reputation_name => "karma2", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'average').valid?.should == true
-      RSReputation.create(:reputation_name => "karma3", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'product').valid?.should == true
+      RSReputation.create(:reputation_name => "karma1", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').should be_valid
+      RSReputation.create(:reputation_name => "karma2", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'average').should be_valid
+      RSReputation.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
-      RSReputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'invalid').valid?.should == false
+      RSReputation.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
-      RSReputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').valid?.should == true
-      RSReputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').valid?.should == false
+      RSReputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').should be_valid
+      RSReputation.create(:reputation_name => "karma", :target_id => @user.id, :target_type => @user.class.to_s, :aggregated_by => 'sum').should_not be_valid
     end
   end
 

data/spec/reputation_system/base_spec.rb

@@ -48,11 +48,11 @@ describe ActiveRecord::Base do
 
       it "should delete reputations if target is deleted" do
         @question.add_evaluation(:total_votes, 5, @user)
-        count = RSReputation.count
-        count = RSReputationMessage.count
+        reputation_count = RSReputation.count
+        message_count = RSReputationMessage.count
         @question.destroy
-        RSReputation.count.should < count
-        RSReputationMessage.count.should < count
+        RSReputation.count.should < reputation_count
+        RSReputationMessage.count.should < message_count
       end
 
       it "should have declared default value if any" do

data/spec/reputation_system/evaluation_spec.rb

@@ -60,7 +60,7 @@ describe ActiveRecord::Base do
         end
 
         it "should raise exception if scope is not given" do
-          lambda{@phrase.add_evaluation(:difficulty_with_scope, 1, :invalid_scope)}.should raise_error(ArgumentError)
+          lambda{@phrase.add_evaluation(:difficulty_with_scope, 1)}.should raise_error(ArgumentError)
         end
       end
     end
@@ -295,7 +295,7 @@ describe ActiveRecord::Base do
         end
       end
 
-      describe "#update_eavluation" do
+      describe "#update_evaluation" do
         before :each do
           @trans_ja.add_evaluation(:votes, 1, @user)
         end
@@ -307,7 +307,7 @@ describe ActiveRecord::Base do
         end
       end
 
-      describe "#delete_eavluation" do
+      describe "#delete_evaluation" do
         before :each do
           @trans_ja.add_evaluation(:votes, 1, @user)
         end
@@ -343,7 +343,7 @@ describe ActiveRecord::Base do
         end
       end
 
-      describe "#update_eavluation" do
+      describe "#update_evaluation" do
         before :each do
           @trans_ja.add_evaluation(:votes, 1, @user)
           @trans_de.add_evaluation(:votes, 3, @user)
@@ -356,7 +356,7 @@ describe ActiveRecord::Base do
         end
       end
 
-      describe "#delete_eavluation" do
+      describe "#delete_evaluation" do
         before :each do
           @trans_ja.add_evaluation(:votes, 1, @user)
           @trans_de.add_evaluation(:votes, 3, @user)

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
+  - 2
   - 0
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Katsuya Noguchi
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-05-22 00:00:00 -07:00
+date: 2012-06-12 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -110,6 +110,9 @@ files:
 - README.md
 - Rakefile
 - 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
+- lib/generators/reputation_system/templates/add_reputations_index.rb
 - lib/generators/reputation_system/templates/create_reputation_system.rb
 - lib/models/rs_evaluation.rb
 - lib/models/rs_reputation.rb