activerecord-reputation-system 1.0.0

data/spec/reputation_system/network_spec.rb

@@ -0,0 +1,27 @@
+##
+#  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 ActiveRecord::Base do
+
+  before(:each) do
+    @user = User.create!(:name => 'jack')
+    @question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+    @answer = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => @question.id)
+    @phrase = Phrase.create!(:text => "One")
+  end
+end

data/spec/reputation_system/normalization_spec.rb

@@ -0,0 +1,68 @@
+##
+#  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 ActiveRecord::Base do
+
+  before(:each) do
+    @user = User.create!(:name => 'jack')
+    @question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+    @answer = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => @question.id)
+    @phrase = Phrase.create!(:text => "One")
+  end
+
+  describe "#normalized_reputation_value_for" do
+    it "should return 0 as if there is no data" do
+      @question.normalized_reputation_value_for(:total_votes).should == 0
+    end
+
+    it "should return appropriate value in case of valid input" do
+      question2 = Question.create!(:text => 'Does this work too?', :author_id => @user.id)
+      question3 = Question.create!(:text => 'Does this work too?', :author_id => @user.id)
+      @question.add_evaluation(:total_votes, 1, @user)
+      question2.add_evaluation(:total_votes, 2, @user)
+      question3.add_evaluation(:total_votes, 3, @user)
+      @question.normalized_reputation_value_for(:total_votes).should == 0
+      question2.normalized_reputation_value_for(:total_votes).should == 0.5
+      question3.normalized_reputation_value_for(:total_votes).should == 1
+    end
+
+    it "should raise exception if invalid reputation name is given" do
+      lambda {@question.normalized_reputation_value_for(:invalid)}.should raise_error(ArgumentError)
+    end
+
+    it "should raise exception if scope is given for reputation with no scopes" do
+      lambda {@question.normalized_reputation_value_for(:difficulty, :s1)}.should raise_error(ArgumentError)
+    end
+
+    it "should raise exception if scope is not given for reputation with scopes" do
+      lambda {@phrase.normalized_reputation_value_for(:difficulty_with_scope)}.should raise_error(ArgumentError)
+    end
+  end
+
+  describe "#exclude_all_reputations_for_normalization" do
+    it "should activate all reputation" do
+      @question2 = Question.create!(:text => 'Does this work??', :author_id => @user.id)
+      @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
+      @question.activate_all_reputations
+      RSReputation.maximum(:value, :conditions => {:reputation_name => 'total_votes', :active => true}).should == 100
+    end
+  end
+end

data/spec/reputation_system/query_spec.rb

@@ -0,0 +1,183 @@
+##
+#  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 ActiveRecord::Base do
+
+  before(:each) do
+    @user = User.create!(:name => 'jack')
+    @question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+    @answer = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => @question.id)
+    @phrase = Phrase.create!(:text => "One")
+  end
+
+  describe "#find_with_reputation" do
+    context "Without Scopes" do
+      before :each do
+        @question.add_evaluation(:total_votes, 3, @user)
+      end
+
+      it "should return result with given reputation" do
+        res = Question.find_with_reputation(:total_votes, :all, {})
+        res.should == [@question]
+        res[0].total_votes.should_not be_nil
+      end
+
+      it "should retain select option" do
+        res = Question.find_with_reputation(:total_votes, :all, {:select => "questions.id"})
+        res.should == [@question]
+        res[0].id.should_not be_nil
+        lambda {res[0].text}.should raise_error
+      end
+
+      it "should retain conditions option" do
+        @question2 = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        @question2.add_evaluation(:total_votes, 5, @user)
+        res = Question.find_with_reputation(:total_votes, :all, {:conditions => "total_votes > 4"})
+        res.should == [@question2]
+      end
+
+      it "should retain joins option" do
+        res = Question.find_with_reputation(:total_votes, :all, {
+          :select => "questions.*, users.name AS user_name",
+          :joins => "JOIN users ON questions.author_id = users.id"})
+        res.should == [@question]
+        res[0].user_name.should == @user.name
+      end
+    end
+
+    context "With Scopes" do
+      before :each do
+        @trans_ja = Translation.create!(:text => "Ichi", :user => @user, :locale => "ja", :phrase => @phrase)
+        @trans_ja.add_evaluation(:votes, 3, @user)
+        @trans_fr = Translation.create!(:text => "Ichi", :user => @user, :locale => "fr", :phrase => @phrase)
+        @trans_fr.add_evaluation(:votes, 6, @user)
+      end
+
+      it "should return result with given reputation" do
+        res = Phrase.find_with_reputation(:maturity, :ja, :all, {})
+        res.should == [@phrase]
+        res[0].maturity.should == 3
+      end
+    end
+  end
+
+  describe "#count_with_reputation" do
+    context "Without Scopes" do
+      before :each do
+        @question.add_evaluation(:total_votes, 3, @user)
+      end
+
+      it "should return result with given reputation" do
+        Question.count_with_reputation(:total_votes, :all, {
+          :conditions => "total_votes < 2"
+        }).should == 0
+        Question.count_with_reputation(:total_votes, :all, {
+          :conditions => "total_votes > 2"
+        }).should == 1
+      end
+    end
+
+    context "With Scopes" do
+      before :each do
+        @trans_ja = Translation.create!(:text => "Ichi", :user => @user, :locale => "ja", :phrase => @phrase)
+        @trans_ja.add_evaluation(:votes, 3, @user)
+        @trans_fr = Translation.create!(:text => "Ichi", :user => @user, :locale => "fr", :phrase => @phrase)
+        @trans_fr.add_evaluation(:votes, 6, @user)
+      end
+
+      it "should return result with given reputation" do
+        Phrase.count_with_reputation(:maturity, :ja, :all, {
+          :conditions => "maturity < 2"
+        }).should == 0
+        Phrase.count_with_reputation(:maturity, :ja, :all, {
+          :conditions => "maturity > 2"
+        }).should == 1
+      end
+    end
+  end
+
+  describe "#find_with_normalized_reputation" do
+    context "Without Scopes" do
+      before :each do
+        @question.add_evaluation(:total_votes, 3, @user)
+      end
+
+      it "should return result with given normalized reputation" do
+        @question2 = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        @question2.add_evaluation(:total_votes, 6, @user)
+        res = Question.find_with_normalized_reputation(:total_votes, :all, {})
+        res.should == [@question, @question2]
+        res[0].normalized_total_votes.should be_within(DELTA).of(0)
+        res[1].normalized_total_votes.should be_within(DELTA).of(1)
+      end
+
+      it "should retain select option" do
+        res = Question.find_with_normalized_reputation(:total_votes, :all, {:select => "questions.id"})
+        res.should == [@question]
+        res[0].id.should_not be_nil
+        lambda {res[0].text}.should raise_error
+      end
+
+      it "should retain conditions option" do
+        @question2 = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        @question2.add_evaluation(:total_votes, 6, @user)
+        res = Question.find_with_normalized_reputation(:total_votes, :all, {:conditions => "normalized_total_votes > 0.6"})
+        res.should == [@question2]
+      end
+
+      it "should retain joins option" do
+        res = Question.find_with_normalized_reputation(:total_votes, :all, {
+          :select => "questions.*, users.name AS user_name",
+          :joins => "JOIN users ON questions.author_id = users.id"})
+        res.should == [@question]
+        res[0].user_name.should == @user.name
+      end
+    end
+
+    context "With Scopes" do
+      before :each do
+        @trans_ja = Translation.create!(:text => "Ichi", :user => @user, :locale => "ja", :phrase => @phrase)
+        @trans_ja.add_evaluation(:votes, 3, @user)
+        @trans_fr = Translation.create!(:text => "Ichi", :user => @user, :locale => "fr", :phrase => @phrase)
+        @trans_fr.add_evaluation(:votes, 6, @user)
+      end
+
+      it "should return result with given reputation" do
+        res = Phrase.find_with_normalized_reputation(:maturity, :ja, :all, {})
+        res.should == [@phrase]
+        res[0].normalized_maturity.should be_within(DELTA).of(0)
+      end
+    end
+  end
+
+  describe "#find_with_reputation_sql" do
+    it "should return a corresponding sql statement" do
+      sql = Question.find_with_reputation_sql(:total_votes, :all, {
+        :select => "questions.*, users.name AS user_name",
+        :joins => "JOIN users ON questions.author_id = users.id",
+        :conditions => "total_votes > 0.6",
+        :order => "total_votes"})
+      sql.should ==
+        "SELECT questions.*, users.name AS user_name, COALESCE(rs_reputations.value, 0) AS total_votes "\
+        "FROM \"questions\" JOIN users ON questions.author_id = users.id "\
+        "LEFT JOIN rs_reputations ON questions.id = rs_reputations.target_id AND rs_reputations.target_type = 'Question' AND rs_reputations.reputation_name = 'total_votes' AND rs_reputations.active = 't' "\
+        "WHERE (total_votes > 0.6) "\
+        "ORDER BY total_votes"
+    end
+  end
+end

