paths_of_glory 0.1.0

data/CHANGELOG

@@ -0,0 +1,7 @@
+Mon Feb 22 2010
+--------------
+- Added "options" type for list
+
+Mon Feb 8 2010
+--------------
+- Added "integer" and "decimal" types

data/README.md

@@ -0,0 +1,73 @@
+Paths of Glory
+==============
+
+Paths of Glory sets you on the road to achievements!
+
+In short, it's a re-usable model for creating an achievement system.
+
+It's extracted from http://peertester.com and inspired by: http://stackoverflow.com/questions/885277/how-to-implement-an-achievement-system-in-ror
+
+
+
+Installation
+============
+
+Paths of Glory is easy to install.
+
+As a plugin:
+
+    ./script/plugin install git://github.com/paulca/paths_of_glory.git
+
+Or as a gem. Add this to your environment.rb:
+  
+    gem install paths_of_glory
+
+    config.gem 'paths_of_glory'
+
+Then generate the migration:
+
+    ./script/generate paths_of_glory
+
+And run the migration:
+
+    rake db:migrate
+    
+This creates the tables.
+
+Then, in your User model:
+
+    class User < ActiveRecord::Base
+      include Achievements
+    end
+
+Basic Usage
+===========
+
+Paths of Glory gives you access to a DSL to generate achievements. Achievements can have multiple levels or can just be standalone achievements.
+
+The pattern is basically:
+
+Create an achievement:
+
+    ./script/generate achievement Glory
+    
+This gives you `app/models/achievements/glory.rb` and `app/models/achievements/glory_observer.rb` with some bootstrapped code.
+
+You're on your own after that. Have fun!
+
+
+Running the tests
+=================
+
+You can run the tests by checking out the code into vendor/plugins of a Rails app and running:
+
+    rake
+
+About me
+========
+
+I'm Paul Campbell. I'm an avid Ruby on Rails web developer. Follow my ramblings at [http://www.pabcas.com](http://www.pabcas.com)
+
+Follow me on Twitter [http://twitter.com/paulca](http://twitter.com/paulca)
+
+Copyright (c) 2010 Paul Campbell, released under the MIT license

data/Rakefile

@@ -0,0 +1,43 @@
+require 'rake'
+require 'spec/rake/spectask'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run the specs'
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'app/**/*',
+  'generators/**/*',
+  'config/*',
+  'lib/**/*',
+  'rails/**/*',
+  'spec/**/*',
+  'features/**/*'
+]
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = "paths_of_glory"
+    s.version = "0.1.0"
+    s.author = "Paul Campbell"
+    s.email = "paul@rslw.com"
+    s.homepage = "http://www.github.com/paulca/paths_of_glory"
+    s.platform = Gem::Platform::RUBY
+    s.summary = "Getting you started on the road to achievements."
+    s.files = PKG_FILES.to_a
+    s.require_path = "lib"
+    s.has_rdoc = false
+    s.extra_rdoc_files = ["README.md"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new

data/achievement_system.gemspec

@@ -0,0 +1,65 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{achievement_system}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Paul Campbell"]
+  s.date = %q{2010-05-20}
+  s.email = %q{paul@rslw.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "CHANGELOG",
+     "README.md",
+     "Rakefile",
+     "app/models/achievement.rb",
+     "app/models/achievements.rb",
+     "generators/achievement/USAGE",
+     "generators/achievement/achievement_generator.rb",
+     "generators/achievement/templates/achievement.rb",
+     "generators/achievement/templates/achievement_observer.rb",
+     "generators/paths_of_glory/USAGE",
+     "generators/paths_of_glory/paths_of_glory_generator.rb",
+     "generators/paths_of_glory/templates/20100311101933_create_achievements.rb",
+     "rails/init.rb",
+     "spec/achievement_generator_spec.rb",
+     "spec/achievement_spec.rb",
+     "spec/blueprints.rb",
+     "spec/database.yml",
+     "spec/debug.log",
+     "spec/paths_of_glory_generator_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.has_rdoc = false
+  s.homepage = %q{http://www.github.com/paulca/achievement_system}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Getting you started on the road to achievements.}
+  s.test_files = [
+    "spec/achievement_generator_spec.rb",
+     "spec/achievement_spec.rb",
+     "spec/blueprints.rb",
+     "spec/paths_of_glory_generator_spec.rb",
+     "spec/schema.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end
+

data/app/models/achievement.rb

@@ -0,0 +1,73 @@
+class Achievement < ActiveRecord::Base
+
+  belongs_to :user
+  
+  named_scope :not_notified, :conditions => {:notified => false}
+  named_scope :recent, :order => "created_at desc"
+  named_scope :kind_of, lambda { |type| {:conditions => {:type => type.to_s}}} do
+    def current
+      order("level desc").limit(1).first
+    end
+  end
+  
+  named_scope :order, lambda { |order| {:order => order} }
+  named_scope :limit, lambda { |limit| {:limit => limit} }
+  
+  class << self
+    def levels
+      @levels ||= []
+    end
+
+    def level(level, options = {})
+      levels << {:level => level, :quota => options[:quota]}
+    end
+    
+    def set_thing_to_check(&block)
+      @thing_to_check = block
+    end
+    
+    def thing_to_check(object)
+      @thing_to_check.call(object)
+    end
+    
+    def select_level(level)
+      levels.select { |l| l[:level] == level }.first
+    end
+    
+    def quota_for(level)
+      select_level(level)[:quota] if select_level(level)
+    end
+    
+    def has_level?(level)
+      select_level(level).present?
+    end
+    
+    def current_level(user)
+      if current_achievement = user.achievements.kind_of(self).current
+        current_achievement.level
+      else
+        0
+      end
+    end
+    
+    def next_level(user)
+      current_level(user) + 1
+    end
+    
+    def current_progress(user)
+      thing_to_check(user) - quota_for(current_level(user)).to_i
+    end
+    
+    def next_level_quota(user)
+      quota_for(next_level(user)) - quota_for(current_level(user)).to_i
+    end
+    
+    def progress_to_next_level(user)
+      if(has_level?(next_level(user)))
+        return [(current_progress(user) * 100) / next_level_quota(user), 95].min
+      else
+        return nil
+      end
+    end
+  end
+end

data/app/models/achievements.rb

@@ -0,0 +1,36 @@
+module Achievements
+  
+  def self.included(base)
+    base.class_eval do
+      has_many :achievements do
+        def include?(achievement, level = nil)
+          all.select { |a| a.type.to_s == achievement.to_s and a.level == level }.any?
+        end
+      end
+    end
+  end
+
+  def award_achievement(achievement, level = nil)
+    achievement.create!(:user => self, :level => level)
+  end
+  
+  def has_achievement?(achievement, level = nil)
+    conditions = {:type => achievement.to_s, :user_id => id}    
+    conditions[:level] = level if level
+    achievements.first(:conditions => conditions).present?
+  end
+  
+  def get_badges_in_progress(badges)
+    badges.collect do |achievement|
+      {
+        :type => achievement,
+        :level => achievement.next_level(self),
+        :progress => achievement.progress_to_next_level(self),
+        :next_level_quota => achievement.next_level_quota(self),
+        :current_progress => achievement.current_progress(self),
+        :next_level => achievement.next_level(self)
+      }
+    end.sort_by { |achievement| achievement[:progress] }.reverse[0,3]
+  end
+  
+end

data/generators/achievement/achievement_generator.rb

@@ -0,0 +1,32 @@
+class AchievementGenerator < Rails::Generator::NamedBase
+  def manifest
+    record do |m|
+      m.class_collisions class_name, "#{class_name}"
+      m.class_collisions class_name, "#{class_name}Observer"
+      
+      m.directory 'app/models/achievements'
+      m.template "achievement.rb", "app/models/achievements/#{file_name}.rb"
+      m.template "achievement_observer.rb", "app/models/achievements/#{file_name}_observer.rb"
+    end
+  end
+
+    def after_generate
+      puts "
+
+Your new achievement, '#{class_name}' has been created.
+
+Now you need to edit:
+
+    app/models/achievements/#{file_name}.rb
+
+and
+
+    app/models/achievements/#{file_name}_observer.rb
+
+Then you need to activate the observer, by adding ':#{file_name}_observer' to environment.rb, eg:
+
+    config.active_record.observers = :#{file_name}_observer
+
+"
+    end
+end

data/generators/achievement/templates/achievement.rb

@@ -0,0 +1,19 @@
+class <%= class_name %> < Achievement
+  
+  # level 1, :quota => 5
+  # level 2, :quota => 10
+  # level 3, :quota => 30
+  # level 4, :quota => 100
+  # level 5, :quota => 500
+  
+  # set_thing_to_check { |user| ... }
+
+  def self.award_achievements_for(user)
+    return unless user
+    levels.each do |level|
+      if user.not.has_achievement?(self, level[:level]) and thing_to_check(user) >= level[:quota]
+        user.award_achievement(self, level[:level])
+      end
+    end
+  end
+end

data/generators/achievement/templates/achievement_observer.rb

@@ -0,0 +1,7 @@
+class <%= class_name %>Observer < ActiveRecord::Observer
+  observe :user
+  
+  def after_save(user)
+    Dedicated.award_achievements_for(user) if ('your conditions here')
+  end
+end

data/generators/paths_of_glory/USAGE

@@ -0,0 +1,5 @@
+Description:
+    Creates a migration to create a table to store achievements called "achievements"
+    
+Examples:
+    `./script/generate paths_of_glory`

data/generators/paths_of_glory/paths_of_glory_generator.rb

@@ -0,0 +1,30 @@
+class PathsOfGloryGenerator < Rails::Generator::Base
+  def manifest
+    record do |m|
+      m.directory 'db/migrate'
+      m.file "20100311101933_create_achievements.rb", "db/migrate/20100311101933_create_achievements.rb"
+    end
+  end
+  
+  def after_generate
+    puts "
+
+You're on the Path to Glory
+
+Now, add 'include Achievements' to your User model:
+
+    class User < ActiveRecord::Base
+      include Achievements
+    end
+
+and run:
+
+    rake db:migrate,
+
+To generate a new Achievement, run:
+
+    ./script/generate achievement Glory
+
+where 'Glory' is the name of the achievement."
+  end
+end

data/generators/paths_of_glory/templates/20100311101933_create_achievements.rb

@@ -0,0 +1,16 @@
+class CreateAchievements < ActiveRecord::Migration
+  def self.up
+    create_table :achievements do |t|
+      t.string :type
+      t.integer :level
+      t.integer :user_id
+      t.notified :boolean, :default => false
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :achievements
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'behavior'

data/spec/achievement_generator_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'rails_generator'
+require 'rails_generator/scripts/generate'
+
+describe AchievementGenerator do
+  
+  before do
+    @dirs = {}
+    @dirs['achievements'] = fake_rails_root + '/app/models/achievements'
+    @dirs.each do |key, dir|
+      FileUtils.mkdir_p(dir)
+    end
+    @original_files = {}
+    @original_files['achievements'] = file_list(@dirs['achievements'])
+    Rails::Generator::Scripts::Generate.new.run(["achievement", 'glory'], :destination => fake_rails_root, :backtrace => true)
+    
+    @files = (file_list(@dirs['achievements']) - @original_files['achievements'])
+  end
+  
+  let(:achievement_file) { @files.first }
+  let(:observer_file) { @files.last }
+  
+  it "should create the achievement file" do
+    File.basename(achievement_file).should == "glory.rb"
+    File.basename(observer_file).should == "glory_observer.rb"
+  end
+  
+  it "should make them beautiful" do
+    File.read(achievement_file).should match(/Glory < Achievement/)
+  end
+  
+  it "should make them beautiful" do
+    File.read(observer_file).should match(/GloryObserver < ActiveRecord::Observer/)
+  end
+  
+  
+  after do
+    FileUtils.rm_r(fake_rails_root)
+  end
+  
+  
+  def fake_rails_root
+    File.join(File.dirname(__FILE__), 'spec', 'rails_root')
+  end
+
+  def file_list(dir)
+    Dir.glob(File.join(dir, "*"))
+  end
+  
+end

data/spec/achievement_spec.rb

@@ -0,0 +1,102 @@
+require 'spec_helper'
+
+describe Achievement do
+  class Thing < Achievement
+    level 1, :quota => 1
+    level 2, :quota => 2
+    
+    set_thing_to_check {|u| u.sign_in_count }
+  end
+  
+  class Dedicated < Achievement
+
+    level 1, :quota => 5
+    level 2, :quota => 10
+    level 3, :quota => 30
+    level 4, :quota => 100
+    level 5, :quota => 500
+
+    set_thing_to_check { |user| user.sign_in_count.to_i }
+
+    def self.award_achievements_for(user)
+      return unless user
+      levels.each do |level|
+        if !user.has_achievement?(self, level[:level]) and thing_to_check(user) >= level[:quota]
+          user.award_achievement(self, level[:level])
+        end
+      end
+    end
+  end
+  
+  class User < ActiveRecord::Base
+    include Achievements
+    
+    def after_save
+      Dedicated.award_achievements_for(self) if sign_in_count_changed?
+    end
+  end
+  
+  User.blueprint do
+    email 'joe@king.com'
+    encrypted_password 'blah'
+    password_salt 'are you joking?'
+  end
+  
+  it "should have 2 levels" do
+    Thing.levels.size.should == 2
+  end
+  
+  it "should have a levels array" do
+    Thing.levels.should == [{:quota=> 1, :level =>1}, {:quota=>2, :level=>2}]
+  end
+  
+  describe ".quota_for" do
+    it "should give me back the quota" do
+      Dedicated.quota_for(2).should == 10
+    end
+  end
+  
+  describe ".has_level?" do
+    it "should tell me if it has a level" do
+      Dedicated.has_level?(1).should be_true
+    end
+    
+    it "should tell me if it doesn't have a level" do
+      Dedicated.has_level?(6).should be_false
+    end
+  end
+  
+  describe ".progress_to_next_level" do
+    before do
+      @user = User.make(:sign_in_count => 2)
+    end
+    
+    it "should tell me the thing to check" do
+      Thing.thing_to_check(@user).should == 2
+    end
+    
+    it "should show me that I'm 40% the way to dedicated" do
+      Dedicated.progress_to_next_level(@user).should == 40
+    end
+    
+    it "should update the progress as things happen" do
+      @user.update_attribute(:sign_in_count, 4)
+      Dedicated.progress_to_next_level(@user).should == 80
+    end
+    
+    it "should work for more than one level" do
+      @user.sign_in_count = 5
+      @user.save!
+      Dedicated.thing_to_check(@user).should == 5
+      Dedicated.progress_to_next_level(@user).should == 0
+      @user.update_attribute(:sign_in_count, 6)
+      Dedicated.progress_to_next_level(@user).should == 20
+    end
+    
+    it "should return nil finally" do
+      @user.sign_in_count = 500
+      @user.save!
+      Dedicated.progress_to_next_level(@user).should be_nil
+    end
+  end
+end

data/spec/blueprints.rb

@@ -0,0 +1,6 @@
+require 'machinist/active_record'
+require 'faker'
+require 'sham'
+
+Achievement.blueprint do
+end

data/spec/database.yml

@@ -0,0 +1,21 @@
+sqlite:
+  :adapter: sqlite
+  :database: spec/paths_of_glory.sqlite.db
+
+sqlite3:
+  :adapter: sqlite3
+  :database: spec/paths_of_glory.sqlite3.db
+
+postgresql:
+  :adapter: postgresql
+  :username: postgres
+  :password: postgres
+  :database: paths_of_glory_test
+  :min_messages: ERROR
+
+mysql:
+  :adapter: mysql
+  :host: localhost
+  :username: root
+  :password: password
+  :database: paths_of_glory_test