qalam_merit 4.0.4

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

@@ -0,0 +1,44 @@
+# encoding: UTF-8
+begin
+    require 'bundler/setup'
+  rescue LoadError
+    puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  end
+  
+  require 'rake/testtask'
+  
+  desc 'Default: run tests for all ORMs.'
+  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'
+    t.libs << 'test'
+    t.pattern = 'test/**/*_test.rb'
+    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|
+      rdoc.rdoc_dir = 'rdoc'
+      rdoc.title    = 'Merit'
+      rdoc.options << '--line-numbers' << '--inline-source'
+      rdoc.rdoc_files.include('README.md')
+      rdoc.rdoc_files.include('lib/**/*.rb')
+    end
+  rescue LoadError
+    puts 'This platform does not support RDocTask'
+  end
+  

data/TESTING.txt

@@ -0,0 +1,12 @@
+# run tests
+rake
+
+# Or spin up self contained testing Rails application
+cd test/dummy
+rails g merit:install
+rails g merit user
+rails g merit comment
+rake db:migrate db:seed
+
+# see it in the browser
+rails server

data/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  merit:
+    granted_badge: "granted %{badge_name} badge"
+    granted_points: "granted %{points} points"
+    removed_badge: "removed %{badge_name} badge"

data/lib/merit.rb

@@ -0,0 +1,95 @@
+require 'zeitwerk'
+
+module Merit
+  def self.setup
+    @config ||= Configuration.new
+    yield @config if block_given?
+  end
+
+  # Check rules on each request
+  def self.checks_on_each_request
+    @config.checks_on_each_request
+  end
+
+  def self.orm
+    @config.orm || :active_record
+  end
+
+  # Define user_model_name
+  def self.user_model
+    @config.user_model_name.constantize
+  end
+
+  # Define current_user_method
+  def self.current_user_method
+    @config.current_user_method ||
+      "current_#{@config.user_model_name.downcase}".to_sym
+  end
+
+  def self.observers
+    @config.observers
+  end
+
+  # @param class_name [String] The string version of observer class
+  def self.add_observer(class_name)
+    @config.add_observer(class_name)
+  end
+
+  class Configuration
+    attr_accessor :checks_on_each_request, :orm, :user_model_name, :observers,
+                  :current_user_method
+
+    def initialize
+      @checks_on_each_request = true
+      @orm = :active_record
+      @user_model_name = 'User'
+      @observers = []
+    end
+
+    def add_observer(class_name)
+      @observers << class_name
+    end
+  end
+
+  setup
+  add_observer('Merit::ReputationChangeObserver')
+
+  class BadgeNotFound < StandardError; end
+  class RankAttributeNotDefined < StandardError; end
+
+  class Engine < Rails::Engine
+    config.app_generators.orm Merit.orm
+
+    initializer 'merit.controller' do |app|
+      extend_orm_with_has_merit
+      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)/
+        end
+      end
+    end
+
+    def extend_orm_with_has_merit
+      ActiveRecord::Base.include(Merit)
+    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/lib/merit/badge_rules_methods.rb

@@ -0,0 +1,30 @@
+module Merit
+  module BadgeRulesMethods
+    # Define rule for granting badges
+    def grant_on(actions, *args, &block)
+      options = args.extract_options!
+
+      actions = Array.wrap(actions)
+
+      rule = Rule.new
+      rule.badge_id   = options[:badge_id]
+      rule.badge_name = options[:badge]
+      rule.level      = options[:level]
+      rule.to         = options[:to] || :action_user
+      rule.multiple   = options[:multiple] || false
+      rule.temporary  = options[:temporary] || false
+      rule.model_name = options[:model_name] || actions.first.split('#').first
+      rule.block      = block
+
+      actions.each do |action|
+        defined_rules[action] ||= []
+        defined_rules[action] << rule
+      end
+    end
+
+    # Currently defined rules
+    def defined_rules
+      @defined_rules ||= {}
+    end
+  end
+end

data/lib/merit/base_target_finder.rb

@@ -0,0 +1,31 @@
+module Merit
+  class BaseTargetFinder
+    def self.find(*args)
+      new(*args).find
+    end
+
+    def initialize(rule, action)
+      @rule = rule
+      @action = action
+    end
+
+    def find
+      get_target_from_database || reanimate_target_from_action
+    rescue => e
+      Rails.logger.warn "[merit] no target found: #{e}. #{caller.first}"
+    end
+
+    def get_target_from_database
+      model_class.find_by_id(@action.target_id)
+    end
+
+    def model_class
+      klass_name = (@rule.model_name || @action.target_model).singularize
+      klass_name.camelize.constantize
+    end
+
+    def reanimate_target_from_action
+      YAML.load(@action.target_data)
+    end
+  end
+end

data/lib/merit/class_methods.rb

@@ -0,0 +1,41 @@
+module Merit
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def has_merit(options = {})
+      # MeritableModel#sash_id is more stable than Sash#meritable_model_id
+      # 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, optional: true
+
+      _merit_delegate_methods_to_sash
+      _merit_define_badge_related_entries_method
+      _merit_sash_initializer
+    end
+
+    # Delegate methods from meritable models to their sash
+    def _merit_delegate_methods_to_sash
+      methods = %w(badge_ids badges points add_badge rm_badge
+                   add_points subtract_points score_points)
+      methods.each { |method| delegate method, to: :_sash }
+    end
+
+    def _merit_define_badge_related_entries_method
+      meritable_class_name = name.demodulize
+      Merit::Badge._define_related_entries_method(meritable_class_name)
+    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:
+    # http://blog.hasmanythrough.com/2012/1/20/modularized-association-methods-in-rails-3-2
+    def _merit_sash_initializer
+      define_method(:_sash) do
+        # TODO: reload.sash is not regression tested
+        sash || reload.sash || update(sash: Sash.create)
+        sash
+      end
+    end
+  end
+end

data/lib/merit/controller_extensions.rb

@@ -0,0 +1,71 @@
+module Merit
+  # Sets up an app-wide after_filter, and inserts merit_action entries if
+  # there are defined rules (for badges or points) for current
+  # 'controller_path#action_name'
+  module ControllerExtensions
+    def self.included(base)
+      base.after_action :log_and_process
+    end
+
+    private
+
+    def log_and_process
+      if rules_defined?
+        Merit::Action.create(merit_action_hash)
+
+        if Merit.checks_on_each_request
+          Merit::Action.check_unprocessed
+        end
+      end
+    end
+
+    def merit_action_hash
+      {
+        user_id:       send(Merit.current_user_method).try(:id),
+        action_method: action_name,
+        action_value:  params[:value],
+        had_errors:    had_errors?,
+        target_model:  controller_path,
+        target_id:     target_id,
+        target_data:   target_object.to_yaml,
+      }
+    end
+
+    def rules_defined?
+      RulesMatcher.new(controller_path, action_name).any_matching?
+    end
+
+    def had_errors?
+      target_object.respond_to?(:errors) && target_object.errors.try(:present?)
+    end
+
+    def target_object
+      variable_name = :"@#{controller_name.singularize}"
+      if instance_variable_defined?(variable_name)
+        if target_obj = instance_variable_get(variable_name)
+          target_obj
+        else
+          warn_no_object_found
+        end
+      end
+    end
+
+    def warn_no_object_found
+      str = '[merit] No object found, you might need a ' \
+        "'@#{controller_name.singularize}' variable in " \
+        "'#{controller_path}_controller' if no reputation is applied. " \
+        'If you are using `model_name` option in the rule this is ok.'
+      Rails.logger.warn str
+      nil
+    end
+
+    def target_id
+      target_id = target_object.try(: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
+  end
+end

data/lib/merit/generators/active_record/install_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record'
+
+module Merit
+  module Generators::ActiveRecord
+    class InstallGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'add active_record merit migrations for the root objects'
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def copy_migrations_and_model
+        migration_template 'create_merit_actions.erb',
+                            'db/migrate/create_merit_actions.rb'
+        sleep 1.1
+        migration_template 'create_merit_activity_logs.erb',
+                            'db/migrate/create_merit_activity_logs.rb'
+        sleep 1.1
+        migration_template 'create_merit_badges.erb',
+                            'db/migrate/create_merit_badges.rb'
+        sleep 1.1
+        migration_template 'create_sashes.erb',
+                            'db/migrate/create_sashes.rb'
+        sleep 1.1
+        migration_template 'create_badges_sashes.erb',
+                           'db/migrate/create_badges_sashes.rb'
+        sleep 1.1
+        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/merit/generators/active_record/merit_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/active_record'
+
+module Merit
+  module Generators::ActiveRecord
+    class MeritGenerator < ::ActiveRecord::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'add active_record merit migrations'
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def copy_migrations_and_model
+        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

data/lib/merit/generators/active_record/remove_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators/active_record'
+
+module Merit
+  module Generators::ActiveRecord
+    class RemoveGenerator < ::ActiveRecord::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      desc 'Creates a migration file to remove all traces of Merit on the DB'
+
+      def self.next_migration_number(path)
+        ActiveRecord::Generators::Base.next_migration_number(path)
+      end
+
+      def copy_migrations_and_model
+        migration_template 'remove_merit_tables.erb',
+                           'db/migrate/remove_merit_tables.rb'
+
+        migration_template(
+          '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