merit 3.0.3 → 4.0.3

data/lib/merit/models/sash_concern.rb

@@ -0,0 +1,53 @@
+module Merit::Models
+  module SashConcern
+    def badges
+      badge_ids.map { |id| Merit::Badge.find id }
+    end
+
+    def badge_ids
+      badges_sashes.map(&:badge_id)
+    end
+
+    def add_badge(badge_id)
+      bs = Merit::BadgesSash.new(badge_id: badge_id.to_i)
+      badges_sashes << bs
+      bs
+    end
+
+    def rm_badge(badge_id)
+      badges_sashes.where(badge_id: badge_id.to_i).first.try(:destroy)
+    end
+
+    # Retrieve the number of points from a category
+    # By default all points are summed up
+    # @param category [String] The category
+    # @return [Integer] The number of points
+    def points(options = {})
+      if (category = options[:category])
+        scores.where(category: category).first.try(:points) || 0
+      else
+        scores.reduce(0) { |sum, score| sum + score.points }
+      end
+    end
+
+    def add_points(num_points, options = {})
+      point = Merit::Score::Point.new
+      point.num_points = num_points
+      scores
+        .where(category: options[:category] || 'default')
+        .first_or_create
+        .score_points << point
+      point
+    end
+
+    def subtract_points(num_points, options = {})
+      add_points(-num_points, options)
+    end
+
+    private
+
+    def create_scores
+      scores << Merit::Score.create
+    end
+  end
+end

data/lib/merit/{rules_rank_methods.rb → rank_rules_methods.rb}

@@ -44,30 +44,15 @@ module Merit
     private
 
     def grant_when_applies(scoped_model, rule, level)
-      scope_to_promote(scoped_model, rule.level_name, level).each do |object|
+      scoped_model.where("#{rule.level_name} < #{level}").each do |object|
         next unless rule.applies?(object)
+
         object.update_attribute rule.level_name, level
       end
-    rescue rank_exception
+    rescue ActiveRecord::StatementInvalid
       str = "Error while granting rankings. Probably you need to add
         #{rule.level_name} column to #{scoped_model.class.name}."
       raise RankAttributeNotDefined, str
     end
-
-    def rank_exception
-      if defined? ActiveRecord
-        ActiveRecord::StatementInvalid
-      else
-        Exception
-      end
-    end
-
-    def scope_to_promote(scope, level_name, level)
-      if Merit.orm == :mongoid
-        scope.where(:"#{level_name}".lt => level)
-      else
-        scope.where("#{level_name} < #{level}")
-      end
-    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,9 +35,14 @@ 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.'
+  # 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
@@ -80,46 +71,28 @@ module Merit
     config.app_generators.orm Merit.orm
 
     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
-          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 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
-    end
-
-    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/merit.gemspec

@@ -6,17 +6,20 @@ 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     = '3.0.3'
+  s.version     = '4.0.3'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
   s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'ambry', '~> 1.0.0'
+  s.add_runtime_dependency 'ambry', '~> 1.0.0'
+  s.add_runtime_dependency 'zeitwerk'
+
   s.add_development_dependency 'rails', '>= 5.1.6'
   s.add_development_dependency 'capybara'
   s.add_development_dependency 'simplecov'
   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/app/models/address.rb

@@ -1,14 +1,3 @@
-case Merit.orm
-when :active_record
-  class Address < ActiveRecord::Base
-  end
-when :mongoid
-  class Address
-    include Mongoid::Document
-    include Mongoid::Timestamps
-  end
-end
-
-class Address
+class Address < ActiveRecord::Base
   belongs_to :user
 end

data/test/dummy/app/models/comment.rb

@@ -1,26 +1,8 @@
-case Merit.orm
-when :active_record
-  class Comment < ActiveRecord::Base
-    def friend
-      User.find_by_name('friend')
-    end
+class Comment < ActiveRecord::Base
+  def friend
+    User.find_by_name('friend')
   end
