merit 1.2.3 → 1.3.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    merit (1.2.3)
+    merit (1.3.0)
       ambry (~> 0.3.0)
 
 GEM

data/README.md

@@ -143,5 +143,4 @@ end
 
 # To-do list
 
-* Improve model_additions with http://blog.8thlight.com/josh-cheek/2012/02/03/modules-called-they-want-their-integrity-back.html
 * Should namespace Badge, BadgesSash and Sash into Merit module.

data/UPGRADING.md

@@ -1,5 +1,24 @@
 # Upgrading
 
+## to 1.3.0
+
+Adds two methods meant to display a leaderboard.
+
+* `Badge#last_granted(options = {})`. Accepts options:
+  * `:since_date` (`1.month.ago` by default)
+  * `:limit` (10 by default).
+
+  It lists last 10 badge grants in the last month, unless you change query
+  parameters.
+
+* `Merit::Score.top_scored(options = {})`. Accepts options:
+  * `:table_name` (`users` by default)
+  * `:since_date` (`1.month.ago` by default)
+  * `:limit` (10 by default).
+
+  It lists top 10 scored objects in the last month, unless you change query
+  parameters.
+
 ## to 1.2.0
 
 * `Badge#grant_to(meritable_object)` no longer exists. Use

data/app/models/badge.rb

@@ -31,4 +31,11 @@ class Badge
     end
     badge
   end
+
+  # Last badges granted
+  def self.last_granted(options = {})
+    options[:since_date] ||= 1.month.ago
+    options[:limit]      ||= 10
+    BadgesSash.last_granted(options)
+  end
 end

data/app/models/merit/action.rb

@@ -14,9 +14,6 @@ require "merit/models/#{Merit.orm}/merit/action"
 # Rules relate to merit_actions by action name ('controller#action' string)
 module Merit
   class Action
-    attr_accessible :user_id, :action_method, :action_value, :had_errors,
-      :target_model, :target_id, :processed, :log
-
     def self.check_unprocessed
       where(:processed => false).map &:check_all_rules
     end

data/lib/merit.rb

@@ -57,9 +57,7 @@ module Merit
           include Merit::ControllerExtensions
         rescue NameError => e
           # Trap NameError if installing/generating files
-          if !(e.to_s =~ /uninitialized constant Merit::BadgeRules/)
-            raise e
-          end
+          raise e unless e.to_s =~ /uninitialized constant Merit::BadgeRules/
         end
       end
     end

data/lib/merit/model_additions.rb

@@ -9,21 +9,20 @@ module Merit
       # https://rails.lighthouseapp.com/projects/8994-ruby-on-rails/tickets/1079-belongs_to-dependent-destroy-should-destroy-self-before-assocation
       belongs_to :sash
 
-      merit_orm_specific_config
-
-      merit_delegate_methods_to_sash
-      merit_sash_initializer
+      _merit_orm_specific_config
+      _merit_delegate_methods_to_sash
+      _merit_sash_initializer
     end
 
     # Delegate methods from meritable models to their sash
-    def merit_delegate_methods_to_sash
+    def _merit_delegate_methods_to_sash
       methods = %w(badge_ids badges points
         add_badge rm_badge
         add_points substract_points)
       methods.each { |method| delegate method, to: :_sash }
     end
 
-    def merit_orm_specific_config
+    def _merit_orm_specific_config
       if Merit.orm == :mongo_mapper
         plugin Merit
         key :sash_id, String
@@ -43,7 +42,7 @@ module Merit
     # From Rails 3.2 we can override association methods to do so
     # transparently, but merit supports Rails ~> 3.0.0. See:
     # http://blog.hasmanythrough.com/2012/1/20/modularized-association-methods-in-rails-3-2
-    def merit_sash_initializer
+    def _merit_sash_initializer
       define_method(:_sash) do
         if sash.nil?
           self.update_attribute :sash_id, Sash.create.id

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

@@ -1,6 +1,14 @@
 class BadgesSash < ActiveRecord::Base
   belongs_to :sash
 
+  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)
   end

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