data/spec/reputation_system/reputation_spec.rb

@@ -0,0 +1,119 @@
+##
+#  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 ActiveRecord::Base do
+
+  before(:each) do
+    @user = User.create!(:name => 'jack')
+    @question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+    @answer = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => @question.id)
+    @phrase = Phrase.create!(:text => "One")
+  end
+
+  context "Primary Reputation" do
+    describe "#reputation_value_for" do
+      it "should return 0 as a default" do
+        @question.reputation_value_for(:total_votes).should == 0
+      end
+
+      it "should return appropriate value in case of valid input" do
+        user2 = User.new(:name => 'dick')
+        @question.add_evaluation(:total_votes, 1, @user)
+        @question.add_evaluation(:total_votes, 1, user2)
+        @question.reputation_value_for(:total_votes).should == 2
+      end
+
+      it "should raise exception if invalid reputation name is given" do
+        lambda {@question.reputation_value_for(:invalid)}.should raise_error(ArgumentError)
+      end
+
+      it "should raise exception if scope is given for reputation with no scopes" do
+        lambda {@question.reputation_value_for(:difficulty, :s1)}.should raise_error(ArgumentError)
+      end
+
+      it "should raise exception if scope is not given for reputation with scopes" do
+        lambda {@phrase.reputation_value_for(:difficulty_with_scope)}.should raise_error(ArgumentError)
+      end
+    end
+
+    describe "#rank_for" do
+      context "without scope" do
+        before :each do
+          @question.add_evaluation(:total_votes, 3, @user)
+          @question2 = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+          @question2.add_evaluation(:total_votes, 5, @user)
+        end
+
+        it "should return rank properly" do
+          @question.rank_for(:total_votes).should == 2
+          @question2.rank_for(:total_votes).should == 1
+        end
+      end
+
+      context "with scope" do
+        before :each do
+          @trans_ja = Translation.create!(:text => "Ichi", :user => @user, :locale => "ja", :phrase => @phrase)
+          @trans_ja.add_evaluation(:votes, 3, @user)
+          @phrase2 = Phrase.create!(:text => "One")
+          @trans_fr = Translation.create!(:text => "Ichi", :user => @user, :locale => "ja", :phrase => @phrase2)
+          @trans_fr.add_evaluation(:votes, 6, @user)
+        end
+
+        it "should return rank properly" do
+          @phrase.rank_for(:maturity, :ja).should == 2
+          @phrase2.rank_for(:maturity, :ja).should == 1
+        end
+      end
+    end
+  end
+
+  context "Non-Primary Reputation with Gathering Aggregation" do
+    describe "#reputation_value_for" do
+      it "should always have correct updated value" do
+        question2 = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        @user.reputation_value_for(:question_karma).should == 0
+        @question.add_evaluation(:total_votes, 1, @user)
+        @user.reputation_value_for(:question_karma).should == 1
+        question2.add_evaluation(:total_votes, 1, @user)
+        @user.reputation_value_for(:question_karma).should == 2
+      end
+    end
+  end
+
+  context "Non-Primary Reputation with Mixing Aggregation" do
+    describe "#reputation_value_for" do
+      it "should always have correct updated value" do
+        question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        question2 = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+        question.add_evaluation(:difficulty, 1, @user)
+        question2.add_evaluation(:difficulty, 2, @user)
+        question.add_evaluation(:total_votes, 1, @user)
+        question2.add_evaluation(:total_votes, 1, @user)
+        answer = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => question.id)
+        answer2 = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => question2.id)
+        answer.add_evaluation(:avg_rating, 3, @user)
+        answer2.add_evaluation(:avg_rating, 2, @user)
+        answer.reputation_value_for(:weighted_avg_rating).should == 3
+        answer2.reputation_value_for(:weighted_avg_rating).should == 4
+        @user.reputation_value_for(:answer_karma).should be_within(DELTA).of(3.5)
+        @user.reputation_value_for(:question_karma).should be_within(DELTA).of(2)
+        @user.reputation_value_for(:karma).should be_within(DELTA).of(1.4)
+      end
+    end
+  end
+end