-when :mongoid
-  class Comment
-    include Mongoid::Document
-    include Mongoid::Timestamps
 
-    field :name, :type => String
-    field :comment, :type => String
-    field :votes, :type => Integer, :default => 0
-
-    def friend
-      User.find_by(name: 'friend')
-    end
-  end
-end
-
-class Comment
   has_merit
 
   belongs_to :user

data/test/dummy/app/models/user.rb

@@ -1,17 +1,4 @@
-case Merit.orm
-when :active_record
-  class User < ActiveRecord::Base
-  end
-when :mongoid
-  class User
-    include Mongoid::Document
-    include Mongoid::Timestamps
-
-    field :name, :type => String
-  end
-end
-
-class User
+class User < ActiveRecord::Base
   has_merit
 
   has_many :addresses

data/test/dummy/config/application.rb

@@ -10,11 +10,15 @@ Bundler.require
 require "merit"
 
 module Dummy
-  class Application < Rails::Application
+  class Application < ::Rails::Application
     if Rails.version.match? "5.2.+"
       config.active_record.sqlite3.represent_boolean_as_integer = true
     end
 
+    if Rails.version.match? "6.0.+"
+      config.load_defaults "6.0"
+    end
+
     config.i18n.enforce_available_locales = true
     config.encoding = "utf-8"
     config.filter_parameters += [:password]

data/test/dummy/config/application_api_only.rb

@@ -19,7 +19,7 @@ Bundler.require
 require "merit"
 
 module Dummy
-  class Application < Rails::Application
+  class Application < ::Rails::Application
     config.load_defaults 5.2 if ENV["RAILS_VERSION"] =~ /^5.2/
     config.api_only = true
     config.i18n.enforce_available_locales = true

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,15 +2,15 @@
 # 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.
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 2014_09_06_225844) do
+ActiveRecord::Schema.define(version: 2014_08_19_133931) do
 
   create_table "addresses", force: :cascade do |t|
     t.integer "user_id"
@@ -49,6 +49,7 @@ ActiveRecord::Schema.define(version: 2014_09_06_225844) 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|
@@ -73,11 +74,6 @@ ActiveRecord::Schema.define(version: 2014_09_06_225844) do
     t.index ["sash_id"], name: "index_merit_scores_on_sash_id"
   end
 
-  create_table "players", force: :cascade do |t|
-    t.integer "sash_id"
-    t.integer "level", default: 0
-  end
-
   create_table "sashes", force: :cascade do |t|
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false

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
 
@@ -305,8 +305,8 @@ class NavigationTest < ActionDispatch::IntegrationTest
       end
     end
 
-    comment_1.reload.points.must_be :==, 2
-    comment_2.reload.points.must_be :==, 2
+    _(comment_1.reload.points).must_be :==, 2
+    _(comment_2.reload.points).must_be :==, 2
   end
 
   test 'api/comments#show should grant 1 point to user' do

data/test/test_helper.rb

@@ -38,5 +38,3 @@ Capybara.default_selector = :css
 
 # Load support files
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each { |f| require f }
-
-Merit.orm = :active_record if Merit.orm.nil?

data/test/unit/base_target_finder_test.rb

@@ -14,7 +14,7 @@ describe Merit::BaseTargetFinder do
 
         finder = Merit::BaseTargetFinder.new(rule, action)
         collection = finder.find
-        collection.must_be :==, comment
+        _(collection).must_be :==, comment
       end
     end
 
@@ -22,13 +22,13 @@ describe Merit::BaseTargetFinder do
       it 'should fall back to the action#target_model' do
         rule = Merit::Rule.new
         rule.to = :itself
-        action = Merit::Action.new(target_model: 'players', target_id: 3)
-        user = Player.new(id: 3)
+        action = Merit::Action.new(target_model: 'users', target_id: 3)
+        user = User.new(id: 3)
 
-        Player.stubs(:find_by_id).with(3).returns(user)
+        User.stubs(:find_by_id).with(3).returns(user)
 
         finder = Merit::BaseTargetFinder.new(rule, action)
