badgeable 0.0.1

data/LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2010 Scott Burton
+
+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.rdoc

@@ -0,0 +1,65 @@
+= About Badgeable
+
+Badgeable is an elegant DSL for awarding badges
+
+== Overview
+
+Badgeable provides an elegant DSL for describing and awarding badges
+to your Ruby objects.
+
+== Usage
+
+Describe the badges you want to award using the badge block. The only 
+configuration directive required for each badge is the name of the badge
+and the name constant of the awarding class:
+
+  class Person
+    include Mongoid::Document
+    include Badgeable
+  end
+
+  badge "Big Eater" do
+    thing Nacho
+    count 40
+    subject :person
+    conditions do |nacho|
+      nacho.spicy?
+    end
+  end
+
+would award the "Big Eater" badge to each Person who eats 40 spicy nachos.
+
+You can also award arbitrary badges using your own business logic by 
+calling #award_badge(badge_name) on any Badgeable instance:
+
+  yehuda = Person.create(:name => "Yehuda Katz")
+  yehuda.award_badge("Total Badass")
+
+
+== Requirements
+
+Currently Mongoid is the only ORM supported. Watch this space.
+
+= License
+
+Copyright (c) 2010 Scott Burton
+
+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/lib/badgeable/badge.rb

@@ -0,0 +1,18 @@
+module Badgeable
+  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/config.rb

@@ -0,0 +1,78 @@
+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
+    end
+   
+    attr_reader :threshold, :klass, :conditions_array, :subject_name
+    
+    def initialize
+      @conditions_array = [Proc.new {true}]
+      @subject_name = :user
+    end
+    
+    def subject(sym)
+      @subject_name = sym
+    end
+    
+    def count(n = 1, &block)
+      if block_given?
+        count_proc = Proc.new { |instance|
+          block.call(instance)
+        }
+      else
+        count_proc = Proc.new { |instance|
+          instance.instance_eval %Q{
+            #{klass}.where(:#{subject_name}_id => #{subject_name}.id).count >= #{n}
+          }
+        }
+      end
+      @conditions_array << count_proc
+    end
+    
+    def thing(klass)
+      @klass = klass
+    end
+    
+    def conditions(&block)
+      @conditions_array << Proc.new {|instance|
+        block.call(instance)
+      }
+    end
+   
+    
+  end
+end

data/lib/badgeable/subject.rb

@@ -0,0 +1,18 @@
+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 = Badgeable::Badge.find_or_create_by_name(name)
+      badges << badge unless has_badge?(badge)      
+    end
+    
+    def has_badge?(badge)
+      badges.include?(badge)
+    end
+    
+    def has_badge_named?(name)
+      badges.map(&:name).include?(name)
+    end
+  end
+end

data/lib/badgeable.rb

@@ -0,0 +1,28 @@
+require 'active_support/core_ext'
+require 'active_support/callbacks'
+require 'active_support/inflector'
+require 'mongoid'
+require 'badgeable/badge'
+require 'badgeable/config'
+require 'badgeable/subject'
+
+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

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: badgeable
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Scott Burton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-08 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Badgeable provides an elegant DSL for describing and awarding badges to your Ruby objects.
+email: 
+- scottburton11@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/badgeable/badge.rb
+- lib/badgeable/config.rb
+- lib/badgeable/subject.rb
+- lib/badgeable.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/scottburton11/badgeable
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Badgeable is an elegant DSL for awarding badges
+test_files: []
+