merit 3.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c2cb7b1562ee27518561243969673e6bc9796f4
-  data.tar.gz: ac96051e01a3ad6223ebc0a84ffa7d0f7845dc67
+SHA256:
+  metadata.gz: 81342bb2e6b393dca1eed04fb9918e964d7add7e4a5144da975deb98fa05651e
+  data.tar.gz: 6b942ef093394de05ad17ddc74b2c802ed3e4e648f4452b1497b0e1a3521eefb
 SHA512:
-  metadata.gz: 74b144eb96c51f83aacb529ac9d87962e9fed9e48f6af0da365b00df773597c28f79a66f8ab3048df3c9042a62e46371442661123b4321f0a9d333fa8f97ed67
-  data.tar.gz: 1022b3357c719d183dfa1b2b068943fecefa009263aeed1905d051310c29e644333c087cadbd5eec433d0542a11abf5174121c38f003d6b657e937895345ca44
+  metadata.gz: 9054350196c3dbb3d9a4542519a100f1ee1f34bc8bd2374de067fea912910afb1d795c78bd120e9b5007c2032dd0aecb4d113e21d7470232f00be15c2fe41c88
+  data.tar.gz: e86554c92ac022a624a911a2e5cdb81562cde41babc2c2fa195aa78e4c264ef389db106c5907ba05f7db6bb4f4ce9a276d57d49b34d78138eee6c633dbed655c

data/Gemfile

@@ -2,27 +2,10 @@ source 'https://rubygems.org'
 
 gemspec
 
-version = ENV['RAILS_VERSION'] || '5.0.3'
-gem 'rails', version
-
-case ENV['ORM']
-when 'active_record'
-  gem 'activerecord'
-when 'mongoid'
-  gem 'mongoid'
-end
+gem 'rails', "~> #{ENV.fetch('RAILS_VERSION', 6.0)}"
 
 group :development, :test do
-  gem 'activerecord-jdbcsqlite3-adapter', :platforms => [:jruby]
-  gem 'sqlite3', '~> 1.3.8', :platforms => [:ruby, :mswin, :mingw]
-end
-
-platforms :rbx do
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-  gem 'racc'
-  gem 'minitest', '~> 5.10', '!= 5.10.2'
-  gem 'rubinius-developer_tools'
+  gem 'sqlite3', '~> 1.4'
 end
 
-gem 'coveralls', require: false
+gem 'coveralls', '~> 0.8.23', require: false

data/NEWS.md

@@ -2,6 +2,36 @@
 
 User-visible changes worth mentioning.
 
+## 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
+- Use `find_each` in favor of `map` in `Merit::Action.check_unprocessed`
+- Allow finding badges defined with symbol names
+- Remove `Badge#last_granted` method (deprecated in merit <2.0)
+
+## 3.0.2
+
+- [#287] Make Sash an optional dependency, fixing issues in Rails 5.1.
+- [#297] Initialize merit once both for API or non-API apps
+- Updates dependencies
+
+## 3.0.1
+
+- [#282] Run action controller load hook only once
+- [#284] Add migration version to active record migrations
+- Add RELEASING.md document
+
 ## 3.0.0
 
 - [#276] Drops Rails <5 version support. Drops deprecated `action_filter` call.

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/RELEASING.md

@@ -0,0 +1,16 @@
+# Releasing
+
+1. Update `NEWS.md` to reflect the changes since last release.
+1. Tag the release: `git tag vVERSION -a -s`. The tag message should contain the
+   appropriate `NEWS.md` subsection.
+1. Push changes: `git push --tags`
+1. Build and publish to rubygems:
+   ```bash
+   gem build merit.gemspec
+   gem push merit-*.gem
+   ```
+
+1. Add a new GitHub release:
+   https://github.com/merit-gem/merit/releases/new?tag=vVERSION
+1. Announce the new release, making sure to say "thank you" to the contributors
+   who helped shape this version!

data/Rakefile

@@ -8,7 +8,11 @@ end
 require 'rake/testtask'
 
 desc 'Default: run tests for all ORMs.'
-task default: :test
+task default: [:setup, :test, :api_test]
+
+task :setup do
+  system "cd test/dummy && rake db:migrate && rake db:test:prepare"
+end
 
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
@@ -17,6 +21,14 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
+Rake::TestTask.new(:api_test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb'].exclude(/navigation_test.rb/)
+  t.verbose = true
+  t.options = '-- -api-only'
+end
+
 begin
   require 'rdoc/task'
   Rake::RDocTask.new(:rdoc) do |rdoc|

data/app/models/merit/badge.rb

@@ -18,7 +18,7 @@ module Merit
       end
 
       def by_name(name)
-        find { |b| b.name == name.to_s }
+        find { |b| b.name.to_s == name.to_s }
       end
 
       def by_level(level)
@@ -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)
@@ -45,22 +37,13 @@ module Merit
         badge
       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 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)
-      end
-
       # Defines Badge#meritable_models method, to get related
       # entries with certain badge. For instance, Badge.find(3).users
       # orm-specified
       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,8 +62,7 @@ module Merit
 
     initializer 'merit.controller' do |app|
       extend_orm_with_has_merit
-      require_models
-      ActiveSupport.on_load(:action_controller) do
+      ActiveSupport.on_load(action_controller_hook) do
         begin
           # Load app rules on boot up
           Merit::AppBadgeRules = Merit::BadgeRules.new.defined_rules
@@ -96,22 +76,20 @@ 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"
+    def extend_orm_with_has_merit
+      ActiveRecord::Base.include(Merit)
     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
+    def action_controller_hook
+      if Rails.application.config.api_only
+        :action_controller_api
+      else
+        :action_controller_base
       end
     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}

@@ -7,10 +7,8 @@ module Merit
       # That's why MeritableModel belongs_to Sash. Can't use
       # dependent: destroy as it may raise FK constraint exceptions. See:
       # 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
-      attr_accessible :sash if show_attr_accessible?
+      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
@@ -23,26 +21,11 @@ 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)
     end
 
-    def show_attr_accessible?
-      defined?(ProtectedAttributes) ||
-        !defined?(ActionController::StrongParameters)
-    end
-
     # _sash initializes a sash if doesn't have one yet.
     # From Rails 3.2 we can override association methods to do so
     # transparently, but merit supports Rails ~> 3.0.0. See:
@@ -50,7 +33,7 @@ module Merit
     def _merit_sash_initializer
       define_method(:_sash) do
         # TODO: reload.sash is not regression tested
-        sash || reload.sash || update_attributes(sash: Sash.create)
+        sash || reload.sash || update(sash: Sash.create)
         sash
       end
     end

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,21 +13,25 @@ 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
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
     end
   end
 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,9 +13,13 @@ 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
+
+      def migration_version
+        "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+      end
     end
   end
 end