qalam_merit 4.0.35

data/lib/merit/generators/active_record/templates/add_merit_fields_to_model.erb

@@ -0,0 +1,7 @@
+### QALAM_MERIT ###
+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
+  end
+end

data/lib/merit/generators/active_record/templates/create_badges_sashes.erb

@@ -0,0 +1,14 @@
+### QALAM_MERIT ###
+class CreateBadgesSashes < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    create_table :badges_sashes do |t|
+      t.references :badge, limit: 8, foreign_key: { to_table: 'merit_badges'}, index: true, null: true
+      t.references :sash, limit: 8, foreign_key: true, index: true, null: true
+      t.datetime :created_at
+    end
+  end
+
+  def self.down
+    drop_table :badges_sashes
+  end
+end

data/lib/merit/generators/active_record/templates/create_merit_actions.erb

@@ -0,0 +1,16 @@
+### QALAM_MERIT ###
+class CreateMeritActions < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :merit_actions do |t|
+      t.integer :user_id
+      t.string  :action_method
+      t.integer :action_value
+      t.boolean :had_errors, default: false
+      t.string  :target_model
+      t.integer :target_id
+      t.text    :target_data
+      t.boolean :processed, default: false
+      t.timestamps null: false
+    end
+  end
+end

data/lib/merit/generators/active_record/templates/create_merit_activity_logs.erb

@@ -0,0 +1,12 @@
+### QALAM_MERIT ###
+class CreateMeritActivityLogs < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :merit_activity_logs do |t|
+      t.integer  :action_id
+      t.string   :related_change_type
+      t.integer  :related_change_id
+      t.string   :description
+      t.datetime :created_at
+    end
+  end
+end

data/lib/merit/generators/active_record/templates/create_merit_badges.erb

@@ -0,0 +1,17 @@
+### QALAM_MERIT ###
+class CreateMeritBadges < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :merit_badges do |t|
+      t.string :name
+      t.integer :level, default: 1
+      t.integer :points, default: 0
+      t.text :description
+      t.string :difficulty
+      t.references :user, limit: 8, foreign_key: true, index: true, null: true
+      t.references :root_account, foreign_key: { to_table: 'accounts'}, limit: 8, null: false, index: true
+
+
+      t.timestamps
+    end
+  end
+end

data/lib/merit/generators/active_record/templates/create_sashes.erb

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

data/lib/merit/generators/active_record/templates/create_scores_and_points.erb

@@ -0,0 +1,16 @@
+### QALAM_MERIT ###
+class CreateScoresAndPoints < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :merit_scores do |t|
+      t.references :sash
+      t.string :category, default: 'default'
+    end
+
+    create_table :merit_score_points do |t|
+      t.references :score
+      t.bigint :num_points, default: 0
+      t.string :log
+      t.datetime :created_at
+    end
+  end
+end

data/lib/merit/generators/active_record/templates/remove_merit_fields_from_model.erb

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

data/lib/merit/generators/active_record/templates/remove_merit_tables.erb

@@ -0,0 +1,12 @@
+### QALAM_MERIT ###
+class RemoveMeritTables < ActiveRecord::Migration<%= migration_version %>
+  def self.up
+    drop_table :merit_actions
+    drop_table :merit_activity_logs
+    drop_table :badges_sashes
+    drop_table :merit_badges
+    drop_table :sashes
+    drop_table :merit_scores
+    drop_table :merit_score_points
+  end
+end

data/lib/merit/generators/install_generator.rb

@@ -0,0 +1,30 @@
+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'
+        sleep 1.1
+        template 'sash.erb', 'app/models/merit/sash.rb'
+        sleep 1.1
+        template 'badge.erb', 'app/models/merit/badge.rb'
+        sleep 1.1
+        template 'badge_sash.erb', 'app/models/merit/badge_sash.rb'
+        sleep 1.1
+        template 'merit_badge_rules.erb', 'app/models/merit/badge_rules.rb'
+        sleep 1.1
+        template 'merit_point_rules.erb', 'app/models/merit/point_rules.rb'
+        sleep 1.1
+        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/merit/generators/merit_generator.rb

