activerecord-reputation-system 2.0.0 → 2.0.1

data/README.md

@@ -1,6 +1,9 @@
 ## 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.
+The Active Record Reputation System helps you build the reputation system for your Rails application. It allows Active Record to have reputations and get evaluated by other records. This gem allows you to:
+* define reputations in easily readable way.
+* integrate reputation systems into applications and decouple the system from the main application.
+* discover more about your application and make better decisions.
 
 ## Installation
 

data/lib/reputation_system/finder_methods.rb

@@ -26,14 +26,14 @@ module FinderMethods
         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])
+        options[:conditions] = build_condition_statement(reputation_name, 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] = build_condition_statement(reputation_name, options[:conditions])
         options[:conditions][0].gsub!(reputation_name.to_s, "COALESCE(rs_reputations.value, 0)")
         count(find_scope, options)
       end
@@ -42,7 +42,7 @@ module FinderMethods
         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])
+        options[:conditions] = build_condition_statement(reputation_name, options[:conditions], srn, true)
         find(find_scope, options)
       end
 
@@ -50,7 +50,7 @@ module FinderMethods
         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])
+        options[:conditions] = build_condition_statement(reputation_name, options[:conditions])
         if respond_to?(:construct_finder_sql, true)
           construct_finder_sql(options)
         else

data/lib/reputation_system/query_builder.rb

@@ -23,41 +23,33 @@ module ReputationSystem
     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 = ?"
+      REPUTATION_FIELD_STRING = "COALESCE(rs_reputations.value, 0)" 
 
       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 = ReputationSystem::Reputation.max(srn, self.name)
-          min = ReputationSystem::Reputation.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
+          sanitize_sql_array(["%s, %s AS normalized_%s", select, normalized_field_string(srn), reputation_name.to_s])
         else
-          sanitize_sql_array(["%s, COALESCE(rs_reputations.value, 0) AS %s", select, reputation_name])
+          sanitize_sql_array(["%s, %s AS %s", select, REPUTATION_FIELD_STRING, reputation_name.to_s])
         end
       end
 
       def build_select_statement_with_reputation_only(table_name, reputation_name, srn=nil, normalize=false)
         if normalize
-          max = ReputationSystem::Reputation.max(srn, self.name)
-          min = ReputationSystem::Reputation.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
+          sanitize_sql_array(["%s AS normalized_%s", normalized_field_string(srn), reputation_name.to_s])
         else
-          sanitize_sql_array(["COALESCE(rs_reputations.value, 0) AS %s", reputation_name])
+          sanitize_sql_array(["%s AS %s", REPUTATION_FIELD_STRING, reputation_name.to_s])
         end
       end
 
-      def build_condition_statement(conditions=nil)
+      def build_condition_statement(reputation_name, conditions=nil, srn=nil, normalize=false)
         conditions ||= [""]
         conditions = [conditions] unless conditions.is_a? Array
+        if normalize
+          normalized_reputation_name = sanitize_sql_array(["normalized_%s", reputation_name.to_s])
+          conditions[0] = conditions[0].gsub(normalized_reputation_name, normalized_field_string(srn))
+        end
+        conditions[0] = conditions[0].gsub(reputation_name.to_s, REPUTATION_FIELD_STRING)
         conditions
       end
 
@@ -68,6 +60,19 @@ module ReputationSystem
           rep_join = sanitize_sql_array([rep_join, table_name])
           joins << rep_join
       end
+
+      protected
+
+      def normalized_field_string(srn)
+        max = ReputationSystem::Reputation.max(srn, self.name)
+        min = ReputationSystem::Reputation.min(srn, self.name)
+        range = max - min
+        if range < DELTA
+          "(0)"
+        else
+          sanitize_sql_array(["((rs_reputations.value - %s) / %s)", min, range])
+        end
+      end
     end
   end
 end

data/lib/reputation_system/query_methods.rb

@@ -22,6 +22,7 @@ module ReputationSystem
 
     module ClassMethods
       def with_reputation(*args)
+        warn "[DEPRECATION] `with_reputation` will be deprecated in version 3.0.0. Please use finder methods instead."
         reputation_name, srn = parse_arel_query_args(args)
         select = build_select_statement(table_name, reputation_name)
         joins = build_join_statement(table_name, name, srn)
@@ -29,6 +30,7 @@ module ReputationSystem
       end
 
       def with_reputation_only(*args)
+        warn "[DEPRECATION] `with_reputation_only` will be deprecated in version 3.0.0. Please use finder methods instead."
         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)
@@ -36,6 +38,7 @@ module ReputationSystem
       end
 
       def with_normalized_reputation(*args)
+        warn "[DEPRECATION] `with_normalized_reputation` will be deprecated in version 3.0.0. Please use finder methods instead."
         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)
@@ -43,6 +46,7 @@ module ReputationSystem
       end
 
       def with_normalized_reputation_only(*args)
+        warn "[DEPRECATION] `with_normalized_reputation_only` will be deprecated in version 3.0.0. Please use finder methods instead."
         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)

data/lib/reputation_system/version.rb

@@ -15,5 +15,5 @@
 ##
 
 module ReputationSystem
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

data/spec/reputation_system/base_spec.rb

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe ActiveRecord::Base do
+describe ReputationSystem::Base do
 
   before(:each) do
     @user = User.create!(:name => 'jack')

data/spec/reputation_system/evaluation_methods_spec.rb

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe ActiveRecord::Base do
+describe ReputationSystem::EvaluationMethods do
 
   before(:each) do
     @user = User.create!(:name => 'jack')

data/spec/reputation_system/finder_methods_spec.rb

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe ActiveRecord::Base do
+describe ReputationSystem::FinderMethods do
 
   before(:each) do
     @user = User.create!(:name => 'jack')
@@ -170,13 +170,13 @@ describe ActiveRecord::Base 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",
+        :conditions => "COALESCE(rs_reputations.value, 0) > 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) "\
+        "WHERE (COALESCE(rs_reputations.value, 0) > 0.6) "\
         "ORDER BY total_votes"
     end
   end

data/spec/reputation_system/query_methods_spec.rb

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe ActiveRecord::Base do
+describe ReputationSystem::QueryMethods do
 
   before(:each) do
     @user = User.create!(:name => 'jack')

data/spec/reputation_system/reputation_methods_spec.rb

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe ActiveRecord::Base do
+describe ReputationSystem::ReputationMethods do
 
   before(:each) do
     @user = User.create!(:name => 'jack')

data/spec/reputation_system/scope_methods_spec.rb

@@ -16,7 +16,7 @@
 
 require 'spec_helper'
 
-describe ActiveRecord::Base do
+describe ReputationSystem::ScopeMethods do
 
   before(:each) do
     @user = User.create!(:name => 'jack')

metadata

@@ -2,7 +2,7 @@
 name: activerecord-reputation-system
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors: 
 - Katsuya Noguchi