activerecord-reputation-system 1.3.4 → 1.4.0

data/README.md

@@ -1,13 +1,7 @@
-## Active Record Reputation System  [![Build Status](https://secure.travis-ci.org/twitter/activerecord-reputation-system.png)](http://travis-ci.org/twitter/activerecord-reputation-system) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/twitter/activerecord-reputation-system)
+## ActiveRecord Reputation System  [![Build Status](https://secure.travis-ci.org/twitter/activerecord-reputation-system.png)](http://travis-ci.org/twitter/activerecord-reputation-system) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/twitter/activerecord-reputation-system)
 
 The Active Record Reputation System helps you discover more about your application and make better decisions. The Reputation System gem makes it easy to integrate reputation systems into Rails applications, decouple the system from the main application and provide guidelines for good design of reputation systems.
 
-## Concept
-
-In this gem, the reputation system is described as a network of reputations where updates are triggered by evaluations and reputation values are computed and propagated by the network. In this network, reputations with values directly computed from evaluations are called primary reputations and reputations with values indirectly computed from evaluations are called non-primary reputations. The following is an abstract view of a possible Reputation System:
-
-![Alt text](./activerecord-reputation-system/raw/master/abs_rs.png "Abstract view of Reputation System")
-
 ## Installation
 
 Add to Gemfile:
@@ -99,19 +93,19 @@ has_reputation  :name,
         :source_of => [{:reputation => name, :of => attribute}, ...],
         :init_value => initial_value
 ```
-* :name is the name of the reputation.
-* :source is a source of the reputation. If it is primary reputation, it takes a class name as input. If it's a non-primary reputation, it takes one or more source definitions, which consist of:
-** :reputation - name of reputation to be used as a source.
-** :of - attribute name (It also accepts a proc as an argument) of the ActiveRecord model which has the source reputation. (default: :self)
-** :weight (optional) - weight value to be used for aggregation (default: 1).
-* :aggregated_by is a mathematical process to be used to aggregate reputation or evaluation values. The following processes are available (each value is weighted by a predefined weight):
-** average - averages all values received.
-** sum - sums up all the values received.
-** product - multiplies all the values received.
-* :source_of (optional) - just like active record association, you don't need to define this if a name can be derived from class name; otherwise if the reputation is used as a part of a source belonging to other reputations, you must define. It takes one or more source definitions, which consists of:
-** :reputation - name of the reputation to be used as a source.
-** :of - attribute name (It also accepts a proc as an argument) of the ActiveRecord model which has the source reputation. (default: :self)
-* :init_value (optional) - initial reputation value assigned to new reputation. It is 0 for average and sum process and 1 for product by default.
+* `:name` is the name of the reputation.
+* `:source` is a source of the reputation. If it is primary reputation, it takes a class name as input. If it's a non-primary reputation, it takes one or more source definitions, which consist of:
+    * `:reputation` - name of reputation to be used as a source.
+    * `:of` - attribute name (It also accepts a proc as an argument) of the ActiveRecord model which has the source reputation. (default: :self)
+    * `:weight` (optional) - weight value to be used for aggregation (default: 1).
+* `:aggregated_by` is a mathematical process to be used to aggregate reputation or evaluation values. The following processes are available (each value is weighted by a predefined weight):
+    * average - averages all values received.
+    * sum - sums up all the values received.
+    * product - multiplies all the values received.
+* `:source_of` (optional) - just like active record association, you don't need to define this if a name can be derived from class name; otherwise if the reputation is used as a part of a source belonging to other reputations, you must define. It takes one or more source definitions, which consists of:
+    * `:reputation` - name of the reputation to be used as a source.
+    * `:of` - attribute name (It also accepts a proc as an argument) of the ActiveRecord model which has the source reputation. (default: :self)
+* `:init_value` (optional) - initial reputation value assigned to new reputation. It is 0 for average and sum process and 1 for product by default.
 
 ## Evaluation
 ```ruby
@@ -161,6 +155,20 @@ reputations_activated?(reputation_name)
 ```
 
 ## Querying with Reputation
+
+``` ruby
+# Includes the specified reputation value for the given name.
+ActiveRecord::Base.with_reputation(reputation_name, scope)
+# For example:
+User.with_reputation(:karma).where("karma > ?", 3).order("karma")
+
+# Includes the specified normalized reputation value for the given name.
+ActiveRecord::Base.with_normalized_reputation(reputation, scope)
+# For example:
+User.with_normalized_reputation(:karma).where("karma > ?" > 0.5).order("karma")
+```
+Note: Above query methods does not support calcualtion methods such as count, sum and etc yet.
+
 ```ruby
 # Includes the specified reputation value for the given name via a normal Active Record find query.
 ActiveRecord::Base.find_with_reputation(reputation_name, find_scope, options)

data/lib/reputation_system.rb

@@ -15,7 +15,9 @@
 ##
 
 require 'reputation_system/base'
-require 'reputation_system/query'
+require 'reputation_system/query_methods'
+require 'reputation_system/finder_methods'
+require 'reputation_system/query_builder'
 require 'reputation_system/evaluation'
 require 'reputation_system/network'
 require 'reputation_system/reputation'

data/lib/reputation_system/base.rb

@@ -50,7 +50,9 @@ module ReputationSystem
         # If it is first time to be called
         unless ancestors.include?(ReputationSystem::Reputation)
           has_many :reputations, :as => :target, :class_name => "RSReputation", :dependent => :destroy
-          include ReputationSystem::Query
+          include ReputationSystem::QueryBuilder
+          include ReputationSystem::QueryMethods
+          include ReputationSystem::FinderMethods
           include ReputationSystem::Reputation
           include ReputationSystem::Scope
         end

data/lib/reputation_system/finder_methods.rb

@@ -0,0 +1,84 @@
+##
+#  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.
+##
+
+module ReputationSystem
+module FinderMethods
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+
+      def find_with_reputation(*args)
+        reputation_name, srn, find_scope, options = parse_query_args(*args)
+        options[:select] = build_select_statement(table_name, reputation_name, options[:select])
+        options[:joins] = build_join_statement(table_name, name, srn, options[:joins])
+        options[:conditions] = build_condition_statement(options[:conditions])
+        find(find_scope, options)
+      end
+
+      def count_with_reputation(*args)
+        reputation_name, srn, find_scope, options = parse_query_args(*args)
+        options[:joins] = build_join_statement(table_name, name, srn, options[:joins])
+        options[:conditions] = build_condition_statement(options[:conditions])
+        options[:conditions][0].gsub!(reputation_name.to_s, "COALESCE(rs_reputations.value, 0)")
+        count(find_scope, options)
+      end
+
+      def find_with_normalized_reputation(*args)
+        reputation_name, srn, find_scope, options = parse_query_args(*args)
+        options[:select] = build_select_statement(table_name, reputation_name, options[:select], srn, true)
+        options[:joins] = build_join_statement(table_name, name, srn, options[:joins])
+        options[:conditions] = build_condition_statement(options[:conditions])
+        find(find_scope, options)
+      end
+
+      def find_with_reputation_sql(*args)
+        reputation_name, srn, find_scope, options = parse_query_args(*args)
+        options[:select] = build_select_statement(table_name, reputation_name, options[:select])
+        options[:joins] = build_join_statement(table_name, name, srn, options[:joins])
+        options[:conditions] = build_condition_statement(options[:conditions])
+        if respond_to?(:construct_finder_sql, true)
+          construct_finder_sql(options)
+        else
+          construct_finder_arel(options).to_sql
+        end
+      end
+
+      protected
+
+        def parse_query_args(*args)
+          case args.length
+          when 2
+            find_scope = args[1]
+            options = {}
+          when 3
+            find_scope = args[1]
+            options = args[2]
+          when 4
+            scope = args[1]
+            find_scope = args[2]
+            options = args[3]
+          else
+            raise ArgumentError, "Expecting 2, 3 or 4 arguments but got #{args.length}"
+          end
+          reputation_name = args[0]
+          srn = ReputationSystem::Network.get_scoped_reputation_name(name, reputation_name, scope)
+          [reputation_name, srn, find_scope, options]
+        end
+    end
+  end
+end

data/lib/reputation_system/query_builder.rb