@@ -0,0 +1,33 @@
+require "rails/generators"
+
+module Merit
+  module Generators
+    class MeritGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def inject_merit_content
+        if model_exists?
+          inject_into_class(model_path, class_name, "  ### END ###\n\n")
+          inject_into_class(model_path, class_name, "  has_many :created_badges, class_name: 'Merit::Badge'\n")
+          inject_into_class(model_path, class_name, "  belongs_to :sash, foreign_key: 'sash_id', class_name: 'Merit::Sash'\n")
+          inject_into_class(model_path, class_name, "  has_merit\n")
+          inject_into_class(model_path, class_name, "  ### QALAM_MERIT ###\n")
+        end
+      end
+
+      def run_active_record_generators
+        invoke 'merit:active_record:merit'
+      end
+
+      private
+
+      def model_exists?
+        File.exist? File.join(destination_root, model_path)
+      end
+
+      def model_path
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/merit/generators/remove_generator.rb

@@ -0,0 +1,23 @@
+require "rails/generators"
+
+module Merit
+  module Generators
+    class RemoveGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      def run_active_record_generators
+        invoke 'merit:active_record:remove'
+      end
+
+      private
+
+      def model_exists?
+        File.exist? File.join(destination_root, model_path)
+      end
+
+      def model_path
+        @model_path ||= File.join('app', 'models', "#{file_path}.rb")
+      end
+    end
+  end
+end

data/lib/merit/generators/templates/badge.erb

@@ -0,0 +1,49 @@
+### QALAM_MERIT ###
+class Merit::Badge < ApplicationRecord
+  self.table_name = "merit_badges"
+
+  validates :name, presence: true, length: { minimum: 3 }
+  validates :points, numericality: true, :inclusion => 1..20
+  validates :description, presence: false, length: { maximum: 50 }
+
+  has_one :image, :class_name => 'Attachment', :as => :context, :inverse_of => :context, :dependent => :destroy
+  belongs_to :root_account, foreign_key: "root_account_id", class_name: 'Account'
+  belongs_to :created_by, foreign_key: "user_id", class_name: 'User'
+  has_many :badges_sashes, class_name: 'Merit::BadgeSash'
+  has_many :sashes, through: :badges_sashes, source: :sash
+
+  class << self
+    def find_by_id(ids)
+      ids = Array.wrap(ids)
+      find { |b| ids.include? b[:id] }
+    end
+  
+    def by_name(name)
+      find { |b| b.name.to_s == name.to_s }
+    end
+  
+    def by_level(level)
+      find { |b| b.level.to_s == level.to_s }
+    end
+
+    def find_by_name_and_level(name, level)
+      badge = Merit::Badge.by_name(name)
+      badge = badge.by_level(level) unless level.nil?
+      if badge.nil?
+        str = "No badge '#{name}' found. Define it in initializers/merit.rb"
+        fail ::Merit::BadgeNotFound, str
+      end
+      badge
+    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 = Merit::BadgeSash.where(badge_id: id).pluck(:sash_id)
+        meritable_class_name.constantize.where(sash_id: sashes)
+      end
+    end
+  end
+end

data/lib/merit/generators/templates/badge_sash.erb

@@ -0,0 +1,21 @@
+### QALAM_MERIT ###
+class Merit::BadgeSash < ApplicationRecord
+    self.table_name = "badges_sashes"
+    belongs_to :badge, foreign_key: "badge_id", class_name: 'Merit::Badge'
+    belongs_to :sash, foreign_key: "sash_id", class_name: 'Merit::Sash'
+    # has_many :users, through: :sash, source: :users
+
+    class << self
+        def user(badge_sash_id = nil)
+            return [] unless badge_sash_id
+
+            return [] unless badge_sash = Merit::BadgeSash.find(badge_sash_id)
+            sash = badge_sash.sash
+
+            return [] unless sash && sash.id && sash_id = sash.id
+
+            User.where(sash_id: sash_id)
+        end
+    end
+end
+  

data/lib/merit/generators/templates/merit.erb

@@ -0,0 +1,18 @@
+### QALAM_MERIT ###
+# Use this hook to configure merit parameters
+Merit.setup do |config|
+  # Check rules on each request or in background
+  # config.checks_on_each_request = true
+
+  # Add application observers to get notifications when reputation changes.
+  # config.add_observer 'MyObserverClassName'
+
+  # 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'
+
+  # Define :current_user_method. Similar to previous option. It will be used
+  # to retrieve :user_model_name object if no `:to` option is given. Default
+  # is "current_#{user_model_name.downcase}".
+  # config.current_user_method = 'current_user'
+end

data/lib/merit/generators/templates/merit_badge_rules.erb

@@ -0,0 +1,50 @@
+### QALAM_MERIT ###
+# Be sure to restart your server when you modify this file.
+#
+# +grant_on+ accepts:
+# * Nothing (always grants)
+# * A block which evaluates to boolean (recieves the object as parameter)
+# * A block with a hash composed of methods to run on the target object with
+#   expected values (+votes: 5+ for instance).
+#
+# +grant_on+ can have a +:to+ method name, which called over the target object
+# should retrieve the object to badge (could be +:user+, +:self+, +:follower+,
+# etc). If it's not defined merit will apply the badge to the user who
+# triggered the action (:action_user by default). If it's :itself, it badges
+# the created object (new user for instance).
+#
+# The :temporary option indicates that if the condition doesn't hold but the
+# badge is granted, then it's removed. It's false by default (badges are kept
+# forever).
+
+module Merit
+  class BadgeRules
+    include Merit::BadgeRulesMethods
+
+    def initialize
+      # If it creates user, grant badge
+      # Should be "current_user" after registration for badge to be granted.
+      # Find badge by badge_id, badge_id takes presidence over badge
+      # grant_on 'users#create', badge_id: 7, badge: 'just-registered', to: :itself
+
+      # If it has 10 comments, grant commenter-10 badge
+      # grant_on 'comments#create', badge: 'commenter', level: 10 do |comment|
+      #   comment.user.comments.count == 10
+      # end
+
+      # If it has 5 votes, grant relevant-commenter badge
+      # grant_on 'comments#vote', badge: 'relevant-commenter',
+      #   to: :user do |comment|
+      #
+      #   comment.votes.count == 5
+      # end
+
+      # Changes his name by one wider than 4 chars (arbitrary ruby code case)
+      # grant_on 'registrations#update', badge: 'autobiographer',
+      #   temporary: true, model_name: 'User' do |user|
+      #
+      #   user.name.length > 4
+      # end
+    end
+  end
+end

data/lib/merit/generators/templates/merit_point_rules.erb

@@ -0,0 +1,31 @@
+### QALAM_MERIT ###
+# Be sure to restart your server when you modify this file.
+#
+# Points are a simple integer value which are given to "meritable" resources
+# according to rules in +app/models/merit/point_rules.rb+. They are given on
+# actions-triggered, either to the action user or to the method (or array of
+# methods) defined in the +:to+ option.
+#
+# 'score' method may accept a block which evaluates to boolean
+# (recieves the object as parameter)
+
+module Merit
+  class PointRules
+    include Merit::PointRulesMethods
+
+    def initialize
+      # score 10, :on => 'users#create' do |user|
+      #   user.bio.present?
+      # end
+      #
+      # score 15, :on => 'reviews#create', :to => [:reviewer, :reviewed]
+      #
+      # score 20, :on => [
+      #   'comments#create',
+      #   'photos#create'
+      # ]
+      #
+      # score -10, :on => 'comments#destroy'
+    end
+  end
+end

data/lib/merit/generators/templates/merit_rank_rules.erb

@@ -0,0 +1,32 @@
+### QALAM_MERIT ###
+# Be sure to restart your server when you modify this file.
+#
+# 5 stars is a common ranking use case. They are not given at specified
+# actions like badges, you should define a cron job to test if ranks are to be
+# granted.
+#
+# +set_rank+ accepts:
+# * :+level+ ranking level (greater is better)
+# * :+to+ model or scope to check if new rankings apply
+# * :+level_name+ attribute name (default is empty and results in 'level'
+#   attribute, if set it's appended like 'level_#{level_name}')
+
+module Merit
+  class RankRules
+    include Merit::RankRulesMethods
+
+    def initialize
+      # set_rank :level => 1, :to => Commiter.active do |commiter|
+      #   commiter.repositories.count > 1 && commiter.followers >= 10
+      # end
+      #
+      # set_rank :level => 2, :to => Commiter.active do |commiter|
+      #   commiter.branches.count > 1 && commiter.followers >= 10
+      # end
+      #
+      # set_rank :level => 3, :to => Commiter.active do |commiter|
+      #   commiter.branches.count > 2 && commiter.followers >= 20
+      # end
+    end
+  end
+end

data/lib/merit/generators/templates/sash.erb

@@ -0,0 +1,15 @@
+### QALAM_MERIT ###
+class Merit::Sash < ApplicationRecord
+    self.table_name = "sashes"
+    has_many :badges_sashes, class_name: 'Merit::BadgeSash'
+    has_many :badges, through: :badges_sashes, source: :badge
+
+    class << self
+        def user(sash_id = nil)
+            return [] unless sash_id
+
+            User.where(sash_id: sash_id)
+        end
+    end
+end
+