scorecard 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1232899ca7b26af8e4a8d8af2baaae024343a688
-  data.tar.gz: c3c252f4debd3424989324fa5a0b239a13f90185
+  metadata.gz: 52409db56a58a6ec606d0f7e967aefe8b45dff3e
+  data.tar.gz: 68ff1f82181c3dd3714258e0fab235773d4b16ea
 SHA512:
-  metadata.gz: 2dee14b5121ee947bf95bd12d17ed95a08b36cbb5e6aa469871d7582129c0b48b3b3517f3332790adf72a75df7e1a134008a5f20f63b4c65f87ce9260a8eaa2e
-  data.tar.gz: 88d9897dd851e560050b03bfeb8b88258264ff0c580dcba90b7f7b1efda7eda10109e50b11aab721de74e39523c202fff8b1fd8718e031bf4cf36a2c17a27950
+  metadata.gz: 21eea64081d80a56970635315e654b8ee119e735b95d435bbf3735658f8c4e48f8dbf66f18baa7741d9fd9693e9a102028d2a988c9338ddb0c1904aa27824d4e
+  data.tar.gz: 2da28683c83900f432e8c8524839f0a785ed60172586ac4b8cf351ca3d6ea82169a97ff52a7d8797882e0109389345badb31e3b9bb29293ee903abea771f002b

data/README.md

@@ -8,7 +8,7 @@ For anyone who comes across this, please note this is not yet feature complete,
 
 Add this line to your application's Gemfile:
 
-    gem 'scorecard', '0.0.3'
+    gem 'scorecard', '0.1.0'
 
 Don't forget to bundle:
 
@@ -24,7 +24,7 @@ In an initializer, define the events that points are tied to - with a unique con
 
 ```ruby
 Scorecard.configure do |config|
-  config.rules.add_rule :new_post, 50
+  config.rules.add :new_post, 50
 end
 ```
 
@@ -32,7 +32,7 @@ You can also provide a block with logic for whether to award the points, the max
 
 ```ruby
 Scorecard.configure do |config|
-  config.rules.add_rule :new_post, 50, limit: 100, timeframe: :day,
+  config.rules.add :new_post, 50, limit: 100, timeframe: :day,
   if: lambda { |payload| payload[:user].posts.count <= 1 }
 end
 ```

data/app/models/scorecard/point.rb

@@ -15,6 +15,9 @@ class Scorecard::Point < ActiveRecord::Base
   validates :amount,     presence: true
   validates :user,       presence: true
 
+  scope :chronological, -> { order('created_at ASC') }
+  scope :reverse,       -> { order('created_at DESC') }
+
   def self.for_context(context)
     where context: context
   end
@@ -27,7 +30,15 @@ class Scorecard::Point < ActiveRecord::Base
     where gameable_id: gameable.id, gameable_type: gameable.class.name
   end
 
+  def self.for_raw_gameable(gameable_type, gameable_id)
+    where gameable_id: gameable_id, gameable_type: gameable_type
+  end
+
+  def self.for_timeframe(timeframe)
+    where created_at: timeframe
+  end
+
   def self.for_user_in_timeframe(context, user, timeframe)
-    for_context(context).for_user(user).where(created_at: timeframe)
+    for_context(context).for_user(user).for_timeframe(timeframe)
   end
 end

data/app/models/scorecard/progress.rb

@@ -0,0 +1,28 @@
+class Scorecard::Progress < ActiveRecord::Base
+  self.table_name = 'scorecard_progresses'
+
+  belongs_to :user,     polymorphic: true
+
+  if Rails.version.to_s < '4.0.0'
+    attr_accessible :identifier, :user
+  end
+
+  validates :identifier, presence: true, uniqueness: {
+    scope: [:user_type, :user_id]
+  }
+  validates :user,       presence: true
+
+  delegate :amount, to: :progression
+
+  def self.for_user(user)
+    where user_id: user.id, user_type: user.class.name
+  end
+
+  def self.for_identifier(identifier)
+    where identifier: identifier.to_s
+  end
+
+  def progression
+    Scorecard.progressions.find identifier.to_sym
+  end
+end

data/app/models/scorecard/user_badge.rb

@@ -0,0 +1,28 @@
+class Scorecard::UserBadge < ActiveRecord::Base
+  self.table_name = 'scorecard_user_badges'
+
+  belongs_to :user,     polymorphic: true
+  belongs_to :gameable, polymorphic: true
+
+  if Rails.version.to_s < '4.0.0'
+    attr_accessible :badge, :identifier, :gameable, :user
+  end
+
+  validates :badge,      presence: true
+  validates :identifier, presence: true, uniqueness: {
+    scope: [:badge, :user_type, :user_id]
+  }
+  validates :user,       presence: true
+
+  def self.for(badge, user)
+    for_user(user).where badge: badge
+  end
+
+  def self.for_user(user)
+    where user_id: user.id, user_type: user.class.name
+  end
+
+  def self.for_gameable(gameable)
+    where gameable_id: gameable.id, gameable_type: gameable.class.name
+  end
+end

data/db/migrate/3_create_user_badges.rb

@@ -0,0 +1,21 @@
+class CreateUserBadges < ActiveRecord::Migration
+  def change
+    create_table :scorecard_user_badges do |table|
+      table.string  :badge,         null: false
+      table.string  :identifier,    null: false
+      table.string  :user_type,     null: false
+      table.integer :user_id,       null: false
+      table.string  :gameable_type
+      table.integer :gameable_id
+      table.timestamps
+    end
+
+    add_index :scorecard_user_badges, :badge
+    add_index :scorecard_user_badges, :identifier
+    add_index :scorecard_user_badges, [:user_type, :user_id]
+    add_index :scorecard_user_badges, [:gameable_type, :gameable_id]
+    add_index :scorecard_user_badges,
+      [:badge, :identifier, :user_type, :user_id],
+      unique: true, name: :unique_badges
+  end
+end

data/db/migrate/4_create_progresses.rb

@@ -0,0 +1,15 @@
+class CreateProgresses < ActiveRecord::Migration
+  def change
+    create_table :scorecard_progresses do |table|
+      table.string  :identifier,    null: false
+      table.string  :user_type,     null: false
+      table.integer :user_id,       null: false
+      table.timestamps
+    end
+
+    add_index :scorecard_progresses, :identifier
+    add_index :scorecard_progresses, [:user_type, :user_id]
+    add_index :scorecard_progresses, [:identifier, :user_type, :user_id],
+      unique: true, name: :unique_progresses
+  end
+end

data/lib/scorecard.rb

@@ -5,15 +5,31 @@ module Scorecard
     yield self
   end
 
+  def self.badges
+    @badges ||= Scorecard::Badges.new
+  end
+
+  def self.progressions
+    @progressions ||= Scorecard::Progressions.new
+  end
+
   def self.rules
     @rules ||= Scorecard::Rules.new
   end
 end
 
+require 'scorecard/applied_badge'
+require 'scorecard/badge'
+require 'scorecard/badger'
+require 'scorecard/badges'
 require 'scorecard/card'
 require 'scorecard/cleaner'
 require 'scorecard/engine'
+require 'scorecard/parameters'
 require 'scorecard/point_rule'
+require 'scorecard/progression'
+require 'scorecard/progressions'
+require 'scorecard/refresh_worker'
 require 'scorecard/rules'
 require 'scorecard/scorer'
 require 'scorecard/subscriber'

data/lib/scorecard/applied_badge.rb

@@ -0,0 +1,18 @@
+class Scorecard::AppliedBadge
+  attr_accessor :badge, :user
+
+  delegate :name, :locked, :unlocked, :repeatable?, :identifier, to: :badge
+
+  def initialize(identifier, user)
+    @user  = user
+    @badge = Scorecard.badges.find identifier
+  end
+
+  def count
+    Scorecard::UserBadge.for(badge.identifier, user).count
+  end
+
+  def gameables
+    Scorecard::UserBadge.for(badge.identifier, user).collect &:gameable
+  end
+end

data/lib/scorecard/badge.rb

@@ -0,0 +1,14 @@
+class Scorecard::Badge
+  attr_reader :identifier
+  attr_accessor :name, :locked, :unlocked, :check, :gameables
+
+  def initialize(identifier, &block)
+    @identifier = identifier
+
+    block.call self
+  end
+
+  def repeatable?
+    @gameables.present?
+  end
+end

data/lib/scorecard/badger.rb

@@ -0,0 +1,78 @@
+class Scorecard::Badger
+  def self.update(user)
+    Scorecard.badges.each do |badge|
+      new(user, badge).update
+    end
+  end
+
+  def initialize(user, badge)
+    @user, @badge = user, badge
+  end
+
+  def update
+    if badge.check.call user
+      return unless existing.empty? || badge.repeatable?
+
+      remove_old
+      add_new
+    else
+      remove_all
+    end
+  end
+
+  private
+
+  attr_reader :user, :badge
+
+  def add_new
+    new_gameables.each do |gameable|
+      user_badge = Scorecard::UserBadge.create(
+        badge:      badge.identifier,
+        gameable:   gameable,
+        user:       user,
+        identifier: gameable.id
+      )
+
+      ActiveSupport::Notifications.instrument(
+        'badge.scorecard', user: user,
+        badge: Scorecard::AppliedBadge.new(badge.identifier, user),
+        gameable: gameable
+      ) if user_badge.persisted?
+    end
+  end
+
+  def existing
+    @existing ||= Scorecard::UserBadge.for badge.identifier, user
+  end
+
+  def gameables
+    @gameables ||= badge.repeatable? ? badge.gameables.call(user) : [user]
+  end
+
+  def new_gameables
+    gameables.reject { |gameable|
+      existing.any? { |existing| existing.gameable == gameable }
+    }
+  end
+
+  def old_user_badges
+    existing.reject { |user_badge|
+      gameables.any? { |gameable| user_badge.gameable == gameable }
+    }
+  end
+
+  def remove(user_badge)
+    user_badge.destroy
+
+    ActiveSupport::Notifications.instrument 'unbadge.scorecard',
+      user: user, badge: badge.identifier, gameable: user_badge.gameable
+  end
+
+  def remove_all
+    existing.each { |user_badge| remove user_badge }
+  end
+
+  def remove_old
+    old_user_badges.each { |user_badge| remove user_badge }
+  end
+end

data/lib/scorecard/badges.rb

@@ -0,0 +1,25 @@
+class Scorecard::Badges
+  include Enumerable
+
+  attr_reader :badges
+
+  def initialize
+    @badges = []
+  end
+
+  def add(identifier, &block)
+    badges << Scorecard::Badge.new(identifier, &block)
+  end
+
+  def each(&block)
+    badges.each &block
+  end
+
+  def find(identifier)
+    badges.detect { |badge| badge.identifier == identifier }
+  end
+
+  def clear
+    badges.clear
+  end
+end

data/lib/scorecard/card.rb

@@ -5,6 +5,15 @@ class Scorecard::Card
     @user = user
   end
 
+  def badges
+    @badges ||= begin
+      identifiers = Scorecard::UserBadge.for_user(user).pluck(:badge).uniq
+      identifiers.collect { |identifier|
+        Scorecard::AppliedBadge.new identifier.to_sym, user
+      }
+    end
+  end
+
   def level
     @level ||= begin
       record = Scorecard::Level.for_user(user)
@@ -15,4 +24,15 @@ class Scorecard::Card
   def points
     @points ||= Scorecard::Point.for_user(user).sum(:amount)
   end
+
+  def progress
+    @progress ||= Scorecard::Progress.for_user(user).collect(&:amount).sum
+  end
+
+  def remaining_progressions
+    @remaining_progressions ||= Scorecard.progressions.without(
+      Scorecard::Progress.for_user(user).collect(&:identifier).
+        collect(&:to_sym)
+    )
+  end
 end

data/lib/scorecard/cleaner.rb

@@ -1,6 +1,10 @@
 class Scorecard::Cleaner
-  def self.points(gameable)
-    Scorecard::Point.for_gameable(gameable).each do |point|
+  def self.points(gameable_or_type, gameable_id = nil)
+    points = gameable_id.nil? ?
+      Scorecard::Point.for_gameable(gameable_or_type) :
+      Scorecard::Point.for_raw_gameable(gameable_or_type, gameable_id)
+
+    points.each do |point|
       point.destroy
       ActiveSupport::Notifications.instrument 'scorecard', user: point.user
     end

data/lib/scorecard/clear_worker.rb

@@ -2,6 +2,6 @@ class Scorecard::ClearWorker
   include Sidekiq::Worker
 
   def perform(class_name, id)
-    Scorecard::Cleaner.points class_name.constantize.find(id)
+    Scorecard::Cleaner.points class_name, id
   end
 end

data/lib/scorecard/engine.rb

@@ -2,6 +2,6 @@ class Scorecard::Engine < Rails::Engine
   engine_name :scorecard
 
   initializer :scorecard do |app|
-    Scorecard::Subscriber.attach_to :scorecard
+    Scorecard::Subscriber.attach_to 'internal.scorecard'
   end
 end

data/lib/scorecard/parameters.rb

@@ -0,0 +1,30 @@
+class Scorecard::Parameters
+  attr_reader :options, :prefixes
+
+  def initialize(options, prefixes = [:gameable, :user])
+    @options, @prefixes = options.clone, prefixes
+  end
+
+  def expand
+    prefixes.collect(&:to_sym).each do |prefix|
+      next unless options[prefix]
+
+      options["#{prefix}_id"]   = options[prefix].id
+      options["#{prefix}_type"] = options[prefix].class.name
+      options.delete prefix
+    end
+
+    options.stringify_keys
+  end
+
+  def contract
+    prefixes.collect(&:to_s).each do |prefix|
+      next unless options["#{prefix}_type"]
+
+      klass = options.delete("#{prefix}_type").constantize
+      options[prefix] = klass.find options.delete("#{prefix}_id")
+    end
+
+    options.symbolize_keys
+  end
+end

data/lib/scorecard/progression.rb

@@ -0,0 +1,10 @@
+class Scorecard::Progression
+  attr_reader :identifier, :amount
+  attr_accessor :link_text, :link_url, :check
+
+  def initialize(identifier, amount, &block)
+    @identifier, @amount = identifier, amount
+
+    block.call self
+  end
+end

data/lib/scorecard/progressions.rb

@@ -0,0 +1,31 @@
+class Scorecard::Progressions
+  include Enumerable
+
+  attr_reader :progressions
+
+  def initialize
+    @progressions = []
+  end
+
+  def add(identifier, amount, &block)
+    progressions << Scorecard::Progression.new(identifier, amount, &block)
+  end
+
+  def each(&block)
+    progressions.each &block
+  end
+
+  def find(identifier)
+    progressions.detect { |progression| progression.identifier == identifier }
+  end
+
+  def without(identifiers)
+    progressions.reject { |progression|
+      identifiers.include?(progression.identifier)
+    }
+  end
+
+  def clear
+    progressions.clear
+  end
+end

data/lib/scorecard/refresh_worker.rb

@@ -0,0 +1,7 @@
+class Scorecard::RefreshWorker
+  include Sidekiq::Worker
+
+  def perform(options)
+    Scorecard::Scorer.refresh Scorecard::Parameters.new(options).contract
+  end
+end

data/lib/scorecard/rules.rb

@@ -5,11 +5,11 @@ class Scorecard::Rules
     @point_rules = []
   end
 
-  def add_rule(context, amount, options = {})
+  def add(context, amount, options = {})
     point_rules << Scorecard::PointRule.new(context, amount, options)
   end
 
-  def find_rule(context)
+  def find(context)
     point_rules.detect { |rule| rule.context == context }
   end
 

data/lib/scorecard/score_worker.rb

@@ -2,13 +2,7 @@ class Scorecard::ScoreWorker
   include Sidekiq::Worker
 
   def perform(context, options)
-    %w(gameable user).each do |prefix|
-      next unless options["#{prefix}_type"]
-
-      klass = options.delete("#{prefix}_type").constantize
-      options[prefix] = klass.find options.delete("#{prefix}_id")
-    end
-
-    Scorecard::Scorer.points context.to_sym, options.symbolize_keys
+    Scorecard::Scorer.points context.to_sym,
+      Scorecard::Parameters.new(options).contract
   end
 end

data/lib/scorecard/scorer.rb

@@ -9,19 +9,25 @@ class Scorecard::Scorer
   end
 
   def self.points(context, options)
-    ActiveSupport::Notifications.instrument 'points.scorecard',
+    ActiveSupport::Notifications.instrument 'points.internal.scorecard',
       options.merge(context: context)
   end
 
   def self.points_async(context, options)
-    [:gameable, :user].each do |prefix|
-      next unless options[prefix]
+    Scorecard::ScoreWorker.perform_async context,
+      Scorecard::Parameters.new(options).expand
+  end
 
-      options["#{prefix}_id"]   = options[prefix].id
-      options["#{prefix}_type"] = options[prefix].class.name
-      options.delete prefix
-    end
+  def self.refresh(options)
+    ActiveSupport::Notifications.instrument 'progress.internal.scorecard',
+      options
+    ActiveSupport::Notifications.instrument 'badge.internal.scorecard',
+      options
+  end
 
-    Scorecard::ScoreWorker.perform_async context, options.stringify_keys
+  def self.refresh_async(options)
+    Scorecard::RefreshWorker.perform_async(
+      Scorecard::Parameters.new(options).expand
+    )
   end
 end

data/lib/scorecard/subscriber.rb

@@ -13,8 +13,13 @@ class Scorecard::Subscriber
     send method, ActiveSupport::Notifications::Event.new(message, *args)
   end
 
+  def badge(event)
+    Scorecard::Badger.update event.payload[:user]
+  end
+
   def points(event)
-    rule = Scorecard.rules.find_rule event.payload[:context]
+    rule = Scorecard.rules.find event.payload[:context]
+    return if rule.nil?
 
     event.payload[:amount]     ||= rule.amount
     event.payload[:identifier] ||= event.payload[:gameable].id
@@ -29,4 +34,26 @@ class Scorecard::Subscriber
       'scorecard', user: event.payload[:user]
     ) if point.persisted?
   end
+
+  def progress(event)
+    Scorecard.progressions.each do |progression|
+      if progression.check.call event.payload[:user]
+        progress = Scorecard::Progress.create(
+          user: event.payload[:user], identifier: progression.identifier
+        )
+
+        ActiveSupport::Notifications.instrument(
+          'progress.scorecard', user: event.payload[:user]
+        ) if progress.persisted?
+      else
+        progresses = Scorecard::Progress.for_user(event.payload[:user]).
+          for_identifier(progression.identifier)
+        progresses.each &:destroy
+
+        ActiveSupport::Notifications.instrument(
+          'progress.scorecard', user: event.payload[:user]
+        ) if progresses.any?
+      end
+    end
+  end
 end

data/scorecard.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 Gem::Specification.new do |spec|
   spec.name          = 'scorecard'
-  spec.version       = '0.0.3'
+  spec.version       = '0.1.0'
   spec.authors       = ['Pat Allan']
   spec.email         = ['pat@freelancing-gods.com']
   spec.summary       = 'Rails Engine for common scorecard patterns'

data/spec/acceptance/badges_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe 'Badges' do
+  let(:user) { User.create! }
+  let(:post) { Post.create! user: user }
+  let(:card) { Scorecard::Card.new user }
+
+  before :each do
+    Scorecard.configure do |config|
+      config.badges.add :new_post do |badge|
+        badge.name     = 'Beginner'
+        badge.locked   = 'Write a post'
+        badge.unlocked = 'You wrote a post!'
+        badge.check    = lambda { |user| Post.where(user_id: user.id).any? }
+      end
+    end
+
+    post
+  end
+
+  it 'assigns badges to users' do
+    Scorecard::Scorer.refresh user: user
+
+    expect(card.badges.collect(&:name)).to eq(['Beginner'])
+  end
+
+  it "fires a badge notification when the badge is awarded" do
+    fired = false
+
+    subscriber = ActiveSupport::Notifications.subscribe 'badge.scorecard' do |*args|
+      payload = ActiveSupport::Notifications::Event.new(*args).payload
+      fired = (payload[:user] == user) && (payload[:badge].identifier == :new_post)
+    end
+
+    Scorecard::Scorer.refresh user: user
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    expect(fired).to be_true
+  end
+
+  it "doesn't repeat badges with different identifiers" do
+    Scorecard::Scorer.refresh user: user
+    Scorecard::Scorer.refresh user: user
+
+    expect(card.badges.collect(&:name)).to eq(['Beginner'])
+  end
+
+  it "fires a badge notification only when the badge is awarded" do
+    count = 0
+
+    subscriber = ActiveSupport::Notifications.subscribe 'badge.scorecard' do |*args|
+      count += 1
+    end
+
+    Scorecard::Scorer.refresh user: user
+    Scorecard::Scorer.refresh user: user
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    expect(count).to eq(1)
+  end
+
+  it "repeats repeatable badges with different identifiers" do
+    Scorecard.badges.find(:new_post).gameables = lambda { |user|
+      Post.where(user_id: user.id)
+    }
+    second = Post.create! user: user
+
+    Scorecard::Scorer.refresh user: user
+
+    badge = card.badges.first
+    expect(badge.name).to eq('Beginner')
+    expect(badge.count).to eq(2)
+    expect(badge.gameables).to eq([post, second])
+  end
+
+  it "fires a badge notification each time it is awarded" do
+    Scorecard.badges.find(:new_post).gameables = lambda { |user|
+      Post.where(user_id: user.id)
+    }
+    Post.create! user: user
+
+    count = 0
+
+    subscriber = ActiveSupport::Notifications.subscribe 'badge.scorecard' do |*args|
+      count += 1
+    end
+
+    Scorecard::Scorer.refresh user: user
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    expect(count).to eq(2)
+  end
+
+  it 'assigns badges to users via Sidekiq' do
+    Scorecard::Scorer.refresh_async user: user
+
+    expect(card.badges.collect(&:name)).to eq(['Beginner'])
+  end
+end

data/spec/acceptance/clearing_points_spec.rb

@@ -6,7 +6,7 @@ describe 'Clearing Points' do
 
   before :each do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50
+      config.rules.add :new_post, 50
     end
 
     post