@@ -0,0 +1,73 @@
+##
+#  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.
+##
+
+module ReputationSystem
+  module QueryBuilder
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      DELTA = 0.000001
+      REPUTATION_JOIN_STATEMENT = "LEFT JOIN rs_reputations ON %s.id = rs_reputations.target_id AND rs_reputations.target_type = ? AND rs_reputations.reputation_name = ? AND rs_reputations.active = ?"
+
+      def build_select_statement(table_name, reputation_name, select=nil, srn=nil, normalize=false)
+        select = sanitize_sql_array(["%s.*", table_name]) unless select
+        if normalize
+          max = RSReputation.max(srn, self.name)
+          min = RSReputation.min(srn, self.name)
+          range = max - min
+          if range < DELTA
+            sanitize_sql_array(["%s, (0) AS normalized_%s", select, reputation_name])
+          else
+            sanitize_sql_array(["%s, ((rs_reputations.value - %s) / %s) AS normalized_%s", select, min, range, reputation_name])
+          end
+        else
+          sanitize_sql_array(["%s, COALESCE(rs_reputations.value, 0) AS %s", select, reputation_name])
+        end
+      end
+
+      def build_select_statement_with_reputation_only(table_name, reputation_name, srn=nil, normalize=false)
+        if normalize
+          max = RSReputation.max(srn, self.name)
+          min = RSReputation.min(srn, self.name)
+          range = max - min
+          if range < DELTA
+            sanitize_sql_array(["(0) AS normalized_%s", reputation_name])
+          else
+            sanitize_sql_array(["((rs_reputations.value - %s) / %s) AS normalized_%s", min, range, reputation_name])
+          end
+        else
+          sanitize_sql_array(["COALESCE(rs_reputations.value, 0) AS %s", reputation_name])
+        end
+      end
+
+      def build_condition_statement(conditions=nil)
+        conditions ||= [""]
+        conditions = [conditions] unless conditions.is_a? Array
+        conditions
+      end
+
+      def build_join_statement(table_name, class_name, srn, joins=nil)
+          joins ||= []
+          joins = [joins] unless joins.is_a? Array
+          rep_join = sanitize_sql_array([REPUTATION_JOIN_STATEMENT, class_name.to_s, srn.to_s, true])
+          rep_join = sanitize_sql_array([rep_join, table_name])
+          joins << rep_join
+      end
+    end
+  end
+end

data/lib/reputation_system/query_methods.rb

@@ -0,0 +1,61 @@
+##
+#  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.
+##
+
+module ReputationSystem
+  module QueryMethods
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def with_reputation(*args)
+        reputation_name, srn = parse_arel_query_args(args)
+        select = build_select_statement(table_name, reputation_name)
+        joins = build_join_statement(table_name, name, srn)
+        self.select(select).joins(joins)
+      end
+
+      def with_reputation_only(*args)
+        reputation_name, srn = parse_arel_query_args(args)
+        select = build_select_statement_with_reputation_only(table_name, reputation_name)
+        joins = build_join_statement(table_name, name, srn)
+        self.select(select).joins(joins)
+      end
+
+      def with_normalized_reputation(*args)
+        reputation_name, srn = parse_arel_query_args(args)
+        select = build_select_statement(table_name, reputation_name, nil, srn, true)
+        joins = build_join_statement(table_name, name, srn)
+        self.select(select).joins(joins)
+      end
+
+      def with_normalized_reputation_only(*args)
+        reputation_name, srn = parse_arel_query_args(args)
+        select = build_select_statement_with_reputation_only(table_name, reputation_name, srn, true)
+        joins = build_join_statement(table_name, name, srn)
+        self.select(select).joins(joins)
+      end
+
+      protected
+
+        def parse_arel_query_args(args)
+          reputation_name = args[0]
+          srn = ReputationSystem::Network.get_scoped_reputation_name(name, reputation_name, args[1])
+          [reputation_name, srn]
+        end
+    end
+  end
+end

data/lib/reputation_system/version.rb

@@ -15,5 +15,5 @@
 ##
 
 module ReputationSystem
-  VERSION = "1.3.4"
+  VERSION = "1.4.0"
 end

data/spec/reputation_system/query_methods_spec.rb

