badgeable 0.3.0 → 0.3.2

data/README.rdoc

@@ -70,7 +70,9 @@ in Rails.root/lib/badges.rb
 
 == Requirements
 
-Currently Mongoid is the only ORM supported. Watch this space.
+=== Supported ORMs
+* Mongoid
+* ActiveRecord
 
 = License
 
@@ -94,4 +96,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/features/step_definitions/badging_steps.rb

@@ -37,18 +37,22 @@ When /^a diner creates (\d+) meals$/ do |num|
 end
 
 When /^the user has completed their profile$/ do
-  @user = User.create
+  Given %Q{I am a user}
   @user.profile_completeness = 100
   @user.save
 end
 
 When /^the user has written (\d+) reviews$/ do |num|
-  @user = User.create
+  Given %Q{I am a user}
   num.to_i.times do
     @user.reviews.create
   end
 end
 
+Given /^I am a user$/ do
+  @user = User.create
+end
+
 Then /^the diner should have the "([^\"]*)" badge$/ do |badge_name|
   @diner.should have_badge_named(badge_name)
 end
@@ -56,3 +60,32 @@ end
 Then /^the user should have the "([^\"]*)" badge$/ do |badge_name|
   @user.should have_badge_named(badge_name)
 end
+
+Given /^I have (\d+) badges already$/ do |num|
+  Given %Q{I am a user}
+  num.to_i.times do |n|
+    badging = @user.award_badge("Badge #{n}")
+    badging.update_attributes(:seen => true)
+  end
+end
+
+Given /^I have just been awarded (\d+) badges$/ do |num|
+  Given %Q{I am a user}
+  num.to_i.times do |n|
+    @user.award_badge("Unseen Badge #{n}")
+  end
+end
+
+Then /^I should have (\d+) unseen badges$/ do |num|
+  @user.badgings.unseen.count.should eql(num.to_i)
+end
+
+Given /^I have (\d+) badges$/ do |num|
+  Given %Q{I have #{num} badges already}
+end
+
+When /^my unseen badges are marked as seen$/ do
+  @user.badgings.each do |badging|
+    badging.mark_as_seen
+  end
+end

data/features/unseen_badges.feature

@@ -0,0 +1,18 @@
+Feature: Badges are marked as unseen until a user sees that they've won them
+  So that I know which badges I've been awarded
+  As a user who just had badges awarded
+  I want to see my unseen badges, and once I've seen them, they should go away
+
+  Scenario: Unseen badges
+    Given I have 3 badges already
+    And I have just been awarded 2 badges
+    When I should have 2 unseen badges
+  
+  Scenario: Mark badges as seen
+    Given I have 0 badges
+    And I have just been awarded 2 badges
+    When my unseen badges are marked as seen
+    Then I should have 0 unseen badges
+  
+  
+  

data/lib/badgeable.rb

@@ -3,7 +3,17 @@ require 'active_support/callbacks'
 require 'active_support/inflector'
 require 'active_support/dependencies'
 require 'active_support/concern'
-require 'badgeable/railtie' if defined?(Rails)
+
+# if defined?(Mongoid)
+  autoload :Badge,   'badgeable/adapters/mongoid_adapter/badge'
+  autoload :Badging, 'badgeable/adapters/mongoid_adapter/badging'
+# end
+# 
+# if defined?(ActiveRecord)
+#   autoload :Badge,   'badgeable/adapters/active_record/badge'
+#   autoload :Badging, 'badgeable/adapters/active_record/badging'
+# end
+
 
 module Badgeable
   autoload :Adapters,     'badgeable/adapters'
@@ -18,4 +28,6 @@ module Badgeable
   end
 end
 
+require 'badgeable/railtie' if defined?(Rails)
+
 module Badgeable; end

data/lib/badgeable/adapters/active_record_adapter.rb

@@ -25,6 +25,11 @@ end
 
 class Badging < ActiveRecord::Base
   belongs_to :badge
+  scope :unseen, {:where => {:seen => false}}
+  
+  def mark_as_seen
+    update_attributes(:seen => true)
+  end
 end  
 
 class Badge < ActiveRecord::Base
@@ -33,6 +38,6 @@ class Badge < ActiveRecord::Base
   end
   
   def icon
-    "/images/#{name}"
+    "/images/#{name.parameterize}.jpg"
   end
 end

data/lib/badgeable/adapters/mongoid_adapter.rb

@@ -2,34 +2,39 @@ module Badgeable
   module Adapters
     module MongoidAdapter
       def self.included(receiver)
-        receiver.class_eval %Q{ 
-          references_many :badges, :stored_as => :array, :class_name => "Badge", :inverse_of => :#{receiver.to_s.tableize}
-        }
+        receiver.class_eval do
+          embeds_many :badgings
+        end
         
-        Badge.class_eval %Q{
-          references_many :#{receiver.to_s.tableize}, :inverse_of => :badges, :stored_as => :array
+        ::Badging.class_eval %Q{
+          embedded_in :#{receiver.to_s.underscore}, :inverse_of => :badgings
+          def receiver
+            #{receiver.to_s.underscore}
+          end
+        }
         
+        ::Badge.class_eval %Q{
           def recipients
-            #{receiver}.where(:badge_ids => id)
+            #{receiver}.where("badgings.badge_id" => id)
           end
         }
+        receiver.send(:include, InstanceMethods)
+      end
+    end
+    
+    module InstanceMethods
+      def award_badge(name)
+        badge = Badge.find_or_create_by_name(name)
+        badgings.create(:badge_id => badge.id) unless has_badge?(badge)
+      end
+      
+      def badges
+        Badge.where(:_id.in => badgings.map(&:badge_id))
+      end
+      
+      def unseen_badges
+        Badge.where(:_id.in => badgings.unseen.map(&:badge_id))
       end
     end
   end
-end
-
-class Badge
-  include Mongoid::Document
-  include Mongoid::Timestamps
-  
-  field :name
-  index :name
-  
-  def self.find_or_create_by_name(name)
-    criteria.where(:name => name).first || create(:name => name)
-  end
-  
-  def icon
-    "/images/#{name}"
-  end
-end
+end

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

@@ -0,0 +1,15 @@
+class Badge
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  
+  field :name
+  index :name
+  
+  def self.find_or_create_by_name(name)
+    criteria.where(:name => name).first || create(:name => name)
+  end
+  
+  def icon
+    "#{name.parameterize}.png"
+  end
+end

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

@@ -0,0 +1,11 @@
+class Badging
+  include Mongoid::Document
+  include Mongoid::Timestamps
+  referenced_in :badge
+  field :seen, :type => Boolean, :default => false
+  scope :unseen, {:where => {:seen => false}}
+  
+  def mark_as_seen
+    update_attributes(:seen => true)
+  end
+end

data/lib/badgeable/version.rb

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

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Scott Burton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-01 00:00:00 -07:00
+date: 2010-11-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,10 +100,13 @@ files:
 - features/support/test_models/meal.rb
 - features/support/test_models/review.rb
 - features/support/test_models/user.rb
+- features/unseen_badges.feature
 - lib/badgeable.rb
 - lib/badgeable/adapters.rb
 - lib/badgeable/adapters/active_record_adapter.rb
 - lib/badgeable/adapters/mongoid_adapter.rb
+- lib/badgeable/adapters/mongoid_adapter/badge.rb
+- lib/badgeable/adapters/mongoid_adapter/badging.rb
 - lib/badgeable/award.rb
 - lib/badgeable/config.rb
 - lib/badgeable/dsl.rb