merit 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 123265ab30632290e284deffe94b000aab61af82
-  data.tar.gz: 3e2dcca325352e75a7237c97f009104945af6215
+  metadata.gz: c2c4d73e01e95da0a10952cf3fc7da4e9d1c2685
+  data.tar.gz: c87f93f700d5b2fa3ef5360d39e424590fa38bc8
 SHA512:
-  metadata.gz: ee7cb5ebfc7acf53f13d03199f3456740d2a10c171a7d7aabb6eafad7abb919ab1c0855ec00d23a5a6a248f36502358ae02b3a6b9a5a70af69aa4bbc47c45a6d
-  data.tar.gz: 907ebc5ea903eb2977c9240fd5d2f5e9772091cff6352743520198b67b595e7187d56c974826f25bdcf2b88417cb5903229356fd5aba185d730142e472283900
+  metadata.gz: ecb5d0edb9dcce2e28315b4801e369ca03e799761db94ceff31402b95cb236d3a983618e0a1761dbd504d00c1825df751b48553c55a2703effe12907a873a1af
+  data.tar.gz: 6f18fef800b516684098b70392c3eb606793c2b7fefec4a00185e8311897b6dbb835dfae31ef8bc06cea883205096d7078b178452b03c830c34fdfb9fc5888d5

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changelog
 
