minimal_state_machine 0.0.2 → 0.0.3

data/.gitignore

@@ -16,4 +16,5 @@ test/tmp
 test/version_tmp
 tmp
 
-.DS_Store
+.DS_Store
+minimal_state_machine.sqlite3

data/README.md

@@ -1,24 +1,74 @@
 # MinimalStateMachine
 
-TODO: Write a gem description
+A state machine for ActiveRecord implemented with the state pattern
 
-## Installation
+## Usage
 
-Add this line to your application's Gemfile:
+Add to Gemfile:
 
-    gem 'minimal_state_machine'
+```ruby
+gem 'minimal_state_machine'
+```
 
-And then execute:
+Run:
 
-    $ bundle
+```ruby
+bundle install
+rails generate minimal_state_machine
+rake db:migrate
+```
 
-Or install it yourself as:
+## Quick Start
 
-    $ gem install minimal_state_machine
+Let's say we have an Issue ActiveRecord model and we want to turn it into a state machine with 3 possible states: open, closed, solved
 
-## Usage
+```ruby
+class Issue < ActiveRecord::Base
+  include MinimalStateMachine
+
+  def self.states
+    { :open => IssueState::Open, :closed => IssueState::Closed, :solved => IssueState::Solved }
+  end
+
+  def self.initial_state
+    'open'
+  end
+end
+
+class IssueState::Open < MinimalStateMachine::State
+  def self.valid_transition_states
+    %w(closed)
+  end
+end
+
+class IssueState::Closed < MinimalStateMachine::State
+  def self.valid_transition_states
+    %w(solved open)
+  end
+end
+
+class IssueState::Solved < MinimalStateMachine::State; end
+```
+
+As you can se we define the possible states with an Hash including both the state names and the classes representing the states.
+We can provide an optional `initial_state` class method to indicate the initial state (the default value is the first of the keys in the states Hash)
+
+What would happen with this configuration:
+
+```ruby
+Issue.new.state
+=> #<IssueState::Open id: nil, type: "IssueState::Open", state_machine_id: nil, state_machine_type: "Issue", created_at: nil, updated_at: nil> 
+
+issue = Issue.new
+issue.save
+issue.state_name = 'closed'
+issue.state
+=> #<IssueState::Closed id: 1, type: "IssueState::Closed", state_machine_id: 1, state_machine_type: "Issue", created_at: "2013-01-03 19:13:31", updated_at: "2013-01-03 19:13:31"> 
+```
+
+If you try to change the state to a non valid state a `MinimalStateMachine::InvalidTransitionError` will be raised.
 
-TODO: Write usage instructions here
+If you try to set the state to a non declared state a `MinimalStateMachine::InvalidStateError` will be raised.
 
 ## Contributing
 

data/lib/minimal_state_machine/version.rb

@@ -1,3 +1,3 @@
 module MinimalStateMachine
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/minimal_state_machine.rb

@@ -34,7 +34,6 @@ module MinimalStateMachine
       if state.class.valid_transition_states.include?(state_name)
         state.destroy
         self.state = self.class.states[state_name.to_sym].new
-        save
       else
         raise InvalidTransitionError
       end

data/spec/minimal_state_machine_spec.rb

@@ -47,6 +47,7 @@ describe StateMachine do
 
   it 'changes state' do
     @state_machine.state_name = 'closed'
+    @state_machine.save
 
     @state_machine.state.should be_a(StateMachineClosed)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minimal_state_machine
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -88,7 +88,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- db/minimal_state_machine.sqlite3
 - lib/generators/minimal_state_machine/minimal_state_machine_generator.rb
 - lib/generators/minimal_state_machine/templates/create_msm_states.rb
 - lib/minimal_state_machine.rb