merit 3.0.3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a847a60ecad264aa85e3118fa9e26a974de2e08142577fe134c12e48c4989faf
-  data.tar.gz: 7f219282c0e6c4f33e10f2b77040ef19dbec9874e11140c47cc216fb17c9665b
+  metadata.gz: f0ee557f98d45fe9a83d5de23d407e2b36f85f6a5d4204b1ed89fec8bf5c90fb
+  data.tar.gz: ae393531c2a569a8aece0d533523aaa6fa6e407c4fe4aa3efe96f49d349b3d37
 SHA512:
-  metadata.gz: 8b2714cb9b1c672ba79a1d1034ac6f53bf66c544d568d358c2fe98f3a42801589db9a1213c7eb36abe03a51f8392b4929d52db06549d8786d6b7bfe125e48486
-  data.tar.gz: 2c062006a8352ad9bc7bce01db34851a30e4b7b8fce7de19c6dc4377366e743832ad0507e88b498ba1ed9f6f498e787ebddbb6f2c27577d1870c2dd08d0e6679
+  metadata.gz: c4b48c33d57774076e00d9732ccac73dbb71b1ee1efe87329ba9ee542593e1a8c3823bef1c5c783a45ed46b28cc3eda4626ddefe9683682341ccc8d51bcf9889
+  data.tar.gz: 0e886c1d895343875d06c537015d4ae14b0723f96d8ddac2a264892b7a3aee0d821f7e6ccb404f68371ac9ca9d5adad78f211b1943747a9bc6dc53361efd6cb6

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,13 @@
 
 User-visible changes worth mentioning.
 
+## 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/*`
 
 
@@ -114,6 +113,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

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.rb

@@ -1,17 +1,4 @@
-require 'merit/rule'
-require 'merit/rules_badge_methods'
-require 'merit/rules_points_methods'
-require 'merit/rules_rank_methods'
-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'
-require 'merit/models/base/sash'
-require 'merit/models/base/badges_sash'
+require 'zeitwerk'
 
 module Merit
   def self.setup
@@ -24,7 +11,6 @@ module Merit
     @config.checks_on_each_request
   end
 
-  # # Define ORM
   def self.orm
     @config.orm || :active_record
   end
@@ -49,11 +35,6 @@ module Merit
     @config.add_observer(class_name)
   end
 
-  def self.upgrade_target_data_warning
-    Rails.logger.warn '[merit] Missing column: target_data. Run `rails ' \
-                      'generate merit:upgrade` and `rake db:migrate` to add it.'
-  end
-
   class Configuration
     attr_accessor :checks_on_each_request, :orm, :user_model_name, :observers,
                   :current_user_method
@@ -81,7 +62,6 @@ module Merit
 
     initializer 'merit.controller' do |app|
       extend_orm_with_has_merit
-      require_models
       ActiveSupport.on_load(action_controller_hook) do
         begin
           # Load app rules on boot up
@@ -96,22 +76,8 @@ module Merit
       end
     end
 
-    def require_models
-      require 'merit/models/base/sash'
-      require 'merit/models/base/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
+      ActiveRecord::Base.include(Merit)
     end
 
     def action_controller_hook
@@ -123,3 +89,7 @@ module Merit
     end
   end
 end
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+loader.eager_load

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__)

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_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,18 @@
+require "rails/generators"
+
+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
+        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
+    end
+  end
+end

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

@@ -1,6 +1,8 @@
+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
 

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

@@ -1,6 +1,8 @@
+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
 

data/lib/{generators/merit/templates/merit.rb → merit/generators/templates/merit.erb}

@@ -3,9 +3,6 @@ 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'
 

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