+## 1.8.0
+
+- [#128] Finishes Observer implementation so client applications can be
+  notified when reputation changes.
+- [#123] Work towards mongoid support. Still work in progress.
+
 ## 1.7.1
 
 - [#121] Adds "Uninstall Merit" rake task.
 - [#124] Thread safe configuration instance variable.
 - [#133] Fixes Rails 4 + protected_attributes bug.
 - Starts this Changelog!
-- General code, tests and README improvements.

data/Gemfile

@@ -18,6 +18,13 @@ end
 
 gem 'rails', rails
 
+case ENV['ORM']
+when 'active_record'
+  gem 'activerecord'
+when 'mongoid'
+  gem 'mongoid', '3.0.10'
+end
+
 group :development, :test do
   gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
   gem 'sqlite3', :platforms => [:ruby, :mswin, :mingw]

data/README.md

@@ -9,8 +9,6 @@ and Rankings.
 
 # Table of Contents
 
-- [Merit](#merit)
-- [Table of Contents](#table-of-contents)
 - [Installation](#installation)
 - [Badges](#badges)
     - [Creating Badges](#creating-badges)
@@ -28,6 +26,7 @@ and Rankings.
     - [Defining Rules](#defining-rules-2)
         - [Examples](#examples-2)
     - [Displaying Rankings](#displaying-rankings)
+- [Getting Notifications](#getting-notifications)
 - [Uninstalling Merit](#uninstalling-merit)
 - [To-do List](#to-do-list)
 
@@ -267,6 +266,36 @@ end
 ```
 
 
+# Getting Notifications
+
+You can get observers notified any time merit changes reputation in your
+application.
+
+To do so, add your observer (to `app/models` or `app/observers`, for example):
+
+```ruby
+# reputation_change_observer.rb
+class ReputationChangeObserver
+  def update(changed_data)
+    # `changed_data[:description]` holds information on what changed
+    # badges granted or removed, points changed.
+
+    # `changed_data[:merit_object]` reputation related object created by merit.
+    # It responds to `sash_id` and `sash`. From there you can get to your
+    # application object that had it's reputation changed, for example:
+    # sash_id = changed_data[:merit_object].sash_id
+    # User.where(sash_id: sash_id).first
+
+    # You may use this to fill a timeline with notifications for users, send
+    # emails, etc.
+  end
+end
+```
+```ruby
+# In `config/initializers/merit.rb`
+config.add_observer 'ReputationChangeObserver'
+```
+
 # Uninstalling Merit
 
 1. Run `rails d merit:install`
@@ -278,7 +307,5 @@ end
 
 # To-do List
 
-* Finish Observer implementation for `Judge`.
 * Move level from meritable model into Sash
 * `ActivityLog` should replace `add_points` `log` parameter
-* FIXMES and TODOS.

data/app/models/merit/action.rb

@@ -15,7 +15,7 @@ require_dependency "merit/models/#{Merit.orm}/merit/action"
 module Merit
   class Action
     def self.check_unprocessed
-      where(processed: false).map &:check_all_rules
+      where(processed: false).map(&:check_all_rules)
     end
 
     # Check rules defined for a merit_action
@@ -44,12 +44,11 @@ module Merit
     # Mark merit_action as processed
     def processed!
       self.processed = true
-      self.save
+      save
     end
 
     def rules_matcher
       @rules_matcher ||= ::Merit::RulesMatcher.new(target_model, action_method)
     end
-
   end
 end

data/app/models/merit/badge.rb

@@ -32,7 +32,7 @@ module Merit
         badges = badges.by_level(level) unless level.nil?
         if (badge = badges.first).nil?
           str = "No badge '#{name}' found. Define it in initializers/merit.rb"
-          raise ::Merit::BadgeNotFound, str
+          fail ::Merit::BadgeNotFound, str
         end
         badge
       end
@@ -48,7 +48,7 @@ module Merit
       # entries with certain badge. For instance, Badge.find(3).users
       def _define_related_entries_method(meritable_class_name)
         define_method(:"#{meritable_class_name.underscore.pluralize}") do
-          sashes = BadgesSash.where(badge_id: self.id).pluck(:sash_id)
+          sashes = BadgesSash.where(badge_id: id).pluck(:sash_id)
           meritable_class_name.constantize.where(sash_id: sashes)
         end
       end

data/lib/generators/active_record/install_generator.rb

@@ -6,7 +6,7 @@ module ActiveRecord
       include Rails::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
-      desc "add active_record merit migrations for the root objects"
+      desc 'add active_record merit migrations for the root objects'
 
       def self.next_migration_number(path)
         ActiveRecord::Generators::Base.next_migration_number(path)

data/lib/generators/active_record/merit_generator.rb

@@ -6,14 +6,14 @@ module ActiveRecord
       include Rails::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
-      desc "add active_record merit migrations"
+      desc 'add active_record merit migrations'
 
       def self.next_migration_number(path)
         ActiveRecord::Generators::Base.next_migration_number(path)
       end
 
       def copy_migrations_and_model
-        migration_template "add_fields_to_model.rb", "db/migrate/add_fields_to_#{table_name}"
+        migration_template 'add_fields_to_model.rb', "db/migrate/add_fields_to_#{table_name}"
       end
     end
   end

data/lib/generators/active_record/remove_generator.rb

@@ -6,7 +6,7 @@ module ActiveRecord
       include Rails::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
-      desc "Creates a migration file to remove all traces of Merit on the DB"
+      desc 'Creates a migration file to remove all traces of Merit on the DB'
 
       def self.next_migration_number(path)
         ActiveRecord::Generators::Base.next_migration_number(path)
@@ -14,7 +14,7 @@ module ActiveRecord
 
       def copy_migrations_and_model
         migration_template 'remove_merit_tables.rb', 'db/migrate/remove_merit_tables.rb'
-        migration_template "remove_fields_from_model.rb", "db/migrate/remove_fields_from_#{table_name}"
+        migration_template 'remove_fields_from_model.rb', "db/migrate/remove_fields_from_#{table_name}"
       end
     end
   end

data/lib/generators/active_record/templates/create_badges_sashes.rb

@@ -2,7 +2,7 @@ class CreateBadgesSashes < ActiveRecord::Migration
   def self.up
     create_table :badges_sashes do |t|
       t.integer :badge_id, :sash_id
-      t.boolean :notified_user, :default => false
+      t.boolean :notified_user, default: false
       t.datetime :created_at
     end
     add_index :badges_sashes, [:badge_id, :sash_id]

data/lib/generators/active_record/templates/create_merit_actions.rb

@@ -1,13 +1,13 @@
 class CreateMeritActions < ActiveRecord::Migration
   def self.up
     create_table :merit_actions do |t|
-      t.integer :user_id # source
+      t.integer :user_id
       t.string  :action_method
       t.integer :action_value
-      t.boolean :had_errors, :default => false
+      t.boolean :had_errors, default: false
       t.string  :target_model
       t.integer :target_id
-      t.boolean :processed, :default => false
+      t.boolean :processed, default: false
       t.timestamps
     end
   end

data/lib/generators/active_record/templates/create_scores_and_points.rb

@@ -2,12 +2,12 @@ class CreateScoresAndPoints < ActiveRecord::Migration
   def self.up
     create_table :merit_scores do |t|
       t.references :sash
-      t.string :category, :default => 'default'
+      t.string :category, default: 'default'
     end
 
     create_table :merit_score_points do |t|
       t.references :score
-      t.integer :num_points, :default => 0
+      t.integer :num_points, default: 0
       t.string :log
       t.datetime :created_at
     end

data/lib/generators/active_record/templates/remove_merit_tables.rb

@@ -6,5 +6,5 @@ class RemoveMeritTables < ActiveRecord::Migration
     drop_table :sashes
     drop_table :merit_scores
     drop_table :merit_score_points
-  end 
+  end
 end

data/lib/generators/merit/install_generator.rb

@@ -4,7 +4,7 @@ module Merit
       source_root File.expand_path('../templates', __FILE__)
       hook_for :orm
 
-      desc "Copy config and rules files"
+      desc 'Copy config and rules files'
       def copy_migrations_and_model
         template 'merit.rb', 'config/initializers/merit.rb'
         template 'merit_badge_rules.rb', 'app/models/merit/badge_rules.rb'

data/lib/generators/merit/merit_generator.rb

@@ -1,7 +1,7 @@
 module Merit
   module Generators
     class MeritGenerator < Rails::Generators::NamedBase
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path('../templates', __FILE__)
       hook_for :orm
 
       def inject_merit_content
@@ -15,9 +15,8 @@ module Merit
       end
 
       def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
       end
-
     end
   end
 end

data/lib/generators/merit/remove_generator.rb

@@ -3,15 +3,15 @@ module Merit
     class RemoveGenerator < Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __FILE__)
       hook_for :orm
-	  
-	  private
+
+      private
 
       def model_exists?
         File.exists?(File.join(destination_root, model_path))
       end
 
       def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
       end
     end
   end

data/lib/generators/merit/templates/merit.rb

@@ -6,11 +6,17 @@ Merit.setup do |config|
   # Define ORM. Could be :active_record (default) and :mongoid
   # config.orm = :active_record
 
-  # Define :user_model_name. This model will be used to grand badge if no :to option is given. Default is "User".
-  # config.user_model_name = "User"
+  # Add application observers to get notifications when reputation changes.
+  # config.add_observer 'MyObserverClassName'
 
-  # Define :current_user_method. Similar to previous option. It will be used to retrieve :user_model_name object if no :to option is given. Default is "current_#{user_model_name.downcase}".
-  # config.current_user_method = "current_user"
+  # Define :user_model_name. This model will be used to grand badge if no
+  # `:to` option is given. Default is 'User'.
+  # config.user_model_name = 'User'
+
+  # Define :current_user_method. Similar to previous option. It will be used
+  # to retrieve :user_model_name object if no `:to` option is given. Default
+  # is "current_#{user_model_name.downcase}".
+  # config.current_user_method = 'current_user'
 end
 
 # Create application badges (uses https://github.com/norman/ambry)

data/lib/merit.rb

@@ -6,6 +6,7 @@ require 'merit/rules_matcher'
 require 'merit/controller_extensions'
 require 'merit/model_additions'
 require 'merit/judge'
+require 'merit/reputation_change_observer'
 require 'merit/sash_finder'
 require 'merit/base_target_finder'
 require 'merit/target_finder'
@@ -23,7 +24,7 @@ module Merit
 
   # # Define ORM
   def self.orm
-    @config.orm
+    @config.orm || :active_record
   end
 
   # Define user_model_name
@@ -36,17 +37,33 @@ module Merit
     @config.current_user_method || "current_#{@config.user_model_name.downcase}".to_sym
   end
 
+  def self.observers
+    @config.observers
+  end
+
+  # @param class_name [String] The string version of observer class
+  def self.add_observer(class_name)
+    @config.add_observer(class_name)
+  end
+
   class Configuration
-    attr_accessor :checks_on_each_request,
-      :orm, :user_model_name, :current_user_method
+    attr_accessor :checks_on_each_request, :orm, :user_model_name, :observers,
+                  :current_user_method
+
     def initialize
       @checks_on_each_request = true
       @orm = :active_record
       @user_model_name = 'User'
+      @observers = []
+    end
+
+    def add_observer(class_name)
+      @observers << class_name
     end
   end
 
   setup
+  add_observer('Merit::ReputationChangeObserver')
 
   class BadgeNotFound < Exception; end
   class RankAttributeNotDefined < Exception; end
@@ -55,20 +72,13 @@ module Merit
     config.app_generators.orm Merit.orm
 
     initializer 'merit.controller' do |app|
-      if Merit.orm == :active_record
-        require 'merit/models/active_record/merit/activity_log'
-        require 'merit/models/active_record/merit/badges_sash'
-        require 'merit/models/active_record/merit/sash'
-        require 'merit/models/active_record/merit/score'
-      elsif Merit.orm == :mongoid
-        require 'merit/models/mongoid/sash'
-      end
-
+      require_models
+      extend_orm_with_has_merit
       ActiveSupport.on_load(:action_controller) do
         begin
-          # Load application defined rules on application boot up
-          ::Merit::AppBadgeRules = ::Merit::BadgeRules.new.defined_rules
-          ::Merit::AppPointRules = ::Merit::PointRules.new.defined_rules
+          # Load app rules on boot up
+          Merit::AppBadgeRules = Merit::BadgeRules.new.defined_rules
+          Merit::AppPointRules = Merit::PointRules.new.defined_rules
           include Merit::ControllerExtensions
         rescue NameError => e
           # Trap NameError if installing/generating files
@@ -76,5 +86,23 @@ module Merit
         end
       end
     end
+
+    def require_models
+      require 'merit/models/base/merit/sash'
+      require 'merit/models/base/merit/badges_sash'
+      require "merit/models/#{Merit.orm}/merit/activity_log"
+      require "merit/models/#{Merit.orm}/merit/badges_sash"
+      require "merit/models/#{Merit.orm}/merit/sash"
+      require "merit/models/#{Merit.orm}/merit/score"
+    end
+
+    def extend_orm_with_has_merit
+      if Object.const_defined?('ActiveRecord')
+        ActiveRecord::Base.send :include, Merit
+      end
+      if Object.const_defined?('Mongoid')
+        Mongoid::Document.send :include, Merit
+      end
+    end
   end
 end

data/lib/merit/base_target_finder.rb

@@ -1,8 +1,7 @@
 module Merit
   class BaseTargetFinder
-
     def self.find(*args)
-      self.new(*args).find
+      new(*args).find
     end
 
     def initialize(rule, action)
@@ -17,6 +16,5 @@ module Merit
     rescue => e
       Rails.logger.warn "[merit] no target found: #{e}. #{caller.first}"
     end
-
   end
 end

data/lib/merit/judge.rb

@@ -1,9 +1,8 @@
-require_relative 'observer'
+require 'observer'
 
 module Merit
   class Judge
-
-    include Observer
+    include Observable
 
     def initialize(sashes, rule, options = {})
       @sashes = sashes
@@ -11,6 +10,10 @@ module Merit
       # 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
     end
 
     # Grant badge if rule applies. If it doesn't, and the badge is temporary,
@@ -27,7 +30,11 @@ module Merit
       return unless rule_applies?
       @sashes.each do |sash|
         point = sash.add_points points
-        notify_observers(@action.id, point)
+        notify_observers(
+          description: "granted #{points} points",
+          merit_object: point,
+          merit_action_id: @action.id
+        )
       end
     end
 
@@ -37,14 +44,22 @@ module Merit
       @sashes.each do |sash|
         next unless new_or_multiple?(sash)
         badge_sash = sash.add_badge badge.id
-        notify_observers(@action.id, badge_sash, 'granted')
+        notify_observers(
+          description: "granted #{badge.name} badge",
+          merit_object: badge_sash,
+          merit_action_id: @action.id
+        )
       end
     end
 
     def remove_badges
       @sashes.each do |sash|
         badge_sash = sash.rm_badge badge.id
-        notify_observers(@action.id, badge_sash, 'removed')
+        notify_observers(
+          description: "removed #{badge.name} badge",
+          merit_object: badge_sash,
+          merit_action_id: @action.id
+        )
       end
     end
 
@@ -71,5 +86,10 @@ module Merit
     def badge
       @rule.badge
     end
+
+    def notify_observers(changed_data)
+      changed
+      super
+    end
   end
 end