simple_states 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 627c1d0bd3ec1db9f71afc51615e7a1c5d8ee194
-  data.tar.gz: ca2532ece2327f549c0c113dcd09155f4df8b578
+  metadata.gz: a68d333f828efbb2ced448294618c846da08b4d1
+  data.tar.gz: ea6fbcdb518fed14d6883ef44c8c887f3e63b58b
 SHA512:
-  metadata.gz: e8295626ea865b2d3e1bfdac8e6ef2e4a5c50100ac3c0168fb68e183a03a3a8d591dfc578713d6ecae618a6ccdd9973f329068fbddde3f1039fd5ab95fd29939
-  data.tar.gz: c6a2062e68a1f7814a3b40634eb7aefcdb3e567bc444dd95b15c8ec2b4adcca3e03526c01829946104572f0ff3fbd29ffd9dc73aa5c38da6fad7c38fa11a8718
+  metadata.gz: f3137b1e0780c03f5a045c4e1df7e381e6a7b7eec8bdf5a2317c979694b097f92f6fe56ba92191cc127eb086916809578a63b1af6c1f362abf9ebb569dbb1661
+  data.tar.gz: 795e118a9f6a5cb73d673b7d7bf393ac5bc7ade2039136a45ad2d5264f907981cb7839a6800fc810faf471fa45af3eb4ee4ec4fbf3c79c15b6a4d9260db0c588

data/Gemfile.lock

@@ -5,22 +5,21 @@ GEM
     metaclass (0.0.4)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
-    rspec (3.3.0)
-      rspec-core (~> 3.3.0)
-      rspec-expectations (~> 3.3.0)
-      rspec-mocks (~> 3.3.0)
-    rspec-core (3.3.2)
-      rspec-support (~> 3.3.0)
-    rspec-expectations (3.3.1)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-mocks (3.3.2)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.3.0)
-    rspec-support (3.3.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
 
 PLATFORMS
-  java
   ruby
 
 DEPENDENCIES
@@ -28,4 +27,4 @@ DEPENDENCIES
   rspec
 
 BUNDLED WITH
-   1.10.6
+   1.11.2

data/README.md

@@ -3,6 +3,10 @@
 A super-slim (~200 loc) statemachine-like support library focussed on use in
 Travis CI.
 
+Note that the current version behaves slightly differently, and comes with
+reduced features compared to the original version. If you are looking for the
+original version see the tag `v1.1.0.rc11`.
+
 ## Usage
 
 Define states and events like this:
@@ -11,10 +15,8 @@ Define states and events like this:
 class Foo
   include SimpleStates
 
-  states :created, :started, :finished
-
-  event :start,  :from => :created, :to => :started,  :if => :startable?
-  event :finish, :to => :finished, :after => :cleanup
+  event :start,  if: :start?
+  event :finish, to: [:passed, :failed], after: :notify, unless: :finished?
 
   attr_accessor :state, :started_at, :finished_at
 
@@ -22,119 +24,57 @@ class Foo
     # start foo
   end
 
-  def startable?
+  def start?
     true
   end
 
-  def cleanup
-    # cleanup foo
+  def notify(event)
+    # notify about event on foo
   end
 end
 ```
 
-Including the SimpleStates module to your class is currently required. We'll add
-hooks for ActiveRecord etc later.
-
 SimpleStates expects your model to support attribute accessors for `:state`.
 
 Event options have the following well-known meanings:
 
 ``` ruby
-:from   # valid states to transition from
-:to     # target state to transition to
+:to     # allowed target states to transition to, deferred from the event name if not given
 :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.
+All of these options except 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 methods `start` and `start!` to a module
-included to the singleton class of instances of `Foo`.
+prepended to your class (included to the singleton class of your class'
+instances on 1.9). E.g. declaring `event :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`/`: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)
-5. add the object's current state to its `past_states` history
-6. set the object's `state` to the target state given as `:to`
-7. set the object's `[state]_at` attribute to `Time.now` if the object defines a writer for it
-8. run `:after` callbacks (if given)
+2. run `:before` callbacks (if given)
+3. set the object's `state` to the target state
+4. set the object's `[state]_at` attribute to `Time.now` if the object defines a writer for it
+5. call `super` if Foo defines the current method (i.e. call `start` but not `finish` in the example above)
+6. run `:after` callbacks (if given)
 
 You can define options for all events like so:
 
 ``` ruby
-event :finish, :to => :finished, :after => :cleanup
-event :all, :after => :notify
+event :finish, after: :cleanup
+event :all,    after: :notify
 ```
 
 This will call :cleanup first and then :notify on :finish.
 
 If no target state was given for an event then SimpleStates will try to derive
-it from the states list. I.e. for an event `start` it will check the states
+it from the event name. I.e. for an event `start` it will check the states
 list for a state `started` and use it. If it can not find a target state this
 way then it will raise an exception.
 
-By default SimpleStates will assume `:created` as an initial state. You can
-overwrite this using:
-
-``` ruby
-# note that we have to use self here!
-self.initial_state = :some_state
-```
-
-So with the example above something the following would work:
-
-``` ruby
-foo = Foo.new
-
-foo.state            # :created
-foo.created?         # true
-foo.was_created?     # true
-foo.state?(:created) # true
-
-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
-```
-
-In order to treat states as "ordered", the option `ordered: true` can be
-passed.  Events will still behave the same, callbacks be called, etc. However,
-the `state` attribute will never be set back to a previous state.
-
-For example:
-
-```
-class Foo
-  include SimpleStates
-
-  states :created, :started, :finished, ordered: true
-end
-
-foo = Foo.new
-foo.finish
-foo.start
-
-p foo.state
-# => :finished
-```

data/lib/simple_states/event.rb

@@ -36,7 +36,11 @@ module SimpleStates
       end
 
       def set_attr(obj, key, value)
-        obj.send(:"#{key}=", value) if obj.respond_to?(:"#{key}=")
+        obj.send(:"#{key}=", value) if obj.respond_to?(:"#{key}=") and not has_timestamp?(obj, key)
+      end
+
+      def has_timestamp?(obj, key)
+        key.to_s.end_with?('_at') && obj.respond_to?(key) && obj.send(key)
       end
 
       def ordered?(obj, data)

data/lib/simple_states/version.rb

@@ -1,3 +1,3 @@
 module SimpleStates
-  VERSION = '2.0.0'
+  VERSION = '2.0.1'
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: simple_states
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Sven Fuchs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-01 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies: []
-description: "[description]"
+description: '[description]'
 email: me@svenfuchs.com
 executables: []
 extensions: []
@@ -27,7 +27,6 @@ files:
 - lib/simple_states/helpers.rb
 - lib/simple_states/states.rb
 - lib/simple_states/version.rb
-- simple_states.gemspec
 homepage: https://github.com/svenfuchs/simple_states
 licenses:
 - MIT
@@ -38,19 +37,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: "[none]"
-rubygems_version: 2.4.5
+rubyforge_project: '[none]'
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: "[summary]"
+summary: '[summary]'
 test_files: []
-has_rdoc: 

data/simple_states.gemspec

@@ -1,20 +0,0 @@
-# encoding: utf-8
-
-$:.unshift File.expand_path('../lib', __FILE__)
-require 'simple_states/version'
-
-Gem::Specification.new do |s|
-  s.name         = "simple_states"
-  s.version      = SimpleStates::VERSION
-  s.authors      = ["Sven Fuchs"]
-  s.email        = "me@svenfuchs.com"
-  s.homepage     = "https://github.com/svenfuchs/simple_states"
-  s.licenses     = ['MIT']
-  s.summary      = "[summary]"
-  s.description  = "[description]"
-
-  s.files        = Dir.glob("{lib/**/*,[A-Z]*}")
-  s.platform     = Gem::Platform::RUBY
-  s.require_path = 'lib'
-  s.rubyforge_project = '[none]'
-end