simple_state_machine 0.6.0 → 0.6.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4cf708bed33ca00037b1fbb2562b2a4c351666d82a4555b84078600b9e90ad03
+  data.tar.gz: 251e24c03f5c59313aec334045670ed024c2720630c188d17bfed1eced1827be
+SHA512:
+  metadata.gz: 482b1ba0a9e91260dfe56153453b636640dcd7c37916fd692e13d8607f59ee141d7161c9db6e9a50cdbb14b21b2895227129edf1c4f35dbcb733caceafeb8beb
+  data.tar.gz: 5c3b05eb49e792a4289e85c5be1f10f9239020a0147e0ab5b617bba58d7fac4b727a47f45564c472e25e4079e8d1fb7d52838f9a8af9dd610a90e2580d6a9132

data/.github/workflows/build.yml

@@ -0,0 +1,46 @@
+name: Build
+on:
+  - push
+  - pull_request
+
+jobs:
+  build:
+    name: Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+    if: github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby:
+          - "3.0"
+          - "2.7"
+          - "2.6"
+          - "2.5"
+        rails:
+          - "5.2"
+          - "6.0"
+          - "6.1"
+          - main
+        exclude:
+          - ruby: 2.5
+            rails: main
+          - ruby: 2.6
+            rails: main
+          - ruby: 3.0
+            rails: "5.1"
+          - ruby: 3.0
+            rails: "5.2"
+
+    runs-on: 'ubuntu-latest'
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/Gemfile.activerecord-${{ matrix.rails }}.x
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+      - name: Setup project
+        run: bundle install
+      - name: Run test
+        run: bundle exec rspec spec

data/.gitignore

@@ -1 +1,4 @@
 *.swp
+.bundle
+.ruby-version
+Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+rvm:
+  - 2.5
+  - 2.7
+  - 3.0
+  - jruby-9.2.16.0
+script: bundle exec rspec spec
+
+gemfile:
+  - gemfiles/Gemfile.activerecord-6.0.x
+  - gemfiles/Gemfile.activerecord-6.1.x
+  - gemfiles/Gemfile.basic
+
+matrix:
+  exclude:
+    - rvm: jruby
+      gemfile: gemfiles/Gemfile.activerecord-4.2.x

data/Gemfile

@@ -2,3 +2,10 @@
 source "http://rubygems.org"
 
 gemspec
+
+group :test do
+  gem "rspec", "~> 3.0"
+  gem "activerecord", ">= 5.2.0"
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+end

data/README.rdoc

@@ -1,5 +1,7 @@
 = SimpleStateMachine
 
+{<img src="https://github.com/mdh/ssm/actions/workflows/build.yml/badge.svg" />}[https://github.com/mdh/ssm/actions?query=workflow%3A.github%2Fworkflows%2Fbuild.yml+branch%3Amaster++]
+
 A simple DSL to decorate existing methods with state transition guards.
 
 Instead of using a DSL to define events, SimpleStateMachine decorates methods 
@@ -7,26 +9,14 @@ to help you encapsulate state and guard state transitions.
 
 It supports exception rescuing, google chart visualization and mountable state machines.
 
-
-== Installation
-
-Use gem install:
-
-  gem install simple_state_machine
-
-Or add it to your Gemfile:
-
-  gem 'simple_state_machine'
-
-
 == Usage
 
 Define an event and specify how the state should transition. If we want the state to change
-from :pending to :active we write:
+from *pending* to *active* we write:
 
   event :activate_account, :pending => :active
 
-That's it. You can now call activate_account and the state will automatically change.
+That's it. You can now call *activate_account* and the state will automatically change.
 If the state change is not allowed, a SimpleStateMachine::IllegalStateTransitionError is
 raised.
 
@@ -74,20 +64,23 @@ when the method is called.
 
 == ActiveRecord
 
+For ActiveRecord methods are decorated with state transition guards _and_ persistence.
+Methods marked as events behave like ActiveRecord *save* and *save!*.
+
 === Example
 
 To add a state machine to an ActiveRecord class, you will have to:
-- extend SimpleStateMachine::ActiveRecord,
-- set the initial state in after_initialize,
-- turn methods into events
+* extend SimpleStateMachine::ActiveRecord,
+* set the initial state in after_initialize,
+* turn methods into events
 
     class User < ActiveRecord::Base
 
       extend SimpleStateMachine::ActiveRecord
 
-      def after_initialize
+      after_initialize do
         self.state ||= 'pending'
-       end
+      end
 
       def invite
         self.activation_code = Digest::SHA1.hexdigest("salt #{Time.now.to_f}")
@@ -102,12 +95,12 @@ To add a state machine to an ActiveRecord class, you will have to:
     user.activation_code  # => 'SOMEDIGEST'
 
 For the invite method this generates the following event methods
-- invite              (behaves like ActiveRecord save )
-- invite!             (behaves like ActiveRecord save!)
+* *invite*              (behaves like ActiveRecord save )
+* *invite!*             (behaves like ActiveRecord save!)
 
 If you want to be more verbose you can also use:
-- invite_and_save  (alias for invite)
-- invite_and_save! (alias for invite!)
+* *invite_and_save*  (alias for invite)
+* *invite_and_save!* (alias for invite!)
 
 
 === Using ActiveRecord / ActiveModel validations
@@ -153,7 +146,7 @@ If you like to separate your state machine from your model class, you can do so
     extend SimpleStateMachine::Mountable
     mount_state_machine MyStateMachine
 
-    def after_initialize
+    after_initialize do
       self.state ||= 'new'
     end
 
@@ -163,7 +156,7 @@ If you like to separate your state machine from your model class, you can do so
 == Transitions
 
 === Catching all from states
-If an event should transition from all other defined states, you can use :all as from state:
+If an event should transition from all other defined states, you can use the *:all* state:
 
   event :suspend, :all => :suspended
 
@@ -173,18 +166,18 @@ If an event should transition from all other defined states, you can use :all as
 You can let the state machine handle exceptions by specifying the failure state for an Error:
 
   def download_data
-    raise Service::ConnectionError
+    raise Service::ConnectionError, "Uhoh"
   end
   event :download_data, Service::ConnectionError => :download_failed
 
   download_data               # catches Service::ConnectionError
   state                       # => "download_failed"
-  state_machine.raised_error  # the raised error
+  state_machine.raised_error  # "Uhoh"
 
 
 === Default error state
 
-To automatically change all states to a default error state use default_error_state:
+To automatically catch all exceptions to a default error state use default_error_state:
   
   state_machine_definition.default_error_state = :failed
 
@@ -192,7 +185,7 @@ To automatically change all states to a default error state use default_error_st
 
 If you want to run events in transactions run them in a transaction block:
 
-  user.transaction { user.invite }
+  user.transaction { user.invite! }
 
 == Tools
 
@@ -207,6 +200,15 @@ For details run:
 A Googlechart example:
 http://tinyurl.com/79xztr6
 
+== Installation
+
+Use gem install:
+
+  gem install simple_state_machine
+
+Or add it to your Gemfile:
+
+  gem 'simple_state_machine'
 
 == Note on Patches/Pull Requests
 

data/examples/conversation.rb

@@ -2,19 +2,19 @@
 #
 # class Conversation
 #   include AASM
-# 
+#
 #   aasm_column :current_state # defaults to aasm_state
-# 
+#
 #   aasm_initial_state :unread
-# 
+#
 #   aasm_state :unread
 #   aasm_state :read
 #   aasm_state :closed
-# 
+#
 #   aasm_event :view do
 #     transitions :to => :read, :from => [:unread]
 #   end
-# 
+#
 #   aasm_event :close do
 #     transitions :to => :closed, :from => [:read, :unread]
 #   end

data/examples/lamp.rb

@@ -1,21 +1,21 @@
 class Lamp
-      
+
   extend SimpleStateMachine
 
   def initialize
     self.state = 'off'
   end
-  
+
   def push_button1
     puts "click1: #{state}"
   end
-  event :push_button1, :off => :on, 
+  event :push_button1, :off => :on,
                        :on  => :off
-  
+
   def push_button2
     puts "click2: #{state}"
   end
   event :push_button2, :off => :on,
                        :on  => :off
 
-end
+end

data/examples/relationship.rb

@@ -2,23 +2,23 @@
 #
 # class Relationship
 #   include AASM
-# 
+#
 #   aasm_column :status
-# 
+#
 #   aasm_initial_state Proc.new { |relationship| relationship.strictly_for_fun? ? :intimate : :dating }
-# 
+#
 #   aasm_state :dating,   :enter => :make_happy,        :exit => :make_depressed
 #   aasm_state :intimate, :enter => :make_very_happy,   :exit => :never_speak_again
 #   aasm_state :married,  :enter => :give_up_intimacy,  :exit => :buy_exotic_car_and_wear_a_combover
-# 
+#
 #   aasm_event :get_intimate do
 #     transitions :to => :intimate, :from => [:dating], :guard => :drunk?
 #   end
-# 
+#
 #   aasm_event :get_married do
 #     transitions :to => :married, :from => [:dating, :intimate], :guard => :willing_to_give_up_manhood?
 #   end
-# 
+#
 #   def strictly_for_fun?; end
 #   def drunk?; end
 #   def willing_to_give_up_manhood?; end
@@ -32,7 +32,7 @@
 
 class Relationship
   extend SimpleStateMachine
-  
+
   def initialize
     self.state = relationship.strictly_for_fun? ? get_intimate : start_dating
   end
@@ -84,4 +84,4 @@ class Relationship
   def never_speak_again; end
   def give_up_intimacy; end
   def buy_exotic_car_and_wear_a_combover; end
-end
+end

data/examples/traffic_light.rb

@@ -1,7 +1,7 @@
 class TrafficLight
-  
+
   extend SimpleStateMachine
-  
+
   def initialize
     self.state = 'green'
   end
@@ -14,4 +14,4 @@ class TrafficLight
   event :change_state, :green  => :orange,
                        :orange => :red,
                        :red    => :green
-end
+end

data/examples/user.rb

@@ -5,6 +5,7 @@ class User < ActiveRecord::Base
 
   extend SimpleStateMachine::ActiveRecord
 
+  after_initialize :after_initialize
   def after_initialize
     self.state ||= 'new'
     # if you get an ActiveRecord::MissingAttributeError

data/gemfiles/Gemfile.activerecord-5.2.x

@@ -0,0 +1,9 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+group :test do
+  gem "rspec"
+  gem "activerecord", "~>5.2.0"
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+end

data/gemfiles/Gemfile.activerecord-6.0.x

@@ -0,0 +1,9 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+group :test do
+  gem "rspec"
+  gem "activerecord", "~>6.0.0"
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+end

data/gemfiles/Gemfile.activerecord-6.1.x

@@ -0,0 +1,8 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+group :test do
+  gem "rspec"
+  gem "activerecord", "~>6.1.0"
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+end

data/gemfiles/Gemfile.activerecord-main.x

@@ -0,0 +1,9 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+group :test do
+  gem "rspec"
+  gem "activerecord", git: "https://github.com/rails/rails.git", branch: "main"
+  gem "sqlite3", :platform => [:ruby, :mswin, :mingw]
+  gem "activerecord-jdbcsqlite3-adapter", :platform => :jruby
+end

data/gemfiles/Gemfile.basic

@@ -0,0 +1,6 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+group :test do
+  gem "rspec"
+end

data/lib/simple_state_machine/decorator/active_record.rb

@@ -20,19 +20,14 @@ module SimpleStateMachine
           event_name_and_save = "#{event_name}_and_save"
           unless @subject.method_defined?(event_name_and_save)
             @subject.send(:define_method, event_name_and_save) do |*args|
-              result    = false
               old_state = self.send(self.class.state_machine_definition.state_method)
               send "#{event_name}_with_managed_state", *args
-              if !self.errors.entries.empty?
-                self.send("#{self.class.state_machine_definition.state_method}=", old_state)
+              if self.errors.entries.empty? && save
+                true
               else
-                if save
-                  result = true
-                else
-                  self.send("#{self.class.state_machine_definition.state_method}=", old_state)
-                end
+                self.send("#{self.class.state_machine_definition.state_method}=", old_state)
+                false
               end
-              return result
             end
             @subject.send :alias_method, "#{event_name}", event_name_and_save
           end
@@ -42,20 +37,19 @@ module SimpleStateMachine
           event_name_and_save_bang = "#{event_name}_and_save!"
           unless @subject.method_defined?(event_name_and_save_bang)
             @subject.send(:define_method, event_name_and_save_bang) do |*args|
-              result = nil
               old_state = self.send(self.class.state_machine_definition.state_method)
               send "#{event_name}_with_managed_state", *args
-              if !self.errors.entries.empty?
+              if self.errors.entries.empty?
+                begin
+                  save!
+                rescue ::ActiveRecord::RecordInvalid
+                  self.send("#{self.class.state_machine_definition.state_method}=", old_state)
+                  raise #re raise
+                end
+              else
                 self.send("#{self.class.state_machine_definition.state_method}=", old_state)
                 raise ::ActiveRecord::RecordInvalid.new(self)
               end
-              begin
-                result = save!
-              rescue ::ActiveRecord::RecordInvalid
-                self.send("#{self.class.state_machine_definition.state_method}=", old_state)
-                raise #re raise
-              end
-              return result
             end
             @subject.send :alias_method, "#{event_name}!", event_name_and_save_bang
           end

data/lib/simple_state_machine/tools/graphviz.rb

@@ -4,13 +4,17 @@ module SimpleStateMachine
     module Graphviz
       # Graphviz dot format for rendering as a directional graph
       def to_graphviz_dot
-        transitions.map { |t| t.to_graphviz_dot }.sort.join(";")
+        "digraph G {\n" +
+          transitions.map { |t| t.to_graphviz_dot }.sort.join(";\n") +
+          "\n}"
       end
 
       # Generates a url that renders states and events as a directional graph.
       # See http://code.google.com/apis/chart/docs/gallery/graphviz.html
       def google_chart_url
-        "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape to_graphviz_dot}}"
+        graph = transitions.map { |t| t.to_graphviz_dot }.sort.join(";")
+        puts graph
+        "http://chart.googleapis.com/chart?cht=gv&chl=digraph{#{::CGI.escape graph}}"
       end
     end
   end

data/lib/simple_state_machine/version.rb

@@ -1,3 +1,3 @@
 module SimpleStateMachine
-  VERSION = "0.6.0"
+  VERSION = "0.6.1"
 end

data/lib/simple_state_machine.rb

@@ -5,9 +5,10 @@ require 'simple_state_machine/tools/inspector'
 require 'simple_state_machine/state_machine_definition'
 require 'simple_state_machine/transition'
 require 'simple_state_machine/decorator/default'
-# if defined?(ActiveRecord)
+if defined?(ActiveRecord)
   require 'simple_state_machine/active_record'
   require 'simple_state_machine/decorator/active_record'
-# end
-require "simple_state_machine/railtie" if defined?(Rails::Railtie)
-
+end
+if defined?(Rails::Railtie)
+  require "simple_state_machine/railtie"
+end

data/lib/tasks/graphviz.rake

@@ -1,5 +1,15 @@
 namespace :ssm do
   namespace :graph do
+
+    desc 'Outputs a dot file. You must specify class=ClassNAME'
+    task :dot => :environment do
+      if clazz = ENV['class']
+        puts clazz.constantize.state_machine_definition.to_graphviz_dot
+      else
+        puts "Missing argument: class. Please specify class=ClassName"
+      end
+    end
+
     desc 'Generate a url for a google chart. You must specify class=ClassName'
     task :url => :environment do
       if clazz = ENV['class']

data/simple_state_machine.gemspec

@@ -3,30 +3,19 @@ $:.push File.expand_path("../lib", __FILE__)
 require "simple_state_machine/version"   
 
 Gem::Specification.new do |s|
-  s.name = %q{simple_state_machine}
-  s.version     = SimpleStateMachine::VERSION
-  s.platform    = Gem::Platform::RUBY
-
-  s.authors = ["Marek de Heus", "Petrik de Heus"]
-  s.description = %q{A simple DSL to decorate existing methods with state transition guards.}
-  s.email = ["FIX@example.com"]
-  s.homepage = %q{http://github.com/mdh/ssm}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files         = `git ls-files`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A simple DSL to decorate existing methods with logic that guards state transitions.}
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.add_development_dependency "rake"
-  s.add_development_dependency "ZenTest"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "activerecord", "~>2.3.5"
-  s.add_development_dependency "sqlite3-ruby"
-  s.add_development_dependency "ruby-debug"
+  s.name             = %q{simple_state_machine}
+  s.version          = SimpleStateMachine::VERSION
+  s.platform         = Gem::Platform::RUBY
+  s.authors          = ["Marek de Heus", "Petrik de Heus"]
+  s.description      = %q{A simple DSL to decorate existing methods with state transition guards.}
+  s.email            = ["FIX@example.com"]
+  s.homepage         = %q{http://github.com/mdh/ssm}
+  s.extra_rdoc_files = ["LICENSE","README.rdoc"]
+  s.files            = `git ls-files`.split("\n")
+  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.rdoc_options     = ["--charset=UTF-8"]
+  s.require_paths    = ["lib"]
+  s.summary          = %q{A simple DSL to decorate existing methods with logic that guards state transitions.}
+  s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
 end