merit 4.0.0 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0ee557f98d45fe9a83d5de23d407e2b36f85f6a5d4204b1ed89fec8bf5c90fb
-  data.tar.gz: ae393531c2a569a8aece0d533523aaa6fa6e407c4fe4aa3efe96f49d349b3d37
+  metadata.gz: 1163ea7681b5daca51eb89a7785bc648fe86ddbefff1a05cdc765c20c9b91973
+  data.tar.gz: 1329168f700f69f1d0eff4ca196ed511302b7839745eb8ed58bb5bb277cd5d51
 SHA512:
-  metadata.gz: c4b48c33d57774076e00d9732ccac73dbb71b1ee1efe87329ba9ee542593e1a8c3823bef1c5c783a45ed46b28cc3eda4626ddefe9683682341ccc8d51bcf9889
-  data.tar.gz: 0e886c1d895343875d06c537015d4ae14b0723f96d8ddac2a264892b7a3aee0d821f7e6ccb404f68371ac9ca9d5adad78f211b1943747a9bc6dc53361efd6cb6
+  metadata.gz: 2e112a21e6ada4964c86c7253c72bc4235f4ab478a876badfa27cf1d60d2cea3ec297f234219100bc9049e50ea859860a7d6c3f504dcca86b8424da3aa28e007
+  data.tar.gz: 39f8af732714702142e9b0f279c63b7aa528113fd81f39df99f94ae09ca0320e9a2f52b230dd919bedc9e42f5947aed9ad656df89c84c9bc09a56cdacd7e8438

data/NEWS.md

@@ -2,6 +2,24 @@
 
 User-visible changes worth mentioning.
 
