badginator 0.0.1

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.ruby-version
+.ruby-gemset
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+spec/dummy/log/
+tmp
+.idea
+badginator.iml

data/.observr

@@ -0,0 +1,7 @@
+watch(/spec\/(.*)_spec.rb/) do |match|
+  system "rspec spec/#{match[1]}_spec.rb"
+end
+
+watch(/lib\/(badginator.*).rb/) do |match|
+  system "rspec spec/#{match[1]}_spec.rb"
+end

data/.rspec

@@ -0,0 +1 @@
+--color

data/.ruby-gemset.example

@@ -0,0 +1 @@
+badginator

data/.ruby-version.example

@@ -0,0 +1 @@
+1.9.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  1.9.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in badginator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Steven Hilton
+
+MIT License
+
+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,146 @@
+# Badginator
+
+Badginator is a gem to add "badges" (or "trophies" or "achievements") to any model
+of a Rails application, like User or Player. Useful for game-oriented applications.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'badginator'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install badginator
+
+Once installed run the install generator:
+
+   $ rails g badginator:install
+
+This generates a model and migration for AwardedBadges. Be sure the run the migration:
+
+    $ rake db:migrate
+
+
+## Usage
+
+Define your badges in `config/initializers/badginator.rb`, using the Badginator.define_badge() method. All badges
+are awarded to a *nominee* based on *condition* in a given *context*.
+
+## Properties
+Badges have a few properties:
+#### code
+A ruby symbol. Each defined badge must be unique across your badge set
+
+#### disabled
+A boolean. You may want to disable a badge if it no longer applies, A disabled badge will never be awarded and will
+ not show up in a global badge list. Awardees will still be able to see their own disabled badges if they have them.
+
+#### description
+A human readable string.
+
+#### condition
+A lamda that accepts a `nominee` and a `context`. Should evaluate to a boolean.
+This determines whether or not the nominee won the award. This lambda should have no effects.
+
+#### level
+Optional declaration of the difficulty level of the badge for use by the application.
+Can be anything, a numeric value (1,2,3,5,8) or string value (bronze, silver, gold, platinum).
+
+It is useful to assign a numeric value here, so you can sum the level of all a players badge's for an
+overall score or reputation.
+
+#### image
+Optional url of image or code used for a graphic of the badge
+
+#### reward
+An optional lambda that gets called and returned as a part of a status object when the badge is awarded.
+Also takes the two `nominee` and `context` params. This lambda should have no effects. Use the return value in
+application code to actually assign rewards.
+
+This could be a numeric value like bonus points or gold. Or and in-game object to add to a Player's inventory.
+
+
+### Examples
+
+    Badginator.define_badge do
+      code :first_blood
+      name First Blood
+      description  "Made your first kill"
+      condition ->(nominee, context) {
+        nominee.kills > 1
+      }
+      reward 1
+      image "http:://example.org/images/first_blood_badge.gif"
+      level :bronze
+    end
+
+    Badginator.define_badge do
+      code :hoarder
+      name "Gold Hoarder"
+      description  "You have collected over 100,000 gold!"
+      condition ->(nominee, context) {
+        nominee.gold > 100000
+      }
+      reward 10
+      image "http://example.org/images/hoarder_badge.gif"
+    end
+
+A class becomes eligible to be nominated when you include the Badginator::Nominee module:
+
+    class Player
+      include Badginator::Nominee
+
+      [...]
+
+    end
+
+After that setup, you are ready to go!
+
+Try to award a player an award:
+
+    status = player.try_award_badge(:hoarder, context) # context is optional
+
+The result will have one of four states:
+
+1. Did not win (no action taken)
+2. Already won (player already has badge, no action taken)
+3. Won (badge added)
+4. Error (something went wrong)
+
+If the badges was awarded, the return status has the badge attached:
+
+    if status.code == Badginator::WON
+      awarded_badge = status.awarded_bade
+    end
+
+The `awarded_badge` is an ActiveRecord object, and has the defined badge attached to it:
+
+    $ awarded_badge.badge.code #=> :hoarder
+
+    $ awarded_badge.reward     #=> 10
+
+
+You can get a list of badges the player has won:
+
+    $ player.badges
+
+
+Lastly, you can get a list of all available badges (minus the disabled ones):
+
+    $ Badginator.badges
+
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,26 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Badginator'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec'
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new('spec')
+
+
+task :default => :spec
+
+

data/badginator.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+$:.push File.expand_path('../lib', __FILE__)
+require 'badginator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "badginator"
+  spec.version       = Badginator::VERSION
+  spec.authors       = ["Steven Hilton"]
+  spec.email         = ["mshiltonj@gmail.com"]
+  spec.description   = %q{Add "badges" to any Rails model.}
+  spec.summary       = %q{Badginator is a gem to add "badges" (or "trophies" or "achievements") to any model of a Rails application, like User or Player. Useful for game-oriented applications.}
+  spec.homepage      = "https://github.com/mshiltonj/badginator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 4.0.0"
+
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "awesome_print"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "observr"
+
+
+end

data/lib/badginator/badge.rb

@@ -0,0 +1,27 @@
+class Badginator
+  class Badge
+
+    def self.setters(*method_names)
+      method_names.each do |name|
+        send :define_method, name do |*data|
+          if data.length > 0
+            instance_variable_set "@#{name}", data.first
+          else
+            instance_variable_get "@#{name}"
+          end
+
+        end
+      end
+    end
+
+    setters :code, :name, :description, :condition, :disabled, :level, :image, :reward
+
+
+    def build_badge(&block)
+      instance_eval &block
+      @code = @code.to_sym if @code
+    end
+
+
+  end
+end

data/lib/badginator/nominee.rb

@@ -0,0 +1,33 @@
+class Badginator
+  module Nominee
+
+    def self.included(base)
+      base.class_eval {
+        has_many :badges, class_name: "AwardedBadge", as: :awardee
+      }
+    end
+
+    def try_award_badge(badge_name, context = {})
+      badge = Badginator.get_badge(badge_name)
+
+      success =  badge.condition.call(self, context)
+
+      if success
+        if (self.has_badge?(badge_name))
+          status = Badginator::Status(Badginator::ALREADY_WON)
+        else
+          awarded_badge = AwardedBadge.create! awardee: self, badge_code: badge.code
+          status = Badginator::Status(Badginator::WON, awarded_badge)
+        end
+      else
+        status = Badginator::Status(Badginator::DID_NOT_WIN)
+      end
+
+      status
+    end
+
+    def has_badge?(badge_code)
+      AwardedBadge.where(badge_code: badge_code, awardee: self).first
+    end
+  end
+end

data/lib/badginator/status.rb

@@ -0,0 +1,11 @@
+class Badginator
+  class Status
+    attr_reader :code, :awarded_badge
+
+    def initialize(args = {})
+      @code = args[:code]
+      @awarded_badge = args[:badge]
+    end
+
+  end
+end

data/lib/badginator/version.rb

@@ -0,0 +1,3 @@
+class Badginator
+  VERSION = "0.0.1"
+end

data/lib/badginator.rb

@@ -0,0 +1,59 @@
+require 'singleton'
+require "badginator/version"
+require "badginator/badge"
+require "badginator/status"
+require "badginator/nominee"
+
+class Badginator
+  include Singleton
+
+  DID_NOT_WIN = 1
+  WON         = 2
+  ALREADY_WON = 3
+  ERROR       = 4
+
+  def initialize
+    @badges = {}
+  end
+
+  def get_badge(badge_code)
+    @badges.fetch(badge_code)
+  end
+
+  def badges
+    @badges.values.select { |badge| ! badge.disabled }
+   end
+
+  def self.badges
+    self.instance.badges
+  end
+
+  def define_badge(*args, &block)
+    badge = Badge.new
+    badge.build_badge &block
+    badge.freeze
+
+    if @badges.key?(badge.code)
+      raise "badge code '#{badge.code}' already defined."
+    end
+
+    @badges[badge.code] = badge
+  end
+
+  def self.define_badge(*args, &block)
+    self.instance.define_badge(*args, &block)
+  end
+
+  def self.get_badge(badge_code)
+    self.instance.get_badge(badge_code)
+  end
+
+  def self.Status(status_code, badge = nil)
+    case status_code
+      when DID_NOT_WIN, WON, ALREADY_WON, ERROR
+        Badginator::Status.new code: status_code, badge: badge
+      else
+        rails TypeError, "Cannot convert #{status_code} to Status"
+    end
+  end
+end

data/lib/generators/badginator/install_generator.rb

@@ -0,0 +1,18 @@
+require 'rails/generators'
+class Badginator
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path("../../templates", __FILE__)
+
+    def create_awarded_badges_model
+      copy_file "app/models/awarded_badge.rb", "app/models/awarded_badge.rb"
+    end
+
+    def create_awarded_badges_migration
+      time_str = Time.now.strftime("%Y%m%d%H%M%S")
+      copy_file "db/migrate/create_table_awarded_badges.rb", "db/migrate/#{time_str}_create_table_awarded_badges.rb"
+    end
+
+
+  end
+end

data/lib/generators/templates/app/models/awarded_badge.rb

@@ -0,0 +1,8 @@
+class AwardedBadge < ActiveRecord::Base
+  belongs_to :awardee, polymorphic: true
+
+  def badge
+    Badginator.get_badge(badge_code)
+  end
+
+end

data/lib/generators/templates/db/migrate/create_table_awarded_badges.rb

@@ -0,0 +1,12 @@
+class CreateTableAwardedBadges < ActiveRecord::Migration
+  def change
+    create_table :awarded_badges do |t|
+      t.integer :awardee_id  
+      t.string  :awardee_type  
+      t.string  :badge_code
+      t.timestamps
+    end
+
+    add_index :awarded_badges, [:awardee_id, :awardee_type]
+  end
+end

data/spec/badge_spec.rb

@@ -0,0 +1,54 @@
+require_relative "spec_helper"
+
+describe "Badginator::Badge" do
+
+  before :each do
+    reset_badginator
+    Badginator.define_badge do
+      code :one
+      description "ONE"
+      condition ->(nominee, context) {
+        true
+      }
+    end
+
+    Badginator.define_badge do
+      code :two
+      description "TWO"
+      condition ->(nominee, context) {
+        true
+      }
+    end
+
+    Badginator.define_badge do
+      code :three
+      description "THREE"
+      condition ->(nominee, context) {
+        true
+      }
+    end
+
+    Badginator.define_badge do
+      code :four
+      description "FOUR"
+      condition ->(nominee, context) {
+        true
+      }
+      disabled true
+    end
+
+    Badginator.define_badge do
+      code :five
+      description "FIVE"
+      condition ->(nominee, context) {
+        true
+      }
+    end
+  end
+
+  it "will show a list of all available badges" do
+    expect(Badginator.badges.size).to eql(4)
+
+  end
+
+end

data/spec/badginator_spec.rb

@@ -0,0 +1,125 @@
+require_relative "spec_helper"
+
+describe "Badginator" do
+
+  it "can reset the singleton for tests" do
+    badginator1 = Badginator.instance
+    badginator2 = Badginator.instance
+
+    expect(badginator1.object_id).to eql(badginator2.object_id)
+
+    reset_badginator
+    badginator3 = Badginator.instance
+
+    expect(badginator3.object_id).to_not eql(badginator2.object_id)
+  end
+
+  describe "when defining a badge" do
+    before(:each) do
+      reset_badginator
+      @thecode = thecode = :foo_badge
+      @thename = thename = "Foo"
+
+      @badge1 = Badginator.define_badge do
+        code thecode
+        name thename
+        description "Foo'd something"
+        image :s3
+        level 2
+        condition ->(nominee, context) {
+          return true
+        }
+        reward ->(nominee, context){
+          1
+        }
+      end
+    end
+
+    it "return a badge definition" do
+      expect(@badge1.name).to eql( @thename)
+    end
+
+    it "can call the condition" do
+      expect(@badge1.condition.call(nil, nil)).to be_true
+    end
+
+    it "can not define the same badge code twice" do
+
+      expect {
+        thecode = @thecode
+        thename = @thename
+        other_badge = Badginator.define_badge do
+          code thecode
+          name thename
+          description "Foo'd something"
+          condition ->(nominee, context) {
+            return true
+          }
+        end
+      }.to raise_error
+    end
+
+    describe "when awarding a badge" do
+      before(:each) do
+
+        @badge_to_win = badge_to_win = :contest_winner
+
+        @badge2 = Badginator.define_badge do
+          code badge_to_win
+          name "Won A Contest"
+          description "We have a winner over here"
+          condition ->(nominee, context) {
+            nominee.winner?
+          }
+         end
+
+        @nominee = double('nominee')
+
+      end
+
+      it "should check for a winning condition" do
+        @nominee = Nominee.new
+        @nominee.should_receive(:winner?).and_return(true)
+
+        awarded_badge = AwardedBadge.new(awardee: @nominee, badge_code: @badge_to_win)
+        @nominee.should_receive(:has_badge?).and_return(false)
+
+        status = @nominee.try_award_badge(@badge_to_win)
+
+        expect(status.code).to eql(Badginator::WON)
+
+      end
+
+      it "should return a did not win status if the conditions is not met" do
+        @nominee = Nominee.new
+        @nominee.should_receive(:winner?).and_return(false)
+
+        status = @nominee.try_award_badge(@badge_to_win)
+        expect(status.code).to eql(Badginator::DID_NOT_WIN)
+      end
+
+      it "should check for already won condition" do
+        @nominee = Nominee.new
+        @nominee.should_receive(:winner?).and_return(true)
+
+        awarded_badge = AwardedBadge.new(awardee: @nominee, badge_code: @badge_to_win)
+        @nominee.should_receive(:has_badge?).and_return(true)
+
+        status = @nominee.try_award_badge(@badge_to_win)
+
+        expect(status.code).to eql(Badginator::ALREADY_WON)
+      end
+
+      it "should return the badge if won" do
+        @nominee = Nominee.new
+        @nominee.should_receive(:winner?).and_return(true)
+
+        awarded_badge = AwardedBadge.new(awardee: @nominee, badge_code: @badge_to_win)
+        @nominee.should_receive(:has_badge?).and_return(false)
+
+        status = @nominee.try_award_badge(@badge_to_win)
+        expect(status.awarded_badge.badge.code).to eql(awarded_badge.badge.code)
+      end
+    end
+  end
+end

data/spec/dummy/.gitignore

@@ -0,0 +1 @@
+log/*

data/spec/dummy/.rspec

@@ -0,0 +1 @@
+--color

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# 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__)
+
+Dummy::Application.load_tasks