qalam_merit 4.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6d18cb74d9ddf61a7a7d053c66cde90d8595a2b1a4aa707bfe7ab463e8d083e4
+  data.tar.gz: 39f3ccf60a27aebbfed60abee1647143ca4b8cb63aab4b92942d1040e4558458
+SHA512:
+  metadata.gz: 27abe76d15dacfe849056f2fa47a435a4699f8d19bebb990866ec2f7f8f2357f136f130f573ce905ca52f9c9412fce42a039b877dc7ba86253f9f7d846d0f7b8
+  data.tar.gz: 6eaa19dbcb7d43c1e182bc18444420f6bc8bfdce6430a28a85453704e6c8bee391ac34ad3f5e257906868fc9a1565b9125689602eb283ee78f7fd27e81d11a8d

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-02-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at eng.a.abdelhamid@outlook.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in qalam_merit.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Ahmed Abdelhamid
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,358 @@
+# Merit
+
+Merit adds reputation behavior to Rails apps in the form of Badges, Points,
+and Rankings.
+
+[![Build Status](https://travis-ci.org/merit-gem/merit.svg?branch=master)](http://travis-ci.org/merit-gem/merit)
+[![Coverage Status](https://coveralls.io/repos/github/merit-gem/merit/badge.svg?branch=master)](https://coveralls.io/github/merit-gem/merit?branch=master)
+[![Code Climate](https://codeclimate.com/github/tute/merit/badges/gpa.svg)](https://codeclimate.com/github/tute/merit)
+
+# Table of Contents
+
+- [Installation](#installation)
+- [Badges](#badges)
+    - [Creating Badges](#creating-badges)
+        - [Example](#example)
+    - [Defining Rules](#defining-rules)
+        - [Examples](#examples)
+    - [Other Actions](#other-actions)
+    - [Displaying Badges](#displaying-badges)
+- [Points](#points)
+    - [Defining Rules](#defining-rules-1)
+        - [Examples](#examples-1)
+    - [Other Actions](#other-actions-1)
+    - [Displaying Points](#displaying-points)
+- [Rankings](#rankings)
+    - [Defining Rules](#defining-rules-2)
+        - [Examples](#examples-2)
+    - [Displaying Rankings](#displaying-rankings)
+- [How merit finds the target object](#how-merit-finds-the-target-object)
+- [Getting Notifications](#getting-notifications)
+- [I18n](#i18n)
+- [Uninstalling Merit](#uninstalling-merit)
+
+
+# Installation
+
+1. Add `gem 'qalam_merit', require: 'merit'` to your `Gemfile`
+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`
+6. Configure reputation rules for your application in `app/models/merit/*`
+
+
+# Badges
+
+## Creating Badges
+
+Create badges in `config/initializers/merit.rb`
+
+`Merit::Badge.create!` takes a hash describing the badge:
+* `:id` integer (required)
+* `:name` this is how you reference the badge (required)
+* `:level` (optional)
+* `:description` (optional)
+* `:custom_fields` hash of anything else you want associated with the badge (optional)
+
+### Example
+
+```ruby
+Merit::Badge.create!(
+  id: 1,
+  name: "year-member",
+  description: "Active member for a year",
+  custom_fields: { difficulty: :silver }
+)
+```
+
+## Defining Rules
+
+Badges can be automatically given to any resource in your application based on
+rules and conditions you create. Badges can also have levels, and be permanent
+or temporary (A temporary badge is revoked when the conditions of the badge
+are no longer met).
+
+Badge rules / conditions are defined in `app/models/merit/badge_rules.rb`
+`initialize` block by calling `grant_on` with the following parameters:
+
+* `'controller#action'` a string similar to Rails routes (required)
+* `:badge_id` or `:badge` these correspond to the `:id` or `:name` of the badge respectively
+* `:level` corresponds to the `:level` of the badge
+* `:to` the object's field to give the badge to. It needs a variable named
+  `@model` in the associated controller action, like `@post` for
+  `posts_controller.rb` or `@comment` for `comments_controller.rb`.
+  * Can be a method name, which called over the target object should retrieve
+    the object to badge. If it's `:user` for example, merit will internally
+    call `@model.user` to find who to badge.
+  * Can be `:itself`, in which case it badges the target object itself
+    (`@model`).
+  * Is `:action_user` by default, which means `current_user`.
+* `:model_name` define the model's name if it's different from
+  the controller's (e.g. the `User` model for the `RegistrationsController`).
+* `:multiple` whether or not the badge may be granted multiple times. `false` by default.
+* `:temporary` whether or not the badge should be revoked if the condition no
+  longer holds. `false` -badges are kept for ever- by default.
+* `&block` can be one of the following:
+  * empty / not included: always grant the badge
+  * a block which evaluates to boolean. It recieves the target object as
+    parameter (e.g. `@post` if you're working with a PostsController action).
+  * a block with a hash composed of methods to run on the target object and
+    expected method return values
+
+### Examples
+
+```ruby
+# app/models/merit/badge_rules.rb
+grant_on 'comments#vote', badge_id: 5, to: :user do |comment|
+  comment.votes.count == 5
+end
+
+grant_on ['users#create', 'users#update'], badge: 'autobiographer', temporary: true do |user|
+  user.name? && user.email?
+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
+# Check granted badges
+current_user.badges # Returns an array of badges
+
+# Grant or remove manually
+current_user.add_badge(badge.id)
+current_user.rm_badge(badge.id)
+```
+
+```ruby
+# Get related entries of a given badge
+Merit::Badge.find(1).users
+```
+
+## Displaying Badges
+
+Meritable models have a `badges` method which returns an array of associated
+badges:
+
+```erb
+<ul>
+  <% current_user.badges.each do |badge| %>
+    <li><%= badge.name %></li>
+  <% end %>
+</ul>
+```
+
+
+# Points
+
+## Defining Rules
+
+Points are given to "meritable" resources on actions-triggered, either to the
+action user or to the method(s) defined in the `:to` option. Define rules on
+`app/models/merit/point_rules.rb`:
+
+`score` accepts:
+
+* `score`
+  * `Integer`
+  * `Proc`, or any object that accepts `call` which takes one argument, where
+    the target object is passed in and the return value is used as the score.
+* `:on` action as string or array of strings (like `controller#action`, similar to Rails routes)
+* `:to` method(s) to send to the target object (who should be scored?)
+* `:model_name` (optional) to specify the model name if it cannot be guessed
+  from the controller. (e.g. `model_name: 'User'` for `RegistrationsController`,
+  or `model_name: 'Comment'` for `Api::CommentsController`)
+* `:category` (optional) to categorize earned points. `default` is used by default.
+* `&block`
+  * empty (always scores)
+  * a block which evaluates to boolean (recieves target object as parameter)
+
+### Examples
+
+```ruby
+# app/models/merit/point_rules.rb
+score 10, to: :post_creator, on: 'comments#create', category: 'comment_activity' do |comment|
+  comment.title.present?
+end
+
+score 20, on: [
+  'comments#create',
+  'photos#create'
+]
+
+score 15, on: 'reviews#create', to: [:reviewer, :reviewed]
+
+proc = lambda { |photo| PhotoPointsCalculator.calculate_score_for(photo) }
+score proc, on: 'photos#create'
+```
+
+## Other Actions
+
+```ruby
+# Score manually
+current_user.add_points(20, category: 'Optional category')
+current_user.subtract_points(10, category: 'Optional category')
+```
+
+```ruby
+# Query awarded points since a given date
+score_points = current_user.score_points(category: 'Optional category')
+score_points.where("created_at > '#{1.month.ago}'").sum(:num_points)
+```
+
+## Displaying Points
+
+Meritable models have a `points` method which returns an integer:
+
+```erb
+<%= current_user.points(category: 'Optional category') %>
+```
+
+If `category` left empty, it will return the sum of points for every category.
+
+```erb
+<%= current_user.points %>
+```
+
+# Rankings
+
+A common ranking use case is 5 stars. They are not given at specified actions
+like badges, a cron job should be defined to test if ranks are to be granted.
+
+## Defining Rules
+
+Define rules on `app/models/merit/rank_rules.rb`:
+
+`set_rank` accepts:
+
+* `:level` ranking level (greater is better, Lexicographical order)
+* `: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}`')
+
+Check for rules on a rake task executed in background like:
+
+```ruby
+task cron: :environment do
+  Merit::RankRules.new.check_rank_rules
+end
+```
+
+
+### Examples
+
+```ruby
+set_rank level: 2, to: Committer.active do |committer|
+  committer.branches > 1 && committer.followers >= 10
+end
+
+set_rank level: 3, to: Committer.active do |committer|
+  committer.branches > 2 && committer.followers >= 20
+end
+```
+
+## Displaying Rankings
+
+```erb
+<%= current_user.level %>
+```
+
+
+# How merit finds the target object
+
+Merit fetches the rule’s target object (the parameter it receives) from its
+`:model_name` option, or from the controller’s instance variable.
+
+To read it from the controller merit searches for the instance variable named
+after the singularized controller name. For example, a rule like:
+
+```ruby
+grant_on 'comments#update', badge_id: 1 do |target_object|
+  # target_object would be better named comment in this sample
+end
+```
+
+Would make merit try to find the `@comment` instance variable in the
+`CommentsController#update` action. If the rule had the `:model_name` option
+specified:
+
+```ruby
+grant_on 'comments#update', badge_id: 1, model_name: "Article" do |target_object|
+  # target_object would be better named article in this sample
+end
+```
+
+Merit would fetch the `Article` object from the database, found by the `:id`
+param sent in that `update` action.
+
+If none of these methods find the target, Merit will log a `no target_obj`
+warning, with a comment to check the configuration for the rule.
+
+
+# Getting Notifications
+
+You can get observers notified any time merit changes reputation in your
+application.
+
+It needs to implement the `update` method, which receives as parameter the
+following hash:
+
+* `description`, describes what happened. For example: "granted 5 points",
+  "granted just-registered badge", "removed autobiographer badge".
+* `sash_id`, who saw it's reputation changed.
+* `granted_at`, date and time when the reputation change took effect.
+
+Example code (add your observer to `app/models` or `app/observers`):
+
+```ruby
+# reputation_change_observer.rb
+class ReputationChangeObserver
+  def update(changed_data)
+    description = changed_data[:description]
+
+    # If user is your meritable model, you can query for it doing:
+    user = User.where(sash_id: changed_data[:sash_id]).first
+
+    # When did it happened:
+    datetime = changed_data[:granted_at]
+  end
+end
+```
+```ruby
+# In `config/initializers/merit.rb`
+config.add_observer 'ReputationChangeObserver'
+```
+
+# I18n
+
+Merit uses default messages with I18n for notify alerts. To customize your app, you can set up your locale file:
+
+```yaml
+en:
+  merit:
+    granted_badge: "granted %{badge_name} badge"
+    granted_points: "granted %{points} points"
+    removed_badge: "removed %{badge_name} badge"
+```
+
+# Uninstalling Merit
+
+1. Run `rails d merit:install`
+2. Run `rails d merit MODEL_NAME` (e.g. `user`)
+3. Run `rails g merit:remove MODEL_NAME` (e.g. `user`)
+4. Run `rake db:migrate`
+5. Remove `merit` from your Gemfile