pipa-statelogic 0.0.2 → 0.0.3

data/README.rdoc

@@ -1,13 +1,47 @@
-Statelogic
-==========
+=== Introduction
+Hi there!
 
-Introduction goes here.
+=== Features
+- State transitions validation.
+- State-scoped validations.
+- State-scoped lifecycle callbacks (before|after_save, etc)
+- ???????
+- PROFIT!!!11
+As a bonus you get multiple conditions in <tt>:if|:unless => [:one, :two, ...]</tt>
+callback and validation options (as in edge Rails).
 
+=== Installation
+  gem install pipa-statelogic --source http://gems.github.com
 
-Example
-=======
+Installable as a plugin too.
 
-Example goes here.
+=== Bugs & such
+http://pipa.lighthouseapp.com/projects/22857-statelogic
+
+=== Example
+    class Order < ActiveRecord::Base
+      ...
+      statelogic do
+        # you get methods +unpaid?+ and +was_unpaid?+.
+        # may be more than one initial state.
+        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?+
+          transitions_to 'redeemed', 'suspended'
+          validates_presence_of :txref # scoped validations
+          before_save :prepare_for_plucking # scoped callbacks
+        end
+        state 'redeemed' do # likewise
+          transitions_to 'suspended'
+          validates_presence_of :txref, :redeemed_at, :facility_id # scoped validations
+        end
+        state 'suspended' do # you guess
+          transitions_to 'unpaid', 'ready', 'redeemed'
+        end
+      end
+      ...
+    end
 
 
 Copyright (c) 2009 Igor Gunko, released under the MIT license

data/Rakefile

@@ -5,7 +5,7 @@ require 'rake/rdoctask'
 desc 'Default: run unit tests.'
 task :default => :test
 
-desc 'Test the statelogic plugin.'
+desc 'Test Statelogic'
 Rake::TestTask.new(:test) do |t|
   t.libs << 'lib'
   t.libs << 'test'
@@ -13,11 +13,12 @@ Rake::TestTask.new(:test) do |t|
   t.verbose = true
 end
 
-desc 'Generate documentation for the statelogic plugin.'
+desc 'Generate documentation for Statelogic.'
 Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Statelogic'
+  files =['README.rdoc', 'MIT-LICENSE', 'lib/**/*.rb']
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc" # page to start on
+  rdoc.title = "Statelogic Documentation"
+  rdoc.rdoc_dir = 'doc/rdoc' # rdoc output folder
   rdoc.options << '--line-numbers' << '--inline-source'
-  rdoc.rdoc_files.include('README')
-  rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/lib/statelogic/activerecord.rb

@@ -10,8 +10,8 @@ module Statelogic
       DEFAULT_OPTIONS = {:attribute => :state}.freeze
 
       class StateScopeHelper
-        CALLBACKS = ::ActiveRecord::Callbacks::CALLBACKS.map(&:to_sym).to_set
-        MACROS_PATTERN = /\Avalidates_/
+        CALLBACKS = ::ActiveRecord::Callbacks::CALLBACKS.map(&:to_sym).to_set.freeze
+        MACROS_PATTERN = /\Avalidates_/.freeze
 
         def initialize(cl, state, config)
           @class, @state, @config, @conditions = cl, state, config, state.map {|x| :"#{x}?"}
@@ -72,9 +72,8 @@ module Statelogic
 
         ConfigHelper.new(self, options).instance_eval(&block)
 
-        initial = options[:initial]
-        validates_inclusion_of attr, :in => initial.to_set, :on => :create unless initial.blank?
-        #validates_inclusion_of attr, :in => options[:states].to_set
+        initial = options[:initial] || options[:states]
+        validates_inclusion_of attr, :in => initial, :on => :create unless initial.blank?
 
         const = attr.to_s.pluralize.upcase
         const_set(const, options[:states].freeze.each(&:freeze)) unless const_defined?(const)
@@ -83,6 +82,7 @@ module Statelogic
   end
 end
 
+# :stopdoc:
 class ActiveRecord::Base
   include Statelogic::ActiveRecord
 end

data/lib/statelogic/callbacks_ext.rb

@@ -1,3 +1,4 @@
+# :stopdoc:
 class ActiveSupport::Callbacks::Callback
   def should_run_callback?(*args)
     [options[:if]].flatten.compact.all? { |a| evaluate_method(a, *args) } &&

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pipa-statelogic
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Igor Gunko