-        finder.find.must_be :==, user
+        _(finder.find).must_be :==, user
       end
     end
 
@@ -41,7 +41,7 @@ describe Merit::BaseTargetFinder do
 
         finder = Merit::BaseTargetFinder.new(rule, action)
         Rails.logger.expects(:warn)
-        finder.find.must_be_nil
+        _(finder.find).must_be_nil
       end
     end
 
@@ -57,26 +57,7 @@ describe Merit::BaseTargetFinder do
                                    target_data: comment.to_yaml)
 
         finder = Merit::BaseTargetFinder.new(rule, action)
-        finder.find.name.must_be :==, 'the comment name'
-      end
-    end
-
-    describe 'warns when the target_data column has not been created' do
-      it 'sends a message to the logger' do
-        comment = Comment.new(name: 'the comment name')
-
-        rule = Merit::Rule.new
-        rule.to = :itself
-        rule.model_name = 'comment'
-        action = Merit::Action.new(target_model: 'comment',
-                                   target_id: 2,
-                                   target_data: comment.to_yaml)
-        action.stubs(:respond_to?).with(:target_data).returns(false)
-
-        Rails.logger.expects(:warn)
-
-        finder = Merit::BaseTargetFinder.new(rule, action)
-        finder.reanimate_target_from_action
+        _(finder.find.name).must_be :==, 'the comment name'
       end
     end
   end

data/test/unit/merit_unit_test.rb

@@ -1,24 +1,22 @@
 require 'test_helper'
 
-# TODO: Split different objects tests in it's own files
 class MeritUnitTest < ActiveSupport::TestCase
-  require "orm_models/#{Merit.orm}"
-
   test 'extends only meritable models' do
-    assert Player.method_defined?(:points), 'has_merit adds methods'
-    assert !Fruit.method_defined?(:points), 'other models aren\'t extended'
+    assert User.method_defined?(:points), 'has_merit adds methods'
+    assert !Address.method_defined?(:points), 'other models aren\'t extended'
   end
 
   test 'Badges get "related_models" methods' do
-    assert Merit::Badge.method_defined?(:soldiers), 'Badge#soldiers should be defined'
-    assert Merit::Badge.method_defined?(:players), 'Badge#players should be defined'
+    Comment.new; User.new # load meritable classes
+    assert Merit::Badge.method_defined?(:comments), 'Badge#comments should be defined'
+    assert Merit::Badge.method_defined?(:users), 'Badge#users should be defined'
   end
 
   test 'unknown ranking raises exception' do
     class WeirdRankRules
       include Merit::RankRulesMethods
       def initialize
-        set_rank level: 1, to: Player, level_name: :clown
+        set_rank level: 1, to: User, level_name: :clown
       end
     end
     assert_raises Merit::RankAttributeNotDefined do

data/test/unit/rule_unit_test.rb

@@ -11,47 +11,47 @@ describe Merit::Rule do
     end
 
     it 'truthy block should make rule apply' do
-      @rule.applies?('str').must_be :==, true
+      _(@rule.applies?('str')).must_be :==, true
     end
 
     it 'falsy block should make rule fail' do
-      @rule.applies?('string').must_be :==, false
+      _(@rule.applies?('string')).must_be :==, false
     end
 
     it 'block needs parameter for rule to pass' do
-      @rule.applies?.must_be :==, false
+      _(@rule.applies?).must_be :==, false
     end
   end
 
   describe '#applies (without block)' do
     it 'empty condition should make rule apply' do
-      @rule.applies?.must_be :==, true
+      _(@rule.applies?).must_be :==, true
     end
   end
 
   describe '#badge' do
     it 'raises exception on inexistent badge' do
       @rule.badge_name = 'inexistent'
-      -> { @rule.badge }.must_raise Merit::BadgeNotFound
+      _(-> { @rule.badge }).must_raise Merit::BadgeNotFound
     end
 
     it 'finds related badge by name, when the name is a string' do
       Merit::Badge.create(id: 98, name: 'test-badge-98')
       @rule.badge_name = "test-badge-98"
-      @rule.badge.must_be :==, Merit::Badge.find(98)
+      _(@rule.badge).must_be :==, Merit::Badge.find(98)
     end
 
     it 'finds related badge by name, when the name is a symbol' do
       Merit::Badge.create(id: 100, name: :testbadge)
       @rule.badge_name = 'testbadge'
-      @rule.badge.must_be :==, Merit::Badge.find(100)
+      _(@rule.badge).must_be :==, Merit::Badge.find(100)
       @rule.badge
     end
 
     it 'finds related badge by name' do
       Merit::Badge.create(id: 98, name: 'test-badge-98')
       @rule.badge_id = 98
-      @rule.badge.must_be :==, Merit::Badge.find(98)
+      _(@rule.badge).must_be :==, Merit::Badge.find(98)
     end
   end
 end

data/test/unit/rules_matcher_test.rb

@@ -5,29 +5,32 @@ describe Merit::RulesMatcher do
   describe 'rules actions are treated as a regexp' do
     it 'selects matching rules (suffix)' do
       matcher = Merit::RulesMatcher.new('comments', 'update')
-      matcher.select_from(
+      selected = matcher.select_from(
         'comments#update' => 'comments#update',
         'comments#up'     => 'comments#up',
         'comments#up$'   => 'comments#up$',
         'comments#up.+$' => 'comments#up.+$',
-      ).must_be :==, ['comments#update', 'comments#up.+$']
+      )
+      _(selected).must_be :==, ['comments#update', 'comments#up.+$']
 
       matcher = Merit::RulesMatcher.new('comments', 'up')
-      matcher.select_from(
+      selected = matcher.select_from(
         'comments#update' => 'comments#update',
         'comments#up'     => 'comments#up',
         'comments#up$'   => 'comments#up$',
         'comments#up.+$' => 'comments#up.+$',
-      ).must_be :==, ['comments#up', 'comments#up$']
+      )
+      _(selected).must_be :==, ['comments#up', 'comments#up$']
     end
 
     it 'selects matching rules (prefix)' do
       matcher = Merit::RulesMatcher.new('/posts/1/comments', 'create')
-      matcher.select_from(
+      selected = matcher.select_from(
         'comments#create' => 'comments#create',
         '^comments#create' => '^comments#create',
         '^.*/comments#create' => '^.*/comments#create',
-      ).must_be :==, ['^.*/comments#create']
+      )
+      _(selected).must_be :==, ['^.*/comments#create']
     end
   end
 

data/test/unit/sash_finder_test.rb

@@ -3,11 +3,11 @@ require 'test_helper'
 describe Merit::SashFinder do
   it 'should return an array of sashes of the target objects' do
     sash_1 = Merit::Sash.new
-    user_1 = Player.new
+    user_1 = User.new
     user_1.stubs(:_sash).returns(sash_1)
 
     sash_2 = Merit::Sash.new
-    user_2 = Player.new
+    user_2 = User.new
     user_2.stubs(:_sash).returns(sash_2)
 
     # TODO: With stub we are not exercising compact
@@ -20,8 +20,8 @@ describe Merit::SashFinder do
 
     Merit::SashFinder.stubs(:targets).returns(users)
     sashes = Merit::SashFinder.find(rule, action)
-    sashes.count.must_be :==, 2
-    sashes.must_include sash_1
-    sashes.must_include sash_2
+    _(sashes.count).must_be :==, 2
+    _(sashes).must_include sash_1
+    _(sashes).must_include sash_2
   end
 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

data/test/unit/score_test.rb

@@ -8,6 +8,6 @@ describe Merit::Score do
     point = Merit::Score::Point.new
     point.score = score
 
-    point.sash_id.must_be :==, score.sash_id
+    _(point.sash_id).must_be :==, score.sash_id
   end
 end