achievable 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.5"
+gem "capybara", ">= 0.4.0"
+gem "sqlite3"
+gem "rspec", '2.2.0'
+gem "rspec-rails", '2.2.1'
+gem 'resque', :require => 'resque/server'
+gem 'resque_spec'
+gem 'sourcify'

data/Gemfile.lock

@@ -0,0 +1,149 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.5)
+      actionpack (= 3.0.5)
+      mail (~> 2.2.15)
+    actionpack (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.5)
+      activesupport (= 3.0.5)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.5)
+      activemodel (= 3.0.5)
+      activesupport (= 3.0.5)
+    activesupport (3.0.5)
+    arel (2.0.9)
+    builder (2.1.2)
+    capybara (0.4.1.2)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.9)
+    childprocess (0.1.8)
+      ffi (~> 1.0.6)
+    culerity (0.2.15)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (1.0.7)
+      rake (>= 0.8.7)
+    file-tail (1.0.5)
+      spruz (>= 0.1.0)
+    i18n (0.5.0)
+    json (1.4.6)
+    json_pure (1.5.1)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.2)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.5)
+      actionmailer (= 3.0.5)
+      actionpack (= 3.0.5)
+      activerecord (= 3.0.5)
+      activeresource (= 3.0.5)
+      activesupport (= 3.0.5)
+      bundler (~> 1.0)
+      railties (= 3.0.5)
+    railties (3.0.5)
+      actionpack (= 3.0.5)
+      activesupport (= 3.0.5)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    redis (2.2.0)
+    redis-namespace (0.10.0)
+      redis (< 3.0.0)
+    resque (1.15.0)
+      json (~> 1.4.6)
+      redis-namespace (>= 0.10.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    resque_spec (0.4.2)
+      resque (>= 1.6.0)
+      rspec (>= 2.0.0.beta.12)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+    rspec-rails (2.2.1)
+      actionpack (~> 3.0)
+      activesupport (~> 3.0)
+      railties (~> 3.0)
+      rspec (~> 2.2.0)
+    ruby2ruby (1.2.5)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.0.6)
+      sexp_processor (~> 3.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.4)
+      childprocess (>= 0.1.7)
+      ffi (>= 1.0.7)
+      json_pure
+      rubyzip
+    sexp_processor (3.0.5)
+    sinatra (1.2.1)
+      rack (~> 1.1)
+      tilt (>= 1.2.2, < 2.0)
+    sourcify (0.4.2)
+      file-tail (>= 1.0.5)
+      ruby2ruby (>= 1.2.5)
+      sexp_processor (>= 3.0.5)
+    spruz (0.2.5)
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    tilt (1.2.2)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.25)
+    vegas (0.1.8)
+      rack (>= 1.0.0)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara (>= 0.4.0)
+  rails (= 3.0.5)
+  resque
+  resque_spec
+  rspec (= 2.2.0)
+  rspec-rails (= 2.2.1)
+  sourcify
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Qi He
+
+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.markdown

