merit 1.7.1 → 1.8.0

data/lib/merit/model_additions.rb

@@ -17,16 +17,18 @@ module Merit
 
     # Delegate methods from meritable models to their sash
     def _merit_delegate_methods_to_sash
-      methods = %w(badge_ids badges points
-        add_badge rm_badge
-        add_points substract_points subtract_points)
+      methods = %w(badge_ids badges points add_badge rm_badge
+                   add_points substract_points subtract_points)
       methods.each { |method| delegate method, to: :_sash }
     end
 
     def _merit_orm_specific_config
-      if Merit.orm == :mongoid
-        field :sash_id
-        field :points, type: Integer, default: 0
+      if Merit.orm == :mongo_mapper
+        plugin Merit
+        key :sash_id, String
+        key :points, Integer, default: 0
+        key :level, Integer, default: 0
+      elsif Merit.orm == :mongoid
         field :level, type: Integer, default: 0
         def find_by_id(id)
           where(_id: id).first
@@ -45,18 +47,9 @@ module Merit
     # http://blog.hasmanythrough.com/2012/1/20/modularized-association-methods-in-rails-3-2
     def _merit_sash_initializer
       define_method(:_sash) do
-        if sash.nil?
-          self.update_attribute :sash_id, Sash.create.id
-        end
-        self.sash
+        sash || update_attribute(:sash_id, Sash.create.id)
+        sash
       end
     end
   end
 end
-
-if Object.const_defined?('ActiveRecord')
-  ActiveRecord::Base.send :include, Merit
-end
-if Object.const_defined?('Mongoid')
-  Mongoid::Document.send :include, Merit
-end

data/lib/merit/models/active_record/merit/action.rb

@@ -6,7 +6,7 @@ module Merit
 
     if defined?(ProtectedAttributes) || !defined?(ActionController::StrongParameters)
       attr_accessible :user_id, :action_method, :action_value, :had_errors,
-        :target_model, :target_id, :processed, :log
+                      :target_model, :target_id, :processed, :log
     end
   end
 end

data/lib/merit/models/active_record/merit/activity_log.rb

@@ -4,6 +4,7 @@ module Merit
 
     belongs_to :action, class_name: Merit::Action
     belongs_to :related_change, polymorphic: true
+    has_one :sash, through: :related_change
 
     if defined?(ProtectedAttributes) || !defined?(ActionController::StrongParameters)
       attr_accessible :action_id, :related_change, :description, :created_at

data/lib/merit/models/active_record/merit/badges_sash.rb

@@ -1,9 +1,9 @@
 module Merit
   class BadgesSash < ActiveRecord::Base
-    belongs_to :sash
+    include Base::BadgesSash
     has_many :activity_logs,
-      class_name: Merit::ActivityLog,
-      as: :related_change
+             class_name: Merit::ActivityLog,
+             as: :related_change
 
     if defined?(ProtectedAttributes) || !defined?(ActionController::StrongParameters)
       attr_accessible :badge_id
@@ -12,13 +12,9 @@ module Merit
     def self.last_granted(options = {})
       options[:since_date] ||= 1.month.ago
       options[:limit]      ||= 10
-      where("created_at > '#{options[:since_date]}'").
-        limit(options[:limit]).
-        map(&:badge)
-    end
-
-    def badge
-      Badge.find(badge_id)
+      where("created_at > '#{options[:since_date]}'")
+        .limit(options[:limit])
+        .map(&:badge)
     end
   end
 end

data/lib/merit/models/active_record/merit/sash.rb

@@ -6,56 +6,20 @@ module Merit
   # It's existence make join models like badges_users and scores_users
   # unnecessary. It should be transparent at the application.
   class Sash < ActiveRecord::Base
+    include Base::Sash
     has_many :badges_sashes, dependent: :destroy
     has_many :scores, dependent: :destroy, class_name: 'Merit::Score'
 
     after_create :create_scores
 
-    def badges
-      badge_ids.map { |id| Badge.find id }
-    end
-
-    def badge_ids
-      badges_sashes.map(&:badge_id)
-    end
-
     def add_badge(badge_id)
       bs = BadgesSash.new(badge_id: badge_id)
-      self.badges_sashes << bs
+      badges_sashes << bs
       bs
     end
 
     def rm_badge(badge_id)
       badges_sashes.find_by_badge_id(badge_id).try(:destroy)
     end
-
-
-    def points(category = 'default')
-      scores.where(category: category).first.points
-    end
-
-    def add_points(num_points, log = 'Manually granted', category = 'default')
-      point = Merit::Score::Point.new
-      point.log = log
-      point.num_points = num_points
-      self.scores.where(category: category).first.score_points << point
-      point
-    end
-
-    # DEPRECATED: Please use <tt>subtract_points</tt> instead.
-    def substract_points(num_points, log = 'Manually granted', category = 'default')
-      warn "[DEPRECATION] `substract_points` is deprecated.  Please use `subtract_points` instead."
-      subtract_points num_points, log, category
-    end
-
-    def subtract_points(num_points, log = 'Manually granted', category = 'default')
-      add_points -num_points, log, category
-    end
-
-    private
-
-    def create_scores
-      self.scores << Merit::Score.create
-    end
   end
 end

data/lib/merit/models/active_record/merit/score.rb

@@ -3,8 +3,8 @@ module Merit
     self.table_name = :merit_scores
     belongs_to :sash
     has_many :score_points,
-      dependent: :destroy,
-      class_name: 'Merit::Score::Point'
+             dependent: :destroy,
+             class_name: 'Merit::Score::Point'
 
     # Meant to display a leaderboard. Accepts options :table_name (users by
     # default), :since_date (1.month.ago by default) and :limit (10 by
@@ -24,7 +24,7 @@ module Merit
         sash_id_column = "#{options[:table_name]}.sash_id"
       end
 
-      # MeritableModel – Sash –< Scores –< ScorePoints
+      # MeritableModel - Sash -< Scores -< ScorePoints
       sql_query = <<SQL
 SELECT
   #{options[:table_name]}.id AS #{alias_id_column},
@@ -50,9 +50,10 @@ SQL
 
     class Point < ActiveRecord::Base
       belongs_to :score, class_name: 'Merit::Score'
+      has_one :sash, through: :score
       has_many :activity_logs,
-        class_name: Merit::ActivityLog,
-        as: :related_change
+               class_name: Merit::ActivityLog,
+               as: :related_change
     end
   end
 end

data/lib/merit/models/base/merit/badges_sash.rb

@@ -0,0 +1,15 @@
+module Merit
+  module Base
+    module BadgesSash
+      extend ActiveSupport::Concern
+
+      included do
+        belongs_to :sash
+      end
+
+      def badge
+        Badge.find(badge_id)
+      end
+    end
+  end
+end

data/lib/merit/models/base/merit/sash.rb

@@ -0,0 +1,42 @@
+module Merit
+  module Base
+    module Sash
+      # Methods that are common between both the active_record and mongoid sash model
+      def badges
+        badge_ids.map { |id| Merit::Badge.find id }
+      end
+
+      def badge_ids
+        badges_sashes.map(&:badge_id)
+      end
+
+      def points(category = 'default')
+        scores.where(category: category).first.points
+      end
+
+      def add_points(num_points, log = 'Manually granted', category = 'default')
+        point = Merit::Score::Point.new
+        point.log = log
+        point.num_points = num_points
+        scores.where(category: category).first.score_points << point
+        point
+      end
+
+      # DEPRECATED: Please use <tt>subtract_points</tt> instead.
+      def substract_points(num_points, log = 'Manually granted', category = 'default')
+        warn '[DEPRECATION] `substract_points` is deprecated.  Please use `subtract_points` instead.'
+        subtract_points num_points, log, category
+      end
+
+      def subtract_points(num_points, log = 'Manually granted', category = 'default')
+        add_points(-num_points, log, category)
+      end
+
+      private
+
+      def create_scores
+        scores << Merit::Score.create
+      end
+    end
+  end
+end

data/lib/merit/models/mongoid/merit/action.rb

@@ -3,13 +3,15 @@ module Merit
     include Mongoid::Document
     include Mongoid::Timestamps
 
-    belongs_to :user
-    field :action_method
-    field :action_value, type: Integer
-    field :had_errors, type: Boolean
+    has_many :activity_logs, class_name: 'Merit::ActivityLog', as: :related_change
 
-    belongs_to :target, polymorphic: true
-    field :processed, type: Boolean, default: false
+    field :user_id
+    field :action_method
+    field :action_value,            type: Integer
+    field :had_errors,              type: Boolean
+    field :target_model
+    field :target_id
+    field :processed,               type: Boolean, default: false
     field :log
   end
 end

data/lib/merit/models/mongoid/merit/activity_log.rb

@@ -0,0 +1,11 @@
+module Merit
+  class ActivityLog
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :description
+
+    belongs_to :action, class_name: 'Merit::Action'
+    belongs_to :related_change, polymorphic: true
+  end
+end

data/lib/merit/models/mongoid/merit/badges_sash.rb

@@ -0,0 +1,19 @@
+module Merit
+  class BadgesSash
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Base::BadgesSash
+
+    field :badge_id,      type: Integer
+    attr_accessible :badge_id
+    has_many :activity_logs, class_name: 'Merit::ActivityLog', as: :related_change
+
+    def self.last_granted(options = {})
+      options[:since_date] ||= 1.month.ago
+      options[:limit]      ||= 10
+      where(:created_at.lte => options[:since_date])
+        .limit(options[:limit])
+        .map(&:badge)
+    end
+  end
+end

data/lib/merit/models/mongoid/merit/sash.rb

@@ -0,0 +1,28 @@
+module Merit
+  # Sash is a container for reputation data for meritable models. It's an
+  # indirection between meritable models and badges and scores (one to one
+  # relationship).
+  #
+  # It's existence make join models like badges_users and scores_users
+  # unnecessary. It should be transparent at the application.
+  class Sash
+    include Mongoid::Document
+    include Mongoid::Timestamps
+    include Base::Sash
+
+    has_many :badges_sashes, class_name: 'Merit::BadgesSash', dependent: :destroy
+    has_many :scores, class_name: 'Merit::Score', dependent: :destroy
+
+    after_create :create_scores
+
+    def add_badge(badge_id)
+      bs = Merit::BadgesSash.new(badge_id: badge_id)
+      badges_sashes.push(bs)
+    end
+
+    def rm_badge(badge_id)
+      bs = badges_sashes.where(badge_id: badge_id).first
+      badges_sashes.delete(bs)
+    end
+  end
+end

data/lib/merit/models/mongoid/merit/score.rb

@@ -0,0 +1,41 @@
+module Merit
+  class Score
+    include Mongoid::Document
+    include Mongoid::Timestamps
+
+    field :category, type: String, default: 'default'
+
+    belongs_to :sash
+    has_many :score_points, class_name: 'Merit::Score::Point', dependent: :destroy
+
+    # Meant to display a leaderboard. Accepts options :table_name (users by
+    # default), :since_date (1.month.ago by default) and :limit (10 by
+    # default).
+    #
+    # It lists top 10 scored objects in the last month, unless you change
+    # query parameters.
+    def self.top_scored(options = {})
+      options[:since_date] ||= 1.month.ago
+      options[:limit]      ||= 10
+      Score.where(created_at: (options[:since_date]..Time.now))
+            .desc(:points)
+            .limit(options[:limit])
+            .flatten.map { |score| score.sash.user }
+    end
+
+    def points
+      score_points.sum(:num_points) || 0
+    end
+
+    class Point
+      include Mongoid::Document
+      include Mongoid::Timestamps
+
+      field :num_points,    type: Integer, default: 0
+      field :log,           type: String
+
+      belongs_to :score, class_name: 'Merit::Score'
+      has_many :activity_logs, class_name: 'Merit::ActivityLog', as: :related_change
+    end
+  end
+end

data/lib/merit/reputation_change_observer.rb

@@ -0,0 +1,11 @@
+module Merit
+  class ReputationChangeObserver
+    def update(changed_data)
+      ActivityLog.create(
+        description:    changed_data[:description],
+        related_change: changed_data[:merit_object],
+        action_id:      changed_data[:merit_action_id]
+      )
+    end
+  end
+end

data/lib/merit/rule.rb

@@ -4,7 +4,7 @@ module Merit
   # Could split this class between badges and rankings functionality
   class Rule
     attr_accessor :badge_name, :level, :to, :model_name, :level_name,
-      :multiple, :temporary, :score, :block
+                  :multiple, :temporary, :score, :block
 
     # Does this rule's condition block apply?
     def applies?(target_obj = nil)

data/lib/merit/rules_matcher.rb

@@ -1,6 +1,5 @@
 module Merit
   class RulesMatcher
-
     def initialize(path, action_name)
       @path = path
       @action_name = action_name
@@ -21,6 +20,5 @@ module Merit
     def entire_path
       @entire_path ||= [@path, @action_name].join('#')
     end
-
   end
 end

data/lib/merit/rules_rank_methods.rb

@@ -23,7 +23,7 @@ module Merit
       end
 
       defined_rules[options[:to]] ||= {}
-      defined_rules[options[:to]].merge!({ options[:level] => rule })
+      defined_rules[options[:to]].merge!(options[:level] => rule)
     end
 
     # Not part of merit after_filter. To be called asynchronously:

data/lib/merit/target_finder.rb

@@ -1,7 +1,7 @@
 module Merit
   class TargetFinder < Struct.new(:rule, :action)
     def self.find(*args)
-      self.new(*args).find
+      new(*args).find
     end
 
     def find
@@ -40,6 +40,5 @@ module Merit
       str << ' (called from Merit::TargetFinder#other_target)'
       Rails.logger.warn str
     end
-
   end
 end

data/merit.gemspec

@@ -5,7 +5,7 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/tute/merit"
   s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
   s.license     = 'MIT'
-  s.version     = '1.7.1'
+  s.version     = '1.8.0'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
@@ -15,6 +15,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rails', '>= 3.2.0'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'simplecov'
+  s.add_development_dependency 'rubocop'
   s.add_development_dependency 'minitest-rails'
   s.add_development_dependency 'mocha', '0.13.3'
 end