merit 3.0.3 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a847a60ecad264aa85e3118fa9e26a974de2e08142577fe134c12e48c4989faf
-  data.tar.gz: 7f219282c0e6c4f33e10f2b77040ef19dbec9874e11140c47cc216fb17c9665b
+  metadata.gz: 1163ea7681b5daca51eb89a7785bc648fe86ddbefff1a05cdc765c20c9b91973
+  data.tar.gz: 1329168f700f69f1d0eff4ca196ed511302b7839745eb8ed58bb5bb277cd5d51
 SHA512:
-  metadata.gz: 8b2714cb9b1c672ba79a1d1034ac6f53bf66c544d568d358c2fe98f3a42801589db9a1213c7eb36abe03a51f8392b4929d52db06549d8786d6b7bfe125e48486
-  data.tar.gz: 2c062006a8352ad9bc7bce01db34851a30e4b7b8fce7de19c6dc4377366e743832ad0507e88b498ba1ed9f6f498e787ebddbb6f2c27577d1870c2dd08d0e6679
+  metadata.gz: 2e112a21e6ada4964c86c7253c72bc4235f4ab478a876badfa27cf1d60d2cea3ec297f234219100bc9049e50ea859860a7d6c3f504dcca86b8424da3aa28e007
+  data.tar.gz: 39f8af732714702142e9b0f279c63b7aa528113fd81f39df99f94ae09ca0320e9a2f52b230dd919bedc9e42f5947aed9ad656df89c84c9bc09a56cdacd7e8438

data/Gemfile

@@ -4,16 +4,8 @@ gemspec
 
 gem 'rails', "~> #{ENV.fetch('RAILS_VERSION', 6.0)}"
 
-case ENV['ORM']
-when 'active_record'
-  gem 'activerecord'
-when 'mongoid'
-  gem 'mongoid'
-end
-
 group :development, :test do
-  gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
   gem 'sqlite3', '~> 1.4'
 end
 
-gem 'coveralls', require: false
+gem 'coveralls', '~> 0.8.23', require: false

data/NEWS.md

@@ -2,6 +2,31 @@
 
 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
+- Drop support for mongoid
+- Drop v2 upgrade generators
+- Enable Zeitwerk gem mode (and renames internal merit constants)
+
 ## 3.0.3
 
 - Test against Ruby 2.6 and Rails 6

data/README.md

@@ -38,8 +38,7 @@ and Rankings.
 2. Run `rails g merit:install`. This creates several migrations.
 3. Run `rails g merit MODEL_NAME` (e.g. `user`). This creates a migration and adds `has_merit` to MODEL_NAME.
 4. Run `rake db:migrate`
-5. Define badges in `config/initializers/merit.rb`. You can also define ORM:
-   `:active_record` (default) or `:mongoid`.
+5. Define badges in `config/initializers/merit.rb`
 6. Configure reputation rules for your application in `app/models/merit/*`
 
 