+## 4.0.3
+
+- Add webrick as a development dependency
+- [#363] Fix: `warning: already initialized constant Merit::*` messages
+- [#357] Fix `merit_actions` migration template
+
+## 4.0.2
+
+- [#355, #356] Add index on merit_actions.processed column
+- [#354] Fix Rails autoloader deprecation warnings
+  Requires wrapping `Merit::Badge.create` with `Rails.application.reloader.to_prepare`
+- Test with Ruby 3 and Rails 6.1 (excludes Rails 5.2 with Ruby 3, that errors out)
+- [#288] Don’t send “removed badge” notifications when user doesn’t have the badge
+
+## 4.0.1
+
+- [#351] Fix bug on generating migrations
+
 ## 4.0.0
 
 - Stop testing on Rails 5.1

data/README.md

@@ -58,12 +58,16 @@ Create badges in `config/initializers/merit.rb`
 ### Example
 
 ```ruby
-Merit::Badge.create!(
-  id: 1,
-  name: "year-member",
-  description: "Active member for a year",
-  custom_fields: { difficulty: :silver }
-)
+# config/initializers/merit.rb
+
+Rails.application.reloader.to_prepare do
+  Merit::Badge.create!(
+    id: 1,
+    name: "year-member",
+    description: "Active member for a year",
+    custom_fields: { difficulty: :silver }
+  )
+end
 ```
 
 ## Defining Rules
@@ -305,8 +309,8 @@ warning, with a comment to check the configuration for the rule.
 
 # Getting Notifications
 
-You can get observers notified any time merit changes reputation in your
-application.
+You can get observers notified any time merit automatically changes reputation
+in your application.
 
 It needs to implement the `update` method, which receives as parameter the
 following hash:
@@ -337,6 +341,9 @@ end
 config.add_observer 'ReputationChangeObserver'
 ```
 
+**NOTE:** Observers won’t get notified if you grant reputation with
+direct calls to `add_badge` or `add_point`.
+
 # I18n
 
 Merit uses default messages with I18n for notify alerts. To customize your app, you can set up your locale file:

data/lib/merit/generators/active_record/merit_generator.rb

@@ -13,7 +13,7 @@ module Merit
       end
 
       def copy_migrations_and_model
-        migration_template 'add_merit_fields_to_model.rb',
+        migration_template 'add_merit_fields_to_model.erb',
                            "db/migrate/add_merit_fields_to_#{table_name}.rb"
       end
 

data/lib/merit/generators/active_record/templates/create_merit_actions.erb

@@ -11,5 +11,7 @@ class CreateMeritActions < ActiveRecord::Migration<%= migration_version %>
       t.boolean :processed, default: false
       t.timestamps null: false
     end
+
+    add_index :merit_actions, :processed
   end
 end

data/lib/merit/generators/install_generator.rb

@@ -4,7 +4,6 @@ module Merit
   module Generators
     class InstallGenerator < ::Rails::Generators::Base
       source_root File.expand_path('../templates', __FILE__)
-      hook_for :orm
 
       desc 'Copy config and rules files'
       def copy_migrations_and_model
@@ -13,6 +12,10 @@ module Merit
         template 'merit_point_rules.erb', 'app/models/merit/point_rules.rb'
         template 'merit_rank_rules.erb', 'app/models/merit/rank_rules.rb'
       end
+
+      def run_active_record_generators
+        invoke 'merit:active_record:install'
+      end
     end
   end
 end

data/lib/merit/generators/merit_generator.rb

@@ -4,7 +4,6 @@ module Merit
   module Generators
     class MeritGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      hook_for :orm
 
       def inject_merit_content
         if model_exists?
@@ -12,6 +11,10 @@ module Merit
         end
       end
 
+      def run_active_record_generators
+        invoke 'merit:active_record:merit'
+      end
+
       private
 
       def model_exists?

data/lib/merit/generators/remove_generator.rb

@@ -4,7 +4,10 @@ module Merit
   module Generators
     class RemoveGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      hook_for :orm
+
+      def run_active_record_generators
+        invoke 'merit:active_record:remove'
+      end
 
       private
 

data/lib/merit/generators/templates/merit.erb

@@ -6,7 +6,7 @@ Merit.setup do |config|
   # Add application observers to get notifications when reputation changes.
   # config.add_observer 'MyObserverClassName'
 
-  # Define :user_model_name. This model will be used to grand badge if no
+  # Define :user_model_name. This model will be used to grant badge if no
   # `:to` option is given. Default is 'User'.
   # config.user_model_name = 'User'
 
@@ -17,14 +17,16 @@ Merit.setup do |config|
 end
 
 # Create application badges (uses https://github.com/norman/ambry)
-# badge_id = 0
-# [{
-#   id: (badge_id = badge_id+1),
-#   name: 'just-registered'
-# }, {
-#   id: (badge_id = badge_id+1),
-#   name: 'best-unicorn',
-#   custom_fields: { category: 'fantasy' }
-# }].each do |attrs|
-#   Merit::Badge.create! attrs
+# Rails.application.reloader.to_prepare do
+#   badge_id = 0
+#   [{
+#     id: (badge_id = badge_id+1),
+#     name: 'just-registered'
+#   }, {
+#     id: (badge_id = badge_id+1),
+#     name: 'best-unicorn',
+#     custom_fields: { category: 'fantasy' }
+#   }].each do |attrs|
+#     Merit::Badge.create! attrs
+#   end
 # end

data/lib/merit/judge.rb

@@ -50,11 +50,12 @@ module Merit
 
     def remove_badges
       sashes.each do |sash|
-        sash.rm_badge badge.id
-        notify_observers(
-          description: I18n.t("merit.removed_badge", badge_name: badge.name),
-          sash_id: sash.id
-        )
+        if sash.rm_badge badge.id
+          notify_observers(
+            description: I18n.t("merit.removed_badge", badge_name: badge.name),
+            sash_id: sash.id
+          )
+        end
       end
     end
 

data/lib/merit.rb

@@ -35,6 +35,16 @@ module Merit
     @config.add_observer(class_name)
   end
 
+  # If the app is reloaded, avoid printing `warning: previous definition of AppBadgeRules was here`
+  def self.remove_badge_rules
+    remove_const(:AppBadgeRules) if self.const_defined?('AppBadgeRules')
+  end
+
+  # If the app is reloaded, avoid printing `warning: previous definition of AppPointRules was here`
+  def self.remove_point_rules
+    remove_const(:AppPointRules) if self.const_defined?('AppPointRules')
+  end
+
   class Configuration
     attr_accessor :checks_on_each_request, :orm, :user_model_name, :observers,
                   :current_user_method
@@ -61,32 +71,25 @@ module Merit
     config.app_generators.orm Merit.orm
 
     initializer 'merit.controller' do |app|
-      extend_orm_with_has_merit
-      ActiveSupport.on_load(action_controller_hook) do
-        begin
-          # 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
-          raise e unless
-            e.to_s =~ /uninitialized constant Merit::(BadgeRules|PointRules)/
+      config.to_prepare do
+        ActiveSupport.on_load(:active_record) { include Merit }
+        ActiveSupport.on_load(app.config.api_only ? :action_controller_api : :action_controller_base) do
+          begin
+            # Remove previous definitions of constant if they are defined when app reloads
+            Merit.remove_badge_rules
+            Merit.remove_point_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
+            raise e unless
+              e.to_s =~ /uninitialized constant Merit::(BadgeRules|PointRules)/
+          end
         end
       end
     end
-
-    def extend_orm_with_has_merit
-      ActiveRecord::Base.include(Merit)
-    end
-
-    def action_controller_hook
-      if Rails.application.config.api_only
-        :action_controller_api
-      else
-        :action_controller_base
-      end
-    end
   end
 end
 

data/merit.gemspec

@@ -6,7 +6,7 @@ Gem::Specification.new do |s|
   s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
   s.test_files  = `git ls-files -- test/*`.split("\n")
   s.license     = 'MIT'
-  s.version     = '4.0.0'
+  s.version     = '4.0.3'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
@@ -21,4 +21,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rubocop'
   s.add_development_dependency 'minitest-rails'
   s.add_development_dependency 'mocha'
+  s.add_development_dependency 'webrick'
 end

data/test/dummy/db/migrate/20130329224406_create_merit_actions.rb

@@ -10,6 +10,8 @@ class CreateMeritActions < ActiveRecord::Migration[5.0]
       t.boolean :processed, :default => false
       t.timestamps null: false
     end
+
+    add_index :merit_actions, :processed
   end
 
   def self.down

data/test/dummy/db/schema.rb

@@ -2,8 +2,8 @@
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
 #
-# This file is the source Rails uses to define your schema when running `rails
-# db:schema:load`. When creating a new database, `rails db:schema:load` tends to
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
 # be faster and is potentially less error prone than running all of your
 # migrations from scratch. Old migrations may fail to apply correctly if those
 # migrations use external dependencies or application code.
@@ -49,6 +49,7 @@ ActiveRecord::Schema.define(version: 2014_08_19_133931) do
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.text "target_data"
+    t.index ["processed"], name: "index_merit_actions_on_processed"
   end
 
   create_table "merit_activity_logs", force: :cascade do |t|

data/test/integration/navigation_test.rb

@@ -180,7 +180,7 @@ class NavigationTest < ActionDispatch::IntegrationTest
 
     visit "/users/#{user.id}/edit"
     fill_in 'Name', with: 'a'
-    assert_difference('Merit::ActivityLog.count', 2) do
+    assert_difference('Merit::ActivityLog.count', 1) do
       click_button('Update User')
     end
 

data/test/unit/sash_test.rb

@@ -6,6 +6,22 @@ class SashTest < ActiveSupport::TestCase
     @sash = Merit::Sash.create
   end
 
+  describe "#rm_badge" do
+    describe "when has badge" do
+      it "returns truthy" do
+        @sash.badges_sashes.create!(badge_id: 1)
+
+        assert_equal !!@sash.rm_badge(1), true
+      end
+    end
+
+    describe "when does NOT have badge" do
+      it "returns falsey" do
+        assert_equal !!@sash.rm_badge(0), false
+      end
+    end
+  end
+
   describe "#add_points" do
     describe "when category specified" do
       it "should create a new Point with specified category" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: merit
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.3
 platform: ruby
 authors:
 - Tute Costa
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-02 00:00:00.000000000 Z
+date: 2022-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ambry
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webrick
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Manage badges, points and rankings (reputation) in your Rails app.
 email: tutecosta@gmail.com
 executables: []
@@ -265,7 +279,7 @@ homepage: https://github.com/merit-gem/merit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -280,8 +294,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.32
+signing_key:
 specification_version: 4
 summary: Reputation engine for Rails apps
 test_files: