badgeable 0.0.1 → 0.1.1

data/.gitignore

@@ -0,0 +1,2 @@
+pkg
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in badgeable.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    badgeable (0.1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    builder (2.1.2)
+    cucumber (0.9.2)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.5)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    factory_girl (1.3.2)
+    gherkin (2.2.8)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    json (1.4.6)
+    rspec (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+      rspec-mocks (= 2.0.0.rc)
+    rspec-core (2.0.0.rc)
+    rspec-expectations (2.0.0.rc)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.0.rc)
+      rspec-core (= 2.0.0.rc)
+      rspec-expectations (= 2.0.0.rc)
+    term-ansicolor (1.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  badgeable!
+  bundler (>= 1.0.0)
+  cucumber
+  factory_girl (>= 1.3.2)
+  rspec (>= 2.0.0.rc)

data/README.rdoc

@@ -15,10 +15,11 @@ and the name constant of the awarding class:
 
   class Person
     include Mongoid::Document
-    include Badgeable
+    include Badgeable::Subject
+    embeds_many :nachos
   end
 
-  badge "Big Eater" do
+  badge "Nacho Nacho Man" do
     thing Nacho
     count 40
     subject :person
@@ -27,7 +28,28 @@ and the name constant of the awarding class:
     end
   end
 
-would award the "Big Eater" badge to each Person who eats 40 spicy nachos.
+would award the "Nacho Nacho Man" badge to each Person who eats 40 
+nachos, and the last one was spicy.
+
+  class Person
+    include Mongoid::Document
+    include Badgeable::Subject
+    references_many :meals
+  end
+
+  badge "Fancy Pants" do
+    thing Meal
+    subject :person
+    count
+      Meal.where(:price_cents.gte => 10000).count >= 12
+    end
+    conditions do |meal|
+      meal.restaurant.city != meal.eater.city
+    end
+  end
+  
+would award the "Fancy Pants" badge to the diner who has eaten 12 
+expensive meals where the awarding meal was out of town.
 
 You can also award arbitrary badges using your own business logic by 
 calling #award_badge(badge_name) on any Badgeable instance:
@@ -35,6 +57,16 @@ calling #award_badge(badge_name) on any Badgeable instance:
   yehuda = Person.create(:name => "Yehuda Katz")
   yehuda.award_badge("Total Badass")
 
+== Setup
+
+Badge recipient classes should include Badgeable::Subject.
+Extending an awarding class with Badgeable::Award will allow you
+to define badge blocks in the awarding class definition. You may
+also eval a separate file of badge definitions in the context of
+Badgeable::Award.
+
+When used with Rails, Badgeable will look for badging definitions
+in Rails.root/lib/badges.rb
 
 == Requirements
 

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/badgeable.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/badgeable/version", __FILE__)
+ 
+
+Gem::Specification.new do |s|
+  s.name        = "badgeable"
+  s.version     = Badgeable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Scott Burton"]
+  s.email       = ["scottburton11@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/badgeable"
+  s.summary     = "Badgeable is an elegant DSL for awarding badges"
+  s.description = "Badgeable provides an elegant DSL for describing and awarding badges to your Ruby objects."
+ 
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "badgeable"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_development_dependency "rspec", ">= 2.0.0.rc"
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "factory_girl", ">= 1.3.2"
+  
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/features/award_badges.feature

@@ -0,0 +1,9 @@
+Feature: Easily award badges to any Ruby class (given enough effort on your part)
+  In order to make somebody feel super awesome about themselves
+  A class that extends Badgeable::Award
+  Wants to award a badge recipient after they've created a certain number of them
+  
+  Scenario: A restaurant meal awards the "Hog Wild" badge to a regular diner
+    Given a Meal awards the "Hog Wild" badge to an Diner after 3 times
+    When a diner creates 3 meals
+    Then the diner should have the "Hog Wild" badge

data/features/step_definitions/badging_steps.rb

@@ -0,0 +1,20 @@
+Given /^a Meal awards the "([^\"]*)" badge to an? Diner after (\d+) times$/ do |badge_name, threshold|
+  Meal.class_eval %Q{
+    badge "#{badge_name}" do
+      count #{threshold}
+      subject :diner
+      thing Meal
+    end
+  }
+end
+
+When /^a diner creates (\d+) meals$/ do |num|
+  @diner = Diner.create
+  num.to_i.times do
+    @diner.meals.create
+  end
+end
+
+Then /^the diner should have the "([^\"]*)" badge$/ do |badge_name|
+  @diner.should have_badge_named(badge_name)
+end

data/features/support/env.rb

@@ -0,0 +1,19 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__),'..', '..', 'lib'))
+
+require 'cucumber'
+require 'rspec/expectations'
+require 'badgeable'
+
+Mongoid.configure do |config|
+  config.master = Mongo::Connection.new.db("badgeable_test")
+end
+
+# factory_girl Factory definitions
+Dir[(File.expand_path(File.dirname(__FILE__), "..") + "spec/factories/**/*.rb").to_s].each {|factory| require factory}
+
+Dir[(File.expand_path(File.dirname(__FILE__)) + "test_models/**/*.rb")].each {|model| require model }
+
+Before do
+  Mongoid.master.collections.select{|c| !c.name.starts_with?("system")}.each(&:drop)
+end

data/features/support/test_models/diner.rb

@@ -0,0 +1,5 @@
+class Diner
+  include Mongoid::Document
+  include Badgeable::Subject
+  references_many :meals
+end

data/features/support/test_models/meal.rb

@@ -0,0 +1,5 @@
+class Meal
+  include Mongoid::Document
+  extend Badgeable::Award
+  referenced_in :diner, :inverse_of => :meals
+end

data/lib/badgeable/award.rb

@@ -0,0 +1,44 @@
+module Badgeable
+  module Award
+    # Configure a class to automatically award badges after creation.
+    # Assign a badge name and a block with configuration
+    # directives.
+    # 
+    # Valid directives:
+    # 
+    # thing        (Required) a class constant in this namespace that 
+    #              awards the badge.
+    # subject      (Optional, default = :user) a symbol that references
+    #              the object to which the badge is awarded. This should
+    #              be a related object that includes Badgeable, and will
+    #              usually have referenced_in :thing, belongs_to :thing etc.
+    # count        (Optional, default = 1) either an integer threshold value
+    #              of :things related to :subject, or a block. If a block
+    #              is given, the created instance of :thing is passed as
+    #              the first block argument, and the block must return
+    #              return true for the badge to be awarded.
+    # conditions   (Optional) provide a block; if your block returns 
+    #              returns true, the badge is awarded. The first block 
+    #              argument is the created instance of :thing. The 
+    #              conditions directive may be called any number of times,
+    #              and all conditions and the count block must return true.
+    #              Also note that the conditions and count directives are
+    #              evaluated separately.
+    # 
+    # See README for usage examples
+    # 
+    def badge(name, &block)
+      config = Badgeable::Config.new
+      config.instance_eval(&block)
+      method_name = name.titleize.gsub(/\s/, "").underscore
+      config.klass.class_eval do
+        set_callback :create, :after, "award_#{method_name}_badge".to_sym
+        define_method "award_#{method_name}_badge".to_sym, Proc.new {
+          if config.conditions_array.all? {|p| p.call(self) }
+            self.send(config.subject_name).award_badge(name)
+          end
+        }
+      end
+    end
+  end
+end

data/lib/badgeable/config.rb

@@ -1,42 +1,10 @@
 module Badgeable
   class Config
-    # Configure a class to automatically award badges after creation.
-    # Assign a badge name and a block with configuration
-    # directives.
-    # 
-    # Valid directives:
-    # 
-    # thing        (Required) a class constant in this namespace that 
-    #              awards the badge.
-    # subject      (Optional, default = :user) a symbol that references
-    #              the object to which the badge is awarded. This should
-    #              be a related object that includes Badgeable, and will
-    #              usually have referenced_in :thing, belongs_to :thing etc.
-    # count        (Optional, default = 1) either an integer threshold value
-    #              of :things related to :subject, or a block. If a block
-    #              is given, the created instance of :thing is passed as
-    #              the first block argument, and the block must return
-    #              return true for the badge to be awarded.
-    # conditions   (Optional) provide a block; if your block returns 
-    #              returns true, the badge is awarded. Works in
-    #              conjunction with #count
-    # 
-    # See README for usage examples
-    # 
-    def self.badge(name, &block)
-      config = new
-      config.instance_eval(&block)
-      method_name = name.titleize.gsub(/\s/, "").underscore
-      config.klass.class_eval do
-        set_callback :create, :after, "award_#{method_name}_badge".to_sym
-        define_method "award_#{method_name}_badge".to_sym, Proc.new {
-          if config.conditions_array.all? {|p| p.call(self) }
-            self.send(config.subject_name).award_badge(name)
-          end
-        }
-      end
+    
+    class << self
+      attr_accessor :badge_definitions
     end
-   
+    
     attr_reader :threshold, :klass, :conditions_array, :subject_name
     
     def initialize
@@ -71,8 +39,6 @@ module Badgeable
       @conditions_array << Proc.new {|instance|
         block.call(instance)
       }
-    end
-   
-    
+    end 
   end
 end

data/lib/badgeable/dsl.rb

@@ -0,0 +1,5 @@
+module Badgeable
+  class Dsl
+    extend Badgeable::Award
+  end
+end

data/lib/badgeable/railtie.rb

@@ -0,0 +1,8 @@
+module Badgeable
+  class Railtie < ::Rails::Railtie
+    initializer "badgeable.load_badges" do
+      Badgeable::Config.badge_definitions = Pathname.new("#{Rails.root}/lib/badges.rb")
+      Badgeable::Dsl.class_eval(File.read(Badgeable::Config.badge_definitions))
+    end
+  end
+end

data/lib/badgeable/subject.rb

@@ -14,5 +14,19 @@ module Badgeable
     def has_badge_named?(name)
       badges.map(&:name).include?(name)
     end
+    
+    def self.included(receiver)
+      receiver.class_eval %Q{ 
+        references_many :badges, :stored_as => :array, :class_name => "Badgeable::Badge", :inverse_of => :#{receiver.to_s.tableize}
+      }
+
+      Badgeable::Badge.class_eval %Q{
+        references_many :#{receiver.to_s.tableize}, :inverse_of => :badges, :stored_as => :array, :inverse_of => :badges
+
+        def recipients
+          #{receiver}.where(:badge_ids => id)
+        end
+      }
+    end
   end
 end

data/lib/badgeable/version.rb

@@ -0,0 +1,3 @@
+module Badgeable
+  VERSION = "0.1.1"
+end

data/lib/badgeable.rb

@@ -2,27 +2,12 @@ require 'active_support/core_ext'
 require 'active_support/callbacks'
 require 'active_support/inflector'
 require 'mongoid'
+require 'badgeable/award'
 require 'badgeable/badge'
 require 'badgeable/config'
+require 'badgeable/dsl'
 require 'badgeable/subject'
+require 'badgeable/version'
+require 'badgeable/railtie' if defined?(Rails)
 
-module Badgeable  
-  
-  VERSION = "0.0.1"
-  
-  def self.included(receiver)
-    receiver.class_eval %Q{ 
-      references_many :badges, :stored_as => :array, :class_name => "Badgeable::Badge", :inverse_of => :#{receiver.to_s.tableize}
-    }
-          
-    Badgeable::Badge.class_eval %Q{
-      references_many :#{receiver.to_s.tableize}, :inverse_of => :badges, :stored_as => :array, :inverse_of => :badges
-      
-      def recipients
-        #{receiver}.where(:badge_ids => id)
-      end
-    }
-    
-    receiver.send :include, Badgeable::Subject
-  end
-end
+module Badgeable; end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: badgeable
 version: !ruby/object:Gem::Version 
-  hash: 29
   prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Scott Burton
@@ -15,10 +14,68 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 -07:00
+date: 2010-10-09 00:00:00 -07:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        - rc
+        version: 2.0.0.rc
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: factory_girl
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 2
+        version: 1.3.2
+  type: :development
+  version_requirements: *id004
 description: Badgeable provides an elegant DSL for describing and awarding badges to your Ruby objects.
 email: 
 - scottburton11@gmail.com
@@ -29,14 +86,28 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- badgeable.gemspec
+- features/award_badges.feature
+- features/step_definitions/badging_steps.rb
+- features/support/env.rb
+- features/support/test_models/diner.rb
+- features/support/test_models/meal.rb
+- lib/badgeable.rb
+- lib/badgeable/award.rb
 - lib/badgeable/badge.rb
 - lib/badgeable/config.rb
+- lib/badgeable/dsl.rb
+- lib/badgeable/railtie.rb
 - lib/badgeable/subject.rb
-- lib/badgeable.rb
-- LICENSE
-- README.rdoc
+- lib/badgeable/version.rb
 has_rdoc: true
-homepage: http://github.com/scottburton11/badgeable
+homepage: http://rubygems.org/gems/badgeable
 licenses: []
 
 post_install_message: 
@@ -49,7 +120,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -58,7 +128,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
       segments: 
       - 1
       - 3
@@ -66,7 +135,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 
-rubyforge_project: 
+rubyforge_project: badgeable
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3