simple_states 0.1.0.pre2 → 0.1.0.pre3

data/README.md

@@ -7,28 +7,30 @@ Travis CI.
 
 Define states and events like this:
 
-    class Foo
-      include SimpleStates
+``` ruby
+class Foo
+  include SimpleStates
 
-      states :created, :started, :finished
+  states :created, :started, :finished
 
-      event :start,  :from => :created, :to => :started,  :if => :startable?
-      event :finish, :to => :finished, :after => :cleanup
+  event :start,  :from => :created, :to => :started,  :if => :startable?
+  event :finish, :to => :finished, :after => :cleanup
 
-      attr_accessor :state, :started_at, :finished_at
+  attr_accessor :state, :started_at, :finished_at
 
-      def start
-        # start foo
-      end
+  def start
+    # start foo
+  end
 
-      def startable?
-        true
-      end
+  def startable?
+    true
+  end
 
-      def cleanup
-        # cleanup foo
-      end
-    end
+  def cleanup
+    # cleanup foo
+  end
+end
+```
 
 Including the SimpleStates module to your class is currently required. We'll add
 hooks for ActiveRecord etc later.
@@ -37,24 +39,26 @@ SimpleStates expects your model to support attribute accessors for `:state`.
 
 Event options have the following well-known meanings:
 
-    :from   # valid states to transition from
-    :to     # target state to transition to
-    :if     # only proceed if the given method returns true
-    :unless # only proceed if the given method returns false
-    :before # run the given method before running `super` and setting the new state
-    :after  # run the given method at the very end
+``` ruby
+:from   # valid states to transition from
+:to     # target state to transition to
+:if     # only proceed if the given method returns true
+:unless # only proceed if the given method returns false
+:before # run the given method before running `super` and setting the new state
+:after  # run the given method at the very end
+```
 
 All of these options except for `:to` can be given as a single symbol or string or
 as an Array of symbols or strings.
 
 Calling `event` will effectively add methods to a proxy module which is
 included to the singleton class of your class' instances. E.g. declaring `event
-:start` in the example above will add a method `start` to a module included to
-the singleton class of instances of `Foo`.
+:start` in the example above will add methods `start` and `start!` to a module
+included to the singleton class of instances of `Foo`.
 
 This method will
 
-1. check if `:if`/`:except` conditions apply (if given) and just return from the method otherwise
+1. check if `:if`/`:unless` conditions apply (if given) and just return from the method otherwise
 2. check if the object currently is in a valid `:from` state (if given) and raise an exception otherwise
 3. run `:before` callbacks (if given)
 4. call `super` if Foo defines the current method (i.e. call `start` but not `finish` in the example above)
@@ -65,8 +69,10 @@ This method will
 
 You can define options for all events like so:
 
-    event :finish, :to => :finished, :after => :cleanup
-    event :all, :after => :notify
+``` ruby
+event :finish, :to => :finished, :after => :cleanup
+event :all, :after => :notify
+```
 
 This will call :cleanup first and then :notify on :finish.
 
@@ -78,31 +84,36 @@ way then it will raise an exception.
 By default SimpleStates will assum `:created` as an initial state. You can
 overwrite this using:
 
-    self.initial_state :something
+``` ruby
+# note that we have to use self here!
+self.initial_state = :some_state
+```
 
 So with the example above something the following would work:
 
-    foo = Foo.new
+``` ruby
+foo = Foo.new
 
-    foo.state            # :created
-    foo.created?         # true
-    foo.was_created?     # true
-    foo.state?(:created) # true
+foo.state            # :created
+foo.created?         # true
+foo.was_created?     # true
+foo.state?(:created) # true
 
-    foo.start            # checks Foo#startable? and then calls Foo#start
+foo.start            # checks Foo#startable? and then calls Foo#start
+# calling foo.start! (with exclamation mark) would perform same actions as foo.start, but
+# also call foo.save! afterwards.
 
-    foo.state            # :started
-    foo.started?         # true
-    foo.started_at       # Time.now
-    foo.created?         # false
-    foo.was_created?     # true
-
-    foo.finish           # just performs state logic as there's no Foo#finish
-
-    foo.state            # :finished
-    foo.finished?        # true
-    foo.finished_at      # Time.now
-    foo.was_created?     # true
-    foo.was_started?     # true
+foo.state            # :started
+foo.started?         # true
+foo.started_at       # Time.now
+foo.created?         # false
+foo.was_created?     # true
 
+foo.finish           # just performs state logic as there's no Foo#finish
 
+foo.state            # :finished
+foo.finished?        # true
+foo.finished_at      # Time.now
+foo.was_created?     # true
+foo.was_started?     # true
+```

data/lib/simple_states.rb

@@ -42,7 +42,7 @@ module SimpleStates
     end
 
     def event(name, options = {})
-      add_states(options[:from], options[:to])
+      add_states(*options[:from], options[:to])
       self.events += [Event.new(name, options)]
     end
   end

data/lib/simple_states/version.rb

@@ -1,3 +1,3 @@
 module SimpleStates
-  VERSION = '0.1.0.pre2'
+  VERSION = '0.1.0.pre3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple_states
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre2
+  version: 0.1.0.pre3
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-01 00:00:00.000000000Z
+date: 2012-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70191004044960 !ruby/object:Gem::Requirement
+  requirement: &70262350435840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70191004044960
+  version_requirements: *70262350435840
 - !ruby/object:Gem::Dependency
   name: hashr
-  requirement: &70191004043800 !ruby/object:Gem::Requirement
+  requirement: &70262350434940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.0.10
   type: :runtime
   prerelease: false
-  version_requirements: *70191004043800
+  version_requirements: *70262350434940
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70191004042340 !ruby/object:Gem::Requirement
+  requirement: &70262350434360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70191004042340
+  version_requirements: *70262350434360
 - !ruby/object:Gem::Dependency
   name: test_declarative
-  requirement: &70191004041700 !ruby/object:Gem::Requirement
+  requirement: &70262350433840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70191004041700
+  version_requirements: *70262350433840
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70191004041140 !ruby/object:Gem::Requirement
+  requirement: &70262350433120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70191004041140
+  version_requirements: *70262350433120
 description: ! '[description]'
 email: svenfuchs@artweb-design.de
 executables: []
@@ -102,9 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.1
 requirements: []
 rubyforge_project: ! '[none]'
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: ! '[summary]'
 test_files: []
-has_rdoc: