state_pattern 1.2.0 → 1.3.0

data/.gitignore

@@ -3,3 +3,5 @@
 coverage
 rdoc
 pkg
+*.gem
+*.log

data/README.rdoc

@@ -2,9 +2,77 @@
 
 A Ruby state pattern implementation.
 
-== Example
+This library intentionally follows the classic state pattern implementation (no mixins, classical delegation to simple state classes, etc.) believing that it increases flexibility (internal DSL constraints vs plain object oriented Ruby power), simplicity and clarity.
 
-Let's use one nice example from the AASM documentation and translate it to state_pattern (but keep in mind state_pattern is a generic gem, AASM is a Rails plugin):
+The gem is ready for Rails active record integration (see below and the examples folder).
+
+== Usage and functionality summary
+
+
+* Define the set of states you want your stateable object to have by creating a class for each state and inheriting from +StatePattern:State+.
+* All public methods defined in this state classes are delegation targets from the stateable object so they will all be available (except +enter+ and +exit+, see below). 
+* If automatic delegation to the current state public methods is not enough for your stateful object needs then you can manually perform the delegation using +delegate_to_state+.
+* Inside each state instance you can access the stateable object through the +stateable+ method.
+* Inside each state instance you can access the previous state through the +previous_state+ method.
+* Define +enter+ or +exit+ methods to hook any behaviour you want to execute whenever the stateable object enters or exits the state.
+* An event is just a method that calls +transition_to+ at some point.
+* If you want guards for some event just use plain old conditional logic before your +transition_to+.
+* In the stateful object you must +set_initial_state+ and you could also define which are +valid_transitions+.
+* If you completely describe your state machine through +valid_transitions+, then you can user +state_classes+ and +state_events+ to get the available set of classes and events.
+
+== Examples
+
+So here's a simple example that mimics a traffic semaphore
+
+  require 'rubygems'
+  require 'state_pattern'
+
+  class Stop < StatePattern::State
+    def next
+      sleep 3
+      transition_to(Go)
+    end
+
+    def color
+      "Red"
+    end
+  end
+
+  class Go < StatePattern::State
+    def next
+      sleep 2
+      transition_to(Caution)
+    end
+
+    def color
+      "Green"
+    end
+  end
+
+  class Caution < StatePattern::State
+    def next
+      sleep 1
+      transition_to(Stop)
+    end
+
+    def color
+      "Amber"
+    end
+  end
+
+  class TrafficSemaphore
+    include StatePattern
+    set_initial_state Stop
+  end
+
+  semaphore = TrafficSemaphore.new
+
+  loop do
+    puts semaphore.color
+    semaphore.next
+  end
+
+Let's now use one nice example from the AASM documentation and translate it to state_pattern.
 
   require 'rubygems'
   require 'state_pattern'
@@ -69,7 +137,7 @@ Let's use one nice example from the AASM documentation and translate it to state
 == Validations
 
 One of the few drawbacks the state pattern has is that it can get difficult to see the global picture of your state machine when dealing with complex cases.
-To deal with this problem you have the option of using the valid_transitions statement to "draw" your state diagram in code. Whenever a state transition is performed, the valid_transitions hash is checked and if the transition is not valid a StatePattern::InvalidTransitionException is thrown.
+To deal with this problem you have the option of using the +valid_transitions+ statement to "draw" your state diagram in code. Whenever a state transition is performed, the valid_transitions hash is checked and if the transition is not valid a StatePattern::InvalidTransitionException is thrown.
 
 Examples:
 
@@ -85,13 +153,127 @@ Using event names to gain more detail
 == Enter and exit hooks
 
 Inside your state classes, any code that you put inside the enter method will be executed when the state is instantiated.
-You can also use the exit hook which is triggered when a successfull transition to another state takes place.
+You can also use the exit hook which is triggered when a successful transition to another state takes place.
 
 == Querying
 
 The state pattern is a very dynamic way of representing a state machine, very few things are hard-coded and everything can change on runtime.
-This means that the only way (apart from parsing ruby code) to get a list of the state classes and events that are used, is inspecting the valid_transitions array.
-So assuming that you completely draw your state machine with valid_transitions (which is always recommended) you can use the class methods state_classes and state_events to get a list of states and events respectively.
+This means that the only way (apart from parsing ruby code) to get a list of the state classes and events that are used, is inspecting the +valid_transitions+ array.
+So assuming that you completely draw your state machine with +valid_transitions+ (which is always recommended) you can use the class methods +state_classes+ and +state_events+ to get a list of states and events respectively.
+
+== Overriding automatic delegation
+
+If automatic delegation to the current state public methods is not enough for your stateful object needs then you can manually perform the delegation using +delegate_to_state+:
+
+  class TrafficSemaphore
+    include StatePattern
+    set_initial_state Stop
+
+    def color
+      # do something
+      delegate_to_state :color
+      # do something
+    end
+  end
+
+== Rails
+
+To use the state pattern in your Rails models you need to:
+
+* Add a state column for your model table of type string
+* Include StatePattern::ActiveRecord in your model file
+* Use the state pattern as you would do in a plain Ruby class as shown above
+
+Please see the examples folder for a Rails 3 example.
+
+=== Example
+
+Note this is not the best example to show as ideally this plugin should be used with lot of state dependent behaviour and this is not the case.
+Remember to put each state class in its correct directory and following Rails naming conventions so they are correctly loaded in the load path.
+
+  module BlogStates
+    class StateBase < StatePattern::State
+      def submit!
+      end
+
+      def publish!
+      end
+
+      def reject!
+        transition_to(Rejected)
+        stateable.save!
+      end
+
+      def verify!
+      end
+    end
+
+    class Published < StateBase
+    end
+
+    class Pending < StateBase
+      def publish!
+        transition_to(Published) if stateable.valid?
+        stateable.save!
+      end
+    end
+
+    class Unverified < StateBase
+      def submit!
+        if stateable.submitter.manager?
+          if stateable.profile_complete?
+            transition_to(Published)
+          else
+            transition_to(Pending)
+          end
+
+          stateable.save!
+        end
+      end
+
+      def verify!
+        transition_to(Pending)
+        stateable.save!
+      end
+    end
+
+    class Rejected < StateBase
+      def publish!
+        transition_to(Published) if stateable.valid?
+        stateable.save!
+      end
+
+      def enter
+        Notifier.notify_blog_owner(stateable)
+      end
+    end
+  end
+
+  class Blog < ActiveRecord::Base
+    include StatePattern::ActiveRecord
+    set_initial_state Unverified
+    valid_transitions [Unverified, :submit!] => [Published, Pending, Unverified], [Unverified, :verify!] => Pending, [Unverified, :reject!] => Rejected,
+                      [Pending, :publish!] => Published, [Pending, :reject!] => Rejected,
+                      [Rejected, :publish!] => Published, [Rejected, :reject!] => Rejected,
+                      [Published, :reject!] => Rejected
+
+     .
+     .
+     .
+
+  end
+
+=== The state attribute
+
+By default StatePattern::ActiveRecord expects a column named 'state' in the model. If you prefer to use another attribute do:
+
+  set_state_attribute :state_column
+
+=== How do I decide? state_pattern or {AASM}[http://github.com/rubyist/aasm]?
+
+* Lot of state dependent behavior? Lot of conditional logic depending on the state? => state_pattern
+* Not much state dependent behavior? => AASM
+
 
 == Installation
 

data/Rakefile

@@ -1,22 +1,6 @@
 require 'rubygems'
 require 'rake'
 
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "state_pattern"
-    gem.summary = %Q{A Ruby state pattern implementation}
-    gem.email = "dcadenas@gmail.com"
-    gem.homepage = "http://github.com/dcadenas/state_pattern"
-    gem.authors = ["Daniel Cadenas"]
-    gem.rubyforge_project = "statepattern"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
-end
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
@@ -39,45 +23,3 @@ end
 
 
 task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION.yml')
-    config = YAML.load(File.read('VERSION.yml'))
-    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
-  else
-    version = ""
-  end
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "state_pattern #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-begin
-  require 'rake/contrib/sshpublisher'
-  namespace :rubyforge do
-
-    desc "Release gem and RDoc documentation to RubyForge"
-    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
-
-    namespace :release do
-      desc "Publish RDoc to RubyForge."
-      task :docs => [:rdoc] do
-        config = YAML.load(
-            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
-        )
-
-        host = "#{config['username']}@rubyforge.org"
-        remote_dir = "/var/www/gforge-projects/statepattern/"
-        local_dir = 'rdoc'
-
-        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
-      end
-    end
-  end
-rescue LoadError
-  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
-end
-

data/examples/rails_2_3_8_button_example/README

@@ -0,0 +1,243 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create 
+database-backed web applications according to the Model-View-Control pattern. 
+
+This pattern splits the view (also called the presentation) into "dumb" templates
+that are primarily responsible for inserting pre-built data in between HTML tags.
+The model contains the "smart" domain objects (such as Account, Product, Person,
+Post) that holds all the business logic and knows how to persist themselves to
+a database. The controller handles the incoming requests (such as Save New Account,
+Update Product, Show Post) by manipulating the model and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails.  You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, start a new Rails application using the <tt>rails</tt> command
+   and your application name. Ex: rails myapp
+2. Change directory into myapp and start the web server: <tt>script/server</tt> (run with --help for options)
+3. Go to http://localhost:3000/ and get "Welcome aboard: You're riding the Rails!"
+4. Follow the guidelines to start developing your application
+
+
+== Web Servers
+
+By default, Rails will try to use Mongrel if it's are installed when started with script/server, otherwise Rails will use WEBrick, the webserver that ships with Ruby. But you can also use Rails
+with a variety of other web servers.
+
+Mongrel is a Ruby-based webserver with a C component (which requires compilation) that is
+suitable for development and deployment of Rails applications. If you have Ruby Gems installed,
+getting up and running with mongrel is as easy as: <tt>gem install mongrel</tt>.
+More info at: http://mongrel.rubyforge.org
+
+Say other Ruby web servers like Thin and Ebb or regular web servers like Apache or LiteSpeed or
+Lighttpd or IIS. The Ruby web servers are run through Rack and the latter can either be setup to use
+FCGI or proxy to a pack of Mongrels/Thin/Ebb servers.
+
+== Apache .htaccess example for FCGI/CGI
+
+# General Apache options
+AddHandler fastcgi-script .fcgi
+AddHandler cgi-script .cgi
+Options +FollowSymLinks +ExecCGI
+
+# If you don't want Rails to look in certain directories,
+# use the following rewrite rules so that Apache won't rewrite certain requests
+# 
+# Example:
+#   RewriteCond %{REQUEST_URI} ^/notrails.*
+#   RewriteRule .* - [L]
+
+# Redirect all requests not available on the filesystem to Rails
+# By default the cgi dispatcher is used which is very slow
+# 
+# For better performance replace the dispatcher with the fastcgi one
+#
+# Example:
+#   RewriteRule ^(.*)$ dispatch.fcgi [QSA,L]
+RewriteEngine On
+
+# If your Rails application is accessed via an Alias directive,
+# then you MUST also set the RewriteBase in this htaccess file.
+#
+# Example:
+#   Alias /myrailsapp /path/to/myrailsapp/public
+#   RewriteBase /myrailsapp
+
+RewriteRule ^$ index.html [QSA]
+RewriteRule ^([^.]+)$ $1.html [QSA]
+RewriteCond %{REQUEST_FILENAME} !-f
+RewriteRule ^(.*)$ dispatch.cgi [QSA,L]
+
+# In case Rails experiences terminal errors
+# Instead of displaying this message you can supply a file here which will be rendered instead
+# 
+# Example:
+#   ErrorDocument 500 /500.html
+
+ErrorDocument 500 "<h2>Application error</h2>Rails application failed to start properly"
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong.  Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files.  Have "tail -f" commands running
+on the server.log and development.log. Rails will automatically display debugging
+and runtime information to these files. Debugging info will also be shown in the
+browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code using
+the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/ including:
+
+* The Learning Ruby (Pickaxe) Book: http://www.ruby-doc.org/docs/ProgrammingRuby/
+* Learn to Program: http://pine.fm/LearnToProgram/  (a beginners guide)
+
+These two online (and free) books will bring you up to speed on the Ruby language
+and also on programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your Mongrel or
+Webrick server with --debugger. This means that you can break out of execution at any point
+in the code, investigate and change the model, AND then resume execution! 
+You need to install ruby-debug to run the server in debugging mode. With gems, use 'gem install ruby-debug'
+Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.find(:all)
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8 @attributes={\"title\"=>nil, \"body\"=>nil, \"id\"=>\"1\"}>,
+       #<Post:0x14a6620 @attributes={\"title\"=>\"Rails you know!\", \"body\"=>\"Only ten..\", \"id\"=>\"2\"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better is that you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you enter "cont"
+
+
+== Console
+
+You can interact with the domain model by starting the console through <tt>script/console</tt>.
+Here you'll have all parts of the application configured, just like it is when the
+application is running. You can inspect domain models, change values, and save to the
+database. Starting the script without arguments will launch it in the development environment.
+Passing an argument will specify a different environment, like <tt>script/console production</tt>.
+
+To reload your controllers and models after launching the console run <tt>reload!</tt>
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>script/dbconsole</tt>.
+You would be connected to the database with the credentials defined in database.yml.
+Starting the script without arguments will connect you to the development database. Passing an
+argument will connect you to a different database, like <tt>script/dbconsole production</tt>.
+Currently works for mysql, postgresql and sqlite.
+
+== Description of Contents
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from ApplicationController
+  which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb.
+  Most models will descend from ActiveRecord::Base.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use eRuby
+  syntax.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the common
+  header/footer method of wrapping views. In your views, define a layout using the
+  <tt>layout :default</tt> and create a file named default.html.erb. Inside default.html.erb,
+  call <% yield %> to render the view using this layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are generated
+  for you automatically when using script/generate for controllers. Helpers can be used to
+  wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database, and other dependencies.
+
+db
+  Contains the database schema in schema.rb.  db/migrate contains all
+  the sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when generated
+  using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that doesn't
+  belong under controllers, models, or helpers. This directory is in the load path.
+
+public
+  The directory available for the web server. Contains subdirectories for images, stylesheets,
+  and javascripts. Also contains the dispatchers and the default HTML files. This should be
+  set as the DOCUMENT_ROOT of your web server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the script/generate scripts, template
+  test files will be generated for you and placed in this directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins subdirectory.
+  If the app has frozen rails, those gems also go here, under vendor/rails/.
+  This directory is in the load path.