@@ -0,0 +1,238 @@
+##
+#  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 "#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.with_reputation(:total_votes)
+        res.should == [@question]
+        res[0].total_votes.should_not be_nil
+      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.with_reputation(:total_votes).where("total_votes > 4")
+        res.should == [@question2]
+      end
+
+      it "should retain joins option" do
+        res = Question.with_reputation(:total_votes).
+          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
+
+      it "should not retain select option" do
+        res = Question.with_reputation(:total_votes).select("questions.id")
+        res.should == [@question]
+        res[0].id.should_not be_nil
+        lambda {res[0].text}.should_not raise_error
+      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.with_reputation(:maturity, :ja)
+        res.should == [@phrase]
+        res[0].maturity.should == 3
+      end
+    end
+  end
+
+  describe "#with_reputation_only" 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.with_reputation_only(:total_votes)
+        res.length.should == 1
+        res[0].total_votes.should_not be_nil
+      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.with_reputation_only(:total_votes).where("total_votes > 4")
+        res.length.should == 1
+        res[0].total_votes.should > 4
+      end
+
+      it "should retain joins option" do
+        res = Question.with_reputation_only(:total_votes).
+          select("questions.*, users.name AS user_name").
+          joins("JOIN users ON questions.author_id = users.id")
+        res[0].user_name.should == @user.name
+      end
+
+      it "should retain select option" do
+        res = Question.with_reputation_only(:total_votes).select("questions.id")
+        res.should == [@question]
+        res[0].id.should_not be_nil
+        lambda {res[0].text}.should raise_error
+      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.with_reputation_only(:maturity, :ja)
+        res.length.should == 1
+        res[0].maturity.should == 3
+      end
+    end
+  end
+
+  describe "#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.with_normalized_reputation(:total_votes)
+        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 not retain select option" do
+        res = Question.with_normalized_reputation(:total_votes).select("questions.id")
+        res.should == [@question]
+        res[0].id.should_not be_nil
+        lambda {res[0].text}.should_not 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.with_normalized_reputation(:total_votes).where("normalized_total_votes > 0.6")
+        res.should == [@question2]
+      end
+
+      it "should retain joins option" do
+        res = Question.with_normalized_reputation(:total_votes).
+          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.with_normalized_reputation(:maturity, :ja)
+        res.should == [@phrase]
+        res[0].normalized_maturity.should be_within(DELTA).of(0)
+      end
+    end
+  end
+
+  describe "#with_normalized_reputation_only" 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.with_normalized_reputation_only(:total_votes)
+        res.length.should == 2
+        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 not retain select option" do
+        res = Question.with_normalized_reputation_only(:total_votes).select("questions.id")
+        res.length.should == 1
+        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.with_normalized_reputation_only(:total_votes).where("normalized_total_votes > 0.6")
+        res.length.should == 1
+        res[0].normalized_total_votes.should > 0.6
+      end
+
+      it "should retain joins option" do
+        res = Question.with_normalized_reputation_only(:total_votes).
+          select("questions.*, users.name AS user_name").
+          joins("JOIN users ON questions.author_id = users.id")
+        res.length.should == 1
+        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.with_normalized_reputation_only(:maturity, :ja)
+        res.length.should == 1
+        res[0].normalized_maturity.should be_within(DELTA).of(0)
+      end
+    end
+  end
+end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: activerecord-reputation-system
 version: !ruby/object:Gem::Version 
-  prerelease: false
+  hash: 7
+  prerelease: 
   segments: 
   - 1
-  - 3
   - 4
-  version: 1.3.4
+  - 0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Katsuya Noguchi
@@ -14,87 +15,98 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-10 00:00:00 +09:00
-default_executable: 
+date: 2012-09-10 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activerecord
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
+  name: activerecord
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rake
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 49
         segments: 
         - 0
         - 8
         - 7
         version: 0.8.7
   type: :development
+  name: rake
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 19
         segments: 
         - 2
         - 8
         version: "2.8"
   type: :development
+  name: rspec
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rdoc
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 3
         segments: 
         - 0
         version: "0"
   type: :development
+  name: rdoc
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: database_cleaner
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 1
         segments: 
         - 0
         - 7
         - 1
         version: 0.7.1
   type: :development
+  name: database_cleaner
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: sqlite3
   prerelease: false
   requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 17
         segments: 
         - 1
         - 3
         - 5
         version: 1.3.5
   type: :development
+  name: sqlite3
   version_requirements: *id006
 description: ActiveRecord Reputation System gem allows rails apps to compute and publish reputation scores for active record models.
 email: 
@@ -122,8 +134,10 @@ files:
 - lib/models/rs_reputation_message.rb
 - lib/reputation_system/base.rb
 - lib/reputation_system/evaluation.rb
+- lib/reputation_system/finder_methods.rb
 - lib/reputation_system/network.rb
-- lib/reputation_system/query.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/version.rb
@@ -133,12 +147,11 @@ files:
 - spec/models/rs_reputation_spec.rb
 - spec/reputation_system/base_spec.rb
 - spec/reputation_system/evaluation_spec.rb