@@ -0,0 +1,53 @@
+# Achievable
+
+This is a simple achievement builder for rails
+
+
+## Installation
+
+To install Achievable, simply install the gem:
+
+    gem install achievable
+    
+Run generator to generate config information in `application.rb`, migration file `achievable_migration`, and model files `achievement.rb` and `achieving.rb`
+
+    rails g achievable
+    
+## Configuration for [resque](https://github.com/defunkt/resque)
+
+Achievable also provides resque functionality. Enable or disable resque in `config/application.rb`:
+
+    config.achievable.resque_enable = false
+
+## Usage
+
+### Specify which model is used for the achiever, take user for example:
+
+    class User < ActiveRecord::Base
+      include Achievable::Achiever
+      has_many :posts
+    end
+
+### Specify which column to check for achievement of in a model, the name of the achievement, receiver of achievement and condition in which achiever has to meet. If receiver is not set, then the model itself is the receiver.
+
+    class User < ActiveRecord::Base
+      ...
+      achievable :image_url,  "first_time_edit_avatar"
+      ...
+    end
+    
+    class Post < ActiveRecord::Base
+      ...
+      achievable :description,  "first_time_edit_description", :receiver => :user
+      ...
+    end
+    
+    class User < ActiveRecord::Base
+      ... 
+      achievable :tags_count, "tags_500_times" :condition => lambda { |u| u.tags_count = 500 }
+      ...
+    end
+
+## TODO
+
+    

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Achievable'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/achievable.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "achievable/version"
+
+Gem::Specification.new do |s|
+  s.name = "achievable"
+  s.version = Achievable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Qi He"]
+  s.email       = ["qihe229@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/achievable"
+  s.summary     = %q{A simple achievment gem for rails.}
+  s.description = %q{This provides achievement features for rails app.}
+
+  s.rubyforge_project = "achievable"
+  
+  s.add_dependency  'sourcify'
+  s.add_dependency  'resque'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+end

data/lib/achievable/achieve_manager.rb

@@ -0,0 +1,28 @@
+# coding: utf-8
+module Achievable
+  module AchieveManager
+    extend ActiveSupport::Concern
+    
+    @queue = :achievable
+    
+    def achieveit!(name)
+      raise NotImplementedError
+    end
+    
+    def achieveit(name, &block)
+      block_source = block_given? ? block.to_source : nil
+      Resque.enqueue(AchieveManager, {"name" => name, "id" => self.id, "class" => self.class.to_s, "condition" => block_source})
+    end  
+      
+    def self.perform(opts={})
+      inst = opts["class"].constantize.find(opts["id"])
+      condition = eval(opts["condition"]) if opts["condition"] 
+      if condition
+        inst.achieveit!(opts["name"], &condition) 
+      else
+        inst.achieveit!(opts["name"])
+      end
+    end
+    
+  end # AchieveManager
+end # Jobs

data/lib/achievable/achiever.rb

@@ -0,0 +1,35 @@
+module Achievable
+  module Achiever
+    extend ActiveSupport::Concern
+    include Achievable::AchieveManager
+
+    included do
+      has_many :achievements, :through => :achievings
+      has_many :achievings, :dependent => :destroy, :as => :achiever
+    end
+         
+    def achieve(name, options = {})
+      condition = options[:condition] ? options[:condition] : ( lambda { |u| true } )
+      if Achievable.resque_enable
+        achieveit(name, &condition)
+      else
+        achieveit!(name, &condition)
+      end
+    end
+    
+    def achieveit!(name, &block)
+      achievement = Achievement.find_by_name!(name)
+      unless achieved?(achievement)
+        achievement.achieve(self) if ( block_given? ? block.call(self) : true )
+      end
+    end
+    
+    def achieved?(achievement)
+      if achievement.is_a? String
+        achievement = Achievement.find_by_name!(achievement)
+      end
+      achievements.include?(achievement)
+    end
+    
+  end # Achiever
+end # Achievable

data/lib/achievable/dsl.rb

@@ -0,0 +1,23 @@
+module Achievable
+  module DSL
+    extend ActiveSupport::Concern
+    
+    module ClassMethods
+      def achievable(attribute, achievement, options = {})
+        options.assert_valid_keys(:receiver, :condition)
+        method_name = :"achieve_#{achievement}"
+        
+        define_method(method_name) do |*args|
+          attr_changed = :"#{attribute.to_s}_changed?"
+          return unless (respond_to? attr_changed) && send(attr_changed)
+          receiver = options[:receiver] ? send(options[:receiver]) : self
+          raise 'object must respond to achieve' unless receiver.respond_to? :achieve
+          receiver.achieve(achievement, options)
+        end
+      
+        send(:"after_update", method_name)
+      end
+    end
+    
+  end
+end

data/lib/achievable/engine.rb

@@ -0,0 +1,18 @@
+module Achievable
+  class Engine < ::Rails::Engine
+    config.achievable = ActiveSupport::OrderedOptions.new
+    
+    initializer "achievable.active_record" do
+      ActiveSupport.on_load(:active_record) do
+        include Achievable::DSL
+      end
+    end
+    
+    initializer "achievable.resque_enable" do |app|
+      if app.config.achievable.resque_enable
+        Achievable.set_resque_enable(app.config.achievable.resque_enable )
+      end
+    end
+    
+  end # Engine
+end # Achievable

data/lib/achievable/version.rb

@@ -0,0 +1,3 @@
+module Achievable
+  VERSION = "0.0.1"
+end

data/lib/achievable.rb

@@ -0,0 +1,19 @@
+module Achievable
+  autoload :DSL,            'achievable/dsl'
+  autoload :Achiever,       'achievable/achiever'
+  autoload :AchieveManager, 'achievable/achieve_manager'
+  
+  # Set which enable resque.
+  #
+  #   Achievable.set_resque_enable
+  #
+  def self.set_resque_enable(true_or_false)
+    singleton_class.send :define_method, :resque_enable, lambda { true_or_false }
+  end
+
+  def self.resque_enable; false; end
+  
+end
+
+require 'achievable/engine'
+

data/lib/generators/achievable_generator.rb

@@ -0,0 +1,26 @@
+class AchievableGenerator < Rails::Generators::NamedBase
+  
+  source_root File.expand_path("../templates", __FILE__)
+  
+  class_option :migration, :type => :boolean, :default => true
+  
+  def manifest 
+    record do |m| 
+      m.migration_template 'migration.rb', 'db/migrate', :migration_file_name => "achievable_migration"
+    end
+  end
+  
+  def copy_achievable_models
+    template "achievement.rb", "app/models/achievement.rb"
+    template "achieving.rb", "app/models/achieving.rb"
+  end
+  
+  def add_application_config
+    inject_into_class "config/application.rb", "Application", <<-CONTENT
+    # Set achievable resque
+    config.achievable.resque_enable = false
+
+CONTENT
+  end
+
+end

data/lib/generators/templates/achievement.rb

@@ -0,0 +1,11 @@
+class Achievement < ActiveRecord::Base
+  has_many :achievings
+  
+  validates_presence_of :name, :category
+  validates_uniqueness_of :name
+  
+  def achieve(achiever)
+    achievings << Achieving.new(:achiever => achiever, :achievement => self)
+  end
+  
+end

data/lib/generators/templates/achieving.rb

@@ -0,0 +1,4 @@
+class Achieving < ActiveRecord::Base
+  belongs_to :achiever,    :polymorphic => true
+  belongs_to :achievement, :class_name => "Achievement", :foreign_key => "achievement_id", :counter_cache => true
+end

data/lib/generators/templates/migration.rb

@@ -0,0 +1,29 @@
+class AchievableMigration < ActiveRecord::Migration
+  
+  def self.up
+    create_table :achievements do |t|
+      t.string   :name
+      t.string   :image_url
+      t.string   :description
+      t.integer  :achievings_count, :default => 0
+      t.string   :category
+      t.timestamps
+    end
+
+    create_table :achievings do |t|
+      t.integer  :achiever_id
+      t.integer  :achievement_id
+      t.boolean  :notify,   :default => false
+      t.string   :achiever_type
+      t.timestamps
+    end
+    
+    add_index :achievements, :name
+  end
+  
+  def self.down
+    drop_table :achievings
+    drop_table :achievements
+  end
+  
+end

data/test/achievable_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+
+describe "Achievable" do
+  
+  before do
+    @achieve1 = Achievement.create!(:name => "achievement1", :description => "test achievement 1", :category => "achi")
+    @achieve2 = Achievement.create!(:name => "achievement2", :description => "test achievement 2", :category => "achi")
+    @achieve3 = Achievement.create!(:name => "achievement3", :description => "test achievement 3", :category => "achi")
+    @user1    = User.create!(:name => "he9qi",  :image_url => "1.png")
+    @user2    = User.create!(:name => "he9lin", :image_url => "2.png")
+    @post1    = Post.create!(:name => "post1", :user => @user1)
+    @post2    = Post.create!(:name => "post2", :user => @user2)
+    Achievable.set_resque_enable(false)
+  end
+  
+  after do
+    Achievement.destroy_all
+    Achieving.destroy_all
+    User.destroy_all
+    Post.destroy_all
+  end
+  
+  it "should return true if user has the achievemnt it is asking for" do
+    @achieve1.achieve(@user1)
+    @user1.achieved?("achievement1").should be_true
+  end
+  
+  context "When user update image_url" do
+    before do
+      User.class_eval do
+        achievable :image_url,  "achievement1"
+      end
+    end
+    
+    it "should give user an achievement" do
+      with_resque do
+        @user1.image_url = "2.png"
+        @user1.save!
+      end
+      @user1.achieved?("achievement1").should be_true
+    end
+    
+  end
+  
+  context "Conditional achievement" do
+    context "When user update posts and the user is not he9qi" do
+      before do
+        Post.class_eval do
+          achievable :name,  "achievement2", :receiver => :user, :condition => lambda { |u| u.name = "he9qi" }
+        end
+      end
+    
+      it "should not give user an achievement" do
+        with_resque do 
+          @post2.name = "post3"
+          @post2.save!
+        end
+        @user1.achieved?("achievement2").should be_false
+      end
+    end
+    
+    context "When user update posts and the user is he9qi" do
+      before do
+        Post.class_eval do
+          achievable :name,  "achievement2", :receiver => :user, :condition => lambda { |u| u.name = "he9qi" }
+        end 
+      end
+    
+      it "should give user an achievement" do
+        with_resque do 
+          @post1.name = "post2"
+          @post1.save!
+        end
+        @user1.achieved?("achievement2").should be_true
+      end
+    end
+  end
+  
+  context "Resque Enable: When user update posts and the user is he9qi" do
+    before do
+      Achievable.set_resque_enable(true)
+      Post.class_eval do
+        achievable :name,  "achievement2", :receiver => :user, :condition => lambda { |u| u.name = "he9qi" }
+      end
+    end
+  
+    it "should not give user an achievement if resque not started" do
+      @post1.name = "post2"
+      @post1.save!
+      @user1.achieved?("achievement2").should be_false
+    end
+    
+    it "should give user an achievement" do
+      with_resque do 
+        @post1.name = "post2"
+        @post1.save!
+      end
+      @user1.achieved?("achievement2").should be_true
+    end
+    
+  end
+
+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,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

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

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

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

@@ -0,0 +1,11 @@
+class Achievement < ActiveRecord::Base
+  has_many :achievings
+
+  validates_presence_of :name, :category
+  validates_uniqueness_of :name
+
+  def achieve(achiever)
+    achievings.create!(:achiever => achiever, :achievement => self)
+  end
+end
+

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

@@ -0,0 +1,4 @@
+class Achieving < ActiveRecord::Base
+  belongs_to :achiever,    :polymorphic => true
+  belongs_to :achievement, :class_name => "Achievement", :foreign_key => "achievement_id", :counter_cache => true
+end

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

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  belongs_to :user
+end

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

@@ -0,0 +1,4 @@
+class User < ActiveRecord::Base
+  include Achievable::Achiever
+  has_many :posts
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>