data/spec/reputation_system/scope_spec.rb

@@ -0,0 +1,43 @@
+##
+#  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 ActiveRecord::Base do
+
+  before(:each) do
+    @user = User.create!(:name => 'jack')
+    @question = Question.create!(:text => 'Does this work?', :author_id => @user.id)
+    @answer = Answer.create!(:text => 'Yes!', :author_id => @user.id, :question_id => @question.id)
+    @phrase = Phrase.create!(:text => "One")
+  end
+
+  describe "#add_scope_for" do
+    it "should add scope if the reputation has scopes defined" do
+      Phrase.add_scope_for(:difficulty_with_scope, :s4)
+      @phrase.add_evaluation(:difficulty_with_scope, 2, @user, :s4)
+      @phrase.reputation_value_for(:difficulty_with_scope, :s4).should == 2
+    end
+
+    it "should raise exception if the scope already exist" do
+      lambda{Phrase.add_scope_for(:difficulty_with_scope, :s1)}.should raise_error(ArgumentError)
+    end
+
+    it "should raise exception if the reputation does not have scopes defined" do
+      lambda{Question.add_scope_for(:difficulty, :s1)}.should raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,190 @@
+##
+#  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 'active_record'
+require 'database_cleaner'
+require 'sqlite3'
+require 'reputation_system'
+
+DELTA = 0.000001
+
+ActiveRecord::Base.establish_connection(
+  :adapter => "sqlite3",
+  :database => ":memory:"
+)
+
+RSpec.configure do |config|
+  config.before(:each) do
+    DatabaseCleaner.start
+  end
+  config.after(:each) do
+    DatabaseCleaner.clean
+  end
+end
+
+ActiveRecord::Migration.verbose = false
+
+ActiveRecord::Schema.define do
+  create_table :rs_evaluations do |t|
+    t.string      :reputation_name
+    t.references  :source, :polymorphic => true
+    t.references  :target, :polymorphic => true
+    t.float       :value, :default => 0
+    t.timestamps
+  end
+
+  add_index :rs_evaluations, :reputation_name
+  add_index :rs_evaluations, [:target_id, :target_type]
+  add_index :rs_evaluations, [:source_id, :source_type]
+
+  create_table :rs_reputations do |t|
+    t.string      :reputation_name
+    t.float       :value, :default => 0
+    t.string      :aggregated_by
+    t.references  :target, :polymorphic => true
+    t.boolean     :active, :default => true
+    t.timestamps
+  end
+
+  add_index :rs_reputations, :reputation_name
+  add_index :rs_reputations, [:target_id, :target_type]
+
+  create_table :rs_reputation_messages do |t|
+    t.references  :sender, :polymorphic => true
+    t.integer     :receiver_id
+    t.float       :weight, :default => 1
+    t.timestamps
+  end
+
+  add_index :rs_reputation_messages, [:sender_id, :sender_type]
+  add_index :rs_reputation_messages, :receiver_id
+
+  create_table :users do |t|
+    t.string :name
+    t.timestamps
+  end
+
+  create_table :answers do |t|
+    t.integer :author_id
+    t.integer :question_id
+    t.string :text
+    t.timestamps
+  end
+
+  create_table :questions do |t|
+    t.integer :author_id
+    t.string :text
+    t.timestamps
+  end
+
+  create_table :phrases do |t|
+    t.string :text
+    t.timestamps
+  end
+
+  create_table :translations do |t|
+    t.integer :user_id
+    t.integer :phrase_id
+    t.string  :text
+    t.string  :locale
+    t.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+  has_many :answers, :foreign_key => 'author_id', :class_name => 'Answer'
+  has_many :questions, :foreign_key => 'author_id', :class_name => 'Question'
+
+  has_reputation :karma,
+    :source => [
+      {:reputation => :question_karma},
+      {:reputation => :answer_karma, :weight => 0.2}],
+    :aggregated_by => :product
+
+  has_reputation :question_karma,
+    :source => {:reputation => :total_votes, :of => :questions},
+    :aggregated_by => :sum
+
+  has_reputation :answer_karma,
+    :source => {:reputation => :weighted_avg_rating, :of => :answers},
+    :aggregated_by => :average
+end
+
+class Question < ActiveRecord::Base
+  belongs_to :author, :class_name => 'User'
+  has_many :answers
+
+  has_reputation :total_votes,
+    :source => :user,
+    :aggregated_by => :sum,
+    :source_of => {:reputation => :question_karma, :of => :author}
+
+  has_reputation :difficulty,
+    :source => :user,
+    :aggregated_by => :average
+end
+
+class Answer < ActiveRecord::Base
+  belongs_to :author, :class_name => 'User'
+  belongs_to :question
+
+  has_reputation :weighted_avg_rating,
+    :source => [
+      {:reputation => :avg_rating},
+      {:reputation => :difficulty, :of => :question}],
+    :aggregated_by => :product,
+    :source_of => {:reputation => :answer_karma, :of => :author}
+
+  has_reputation :avg_rating,
+    :source => :user,
+    :aggregated_by => :average,
+    :init_value => 1
+end
+
+class Phrase < ActiveRecord::Base
+  has_many :translations do
+    def for(locale)
+      self.find_all_by_locale(locale.to_s)
+    end
+  end
+
+  has_reputation :maturity_all,
+    :source => [
+      {:reputation => :maturity, :of => :self, :scope => :ja},
+      {:reputation => :maturity, :of => :self, :scope => :fr}],
+    :aggregated_by => :sum
+
+  has_reputation :maturity,
+    :source => { :reputation => :votes, :of => lambda {|this, s| this.translations.for(s)} },
+    :aggregated_by => :sum,
+    :scopes => [:ja, :fr, :de],
+    :source_of => {:reputation => :maturity_all, :of => :self, :defined_for_scope => [:ja, :fr]}
+
+  has_reputation :difficulty_with_scope,
+    :source => :user,
+    :aggregated_by => :average,
+    :scopes => [:s1, :s2, :s3]
+end
+
+class Translation < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :phrase
+
+  has_reputation :votes,
+    :source => :user,
+    :aggregated_by => :sum,
+    :source_of => {:reputation => :maturity, :of => :phrase, :scope => :locale}
+end