merit 0.2.5 → 0.3.0

data/Gemfile

@@ -1,5 +1,7 @@
 source "http://rubygems.org"
 
+gem 'ambry'
+
 gem "rails", "~> 3.0.10"
 gem "sqlite3"
 gem "haml"

data/Gemfile.lock

@@ -0,0 +1,103 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.11)
+      actionpack (= 3.0.11)
+      mail (~> 2.2.19)
+    actionpack (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.5.0)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.14)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.11)
+      activesupport (= 3.0.11)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.11)
+      activemodel (= 3.0.11)
+      activesupport (= 3.0.11)
+    activesupport (3.0.11)
+    ambry (0.2.4)
+    arel (2.0.10)
+    builder (2.1.2)
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (1.0.11)
+    haml (3.1.4)
+    i18n (0.5.0)
+    json (1.6.5)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    polyglot (0.3.3)
+    rack (1.2.5)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.11)
+      actionmailer (= 3.0.11)
+      actionpack (= 3.0.11)
+      activerecord (= 3.0.11)
+      activeresource (= 3.0.11)
+      activesupport (= 3.0.11)
+      bundler (~> 1.0)
+      railties (= 3.0.11)
+    railties (3.0.11)
+      actionpack (= 3.0.11)
+      activesupport (= 3.0.11)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (~> 0.14.4)
+    rake (0.9.3.beta.1)
+    rdoc (3.12)
+      json (~> 1.4)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.19.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
+      rubyzip
+    sqlite3 (1.3.5)
+    thor (0.14.6)
+    treetop (1.4.10)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.31)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ambry
+  capybara
+  haml
+  rails (~> 3.0.10)
+  sqlite3

data/README.markdown

@@ -5,7 +5,7 @@
 
 # Installation
 
-1. Add 'merit' to your Gemfile
+1. Add <tt>gem 'merit'</tt> to your Gemfile
 2. Run <tt>rails g merit:install</tt>
 3. Run <tt>rails g merit MODEL_NAME</tt>
 4. Run <tt>rake db:migrate</tt>
@@ -115,6 +115,21 @@ You may also add badges/rank "by hand" from controller actions:
 
 ---
 
+# MongoMapper support (experimental)
+
+You may use <tt>merit</tt> with <tt>mongo_mapper</tt> ORM by calling
+<tt>rails g merit MODEL_NAME --orm mongo_mapper</tt> in the third step of the
+installation, and configuring <tt>config.orm = :mongo_mapper</tt> in
+<tt>config/initializers/merit.rb</tt>.
+
+---
+
+# Upgrade to 0.3.0
+
+Badges data is now stored in <tt>config/initializers/merit.rb</tt> using
+<tt>ambry</tt> syntax (not in the DB anymore, as that table needed to be in
+sync in all development environments).
+
 # Upgrade to 0.2.0
 
 Added <tt>had_errors</tt> boolean attribute to <tt>merit_actions</tt> table.
@@ -138,9 +153,9 @@ To run tests follow:
 
 # To-do list
 
+* Use ActiveSupport's Array#wrap where I build arrays by hand
 * Ranking should not be badges, so .badges doesn't return them (2-stars
   shouldn't be badge).
-* <tt>grep -r 'FIXME\|TODO' .</tt>
 * :value parameter (for star voting for example) should be configurable
   (depends on params[:value] on the controller).
 * Make fixtures for integration testing (now creating objects on test file!).

data/app/models/badge.rb

@@ -1,39 +1,47 @@
-class Badge < ActiveRecord::Base
-  has_many :badges_sashes
-  has_many :sashes, :through => :badges_sashes
+require 'ambry/active_model'
+
+class Badge
+  extend Ambry::Model
+  extend Ambry::ActiveModel
+
+  field :id, :name, :level, :image, :description
+
+  validates_presence_of :id, :name
+  validates_uniqueness_of :id
+
+  filters do
+    def find_by_id(ids)
+      ids = ids.kind_of?(Array) ? ids : [ids]
+      find{|b| ids.include? b.id }
+    end
+    def by_name(name)
+      find{|b| b.name == name.to_s }
+    end
+    def by_level(level)
+      find{|b| b.level.to_s == level.to_s }
+    end
+  end
 
   # Grant badge to sash
   def grant_to(object_or_sash)
     object_or_sash.create_sash_if_none unless object_or_sash.kind_of?(Sash)
     sash = object_or_sash.respond_to?(:sash) ? object_or_sash.sash : object_or_sash
-    unless sash.badges.include? self
-      sash.badges << self
-      sash.save
-    end
+    sash.add_badge(id) unless sash.badge_ids.include?(id)
   end
 
   # Take out badge from sash
   def delete_from(object_or_sash)
     object_or_sash.create_sash_if_none unless object_or_sash.kind_of?(Sash)
     sash = object_or_sash.respond_to?(:sash) ? object_or_sash.sash : object_or_sash
-    if sash.badges.include? self
-      sash.badges -= [self]
-      sash.save
-    end
+    sash.rm_badge(id) if sash.badge_ids.include?(id)
   end
 
   # Give rank to sash if it's greater. Delete lower ranks it may have.
   def grant_rank_to(sash)
     # Grant to sash if had lower rank. Do nothing if has same or greater rank.
     if sash.has_lower_rank_than(self)
-      sash.badges -= Badge.where(:name => name) # Clean up old ranks
-      sash.badges << self
-      sash.save
+      Badge.by_name(name).keys.each{|id| sash.rm_badge(id) } # Clean up old ranks
+      sash.add_badge(id)
     end
   end
-
-  def self.latest(limit = nil)
-    scope = order('created_at DESC')
-    limit.present? ? scope.limit(limit) : scope
-  end
 end

data/app/models/merit_action.rb

@@ -1,6 +1,8 @@
-class MeritAction < ActiveRecord::Base
+require "merit/models/#{Merit.orm}/merit_action"
+
+class MeritAction
   # Check rules defined for a merit_action
-  def check_badge_rules(defined_rules)
+  def check_rules(defined_rules)
     action_name = "#{target_model}\##{action_method}"
 
     unless had_errors
@@ -25,7 +27,7 @@ class MeritAction < ActiveRecord::Base
             begin
               target = target_object.send(to)
             rescue
-              Rails.logger.warn "[merit] No target_object found on check_badge_rules."
+              Rails.logger.warn "[merit] No target_object found on check_rules."
               return
             end
           end

data/app/models/sash.rb

@@ -1,19 +1,10 @@
-class Sash < ActiveRecord::Base
-  has_many :badges_sashes
-  has_many :badges, :through => :badges_sashes
-
-  # Latest badges granted by Merit
-  def self.latest_badges(limit = 10)
-    select('DISTINCT sashes.id, sashes.*').joins(:badges_sashes).order('badges_sashes.created_at DESC').limit(limit)
-  end
+require "merit/models/#{Merit.orm}/sash"
 
+class Sash
   # Decides if sash has lower rank than a given badge
   def has_lower_rank_than(badge)
-    levels(badge.name).all_lower_than badge.level
-  end
-
-  # Collect Sash levels given a badge name
-  def levels(badge_name)
-    badges.where(:name => badge_name).collect(&:level)
+    badges = Badge.find_by_id(badge_ids)
+    levels = badges.by_name(badge.name).collect(&:level)
+    levels.all_lower_than badge.level
   end
 end

data/lib/generators/active_record/merit_generator.rb

@@ -3,25 +3,25 @@ require 'rails/generators/active_record'
 module ActiveRecord
   module Generators
     class MeritGenerator < ActiveRecord::Generators::Base
-      argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      desc "add active_record merit migrations"
 
-      source_root File.expand_path("../templates", __FILE__)
-
-      def model_exists?
-        File.exists?(File.join(destination_root, model_path))
-      end
-
-      def model_path
-        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      def self.next_migration_number(path)
+        unless @prev_migration_nr
+          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+        else
+          @prev_migration_nr += 1
+        end
+        @prev_migration_nr.to_s
       end
 
-      def copy_merit_migration
+      def copy_migrations_and_model
+        migration_template 'create_merit_actions.rb', 'db/migrate/create_merit_actions.rb'
+        migration_template 'create_sashes.rb', 'db/migrate/create_sashes.rb'
+        migration_template 'create_badges_sashes.rb', 'db/migrate/create_badges_sashes.rb'
         migration_template "add_fields_to_model.rb", "db/migrate/add_fields_to_#{table_name}"
       end
-
-      def inject_merit_content
-        inject_into_class(model_path, class_name, "  has_merit\n\n") if model_exists?
-      end
     end
   end
 end

data/lib/generators/merit/install_generator.rb

@@ -1,30 +1,13 @@
-require 'rails/generators/migration'
-
 module Merit
   module Generators
-    class InstallGenerator < ::Rails::Generators::Base
-      include Rails::Generators::Migration
+    class InstallGenerator < Rails::Generators::Base
       source_root File.expand_path('../templates', __FILE__)
-      desc "add the migrations"
-
-      def self.next_migration_number(path)
-        unless @prev_migration_nr
-          @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
-        else
-          @prev_migration_nr += 1
-        end
-        @prev_migration_nr.to_s
-      end
-
+      desc "Copy config and rules files"
       def copy_migrations_and_model
-        migration_template 'create_merit_actions.rb', 'db/migrate/create_merit_actions.rb'
-        migration_template 'create_badges.rb', 'db/migrate/create_badges.rb'
-        migration_template 'create_sashes.rb', 'db/migrate/create_sashes.rb'
-        migration_template 'create_badges_sashes.rb', 'db/migrate/create_badges_sashes.rb'
+        template 'merit.rb', 'config/initializers/merit.rb'
         template 'merit_badge_rules.rb', 'app/models/merit_badge_rules.rb'
         template 'merit_point_rules.rb', 'app/models/merit_point_rules.rb'
         template 'merit_rank_rules.rb', 'app/models/merit_rank_rules.rb'
-        template 'merit.rb', 'config/initializers/merit.rb'
       end
     end
   end

data/lib/generators/merit/merit_generator.rb

@@ -3,6 +3,18 @@ module Merit
     class MeritGenerator < Rails::Generators::NamedBase
       source_root File.expand_path("../templates", __FILE__)
       hook_for :orm
+
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{file_path}.rb")
+      end
+
+      def inject_merit_content
+        inject_into_class(model_path, class_name, "  has_merit\n\n") if model_exists?
+      end
     end
   end
 end

data/lib/generators/merit/templates/merit.rb

@@ -2,4 +2,13 @@
 Merit.setup do |config|
   # Check rules on each request or in background
   # config.checks_on_each_request = true
-end
+
+  # Define ORM. Could be :active_record (default) and :mongo_mapper
+  # config.orm = :active_record
+end
+
+# Create application badges (uses https://github.com/norman/ambry)
+# Badge.create!({
+#   :id => 1,
+#   :name => 'just-registered'
+# })

data/lib/merit.rb

@@ -11,6 +11,10 @@ module Merit
   mattr_accessor :checks_on_each_request
   @@checks_on_each_request = true
 
+  # Define ORM
+  mattr_accessor :orm
+  @@orm = :active_record
+
   # Load configuration from initializer
   def self.setup
     yield self
@@ -18,9 +22,14 @@ module Merit
 
   class Engine < Rails::Engine
     initializer 'merit.controller' do |app|
+      # Merit.orm now set
+      if Merit.orm == :active_record
+        require "merit/models/#{Merit.orm}/badges_sash"
+      end
+
       ActiveSupport.on_load(:action_controller) do
-         include Merit::ControllerExtensions
+        include Merit::ControllerExtensions
       end
     end
   end
-end
+end

data/lib/merit/controller_extensions.rb

@@ -16,7 +16,7 @@ module Merit
             target_id = target_object.try(:id)
           end
 
-          # TODO: value relies on params[:value] on the controller, should be configurable
+          # TODO: value should be configurable (now it's params[:value] set in the controller)
           value = params[:value]
           MeritAction.create(
             :user_id       => current_user.try(:id),
@@ -29,7 +29,7 @@ module Merit
 
           # Check rules in after_filter?
           if Merit.checks_on_each_request
-            ::MeritBadgeRules.new.check_new_actions
+            badge_rules.check_new_actions
           end
         end
       end

data/lib/merit/model_additions.rb

@@ -1,30 +1,31 @@
 module Merit
-  def self.included(base)
-    base.send :extend, ClassMethods
-  end
+  extend ActiveSupport::Concern
 
   module ClassMethods
     def has_merit(options = {})
       belongs_to :sash
-      send :include, InstanceMethods
+
+      if Merit.orm == :mongo_mapper
+        plugin Merit
+        key :sash_id, String
+        key :points, Integer, :default => 0
+      end
     end
   end
 
-  module InstanceMethods
-    # Return it's sash badges
-    def badges
-      create_sash_if_none
-      sash.badges
-    end
+  def badges
+    create_sash_if_none
+    Badge.find_by_id(sash.badge_ids).to_a
+  end
 
-    # Create sash if doesn't have
-    def create_sash_if_none
-      if sash.nil?
-        self.sash = Sash.new
-        self.save(:validate => false)
-      end
+  # Create sash if doesn't have
+  def create_sash_if_none
+    if sash.nil?
+      self.sash = Sash.new
+      self.save(:validate => false)
     end
   end
 end
 
-ActiveRecord::Base.send :include, Merit
+ActiveRecord::Base.send :include, Merit if Object.const_defined?('ActiveRecord')
+MongoMapper::Document.plugin Merit if Object.const_defined?('MongoMapper')