@@ -1,5 +1,8 @@
 module Merit
   class Action < ActiveRecord::Base
     self.table_name = :merit_actions
+
+    attr_accessible :user_id, :action_method, :action_value, :had_errors,
+      :target_model, :target_id, :processed, :log
   end
 end

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

@@ -4,6 +4,40 @@ module Merit
     belongs_to :sash
     has_many :score_points, :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
+    # default).
+    #
+    # It lists top 10 scored objects in the last month, unless you change
+    # query parameters.
+    def self.top_scored(options = {})
+      options[:table_name] ||= :users
+      options[:since_date] ||= 1.month.ago
+      options[:limit]      ||= 10
+
+      alias_id_column = "#{options[:table_name].to_s.singularize}_id"
+      if options[:table_name] == :sashes
+        sash_id_column = "#{options[:table_name]}.id"
+      else
+        sash_id_column = "#{options[:table_name]}.sash_id"
+      end
+
+      # MeritableModel – Sash –< Scores –< ScorePoints
+      sql_query = <<SQL
+SELECT
+  #{options[:table_name]}.id AS #{alias_id_column},
+  SUM(num_points) as sum_points
+FROM #{options[:table_name]}
+  LEFT JOIN merit_scores ON merit_scores.sash_id = #{sash_id_column}
+  LEFT JOIN merit_score_points ON merit_score_points.score_id = merit_scores.id
+WHERE merit_score_points.created_at > '#{options[:since_date]}'
+GROUP BY merit_scores.sash_id
+ORDER BY sum_points DESC
+LIMIT #{options[:limit]}
+SQL
+      ActiveRecord::Base.connection.execute(sql_query)
+    end
+
     def points
       score_points.group(:score_id).sum(:num_points).values.first || 0
     end

data/merit.gemspec

@@ -4,7 +4,7 @@ Gem::Specification.new do |s|
   s.description = "Manage badges, points and rankings (reputation) of resources in a Rails application."
   s.homepage    = "http://github.com/tute/merit"
   s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
-  s.version     = '1.2.3'
+  s.version     = '1.3.0'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
   s.add_dependency 'ambry',  '~> 0.3.0'

data/test/merit_unit_test.rb

@@ -48,6 +48,35 @@ class MeritUnitTest < ActiveSupport::TestCase
     assert badge_sash.notified_user
   end
 
+  test "Badge#last_granted returns recently granted badges" do
+    sash = Sash.create
+    badge = Badge.create(id: 20, name: 'test-badge-21')
+    sash.add_badge badge.id
+    BadgesSash.last.update_attribute :created_at, 1.day.ago
+    sash.add_badge badge.id
+    BadgesSash.last.update_attribute :created_at, 8.days.ago
+    sash.add_badge badge.id
+    BadgesSash.last.update_attribute :created_at, 15.days.ago
+
+    assert_equal Badge.last_granted(since_date: Time.now), []
+    assert_equal Badge.last_granted(since_date: 1.week.ago), [badge]
+    assert_equal Badge.last_granted(since_date: 2.weeks.ago).count, 2
+    assert_equal Badge.last_granted(since_date: 2.weeks.ago, limit: 1), [badge]
+  end
+
+  test "Merit::Score.top_scored returns scores leaderboard" do
+    sash_1 = Sash.create
+    sash_1.add_points(10); sash_1.add_points(10)
+    sash_2 = Sash.create
+    sash_2.add_points(5); sash_2.add_points(5)
+
+    assert_equal Merit::Score.top_scored(table_name: :sashes),
+      [{"sash_id"=>1, "sum_points"=>20, 0=>1, 1=>20},
+       {"sash_id"=>2, "sum_points"=>10, 0=>2, 1=>10}]
+    assert_equal Merit::Score.top_scored(table_name: :sashes, limit: 1),
+      [{"sash_id"=>1, "sum_points"=>20, 0=>1, 1=>20}]
+  end
+
   test 'unknown ranking should raise merit exception' do
     class WeirdRankRules
       include Merit::RankRulesMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry