badgeable 0.3.2 → 0.4.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    badgeable (0.1.0)
+    badgeable (0.3.2)
 
 GEM
   remote: http://rubygems.org/

data/features/award_badges.feature

@@ -17,4 +17,13 @@ Feature: Easily award badges to any Ruby class (given enough effort on your part
     Given a User gets the "Guppy" badge when they have written 10 reviews
     When the user has written 10 reviews
     Then the user should have the "Guppy" badge
+  
+  Scenario: If I supply some extra attributes, the badge gets created with them
+    Given A user gets the "Awesome" badge with a custom description "This badge is awesome" and icon "awesome-badge.jpg" for being awesome
+    When they are awesome
+    Then the user should have the "Awesome" badge
+    And the badge description should be "This badge is awesome"
+    And the badge icon should be "awesome-badge.jpg"
+  
+  
   

data/features/step_definitions/badging_steps.rb

@@ -29,6 +29,19 @@ Given /^a User gets the "([^\"]*)" badge when they have written (\d+) reviews$/
   }
 end
 
+Given /^A user gets the "([^"]*)" badge with a custom description "([^"]*)" and icon "([^"]*)" for being awesome$/ do |badge_name, description, icon|
+  User.class_eval %Q{
+    badge "#{badge_name}", :after => :save do
+      thing User
+      conditions do |user|
+        user.awesome?
+      end
+      description "#{description}"
+      icon "#{icon}"
+    end
+  }
+end
+
 When /^a diner creates (\d+) meals$/ do |num|
   @diner = Diner.create
   num.to_i.times do
@@ -49,6 +62,12 @@ When /^the user has written (\d+) reviews$/ do |num|
   end
 end
 
+When /^they are awesome$/ do
+  Given %Q{I am a user}
+  @user.awesome = true
+  @user.save
+end
+
 Given /^I am a user$/ do
   @user = User.create
 end
@@ -89,3 +108,13 @@ When /^my unseen badges are marked as seen$/ do
     badging.mark_as_seen
   end
 end
+
+Then /^the badge description should be "([^"]*)"$/ do |description|
+  @badge = @user.badges.first
+  @badge.description.should eql(description)
+end
+
+Then /^the badge icon should be "([^"]*)"$/ do |icon|
+  @badge = @user.badges.first
+  @badge.icon.should eql(icon)
+end

data/features/support/test_models/user.rb

@@ -3,5 +3,6 @@ class User
   include Badgeable::Subject
   extend Badgeable::Award
   field :profile_completeness, :type => Integer
+  field :awesome, :type => Boolean, :default => false
   references_many :reviews
 end

data/lib/badgeable/adapters/mongoid_adapter.rb

@@ -23,8 +23,10 @@ module Badgeable
     end
     
     module InstanceMethods
-      def award_badge(name)
-        badge = Badge.find_or_create_by_name(name)
+      def award_badge(*args)
+        options = args.extract_options!
+        name = args[0]
+        badge = Badge.find_or_create_by_name(name, options)
         badgings.create(:badge_id => badge.id) unless has_badge?(badge)
       end
       

data/lib/badgeable/adapters/mongoid_adapter/badge.rb

@@ -3,13 +3,25 @@ class Badge
   include Mongoid::Timestamps
   
   field :name
+  field :description
+  field :icon
   index :name
   
-  def self.find_or_create_by_name(name)
-    criteria.where(:name => name).first || create(:name => name)
+  before_create :assign_default_icon_name, :unless => lambda{icon}
+  
+  def self.find_or_create_by_name(name, options)
+    attrs = options.merge(:name => name)
+    criteria.where(:name => name).first || create(attrs)
   end
   
-  def icon
+  private
+  
+  def assign_default_icon_name
+    self.icon = default_icon_name
+  end
+  
+  def default_icon_name
     "#{name.parameterize}.png"
   end
+  
 end

data/lib/badgeable/award.rb

@@ -31,12 +31,13 @@ module Badgeable
       after_callback = options[:after] || :create
       config = Badgeable::Config.new
       config.instance_eval(&block)
+      attrs = [:description, :icon].inject({}) {|hash, key| hash.merge(key => config.send(key)) }
       method_name = "award_#{name.titleize.gsub(/\s/, '').underscore}_badge".to_sym
       config.klass.class_eval do
         set_callback after_callback, :after, method_name
         define_method method_name, Proc.new {
           if config.conditions_array.all? {|p| p.call(self) }
-            config.subject_proc.call(self).award_badge(name)
+            config.subject_proc.call(self).award_badge(name, attrs)
           end
         }
       end

data/lib/badgeable/config.rb

@@ -53,5 +53,24 @@ module Badgeable
         block.call(instance)
       }
     end 
+    
+    def icon(*args)
+      raise ArgumentError unless args.length <= 1
+      if args.length == 1
+        @icon = args[0]
+      else
+        @icon
+      end
+    end
+    
+    def description(*args)
+      raise ArgumentError unless args.length <= 1
+      if args.length == 1
+        @description = args[0]
+      else
+        @description
+      end
+    end
+    
   end
 end

data/lib/badgeable/subject.rb

@@ -2,8 +2,10 @@ module Badgeable
   module Subject
     # Award a named badge to this object. If the badge doesn't exist
     # in the database already, it's created by name.
-    def award_badge(name)
-      badge = Badge.find_or_create_by_name(name)
+    def award_badge(*args)
+      options = args.extract_options!
+      name = args[0]
+      badge = Badge.find_or_create_by_name(name, options)
       badges << badge unless has_badge?(badge)      
     end
     

data/lib/badgeable/version.rb

@@ -1,3 +1,3 @@
 module Badgeable
-  VERSION = "0.3.2"
+  VERSION = "0.4.0"
 end

data/lib/generators/templates/badge.rb

@@ -0,0 +1,22 @@
+# class BadgeCreate<%= table_name.camelize %> < ActiveRecord::Migration
+#   def self.up
+#     create_table(:<%= table_name %>) do |t|
+#       t.name :string
+# 
+# <% for attribute in attributes -%>
+#       t.<%= attribute.type %> :<%= attribute.name %>
+# <% end -%>
+# 
+#       t.timestamps
+#     end
+# 
+#     add_index :<%= table_name %>, :email,                :unique => true
+#     add_index :<%= table_name %>, :reset_password_token, :unique => true
+#     # add_index :<%= table_name %>, :confirmation_token,   :unique => true
+#     # add_index :<%= table_name %>, :unlock_token,         :unique => true
+#   end
+# 
+#   def self.down
+#     drop_table :<%= table_name %>
+#   end
+# end

data/lib/generators/templates/badging.rb

@@ -0,0 +1,29 @@
+# class DeviseCreate<%= table_name.camelize %> < ActiveRecord::Migration
+#   def self.up
+#     create_table(:<%= table_name %>) do |t|
+#       t.database_authenticatable :null => false
+#       t.recoverable
+#       t.rememberable
+#       t.trackable
+# 
+#       # t.confirmable
+#       # t.lockable :lock_strategy => :<%= Devise.lock_strategy %>, :unlock_strategy => :<%= Devise.unlock_strategy %>
+#       # t.token_authenticatable
+# 
+# <% for attribute in attributes -%>
+#       t.<%= attribute.type %> :<%= attribute.name %>
+# <% end -%>
+# 
+#       t.timestamps
+#     end
+# 
+#     add_index :<%= table_name %>, :email,                :unique => true
+#     add_index :<%= table_name %>, :reset_password_token, :unique => true
+#     # add_index :<%= table_name %>, :confirmation_token,   :unique => true
+#     # add_index :<%= table_name %>, :unlock_token,         :unique => true
+#   end
+# 
+#   def self.down
+#     drop_table :<%= table_name %>
+#   end
+# end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Scott Burton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 -07:00
+date: 2010-12-17 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -113,6 +113,8 @@ files:
 - lib/badgeable/railtie.rb
 - lib/badgeable/subject.rb
 - lib/badgeable/version.rb
+- lib/generators/templates/badge.rb
+- lib/generators/templates/badging.rb
 - spec/spec_helper.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/badgeable