ruby-state-machine 1.0.2 → 1.1.0

data/README.md

@@ -0,0 +1,87 @@
+## Ruby State Machine
+Ruby State Machine (ruby-state-machine) is a full-featured state machine gem for use within ruby.  It can also be used in Rails.  This was written because we required a state machine that allowed different actions to be performed based on the previous and current events, as well as injecting logic (a "decider") to determine the next event.  
+
+## Installation:
+
+Add this line to your application's Gemfile:
+
+    gem 'ruby-state-machine'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby-state-machine
+
+## Location:
+Here: http://github.com/tangledpath/ruby-state-machine
+
+RDocs: http://ruby-state-mach.rubyforge.org/
+
+
+## USAGE:
+
+```ruby
+require 'ruby-state-machine/state_machine'
+
+# Note, a state machine is not created directly; instead, the behavior of a state
+# machine is added through a mixin, e.g.:
+class SampleMachine
+  include StateMachine
+  state_machine :states => [:a_state, :b_state, :c_state, :d_state], :events => [:w_event, :x_event, :y_event, :z_event]
+  state_transition :state=>:a_state, :event=>:x_event, :next=>:c_state # Define next state for :a_state when :x_event is sent
+  state_transition :state=>:a_state, :event=>:y_event, :next=>:a_state # Define next state for :a_state when :y_event is sent
+  state_transition :state=>:a_state, :event=>:z_event, :next=>:b_state # ...
+                                                            
+  state_transition :state=>:b_state, :event=>:w_event, :next=>:b_state
+  state_transition :state=>:b_state, :event=>:y_event, :next=>:c_state
+  state_transition :state=>:b_state, :event=>:z_event, :next=>:a_state
+                                                            
+  state_transition :state=>:c_state, :event=>:x_event, :next=>:b_state
+end
+```
+
+sm = SampleMachine.new
+puts sm.current_state # :a_state
+sm.send_event(:x_event)
+puts sm.current_state # :c_state
+```
+
+For examples of other functionality, including branching, deciders, lambdas, etc, see http://ruby-state-mach.rubyforge.org/StateMachine/ClassMethods.html#state_transition-instance_method.
+
+
+## CONTRIBUTE
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2007-2013 Steven Miers
+
+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/ruby-state-machine.rb

@@ -1,6 +1,6 @@
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+require "ruby-state-machine/version"
+#require "ruby-state-machine/state_machine"
 
 module RubyStateMachine
-  VERSION = '1.0.2'
+  
 end

data/lib/ruby-state-machine/state_machine.rb

@@ -5,9 +5,12 @@ require 'ruby-state-machine/bounded_array'
 # an array of events, and one or more transition actions.  A transition can be
 # as simple as the symbol for the next state, a lambda (code) to execute.  Primitive
 # branching can also be achieved if necessary by using a "decider" instance method.
-# Please see StateMachine.state_transition for full details on the variations
-# available.  StateMachineTest also contains examples and unit tests for most (if not all)
-# of the available functionality.  See README for example.
+#
+# The {StateMachineTest} (view source) also contains examples and unit tests for most (if not all)
+# of the available functionality.  
+# Also see {http://ruby-state-mach.rubyforge.org/ README} for examples
+# @see ClassMethods#state_transition StateTransition for full details on the variations available.
+# @see StateMachineTest
 module StateMachine
   def self.included(base)
     base.extend StateMachine::ClassMethods

data/lib/ruby-state-machine/version.rb

@@ -0,0 +1,8 @@
+module RubyStateMachine
+  module VERSION
+    MAJOR = 1
+    MINOR = 1
+    TINY  = 0
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

metadata

@@ -1,114 +1,53 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: ruby-state-machine
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
-- stevenmiers
+authors:
+- tangledpath
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-05-18 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 6
-        - 0
-        version: 2.6.0
-  type: :development
-  version_requirements: *id002
-description: FIX (describe your package)
-email: 
+date: 2013-06-04 00:00:00.000000000 Z
+dependencies: []
+description: A ruby state machine
+email:
 - steven.miers@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
-- website/index.txt
-files: 
-- History.txt
-- Manifest.txt
-- PostInstall.txt
-- README.rdoc
-- Rakefile
-- config/website.yml
-- lib/ruby-state-machine.rb
+extra_rdoc_files:
+- README.md
+files:
 - lib/ruby-state-machine/bounded_array.rb
 - lib/ruby-state-machine/state_machine.rb
-- script/console
-- script/destroy
-- script/generate
-- script/txt2html
-- test/test_helper.rb
-- test/test_state_machine.rb
-- website/index.html
-- website/index.txt
-- website/javascripts/rounded_corners_lite.inc.js
-- website/stylesheets/screen.css
-- website/template.html.erb
-has_rdoc: true
-homepage: http://github.com/#{github_username}/#{project_name}
+- lib/ruby-state-machine/version.rb
+- lib/ruby-state-machine.rb
+- README.md
+homepage: http://github.com/tangledpath/ruby-state-machine
 licenses: []
-
-post_install_message: PostInstall.txt
-rdoc_options: 
-- --main
-- README.rdoc
-require_paths: 
+post_install_message: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+- ext
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: ruby-state-mach
-rubygems_version: 1.3.6
+rubyforge_project: ruby-state-machine
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: FIX (describe your package)
-test_files: 
-- test/test_helper.rb
-- test/test_state_machine.rb
+summary: A full-featured state machine gem for use within ruby.
+test_files: []
+has_rdoc: true

data/History.txt

@@ -1,32 +0,0 @@
-== 0.0.1 2009-08-11
-
-* 1 major enhancement:
-  * Initial release
-
-== 0.0.2 2009-08-11
-
-* 1 minor enhancement:
-  * Docs
-
-== 0.0.3 2009-08-17
-
-* 1 minor enhancement:
-  * Change ruby-state-mach -> ruby-state-machine
-
-== 0.0.4 2009-08-19
-
-* 1 minor enhancement:
-  * Add missing files
-
-== 1.0.1 2010-05-03
-
-* 1 bug fix:
-  * Fix initialize to call super when used on AR models.
-
-== 1.0.2 2010-05-18
-
-* 1 behavioral change:
-  * No longer returns to default state upon InvalidStateException.  This was making several unit tests more difficult than necessary.
-
-
-

data/Manifest.txt

@@ -1,20 +0,0 @@
-History.txt
-Manifest.txt
-PostInstall.txt
-README.rdoc
-Rakefile
-config/website.yml
-lib/ruby-state-machine.rb
-lib/ruby-state-machine/bounded_array.rb
-lib/ruby-state-machine/state_machine.rb
-script/console
-script/destroy
-script/generate
-script/txt2html
-test/test_helper.rb
-test/test_state_machine.rb
-website/index.html
-website/index.txt
-website/javascripts/rounded_corners_lite.inc.js
-website/stylesheets/screen.css
-website/template.html.erb

data/PostInstall.txt

@@ -1 +0,0 @@
-For more information on ruby-state-machine, see http://ruby-state-mach.rubyforge.org

data/README.rdoc

@@ -1,48 +0,0 @@
-= ruby-state-machine
-
-* http://github.com/#{github_username}/#{project_name}
-
-== DESCRIPTION:
-
-FIX (describe your package)
-
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
-
-== SYNOPSIS:
-
-  FIX (code sample of usage)
-
-== REQUIREMENTS:
-
-* None
-
-== INSTALL:
-
-* sudo gem install ruby-state-machine
-
-== LICENSE:
-
-(The MIT License)
-
-Copyright (c) 2007-2009 Steven Miers
-
-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/Rakefile

@@ -1,26 +0,0 @@
-require 'rubygems'
-gem 'hoe', '>= 2.1.0'
-require 'hoe'
-require 'fileutils'
-require './lib/ruby-state-machine'
-
-Hoe.plugin :newgem
-Hoe.plugin :website
-# Hoe.plugin :cucumberfeatures
-
-# Generate all the Rake tasks
-# Run 'rake -T' to see list of generated tasks (from gem root directory)
-$hoe = Hoe.spec 'ruby-state-machine' do
-  self.developer 'stevenmiers', 'steven.miers@gmail.com'
-  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
-  self.rubyforge_name       = 'ruby-state-mach'  #self.name # TODO this is default value
-  # self.extra_deps         = [['activesupport','>= 2.0.2']]
-
-end
-
-require 'newgem/tasks'
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-# TODO - want other tests/tasks run by default? Add them to the list
-# remove_task :default
-# task :default => [:spec, :features]

data/config/website.yml

@@ -1,2 +0,0 @@
-host: stevenmiers@rubyforge.org
-remote_dir: /var/www/gforge-projects/ruby-state-mach

data/script/console

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# File: script/console
-irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
-
-libs =  " -r irb/completion"
-# Perhaps use a console_lib to store any extra methods I may want available in the cosole
-# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
-libs <<  " -r #{File.dirname(__FILE__) + '/../lib/ruby-state-machine.rb'}"
-puts "Loading ruby-state-machine gem"
-exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
-
-begin
-  require 'rubigen'
-rescue LoadError
-  require 'rubygems'
-  require 'rubigen'
-end
-require 'rubigen/scripts/destroy'
-
-ARGV.shift if ['--help', '-h'].include?(ARGV[0])
-RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
-RubiGen::Scripts::Destroy.new.run(ARGV)