merit 3.0.0 → 4.0.1

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

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

@@ -1,4 +1,4 @@
-class AddMeritFieldsTo<%= table_name.camelize %> < ActiveRecord::Migration
+class AddMeritFieldsTo<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def change
     add_column :<%= table_name %>, :sash_id, :integer
     add_column :<%= table_name %>, :level,   :integer, :default => 0

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

@@ -1,4 +1,4 @@
-class CreateBadgesSashes < ActiveRecord::Migration
+class CreateBadgesSashes < ActiveRecord::Migration<%= migration_version %>
   def self.up
     create_table :badges_sashes do |t|
       t.integer :badge_id, :sash_id

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

@@ -1,4 +1,4 @@
-class CreateMeritActions < ActiveRecord::Migration
+class CreateMeritActions < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :merit_actions do |t|
       t.integer :user_id

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

@@ -1,4 +1,4 @@
-class CreateMeritActivityLogs < ActiveRecord::Migration
+class CreateMeritActivityLogs < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :merit_activity_logs do |t|
       t.integer  :action_id

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

@@ -1,4 +1,4 @@
-class CreateSashes < ActiveRecord::Migration
+class CreateSashes < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :sashes do |t|
       t.timestamps null: false

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

@@ -1,4 +1,4 @@
-class CreateScoresAndPoints < ActiveRecord::Migration
+class CreateScoresAndPoints < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :merit_scores do |t|
       t.references :sash
@@ -7,7 +7,7 @@ class CreateScoresAndPoints < ActiveRecord::Migration
 
     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/{generators/active_record/templates/remove_merit_fields_from_model.rb → merit/generators/active_record/templates/remove_merit_fields_from_model.erb}

@@ -1,4 +1,4 @@
-class RemoveMeritFieldsFrom<%= table_name.camelize %> < ActiveRecord::Migration
+class RemoveMeritFieldsFrom<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
   def self.up
     remove_column :<%= table_name %>, :sash_id
     remove_column :<%= table_name %>, :level

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

@@ -1,4 +1,4 @@
-class RemoveMeritTables < ActiveRecord::Migration
+class RemoveMeritTables < ActiveRecord::Migration<%= migration_version %>
   def self.up
     drop_table :merit_actions
     drop_table :merit_activity_logs

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'
 

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).map(&: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/action.rb

@@ -0,0 +1,11 @@
+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,13 +1,11 @@
-module Merit
+module Merit::Models::ActiveRecord
   class ActivityLog < ActiveRecord::Base
     self.table_name = :merit_activity_logs
 
     belongs_to :action, class_name: 'Merit::Action'
-    belongs_to :related_change, polymorphic: true
+    belongs_to :related_change, polymorphic: true, optional: true
     has_one :sash, through: :related_change
-
-    if show_attr_accessible?
-      attr_accessible :action_id, :related_change, :description, :created_at
-    end
   end
 end
+
+class Merit::ActivityLog < Merit::Models::ActiveRecord::ActivityLog; end

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

@@ -1,13 +1,13 @@
-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',
              as: :related_change
 
     validates_presence_of :badge_id, :sash
-
-    attr_accessible :badge_id if show_attr_accessible?
   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 }

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/merit.gemspec

@@ -6,17 +6,19 @@ 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.0'
+  s.version     = '4.0.1'
   s.authors     = ["Tute Costa"]
   s.email       = 'tutecosta@gmail.com'
 
-  s.required_ruby_version = '>= 2.2.2'
+  s.required_ruby_version = '>= 2.3.0'
 
-  s.add_dependency 'ambry', '~> 1.0.0'
-  s.add_development_dependency 'rails', '>= 5.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', '1.1.0'
+  s.add_development_dependency 'mocha'
 end