-- spec/reputation_system/network_spec.rb
-- spec/reputation_system/query_spec.rb
+- spec/reputation_system/finder_methods_spec.rb
+- spec/reputation_system/query_methods_spec.rb
 - spec/reputation_system/reputation_spec.rb
 - spec/reputation_system/scope_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: https://github.com/twitter/activerecord-reputation-system
 licenses: []
 
@@ -148,23 +161,27 @@ rdoc_options: []
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: ActiveRecord Reputation System gem allows rails apps to compute and publish reputation scores for active record models

data/lib/reputation_system/query.rb

@@ -1,102 +0,0 @@
-##
-#  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.
-##
-
-module ReputationSystem
-  module Query
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-
-    module ClassMethods
-      DELTA = 0.000001
-
-      def find_with_reputation(*args)
-        reputation_name, srn, find_scope, options = parse_query_args(*args)
-        options[:select] ||= sanitize_sql_array(["%s.*", self.table_name])
-        options[:select] = sanitize_sql_array(["%s, COALESCE(rs_reputations.value, 0) AS %s", options[:select], reputation_name])
-        find_options = get_find_options(srn, options)
-        find_options[:conditions][0].gsub!(reputation_name.to_s, "COALESCE(rs_reputations.value, 0)")
-        find(find_scope, find_options)
-      end
-
-      def count_with_reputation(*args)
-        reputation_name, srn, find_scope, options = parse_query_args(*args)
-        find_options = get_find_options(srn, options)
-        find_options[:conditions][0].gsub!(reputation_name.to_s, "COALESCE(rs_reputations.value, 0)")
-        count(find_scope, find_options)
-      end
-
-      def find_with_normalized_reputation(*args)
-        reputation_name, srn, find_scope, options = parse_query_args(*args)
-        max = RSReputation.max(srn, self.name)
-        min = RSReputation.min(srn, self.name)
-        range = max - min
-        options[:select] ||= sanitize_sql_array(["%s.*", self.table_name])
-        if range < DELTA
-          options[:select] = sanitize_sql_array(["%s, (0) AS normalized_%s", options[:select], reputation_name])
-        else
-          options[:select] = sanitize_sql_array(["%s, ((rs_reputations.value - %s) / %s) AS normalized_%s", options[:select], min, range, reputation_name])
-        end
-        find_options = get_find_options(srn, options)
-        find(find_scope, options)
-      end
-
-      def find_with_reputation_sql(*args)
-        reputation_name, srn, find_scope, options = parse_query_args(*args)
-        options[:select] ||= sanitize_sql_array(["%s.*", self.table_name])
-        options[:select] = sanitize_sql_array(["%s, COALESCE(rs_reputations.value, 0) AS %s", options[:select], reputation_name])
-        find_options = get_find_options(srn, options)
-        if respond_to?(:construct_finder_sql, true)
-          construct_finder_sql(find_options)
-        else
-          construct_finder_arel(find_options).to_sql
-        end
-      end
-
-      protected
-        def get_find_options(srn, options)
-          options[:joins] ||= []
-          options[:joins] = [options[:joins]] unless options[:joins].is_a? Array
-          temp_joins = sanitize_sql_array(["LEFT JOIN rs_reputations ON %s.id = rs_reputations.target_id AND rs_reputations.target_type = ? AND rs_reputations.reputation_name = ? AND rs_reputations.active = ?", self.name, srn.to_s, true])
-          temp_joins = sanitize_sql_array([temp_joins, self.table_name])
-          options[:joins] << temp_joins
-          options[:conditions] ||= [""]
-          options[:conditions] = [options[:conditions]] unless options[:conditions].is_a? Array
-          options
-        end
-
-        def parse_query_args(*args)
-          case args.length
-          when 2
-            find_scope = args[1]
-            options = {}
-          when 3
-            find_scope = args[1]
-            options = args[2]
-          when 4
-            scope = args[1]
-            find_scope = args[2]
-            options = args[3]
-          else
-            raise ArgumentError, "Expecting 2, 3 or 4 arguments but got #{args.length}"
-          end
-          reputation_name = args[0]
-          srn = ReputationSystem::Network.get_scoped_reputation_name(name, reputation_name, scope)
-          [reputation_name, srn, find_scope, options]
-        end
-    end
-  end
-end

data/spec/reputation_system/network_spec.rb

@@ -1,27 +0,0 @@
-##
-#  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