merit 0.2.5 → 0.3.0

data/lib/merit/models/active_record/badges_sash.rb

@@ -0,0 +1,12 @@
+class BadgesSash < ActiveRecord::Base
+  belongs_to :badge
+  belongs_to :sash
+
+  # To be used in the application, mark badge granting as notified to user
+  def set_notified!(badge, sash)
+    # With composite keys ARel complained, had to use SQL
+    ActiveRecord::Base.connection.execute("UPDATE badges_sashes
+      SET notified_user = TRUE
+      WHERE badge_id = #{badge.id} AND sash_id = #{sash.id}")
+  end
+end

data/lib/merit/models/active_record/merit_action.rb

@@ -0,0 +1,2 @@
+class MeritAction < ActiveRecord::Base
+end

data/lib/merit/models/active_record/sash.rb

@@ -0,0 +1,12 @@
+class Sash < ActiveRecord::Base
+  has_many :badges_sashes
+  has_many :badges, :through => :badges_sashes
+
+  def add_badge(badge_id)
+    BadgesSash.create(sash: self, badge_id: badge_id)
+  end
+  def rm_badge(badge_id)
+    ActiveRecord::Base.connection.execute("DELETE FROM badges_sashes
+      WHERE badge_id = #{badge_id} AND sash_id = #{self.id}")
+  end
+end

data/lib/merit/models/mongo_mapper/merit_action.rb

@@ -0,0 +1,12 @@
+class MeritAction
+  include MongoMapper::Document
+
+  key :user_id, String
+  key :action_method, String
+  key :action_value, Integer
+  key :had_errors, Boolean
+  key :target_model, String
+  key :target_id, String
+  key :processed, Boolean, :default => false
+  timestamps!
+end

data/lib/merit/models/mongo_mapper/sash.rb

@@ -0,0 +1,15 @@
+class Sash
+  include MongoMapper::Document
+
+  key :badge_ids, Array
+  timestamps!
+
+  def add_badge(badge_id)
+    self.badge_ids << badge_id
+    self.save
+  end
+  def rm_badge(badge_id)
+    self.badge_ids -= [badge_id]
+    self.save
+  end
+end

data/lib/merit/rule.rb

@@ -72,8 +72,8 @@ module Merit
     # Get rule's related Badge.
     def badge
       if @badge.nil?
-        badges = Badge.where(:name => badge_name)
-        badges = badges.where(:level => level.to_s) unless level.nil?
+        badges = Badge.by_name(badge_name)
+        badges = badges.by_level(level) unless level.nil?
         @badge = badges.first
       end
       @badge

data/lib/merit/rules_badge.rb

@@ -54,7 +54,7 @@ module Merit
     # Check non processed actions and grant badges if applies
     def check_new_actions
       MeritAction.where(:processed => false).each do |merit_action|
-        merit_action.check_badge_rules(defined_rules)
+        merit_action.check_rules(defined_rules)
       end
     end
 

data/merit.gemspec

@@ -0,0 +1,16 @@
+# Provide a simple gemspec so you can easily use your enginex
+# project in your rails apps through git.
+Gem::Specification.new do |s|
+  s.name        = "merit"
+  s.summary     = "General reputation Rails engine."
+  s.description = "General reputation Rails engine."
+  s.files       = `git ls-files`.split("\n").reject{|f| f =~ /^\./ }
+  s.version     = "0.3.0"
+  s.authors     = ["Tute Costa"]
+  s.email       = 'tutecosta@gmail.com'
+  s.add_dependency 'ambry'
+  s.add_development_dependency 'rails'
+  s.add_development_dependency 'sqlite3'
+  s.add_development_dependency 'haml'
+  s.add_development_dependency 'capybara'
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+
+  def current_user
+    @current_user ||= User.first
+  end
+end

data/test/dummy/app/controllers/comments_controller.rb

@@ -0,0 +1,90 @@
+class CommentsController < ApplicationController
+  # GET /comments
+  # GET /comments.xml
+  def index
+    @comments = Comment.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @comments }
+    end
+  end
+
+  # GET /comments/1
+  # GET /comments/1.xml
+  def show
+    @comment = Comment.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @comment }
+    end
+  end
+
+  # GET /comments/new
+  # GET /comments/new.xml
+  def new
+    @comment = Comment.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @comment }
+    end
+  end
+
+  # GET /comments/1/edit
+  def edit
+    @comment = Comment.find(params[:id])
+  end
+
+  def vote
+    @comment = Comment.find(params[:id])
+    @comment.votes += params[:value].to_i
+    @comment.save
+    redirect_to(comments_url, :notice => 'Vote added!')
+  end
+
+  # POST /comments
+  # POST /comments.xml
+  def create
+    @comment = Comment.new(params[:comment])
+
+    respond_to do |format|
+      if @comment.save
+        format.html { redirect_to(@comment, :notice => 'Comment was successfully created.') }
+        format.xml  { render :xml => @comment, :status => :created, :location => @comment }
+      else
+        format.html { render "new" }
+        format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /comments/1
+  # PUT /comments/1.xml
+  def update
+    @comment = Comment.find(params[:id])
+
+    respond_to do |format|
+      if @comment.update_attributes(params[:comment])
+        format.html { redirect_to(@comment, :notice => 'Comment was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render "edit" }
+        format.xml  { render :xml => @comment.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /comments/1
+  # DELETE /comments/1.xml
+  def destroy
+    @comment = Comment.find(params[:id])
+    @comment.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(comments_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/test/dummy/app/controllers/registrations_controller.rb

@@ -0,0 +1,15 @@
+class RegistrationsController < ApplicationController
+  def update
+    @user = User.find(params[:id])
+
+    respond_to do |format|
+      if @user.update_attributes(params[:user])
+        format.html { redirect_to(@user, :notice => 'User was successfully updated.') }
+        format.xml  { head :ok }
+      else
+        format.html { render "edit" }
+        format.xml  { render :xml => @user.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+end

data/test/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,67 @@
+class UsersController < ApplicationController
+  # GET /users
+  # GET /users.xml
+  def index
+    @users = User.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.xml  { render :xml => @users }
+    end
+  end
+
+  # GET /users/1
+  # GET /users/1.xml
+  def show
+    @user = User.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.xml  { render :xml => @user }
+    end
+  end
+
+  # GET /users/new
+  # GET /users/new.xml
+  def new
+    @user = User.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.xml  { render :xml => @user }
+    end
+  end
+
+  # GET /users/1/edit
+  def edit
+    @user = User.find(params[:id])
+  end
+
+  # POST /users
+  # POST /users.xml
+  def create
+    @user = User.new(params[:user])
+
+    respond_to do |format|
+      if @user.save
+        format.html { redirect_to(@user, :notice => 'User was successfully created.') }
+        format.xml  { render :xml => @user, :status => :created, :location => @user }
+      else
+        format.html { render "new" }
+        format.xml  { render :xml => @user.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /users/1
+  # DELETE /users/1.xml
+  def destroy
+    @user = User.find(params[:id])
+    @user.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(users_url) }
+      format.xml  { head :ok }
+    end
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

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

@@ -0,0 +1,4 @@
+class Comment < ActiveRecord::Base
+  belongs_to :user
+  validates :name, :comment, :user_id, :presence => true
+end

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

@@ -0,0 +1,41 @@
+# +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).
+
+class MeritBadgeRules
+  include Merit::BadgeRules
+
+  def initialize
+    # If it creates user, grant badge
+    # Should be "current_user" after registration for badge to be granted.
+    grant_on 'users#create', :badge => 'just-registered', :to => :itself
+
+    # If it has 10 comments, grant commenter-10 badge
+    grant_on 'comments#create', :badge => 'commenter', :level => 10 do
+      { :user => { :comments => { :count => 10 } } }
+    end
+
+    # If it has at least 10 votes, grant relevant-commenter badge
+    grant_on 'comments#vote', :badge => 'relevant-commenter', :to => :user do |comment|
+      comment.votes >= 10
+    end
+
+    # Changes his name by one wider than 4 chars (arbitrary ruby code and custom model_name)
+    # This badge is temporary (user may lose it)
+    grant_on 'registrations#update', :badge => 'autobiographer', :temporary => true, :model_name => 'User' do |user|
+      user.name.length > 4
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# 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.
+
+class MeritPointRules
+  include Merit::PointRules
+
+  def initialize
+    score 5, :to => :user, :on => [
+      'comments#vote'
+    ]
+
+    score 20, :on => [
+      'comments#create',
+      'registrations#update'
+    ]
+  end
+end

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

@@ -0,0 +1,25 @@
+# Rankings are very similar to badges. They give "badges" which have a hierarchy
+# defined by +level+'s lexicografical order (greater is better). If a rank is
+# granted, lower level ranks are taken off. 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:
+# * +badge_name+ name of this ranking
+# * :+level+ ranking level (greater is better)
+# * :+to+ model or scope to check if new rankings apply
+
+class MeritRankRules
+  include Merit::RankRules
+
+  def initialize
+    # i stars for i chars name
+    (1..5).each do |i|
+      set_rank :stars, :level => i, :to => User do |user|
+        user.name.length == i
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+class User < ActiveRecord::Base
+  has_merit
+
+  has_many :comments
+
+  def show_badges
+    badges.collect{|b| "#{b.name.capitalize} (#{b.level})" }.join(', ')
+  end
+end

data/test/dummy/app/views/comments/_form.html.erb

@@ -0,0 +1,29 @@
+<%= form_for(@comment) do |f| %>
+  <% if @comment.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@comment.errors.count, "error") %> prohibited this comment from being saved:</h2>
+
+      <ul>
+      <% @comment.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :name %><br />
+    <%= f.text_field :name %>
+  </div>
+  <div class="field">
+    <%= f.label :comment %><br />
+    <%= f.text_area :comment %>
+  </div>
+  <div class="field">
+    <%= f.label :user_id %><br />
+    <%= f.text_field :user_id %>
+  </div>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/test/dummy/app/views/comments/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing comment</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @comment %> |
+<%= link_to 'Back', comments_path %>

data/test/dummy/app/views/comments/index.html.erb

@@ -0,0 +1,35 @@
+<h1>Listing comments</h1>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Comment</th>
+    <th>User</th>
+    <th>Votes</th>
+    <th>Vote up!</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @comments.each do |comment| %>
+  <tr id="c_<%= comment.id %>">
+    <td><%= comment.name %></td>
+    <td><%= comment.comment %></td>
+    <td><%= comment.user_id %></td>
+    <td><%= comment.votes %></td>
+    <td>
+    <% (1..5).each do |i| %>
+      <%= link_to "#{i}", "/comments/#{comment.id}/vote/#{i}" %>
+    <% end %>
+    </td>
+    <td><%= link_to 'Show', comment %></td>
+    <td><%= link_to 'Edit', edit_comment_path(comment) %></td>
+    <td><%= link_to 'Destroy', comment, :confirm => 'Are you sure?', :method => :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Comment', new_comment_path %>