@@ -59,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
@@ -114,6 +117,19 @@ grant_on ['users#create', 'users#update'], badge: 'autobiographer', temporary: t
 end
 ```
 
+If your controller is under a namespace other than root (example:
+`Api::ModelController`) then for merit to find your object automatically you
+must specify the model class and not forget that your action is of the form
+`namespace/models#action`.
+
+See an example of a `Post` model that belongs to user:
+
+```ruby
+grant_on 'api/posts#create', badge: 'first-post', model_name: 'Post', to: :user do |post|
+  post.user.posts.count >= 1
+end
+```
+
 ## Other Actions
 
 ```ruby
@@ -293,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:
@@ -325,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/app/models/merit/badge.rb

@@ -26,14 +26,6 @@ module Merit
       end
     end
 
-    def _mongoid_sash_in(sashes)
-      {:sash_id.in => sashes}
-    end
-
-    def _active_record_sash_in(sashes)
-      {sash_id: sashes}
-    end
-
     class << self
       def find_by_name_and_level(name, level)
         badges = Merit::Badge.by_name(name)
@@ -51,7 +43,7 @@ module Merit
       def _define_related_entries_method(meritable_class_name)
         define_method(:"#{meritable_class_name.underscore.pluralize}") do
           sashes = BadgesSash.where(badge_id: id).pluck(:sash_id)
-          meritable_class_name.constantize.where(send "_#{Merit.orm}_sash_in", sashes)
+          meritable_class_name.constantize.where(sash_id: sashes)
         end
       end
     end

data/lib/merit/base_target_finder.rb

@@ -25,12 +25,7 @@ module Merit
     end
 
     def reanimate_target_from_action
-      if @action.respond_to? :target_data
-        YAML.load(@action.target_data)
-      else
-        Merit.upgrade_target_data_warning
-        nil
-      end
+      YAML.load(@action.target_data)
     end
   end
 end

data/lib/merit/{model_additions.rb → class_methods.rb}

@@ -9,7 +9,6 @@ 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, class_name: 'Merit::Sash', inverse_of: nil, optional: true
 
-      send :"_merit_#{Merit.orm}_specific_config"
       _merit_delegate_methods_to_sash
       _merit_define_badge_related_entries_method
       _merit_sash_initializer
@@ -22,16 +21,6 @@ module Merit
       methods.each { |method| delegate method, to: :_sash }
     end
 
-    def _merit_active_record_specific_config
-    end
-
-    def _merit_mongoid_specific_config
-      field :level, type: Integer, default: 0
-      def find_by_id(id)
-        where(_id: id).first
-      end
-    end
-
     def _merit_define_badge_related_entries_method
       meritable_class_name = name.demodulize
       Merit::Badge._define_related_entries_method(meritable_class_name)

data/lib/merit/controller_extensions.rb

@@ -27,16 +27,8 @@ module Merit
         had_errors:    had_errors?,
         target_model:  controller_path,
         target_id:     target_id,
-      }.merge(target_data_hash)
-    end
-
-    def target_data_hash
-      if Merit::Action.new.respond_to?(:target_data)
-        { target_data: target_object.to_yaml }
-      else
-        Merit.upgrade_target_data_warning
-        {}
-      end
+        target_data:   target_object.to_yaml,
+      }
     end
 
     def rules_defined?
@@ -69,21 +61,11 @@ module Merit
 
     def target_id
       target_id = target_object.try(:id)
-      # If target_id is nil
-      # then use params[:id].
-      if target_id.nil? && send("check_#{Merit.orm}_id", params[:id])
+      # If target_id is nil use (only digits of) params[:id]
+      if target_id.nil? && params[:id].to_s =~ /^[0-9]+$/
         target_id = params[:id]
       end
       target_id
     end
-
-    # This check avoids trying to set a slug as integer FK
-    def check_active_record_id(id)
-      id.to_s =~ /^[0-9]+$/
-    end
-
-    def check_mongoid_id(id)
-      id.to_s =~ /^[0-9a-fA-F]{24}$/
-    end
   end
 end

data/lib/{generators → merit/generators}/active_record/install_generator.rb

@@ -1,8 +1,8 @@
 require 'rails/generators/active_record'
 
-module ActiveRecord
-  module Generators
-    class InstallGenerator < Rails::Generators::Base
+module Merit
+  module Generators::ActiveRecord
+    class InstallGenerator < ::Rails::Generators::Base
       include Rails::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
@@ -13,19 +13,19 @@ module ActiveRecord
       end
 
       def copy_migrations_and_model
-        migration_template 'create_merit_actions.rb',
+        migration_template 'create_merit_actions.erb',
                            'db/migrate/create_merit_actions.rb'
 
-        migration_template 'create_merit_activity_logs.rb',
+        migration_template 'create_merit_activity_logs.erb',
                            'db/migrate/create_merit_activity_logs.rb'
 
-        migration_template 'create_sashes.rb',
+        migration_template 'create_sashes.erb',
                            'db/migrate/create_sashes.rb'
 
-        migration_template 'create_badges_sashes.rb',
+        migration_template 'create_badges_sashes.erb',
                            'db/migrate/create_badges_sashes.rb'
 
-        migration_template 'create_scores_and_points.rb',
+        migration_template 'create_scores_and_points.erb',
                            'db/migrate/create_scores_and_points.rb'
       end
 

data/lib/{generators → merit/generators}/active_record/merit_generator.rb

@@ -1,8 +1,8 @@
 require 'rails/generators/active_record'
 
-module ActiveRecord
-  module Generators
-    class MeritGenerator < ActiveRecord::Generators::Base
+module Merit
+  module Generators::ActiveRecord
+    class MeritGenerator < ::ActiveRecord::Generators::Base
       include Rails::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
@@ -13,7 +13,7 @@ module ActiveRecord
       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/{generators → merit/generators}/active_record/remove_generator.rb

@@ -1,8 +1,8 @@
 require 'rails/generators/active_record'
 
-module ActiveRecord
-  module Generators
-    class RemoveGenerator < ActiveRecord::Generators::Base
+module Merit
+  module Generators::ActiveRecord
+    class RemoveGenerator < ::ActiveRecord::Generators::Base
       include Rails::Generators::Migration
 
       source_root File.expand_path('../templates', __FILE__)
@@ -13,11 +13,11 @@ module ActiveRecord
       end
 
       def copy_migrations_and_model
-        migration_template 'remove_merit_tables.rb',
+        migration_template 'remove_merit_tables.erb',
                            'db/migrate/remove_merit_tables.rb'
 
         migration_template(
-          'remove_merit_fields_from_model.rb',
+          'remove_merit_fields_from_model.erb',
           "db/migrate/remove_merit_fields_from_#{table_name}.rb"
         )
       end

data/lib/{generators/active_record/templates/create_merit_actions.rb → 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/{generators/active_record/templates/create_scores_and_points.rb → merit/generators/active_record/templates/create_scores_and_points.erb}

@@ -7,7 +7,7 @@ class CreateScoresAndPoints < ActiveRecord::Migration<%= migration_version %>
 
     create_table :merit_score_points do |t|
       t.references :score
-      t.integer :num_points, default: 0
+      t.bigint :num_points, default: 0
       t.string :log
       t.datetime :created_at
     end

data/lib/merit/generators/install_generator.rb

@@ -0,0 +1,21 @@
+require "rails/generators"
+
+module Merit
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      desc 'Copy config and rules files'
+      def copy_migrations_and_model
+        template 'merit.erb', 'config/initializers/merit.rb'
+        template 'merit_badge_rules.erb', 'app/models/merit/badge_rules.rb'
+        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/{generators/merit → merit/generators}/merit_generator.rb

@@ -1,8 +1,9 @@
+require "rails/generators"
+
 module Merit
   module Generators
-    class MeritGenerator < Rails::Generators::NamedBase
+    class MeritGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path('../templates', __FILE__)
-      hook_for :orm
 
       def inject_merit_content
         if model_exists?
@@ -10,6 +11,10 @@ module Merit
         end
       end
 
+      def run_active_record_generators
+        invoke 'merit:active_record:merit'
+      end
+
       private
 
       def model_exists?

data/lib/{generators/merit → merit/generators}/remove_generator.rb

@@ -1,8 +1,13 @@
+require "rails/generators"
+
 module Merit
   module Generators
-    class RemoveGenerator < Rails::Generators::NamedBase
+    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/{generators/merit/templates/merit.rb → merit/generators/templates/merit.erb}

@@ -3,13 +3,10 @@ Merit.setup do |config|
   # Check rules on each request or in background
   # config.checks_on_each_request = true
 
-  # Define ORM. Could be :active_record (default) and :mongoid
-  # config.orm = :active_record
-
   # 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'
 
@@ -20,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/{app/models/merit/action.rb → lib/merit/models/action_concern.rb}

@@ -1,5 +1,3 @@
-require_dependency "merit/models/#{Merit.orm}/merit/action"
-
 # Merit::Action general schema
 #   ______________________________________________________________
 #   source  | action       | target
@@ -12,10 +10,14 @@ require_dependency "merit/models/#{Merit.orm}/merit/action"
 #   ______________________________________________________________
 #
 # Rules relate to merit_actions by action name ('controller#action' string)
-module Merit
-  class Action
-    def self.check_unprocessed
-      where(processed: false).find_each(&:check_all_rules)
+module Merit::Models
+  module ActionConcern
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def check_unprocessed
+        where(processed: false).find_each(&:check_all_rules)
+      end
     end
 
     # Check rules defined for a merit_action
@@ -23,16 +25,16 @@ module Merit
       mark_as_processed!
       return if had_errors
 
-      check_rules rules_matcher.select_from(AppBadgeRules), :badges
-      check_rules rules_matcher.select_from(AppPointRules), :points
+      check_rules rules_matcher.select_from(Merit::AppBadgeRules), :badges
+      check_rules rules_matcher.select_from(Merit::AppPointRules), :points
     end
 
     private
 
     def check_rules(rules_array, badges_or_points)
       rules_array.each do |rule|
-        judge = Judge.new rule, action: self
-        judge.send :"apply_#{badges_or_points}"
+        judge = Merit::Judge.new(rule, action: self)
+        judge.public_send(:"apply_#{badges_or_points}")
       end
     end
 

data/lib/merit/models/active_record/{merit/action.rb → action.rb}

@@ -1,7 +1,11 @@
-module Merit
+module Merit::Models::ActiveRecord
   class Action < ActiveRecord::Base
+    include Merit::Models::ActionConcern
+
     self.table_name = :merit_actions
 
     has_many :activity_logs, class_name: 'Merit::ActivityLog'
   end
 end
+
+class Merit::Action < Merit::Models::ActiveRecord::Action; end

data/lib/merit/models/active_record/{merit/activity_log.rb → activity_log.rb}

@@ -1,4 +1,4 @@
-module Merit
+module Merit::Models::ActiveRecord
   class ActivityLog < ActiveRecord::Base
     self.table_name = :merit_activity_logs
 
@@ -7,3 +7,5 @@ module Merit
     has_one :sash, through: :related_change
   end
 end
+
+class Merit::ActivityLog < Merit::Models::ActiveRecord::ActivityLog; end

data/lib/merit/models/active_record/{merit/badges_sash.rb → badges_sash.rb}

@@ -1,6 +1,6 @@
-module Merit
+module Merit::Models::ActiveRecord
   class BadgesSash < ActiveRecord::Base
-    include Base::BadgesSash
+    include Merit::Models::BadgesSashConcern
 
     has_many :activity_logs,
              class_name: 'Merit::ActivityLog',
@@ -9,3 +9,5 @@ module Merit
     validates_presence_of :badge_id, :sash
   end
 end
+
+class Merit::BadgesSash < Merit::Models::ActiveRecord::BadgesSash; end

data/lib/merit/models/active_record/{merit/sash.rb → sash.rb}

@@ -1,4 +1,4 @@
-module Merit
+module Merit::Models::ActiveRecord
   # 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).
@@ -6,7 +6,8 @@ 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
+    include Merit::Models::SashConcern
+
     has_many :badges_sashes, dependent: :destroy
     has_many :scores, dependent: :destroy, class_name: 'Merit::Score'
 
@@ -27,3 +28,5 @@ module Merit
     end
   end
 end
+
+class Merit::Sash < Merit::Models::ActiveRecord::Sash; end

data/lib/merit/models/active_record/{merit/score.rb → score.rb}

@@ -1,4 +1,4 @@
-module Merit
+module Merit::Models::ActiveRecord
   class Score < ActiveRecord::Base
     self.table_name = :merit_scores
     belongs_to :sash
@@ -20,3 +20,6 @@ module Merit
     end
   end
 end
+
+class Merit::Score < Merit::Models::ActiveRecord::Score; end
+class Merit::Score::Point < Merit::Models::ActiveRecord::Score::Point; end

data/lib/merit/models/badges_sash_concern.rb

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

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

@@ -1,5 +1,5 @@
 module Merit
-  module Base
+  module Models::Base
     module BadgesSash
       extend ActiveSupport::Concern
 

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

@@ -1,5 +1,5 @@
 module Merit
-  module Base
+  module Models::Base
     module Sash
       def badges
         badge_ids.map { |id| Merit::Badge.find id }