merit 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2c4d73e01e95da0a10952cf3fc7da4e9d1c2685
-  data.tar.gz: c87f93f700d5b2fa3ef5360d39e424590fa38bc8
+  metadata.gz: debce052338bde9db1f6ad4a50b88cbad2cdd466
+  data.tar.gz: 3c41c3c3ce1df213836fdb4f708425cc83fb9ec6
 SHA512:
-  metadata.gz: ecb5d0edb9dcce2e28315b4801e369ca03e799761db94ceff31402b95cb236d3a983618e0a1761dbd504d00c1825df751b48553c55a2703effe12907a873a1af
-  data.tar.gz: 6f18fef800b516684098b70392c3eb606793c2b7fefec4a00185e8311897b6dbb835dfae31ef8bc06cea883205096d7078b178452b03c830c34fdfb9fc5888d5
+  metadata.gz: ccb24cf9023b3aa519e9e265379a57864176019a63cfde2253fc145b82a58fe402fc0ffe2963b7f43ec9ab5242d26819d10e7814743c62e2aa435e2a91b427d3
+  data.tar.gz: e77bf853ca0b6ca140f57a04fe32d3e0c6499cc13027e4a413514967afabb3544d6dc7bb9babd5fe84b5cf382bfe242a0bff222a2121be543ae13fdb08af27cd

data/README.md

@@ -57,12 +57,12 @@ Create badges in `config/initializers/merit.rb`
 ### Example
 
 ```ruby
-Merit::Badge.create! ({
+Merit::Badge.create!(
   id: 1,
   name: "Yearling",
   description: "Active member for a year",
   custom_fields: { difficulty: :silver }
-})
+)
 ```
 
 ## Defining Rules
@@ -122,12 +122,6 @@ current_user.rm_badge(badge.id)
 ```
 
 ```ruby
-# List 10 badge grants in the last month
-Badge.last_granted
-
-# List 20 badge grants in the last week
-Badge.last_granted(since_date: 1.week.ago, limit: 20)
-
 # Get related entries of a given badge
 Badge.find(1).users
 ```
@@ -192,7 +186,7 @@ score proc, on: 'photos#create'
 
 ```ruby
 # Score manually
-current_user.add_points(20, 'Optional log message')
+current_user.add_points(20)
 current_user.subtract_points(10)
 ```
 
@@ -200,16 +194,6 @@ current_user.subtract_points(10)
 # Query awarded points since a given date
 score_points = current_user.sash.scores.first.score_points
 score_points.where("created_at > '#{1.month.ago}'").sum(:num_points)
-
-# List top 10 scored users in the last month
-Merit::Score.top_scored
-
-# List top 25 scored lists in the last week
-Merit::Score.top_scored(
-  table_name: :lists,
-  since_date: 1.week.ago,
-  limit: 25
-)
 ```
 
 ## Displaying Points
@@ -307,5 +291,6 @@ config.add_observer 'ReputationChangeObserver'
 
 # To-do List
 
+## Pre 2.0.0
+
 * Move level from meritable model into Sash
-* `ActivityLog` should replace `add_points` `log` parameter

data/UPGRADING.md

@@ -1,4 +1,19 @@
-# Upgrading
+# Main Changes / Upgrading Notes
+
+## 1.9.0 (not released yet)
+
+* Deprecates `Merit::Badge.last_granted` and `Merit::Score.top_scored`.
+  Code can be readded to client applications following instructions in:
+  https://github.com/tute/merit/wiki/How-to-show-a-points-leaderboard
+  https://github.com/tute/merit/wiki/How-to-show-last-granted-badges
+* Deprecates `add_points` `log` parameter.
+
+## 1.8.0
+
+* Completes implementation of observer patter for getting reputation grant
+  notifications to the client app. See: https://github.com/tute/merit#getting-
+  notifications.
+* Work on mongoid adapter (not yet ready), and other internals polishing.
 
 ## 1.7.0
 

data/app/models/merit/action.rb

@@ -31,16 +31,11 @@ module Merit
 
     def check_rules(rules_array, badges_or_points)
       rules_array.each do |rule|
-        judge = Judge.new sashes_to_badge(rule), rule, action: self
+        judge = Judge.new rule, action: self
         judge.send :"apply_#{badges_or_points}"
       end
     end
 
-    # Subject to badge: source_user or target.user?
-    def sashes_to_badge(rule)
-      SashFinder.find(rule, self)
-    end
-
     # Mark merit_action as processed
     def processed!
       self.processed = true

data/app/models/merit/badge.rb

@@ -37,8 +37,10 @@ module Merit
         badge
       end
 
-      # Last badges granted
+      # DEPRECATED: `last_granted` will be removed from merit, please refer to:
+      # https://github.com/tute/merit/wiki/How-to-show-last-granted-badges
       def last_granted(options = {})
+        warn '[merit] [DEPRECATION] `last_granted` will be removed from merit, please refer to: https://github.com/tute/merit/wiki/How-to-show-last-granted-badges'
         options[:since_date] ||= 1.month.ago
         options[:limit]      ||= 10
         BadgesSash.last_granted(options)

data/lib/merit/judge.rb

@@ -4,13 +4,9 @@ module Merit
   class Judge
     include Observable
 
-    def initialize(sashes, rule, options = {})
-      @sashes = sashes
+    def initialize(rule, options = {})
       @rule = rule
-      # FIXME: Too much context?
-      # A Judge should apply reputation independently of the action
       @action = options[:action]
-
       Merit.observers.each do |class_name|
         add_observer class_name.constantize.new
       end
@@ -28,7 +24,7 @@ module Merit
 
     def apply_points
       return unless rule_applies?
-      @sashes.each do |sash|
+      sashes.each do |sash|
         point = sash.add_points points
         notify_observers(
           description: "granted #{points} points",
@@ -41,7 +37,7 @@ module Merit
     private
 
     def grant_badges
-      @sashes.each do |sash|
+      sashes.each do |sash|
         next unless new_or_multiple?(sash)
         badge_sash = sash.add_badge badge.id
         notify_observers(
@@ -53,7 +49,7 @@ module Merit
     end
 
     def remove_badges
-      @sashes.each do |sash|
+      sashes.each do |sash|
         badge_sash = sash.rm_badge badge.id
         notify_observers(
           description: "removed #{badge.name} badge",
@@ -83,6 +79,10 @@ module Merit
       end
     end
 
+    def sashes
+      @sashes ||= SashFinder.find @rule, @action
+    end
+
     def badge
       @rule.badge
     end

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

@@ -9,7 +9,10 @@ module Merit
       attr_accessible :badge_id
     end
 
+    # DEPRECATED: `last_granted` will be removed from merit, please refer to:
+    # https://github.com/tute/merit/wiki/How-to-show-last-granted-badges
     def self.last_granted(options = {})
+      warn '[merit] [DEPRECATION] `last_granted` will be removed from merit, please refer to: https://github.com/tute/merit/wiki/How-to-show-last-granted-badges'
       options[:since_date] ||= 1.month.ago
       options[:limit]      ||= 10
       where("created_at > '#{options[:since_date]}'")

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

@@ -6,13 +6,10 @@ module Merit
              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.
+    # DEPRECATED: `top_scored` will be removed from merit, please refer to:
+    # https://github.com/tute/merit/wiki/How-to-show-a-points-leaderboard
     def self.top_scored(options = {})
+      warn '[merit] [DEPRECATION] `top_scored` will be removed from merit, please refer to: https://github.com/tute/merit/wiki/How-to-show-a-points-leaderboard'
       options[:table_name] ||= :users
       options[:since_date] ||= 1.month.ago
       options[:limit]      ||= 10

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

@@ -15,6 +15,9 @@ module Merit
       end
 
       def add_points(num_points, log = 'Manually granted', category = 'default')
+        if log != 'Manually granted'
+          warn '[merit] [DEPRECATION] `add_points` `log` parameter is deprecated'
+        end
         point = Merit::Score::Point.new
         point.log = log
         point.num_points = num_points
@@ -24,7 +27,7 @@ module Merit
 
       # 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.'
+        warn '[merit] [DEPRECATION] `substract_points` is deprecated.  Please use `subtract_points` instead.'
         subtract_points num_points, log, category
       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.8.0'
+  s.version     = '1.9.0'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 

data/test/dummy/app/models/address.rb

@@ -0,0 +1,14 @@
+case Merit.orm
+when :active_record
+  class Address < ActiveRecord::Base
+  end
+when :mongoid
+  class Address
+    include Mongoid::Document
+    include Mongoid::Timestamps
+  end
+end
+
+class Address
+  belongs_to :user
+end

data/test/dummy/app/models/merit/badge_rules.rb

@@ -26,6 +26,13 @@ module Merit
         true
       end
 
+      # For regression test: if condition doesn't hold, it doesn't check
+      # sashes to badge. Useful for polymorphic relations where not every
+      # model has reputation. See https://github.com/tute/merit/issues/134.
+      grant_on 'users#create', badge: 'just-registered', to: :model_with_no_reputation do |user|
+        user.model_with_no_reputation.respond_to?(:_sash)
+      end
+
       # Example rule for multiple badge granting
       grant_on 'users#index', badge: 'gossip', multiple: true
 

data/test/dummy/app/models/user.rb

@@ -14,12 +14,17 @@ end
 class User
   has_merit
 
+  has_many :addresses
   has_many :comments
 
   if defined?(ProtectedAttributes) || !defined?(ActionController::StrongParameters)
     attr_accessible :name
   end
 
+  def model_with_no_reputation
+    addresses.first || addresses.create
+  end
+
   def show_badges
     badges_uniq = Badge.find_by_id(badge_ids)
     badges_uniq.collect{|b| "#{b.name.capitalize}#{badge_status(b)}" }.join(', ')

data/test/dummy/db/migrate/20140211144001_create_addresses.rb

@@ -0,0 +1,11 @@
+class CreateAddresses < ActiveRecord::Migration
+  def up
+    create_table :addresses do |t|
+      t.references :user
+    end
+  end
+
+  def down
+    drop_table :addresses
+  end
+end

data/test/dummy/db/schema.rb

@@ -11,7 +11,11 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20130329224410) do
+ActiveRecord::Schema.define(:version => 20140211144001) do
+
+  create_table "addresses", :force => true do |t|
+    t.integer "user_id"
+  end
 
   create_table "badges_sashes", :force => true do |t|
     t.integer  "badge_id"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Tute Costa
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-09 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
@@ -177,6 +177,7 @@ files:
 - test/dummy/app/controllers/registrations_controller.rb
 - test/dummy/app/controllers/users_controller.rb
 - test/dummy/app/helpers/application_helper.rb
+- test/dummy/app/models/address.rb
 - test/dummy/app/models/comment.rb
 - test/dummy/app/models/dummy_observer.rb
 - test/dummy/app/models/merit/badge_rules.rb
@@ -221,6 +222,7 @@ files:
 - test/dummy/db/migrate/20130329224408_create_sashes.rb
 - test/dummy/db/migrate/20130329224409_create_badges_sashes.rb
 - test/dummy/db/migrate/20130329224410_create_scores_and_points.rb
+- test/dummy/db/migrate/20140211144001_create_addresses.rb
 - test/dummy/db/schema.rb
 - test/dummy/db/seeds.rb
 - test/dummy/public/404.html