data/spec/acceptance/progessions_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe 'Progressions' do
+  let(:user) { User.create! }
+  let(:card) { Scorecard::Card.new user }
+
+  before :each do
+    Scorecard.configure do |config|
+      config.progressions.add :add_info, 10 do |progression|
+        progression.link_text = 'Add some information'
+        progression.link_url  = '/foo'
+        progression.check     = lambda { |user| true }
+      end
+    end
+  end
+
+  it 'marks progress for users' do
+    Scorecard::Scorer.refresh user: user
+
+    expect(card.progress).to eq(10)
+  end
+
+  it "fires a notification when progress is made" do
+    fired = false
+
+    subscriber = ActiveSupport::Notifications.subscribe 'progress.scorecard' do |*args|
+      payload = ActiveSupport::Notifications::Event.new(*args).payload
+      fired = (payload[:user] == user)
+    end
+
+    Scorecard::Scorer.refresh user: user
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    expect(fired).to be_true
+  end
+
+  it "doesn't duplicate progress" do
+    Scorecard::Scorer.refresh user: user
+    Scorecard::Scorer.refresh user: user
+
+    expect(card.progress).to eq(10)
+  end
+
+  it "fires only a single notification when progress is made" do
+    count = 0
+
+    subscriber = ActiveSupport::Notifications.subscribe 'progress.scorecard' do |*args|
+      count += 1
+    end
+
+    Scorecard::Scorer.refresh user: user
+    Scorecard::Scorer.refresh user: user
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    expect(count).to eq(1)
+  end
+
+  it 'marks progress for users via Sidekiq' do
+    Scorecard::Scorer.refresh_async user: user
+
+    expect(card.progress).to eq(10)
+  end
+
+  it "removes percentage if progression no longer applies" do
+    Scorecard::Scorer.refresh user: user
+
+    expect(card.progress).to eq(10)
+
+    Scorecard.progressions.find(:add_info).check = lambda { |user| false }
+
+    Scorecard::Scorer.refresh_async user: user
+
+    card = Scorecard::Card.new user
+    expect(card.progress).to eq(0)
+  end
+end

data/spec/acceptance/read_points_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe 'Reading points' do
   it "returns the total points for a user" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_user, 20
-      config.rules.add_rule :new_post, 30
+      config.rules.add :new_user, 20
+      config.rules.add :new_post, 30
     end
 
     user = User.create!

data/spec/acceptance/score_points_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe 'Scoring points' do
   it "stores points for configured behaviour" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50
+      config.rules.add :new_post, 50
     end
 
     user = User.create!
@@ -23,7 +23,7 @@ describe 'Scoring points' do
 
   it "only stores points when provided logic passes" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50,
+      config.rules.add :new_post, 50,
         if: lambda { |payload| Post.count <= 1 }
     end
 
@@ -40,7 +40,7 @@ describe 'Scoring points' do
 
   it "does not double-up on points for the same event" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50
+      config.rules.add :new_post, 50
     end
 
     user = User.create!
@@ -61,7 +61,7 @@ describe 'Scoring points' do
 
   it "respects limit options" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50, limit: 100
+      config.rules.add :new_post, 50, limit: 100
     end
 
     user = User.create!
@@ -75,7 +75,7 @@ describe 'Scoring points' do
 
   it "respects timeframe options" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50, timeframe: :day
+      config.rules.add :new_post, 50, timeframe: :day
     end
 
     user = User.create!
@@ -88,7 +88,7 @@ describe 'Scoring points' do
 
   it "allows for processing via Sidekiq" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_user, 20
+      config.rules.add :new_user, 20
     end
 
     user = User.create!
@@ -108,7 +108,7 @@ describe 'Scoring points' do
 
   it "fires a generic notification" do
     Scorecard.configure do |config|
-      config.rules.add_rule :new_post, 50
+      config.rules.add :new_post, 50
     end
 
     fired = false

data/spec/acceptance/unbadging_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'Unbadging' do
+  let(:user) { User.create! }
+  let(:post) { Post.create! user: user }
+  let(:card) { Scorecard::Card.new user }
+
+  before :each do
+    Scorecard.configure do |config|
+      config.badges.add :new_post do |badge|
+        badge.name     = 'Beginner'
+        badge.locked   = 'Write a post'
+        badge.unlocked = 'You wrote a post!'
+        badge.check    = lambda { |user| Post.where(user_id: user.id).any? }
+      end
+    end
+
+    post
+    Scorecard::Scorer.refresh user: user
+    post.destroy
+  end
+
+  it 'removes badges from users' do
+    Scorecard::Scorer.refresh user: user
+
+    expect(card.badges.collect(&:name)).to be_empty
+  end
+
+  it "fires a badge notification when the badge is removed" do
+    fired = false
+
+    subscriber = ActiveSupport::Notifications.subscribe 'unbadge.scorecard' do |*args|
+      payload = ActiveSupport::Notifications::Event.new(*args).payload
+      fired = (payload[:user] == user) && (payload[:badge] == :new_post)
+    end
+
+    Scorecard::Scorer.refresh user: user
+
+    ActiveSupport::Notifications.unsubscribe(subscriber)
+
+    expect(fired).to be_true
+  end
+
+  it 'removes badges when there were many and some are no longer valid' do
+    Scorecard.badges.find(:new_post).gameables = lambda { |user|
+      Post.where(user_id: user.id)
+    }
+    second = Post.create! user: user
+
+    Scorecard::Scorer.refresh user: user
+
+    badge = card.badges.first
+    expect(badge.name).to eq('Beginner')
+    expect(badge.count).to eq(1)
+    expect(badge.gameables).to eq([second])
+  end
+
+  it 'removes badges to users via Sidekiq' do
+    Scorecard::Scorer.refresh_async user: user
+
+    expect(card.badges.collect(&:name)).to be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -17,5 +17,7 @@ RSpec.configure do |config|
   config.use_transactional_fixtures = true
   config.before :each do
     Scorecard.rules.clear
+    Scorecard.badges.clear
+    Scorecard.progressions.clear
   end
 end

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: scorecard
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Pat Allan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2014-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.15'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.8
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.8
 description: Use an engine to track points, badges and levels in your Rails app.
@@ -87,32 +87,47 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - app/models/scorecard/level.rb
 - app/models/scorecard/point.rb
+- app/models/scorecard/progress.rb
+- app/models/scorecard/user_badge.rb
 - config.ru
 - db/migrate/1_create_points.rb
 - db/migrate/2_create_levels.rb
+- db/migrate/3_create_user_badges.rb
+- db/migrate/4_create_progresses.rb
 - lib/scorecard.rb
+- lib/scorecard/applied_badge.rb
+- lib/scorecard/badge.rb
+- lib/scorecard/badger.rb
+- lib/scorecard/badges.rb
 - lib/scorecard/card.rb
 - lib/scorecard/cleaner.rb
 - lib/scorecard/clear_worker.rb
 - lib/scorecard/engine.rb
+- lib/scorecard/parameters.rb
 - lib/scorecard/point_rule.rb
+- lib/scorecard/progression.rb
+- lib/scorecard/progressions.rb
+- lib/scorecard/refresh_worker.rb
 - lib/scorecard/rules.rb
 - lib/scorecard/score_worker.rb
 - lib/scorecard/scorer.rb
 - lib/scorecard/subscriber.rb
 - scorecard.gemspec
+- spec/acceptance/badges_spec.rb
 - spec/acceptance/clearing_points_spec.rb
 - spec/acceptance/levels_spec.rb
+- spec/acceptance/progessions_spec.rb
 - spec/acceptance/read_points_spec.rb
 - spec/acceptance/score_points_spec.rb
+- spec/acceptance/unbadging_spec.rb
 - spec/internal/app/models/post.rb
 - spec/internal/app/models/user.rb
 - spec/internal/config/database.yml
@@ -131,25 +146,28 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.2
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Rails Engine for common scorecard patterns
 test_files:
+- spec/acceptance/badges_spec.rb
 - spec/acceptance/clearing_points_spec.rb
 - spec/acceptance/levels_spec.rb
+- spec/acceptance/progessions_spec.rb
 - spec/acceptance/read_points_spec.rb
 - spec/acceptance/score_points_spec.rb
+- spec/acceptance/unbadging_spec.rb
 - spec/internal/app/models/post.rb
 - spec/internal/app/models/user.rb
 - spec/internal/config/database.yml