acts_as_statused 1.0.0

data/README

@@ -0,0 +1,78 @@
+README
+========================================================================
+Ok, so now I have a status, what’s the best way to check if an object is equal to that status? or How I learned to stop worrying and love the ‘acts_as_statused’ plugin
+
+Great question, well, first make sure the object you want to check has a status! Remember, not all models in our system have statuses. If you’re confident that your model has a status then continue on.
+
+In your model make sure you that you have the following near the top of your class definition:
+
+acts_as_statused
+
+That’s all the code you need to put in to have access to that objects status. You do NOT have to put the standard:
+belongs_to :status
+
+As a matter of fact if you do this I’ll personally beat you with your own shoe!
+Well, you’re asking yourself, what does ‘acts_as_statused’ do? Great question! First thing is does it does the belongs_to assignment. The next thing it does is magic!
+
+Several methods will be created that are similiar to the ones on Status, except these methods give you really great, and efficient, ways to check an objects status. Let’s look at some examples, shall we?
+
+How to get an object’s status:
+bob = User.find(1)
+bob.status
+
+That’s pretty straight forward, no surprises there. The .status method returns the status object for the that object.
+How do I assert on object’s status is equal to another status?
+bob = User.find(1)
+bob.status_is_active?
+bob.status_is_pending?
+
+Each of these methods is generated in a very similar way to the methods described earlier on status. For each record in the status table a new .status_is_XXXXX? method is created. These methods are essentially doing the following:
+def status_is_active?
+  self.status_id == Status.active.id
+end
+
+This, again, makes for very easy to read code. Example:
+if bob.status_is_active?
+  puts "welcome back bob" 
+end
+
+Don’t forget that as we add new statuses to the database, we get new methods without a single line of code! Yippie!!
+How NOT to check an object’s status is equal to another status?
+bob = User.find(1)
+if bob.status == Status.active
+  puts "welcome back bob" 
+end
+
+Not only is this code not pretty to look at, but it can also be a fairly expensive call. Again, I will administer beatings if I find people doing this sort of code!
+How to tell if an objects status has changed?
+bob = User.find(1)
+assert bob.status_is_active?
+puts bob.has_status_changed? (false)
+bob.status = Status.pending
+bob.update
+puts bob.has_status_changed? (true)
+puts bob.previous_status (this should return Status.active)
+
+The ability to known if a.) the status has changed and b.) what it’s previous state is extremely useful, especially in observers. Here’s an example:
+item = Item.find(1)
+item.status = Status.pending
+item.update
+
+In the observer:
+def after_update(item)
+  if item.has_status_changed?
+    if item.previous_status == Status.active
+      # do something
+    end
+  end
+end
+
+In the model there are call back hooks for before and after of each verb (create, update, save, destroy). Example:
+def before_save_status_changed
+  #do something
+end
+def after_save_status_changed
+  #do something else
+end
+
+These call backs only get called if the status has changed.

data/lib/acts_as_statused.rb

@@ -0,0 +1,88 @@
+module ActiveRecord #:nodoc:
+  module Acts #:nodoc:
+
+    module Statused
+      def self.included(base) # :nodoc:
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def acts_as_statused(options = {}, &extension)
+          # don't allow multiple calls
+          return if self.included_modules.include?(ActiveRecord::Acts::Statused::ActMethods)
+
+          send :include, ActiveRecord::Acts::Statused::ActMethods
+          
+          valid_status = []
+          valid_statuses = options[:only] if options.is_a?(Hash)
+          
+          class_eval do
+            belongs_to :status
+            
+            attr_accessor :previous_status
+
+            def after_find
+              self.previous_status = self.status if respond_to?:status_id
+            end
+            
+            def status
+              Status.get(self.status_id)
+            end
+            
+            def has_status_changed?
+              return self.previous_status != self.status
+            end
+
+            begin   
+              Status.find(:all).each do |status| #get all the statuses in the db.
+                # only define valid statuses
+                # EX: acts_as_statused :only => ['active', 'inactive', 'pending']
+                next unless valid_statuses.blank? || valid_statuses.include?(status.name)
+
+                define_method("status_is_#{status.name}?") do #define the method status_is_statusname?
+                  return self.status_id == status.id
+                end                           
+              end
+            rescue
+            end
+            
+          end
+          
+          %w{save update create destroy}.each do |verb|
+            define_method("before_#{verb}_status_changed") do
+              #puts "before_#{verb}_status_changed"
+            end
+            
+            define_method("after_#{verb}_status_changed") do
+              #puts "after_#{verb}_status_changed"
+            end
+            
+            define_method("do_before_#{verb}_status_changed") do
+              eval %{before_#{verb}_status_changed if self.has_status_changed?}
+            end
+            
+            define_method("do_after_#{verb}_status_changed") do
+              eval %{after_#{verb}_status_changed if self.has_status_changed?}
+            end
+            
+            eval %{
+              before_#{verb} :do_before_#{verb}_status_changed
+              after_#{verb} :do_after_#{verb}_status_changed
+            }
+          end
+        end
+      end
+    
+      module ActMethods
+        def self.included(base) # :nodoc:
+          base.extend ClassMethods
+        end
+
+        module ClassMethods
+        end
+      end
+    end
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecord::Acts::Statused

data/test/test_acts_as_statused.rb

@@ -0,0 +1,11 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class ActsAsStatusedTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_truth
+    assert true
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require "test/unit"

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: acts_as_statused
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2007-02-27 00:00:00 -05:00
+summary: acts_as_statused
+require_paths: 
+- lib
+- lib
+email: 
+homepage: 
+rubyforge_project: 
+description: "acts_as_statused was developed by: markbates"
+autorequire: 
+- acts_as_statused
+default_executable: 
+bindir: bin
+has_rdoc: false
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- markbates
+files: 
+- lib/acts_as_statused.rb
+- README
+test_files: 
+- test/test_acts_as_statused.rb
+- test/test_helper.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: acts_as_constant
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+    version: