omg-statelogic 1.0.2 → 1.1

data/CHANGELOG

@@ -1,2 +1,8 @@
-0.1.2 - 2008-01-10
+1.1 - 2009-08-11
+- adds finder methods in the form of find_all_#{state}(*args)
+- adds named scope named after corresponding state
+- no longer redefines existing methods with the same names, issues warnings instead
+- forces state names to underscore notation when used as part of method/scope names
+
+0.1.2 - 2009-01-10
 - Support scoping arbitrary callbacks beyond ActiveRecord's

data/README.rdoc

@@ -12,6 +12,13 @@ consistency over merely formal... whatever...
 - ???????
 - PROFIT!!!11
 
+=== Changes in v1.1
+_Please review these carefully as they may be incompatible with your existing code._
+- adds finder methods in the form of +find_all_#{state}(*args)+ (Order.find_all_ready) sugg. by ares
+- adds named scope named after corresponding state (Order.paid) sugg. by ares
+- no longer redefines existing methods with the same names, issues warnings instead
+- forces state names to underscore notation when used as part of method names
+
 === Installation
   gem install omg-statelogic --source http://gems.github.com
 
@@ -32,7 +39,7 @@ Please report via Github issue tracking.
         initial_state 'unpaid' do
           transitions_to 'ready', 'suspended' # won't let you change to wrong states
         end
-        state 'ready' do # you get +ready?+, +was_ready?+
+        state 'ready' do # you get +ready?+, +was_ready?+, +Order.ready+ named scope and +Order.find_all_ready+ finder
           transitions_to 'redeemed', 'suspended'
           validates_presence_of :txref # scoped validations
           before_save :prepare_for_plucking # scoped callbacks

data/lib/statelogic/activerecord.rb

@@ -1,6 +1,27 @@
-require 'statelogic/callbacks_ext'
+require 'statelogic/callbacks_ext' unless ([ActiveRecord::VERSION::MAJOR, ActiveRecord::VERSION::MINOR] <=> [2, 3]) >= 0
 
 module Statelogic
+  module Util
+    def self.debug(msg = nil, &block)
+      ::ActiveRecord::Base.logger.debug(msg, &block) if ::ActiveRecord::Base.logger
+    end
+
+    def self.warn(msg = nil, &block)
+      ::ActiveRecord::Base.logger.warn(msg, &block) if ::ActiveRecord::Base.logger
+    end
+
+    def self.defmethod(cls, name, meta = false, &block)
+      c = meta ? cls.metaclass : cls
+      unless c.method_defined?(name)
+        c.send(:define_method, name, &block)
+        Util.debug { "Statelogic created #{meta ? 'class' : 'instance'} method #{name} on #{cls.name}." }
+      else
+        warn { "Statelogic won't override #{meta ? 'class' : 'instance'} method #{name} already defined on #{cls.name}." }
+        nil
+      end
+    end
+  end
+    
   module ActiveRecord
     def self.included(other)
       other.extend(ClassMethods)
@@ -51,14 +72,25 @@ module Statelogic
         alias initial initial_state
 
         def state(name, options = {}, &block)
+          name = name.to_s
+          uname = name.underscore
           attr = @config[:attribute]
           attr_was = :"#{attr}_was"
-          @class.class_eval do
-            define_method("#{name}?") { send(attr) == name }
-            define_method("was_#{name}?") { send(attr_was) == name }
+          find_all_by_attr = "find_all_by_#{attr}"
+
+          Util.defmethod(@class, "#{uname}?") { send(attr) == name }
+          Util.defmethod(@class, "was_#{uname}?") { send(attr_was) == name }
+
+          unless @class.respond_to?(name)
+            @class.send(:named_scope, uname, :conditions => {attr.to_sym => name })
+            Util.debug { "Statelogic has defined named scope #{uname} on #{@class.name}." }
+          else
+            Util.warn { "Statelogic won't override class method #{uname} already defined on #{@class.name}." }
           end
 
-          StateScopeHelper.new(@class, name, @config).instance_eval(&block)
+          Util.defmethod(@class, "find_all_#{uname}", true) {|*args| send(find_all_by_attr, name, *args) }
+
+          StateScopeHelper.new(@class, name, @config).instance_eval(&block) if block_given?
 
           @config[:states] << name
           @config[:initial] << name if options[:initial]
@@ -73,7 +105,7 @@ module Statelogic
 
         ConfigHelper.new(self, options).instance_eval(&block)
 
-        initial = [options[:initial], options[:states]].find {|x| !x.blank? }
+        initial = [options[:initial], options[:states]].find(&:present?)
         validates_inclusion_of attr, :in => initial, :on => :create if initial
 
         const = attr.to_s.pluralize.upcase
@@ -83,7 +115,5 @@ module Statelogic
   end
 end
 
-# :stopdoc:
-class ActiveRecord::Base
-  include Statelogic::ActiveRecord
-end
+ActiveRecord::Base.send :include, Statelogic::ActiveRecord
+

data/shoulda_macros/statelogic.rb

@@ -1,7 +1,7 @@
 class Test::Unit::TestCase
   def self.should_not_require_attributes(*attributes)
     get_options!(attributes)
-    klass = model_class
+    klass = described_type
 
     attributes.each do |attribute|
       should "not require #{attribute} to be set" do
@@ -9,4 +9,5 @@ class Test::Unit::TestCase
       end
     end
   end
-end
+end
+

data/test/statelogic_test.rb

@@ -1,39 +1,32 @@
 require 'test_helper'
 
-class Order < ActiveRecord::Base
-  statelogic do
-    initial_state 'unpaid' do
-      transitions_to 'ready', 'suspended'
-    end
-    state 'ready' do
-      transitions_to 'redeemed', 'suspended'
-      validates_presence_of :txref
-    end
-    state 'redeemed' do
-      transitions_to 'suspended'
-      validates_presence_of :txref, :redeemed_at, :facility_id
-    end
-    state 'suspended' do
-      transitions_to 'unpaid', 'ready', 'redeemed'
-      validate do |order|
-        order.errors.add(:txref, :invalid) if order.txref && order.txref !~ /\AREF/
-      end
-    end
-  end
-end
+#ActiveRecord::Base.logger = Logger.new(STDERR)
 
 class OrderTest < ActiveSupport::TestCase
   include ActiveRecord::TestFixtures
   self.fixture_path = 'test/fixtures'
 
   fixtures :orders
+  
+  should_have_class_methods :unpaid,          :ready,          :redeemed,          :suspended
+  should_have_class_methods :find_all_unpaid, :find_all_ready, :find_all_redeemed, :find_all_suspended
 
+  should_have_instance_methods :unpaid?,     :ready?,     :redeemed?,     :suspended?
+  should_have_instance_methods :was_unpaid?, :was_ready?, :was_redeemed?, :was_suspended?
+
+  context 'Finders and scopes' do
+    should 'return adequate shit' do
+      for st in %w(unpaid ready redeemed suspended)
+        assert_same_elements Order.find_all_by_state(st), Order.send(st)
+        assert_same_elements Order.find_all_by_state(st), Order.send("find_all_#{st}")
+      end
+    end
+  end
+  
   should_validate_presence_of :state, :message => default_error_message(:inclusion)
 
   context 'A fresh order' do
-    setup do
-      @order = Order.new
-    end
+    subject { Order.new }
 
     should_allow_values_for :state, 'unpaid'
     should_not_allow_values_for :state, 'ready', 'redeemed', 'suspended', 'screwed_up',
@@ -42,9 +35,7 @@ class OrderTest < ActiveSupport::TestCase
   end
 
   context 'An unpaid order' do
-    setup do
-      @order = orders(:unpaid)
-    end
+    subject { orders(:unpaid) }
 
     should_allow_values_for :state, 'unpaid', 'ready', 'suspended'
     should_not_allow_values_for :state, 'redeemed', 'screwed_up',
@@ -53,9 +44,7 @@ class OrderTest < ActiveSupport::TestCase
   end
 
   context 'A ready order' do
-    setup do
-      @order = orders(:ready)
-    end
+    subject { orders(:ready) }
 
     should_allow_values_for :state, 'ready', 'redeemed', 'suspended'
     should_not_allow_values_for :state, 'unpaid', 'screwed_up',
@@ -65,9 +54,7 @@ class OrderTest < ActiveSupport::TestCase
   end
 
   context 'A redeemed order' do
-    setup do
-      @order = orders(:redeemed)
-    end
+    subject { orders(:redeemed) }
 
     should_allow_values_for :state, 'redeemed', 'suspended'
     should_not_allow_values_for :state, 'unpaid', 'ready', 'screwed_up',
@@ -76,9 +63,7 @@ class OrderTest < ActiveSupport::TestCase
   end
 
   context 'A suspended order' do
-    setup do
-      @order = orders(:suspended)
-    end
+    subject { orders(:suspended) }
 
     should_allow_values_for :state, 'suspended', 'redeemed', 'ready', 'unpaid'
     should_not_allow_values_for :state, 'screwed_up', :message => default_error_message(:inclusion)
@@ -87,3 +72,4 @@ class OrderTest < ActiveSupport::TestCase
     should_not_require_attributes :txref, :redeemed_at, :facility_id
   end
 end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: omg-statelogic
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: "1.1"
 platform: ruby
 authors: 
 - Igor Gunko
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-06-23 00:00:00 -07:00
+date: 2009-08-11 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -64,7 +64,8 @@ files:
 - rails/init.rb
 has_rdoc: true
 homepage: http://github.com/omg/statelogic
-post_install_message: 
+licenses: 
+post_install_message: v1.1 introduces changes that may (or may not) be incompatible for you. Please review them at http://github.com/omg/statelogic
 rdoc_options: 
 - --line-numbers
 - --main
@@ -86,7 +87,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 2
 summary: Another state machine for ActiveRecord