workflow 1.2.0 → 2.0.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9b3ca21163c2fe680f13487bd176530fa13e09b0
-  data.tar.gz: 3413ad93c300e668a778db3480a7ab11ea3910f1
+SHA256:
+  metadata.gz: f86a2a059cb997a5c36395d7f8bab2b572e3468cd7e93819daa37ddb33dd7685
+  data.tar.gz: af05dfbb7fbcb238641acb8bad34e78c47afbcbb078dbc71fcd217027b487209
 SHA512:
-  metadata.gz: 78329832051f3798e4fc5742eb1ea0f8d10e4f342bcd42e5cf6cb680a7355747e1e12dbcc9a13bc17537843e59e238cc98edd72e67aff106d9b087b2f53901b8
-  data.tar.gz: 992fe9887c6825b047fbdb28dcc16f10994705fad01aeaedb27266e92469ab4e28f91784d8cb8cb7901b82ce1843b51c03f28abca4b9f8b2550a95b8c88e6c14
+  metadata.gz: 79e6e4f70e76e0bce0bfaebfba3e6f20def8b0da4eb9ed6dd8493ae10efe8c5baed5a40ae5d9a7c2c0b1489fdcd2d76445a7f39b8e087998d506635478a9797c
+  data.tar.gz: ba55dc2332a66ad167e2522b20fff129dc6eff37778a996acb74c44e931864cf2e321079136a1b41bd96ad590b4fb66ae1ef3b9ad08a0ef9c5a52d61924c7607

data/README.markdown

@@ -1,8 +1,26 @@
-[![Build Status](https://travis-ci.org/geekq/workflow.png?branch=master)](https://travis-ci.org/geekq/workflow) Tested with [different Ruby and Rails versions](https://travis-ci.org/geekq/workflow)
+[![Version      ](https://img.shields.io/gem/v/workflow.svg?maxAge=2592000)](https://rubygems.org/gems/workflow)
+[![Build Status ](https://travis-ci.org/geekq/workflow.svg)](https://travis-ci.org/geekq/workflow)
+[![Code Climate ](https://codeclimate.com/github/geekq/workflow/badges/gpa.svg)](https://codeclimate.com/github/geekq/workflow)
+[![Test Coverage](https://codeclimate.com/github/geekq/workflow/badges/coverage.svg)](https://codeclimate.com/github/geekq/workflow/coverage)
 
-Note: you can find documentation for specific workflow rubygem versions at
-http://rubygems.org/gems/workflow: select a version (optional, default
-is latest release), click "Documentation" link.
+# Workflow
+
+Note: you can find documentation for specific workflow rubygem versions
+at http://rubygems.org/gems/workflow : select a version (optional,
+default is latest release), click "Documentation" link. When reading on
+github.com, the README refers to the upcoming release.
+
+**Note on ActiveRecord/Rails 4.\*, 5.\* Support:**
+
+Since integration with ActiveRecord makes over 90% of the issues and
+maintenance effort, and also to allow for an independent (faster) release cycle
+for Rails support, starting with workflow **version 2.0** the support for
+ActiveRecord (4.\*, 5.\* and newer) is extracted into a separate
+[workflow-activerecord](https://github.com/geekq/workflow-activerecord) gem.
+
+You can also implement
+[your own state persistence](https://github.com/geekq/workflow#custom-workflow-state-persistence)
+for ActiveRecord or any other persistence library.
 
 What is workflow?
 -----------------
@@ -106,7 +124,7 @@ Installation
     gem install workflow
 
 **Important**: If you're interested in graphing your workflow state machine, you will also need to
-install the `active_support` and `ruby-graphviz` gems.
+install the `activesupport` and `ruby-graphviz` gems.
 
 Versions up to and including 1.0.0 are also available as a single file download -
 [lib/workflow.rb file](https://github.com/geekq/workflow/blob/v1.0.0/lib/workflow.rb).
@@ -424,20 +442,26 @@ representation of the workflow. See below.
 Conditional event transitions
 -----------------------------
 
-Conditions are procs or lambdas added to events, like so:
+Conditions can be a "method name symbol" with a corresponding instance method, a `proc` or `lambda` which are added to events, like so:
 
     state :off
       event :turn_on, :transition_to => :on,
-                      :if => proc { |device| device.battery_level > 0 }
+                      :if => :sufficient_battery_level?
+
       event :turn_on, :transition_to => :low_battery,
-                      :if => proc { |device| device.battery_level > 10 }
+                      :if => proc { |device| device.battery_level > 0 }
+    end
+
+    # corresponding instance method
+    def sufficient_battery_level?
+      battery_level > 10
     end
 
 When calling a `device.can_<fire_event>?` check, or attempting a `device.<event>!`, each event is checked in turn:
 
-* With no :if check, proceed as usual.
-* If an :if check is present, proceed if it evaluates to true, or drop to the next event.
-* If you've run out of events to check (eg. battery_level == 0), then the transition isn't possible.
+* With no `:if` check, proceed as usual.
+* If an `:if` check is present, proceed if it evaluates to true, or drop to the next event.
+* If you've run out of events to check (eg. `battery_level == 0`), then the transition isn't possible.
 
 
 Advanced transition hooks
@@ -603,6 +627,18 @@ Use `Workflow::create_workflow_diagram(class)` in your rake task like:
     end
 
 
+Development Setup
+-----------------
+
+    sudo apt-get install graphviz # Linux
+    brew cask install graphviz # Mac OS
+    cd workflow
+    gem install bundler
+    bundle install
+    # run all the tests
+    bundle exec rake test
+
+
 Earlier versions
 ----------------
 
@@ -640,11 +676,29 @@ when using both a block and a callback method for an event, the block executes p
 Changelog
 ---------
 
+### New in the upcoming version 2.0.0
+
+* extract Rails/ActiveRecord integration into a separate gem
+  workflow-activerecord
+* Remodel integration removed - needs to be a separate gem
+
+### New in the upcoming version 1.3.0 (never released)
+
+* Retiring Ruby 1.8.7 and Rails 2 support #118. If you still need this older
+  versions despite security issues and missing updates, you can use
+  workflow 1.2.0 or older. In your Gemfile put
+
+      gem 'workflow', '~> 1.2.0'
+
+  or when using github source just reference the v1.2.0 tag.
+* improved callback method handling: #113 and #125
+
 ### New in the version 1.2.0
 
 * Fix issue #98 protected on\_\* callbacks in Ruby 2
 * #106 Inherit exceptions from StandardError instead of Exception
 * #109 Conditional event transitions, contributed by [damncabbage](http://robhoward.id.au/)
+  Please note: this introduces incompatible changes to the meta data API, see also #131.
 * New policy for supporting other databases - extract to separate
   gems. See the README section above.
 * #111 Custom Versions of Existing Adapters by [damncabbage](http://robhoward.id.au/)

data/lib/workflow.rb

@@ -1,9 +1,15 @@
 require 'rubygems'
 
 require 'workflow/specification'
-require 'workflow/adapters/active_record'
 require 'workflow/adapters/remodel'
 
+begin
+  require 'ruby-graphviz'
+  require 'workflow/draw'
+rescue LoadError => e
+  $stderr.puts "Could not load the ruby-graphiz or active_support gems for rendering: #{e.message}"
+end
+
 # See also README.markdown for documentation
 module Workflow
   module ClassMethods
@@ -13,7 +19,7 @@ module Workflow
       if column_name
         @workflow_state_column_name = column_name.to_sym
       end
-      if !@workflow_state_column_name && superclass.respond_to?(:workflow_column)
+      if !instance_variable_defined?('@workflow_state_column_name') && superclass.respond_to?(:workflow_column)
         @workflow_state_column_name = superclass.workflow_column
       end
       @workflow_state_column_name ||= :workflow_state
@@ -199,6 +205,7 @@ module Workflow
       # 1. public callback method or
       # 2. protected method somewhere in the class hierarchy or
       # 3. private in the immediate class (parent classes ignored)
+      action = action.to_sym
       self.respond_to?(action) or
         self.class.protected_method_defined?(action) or
         self.private_methods(false).map(&:to_sym).include?(action)
@@ -265,13 +272,6 @@ module Workflow
     # Look for a hook; otherwise detect based on ancestor class.
     if klass.respond_to?(:workflow_adapter)
       klass.send :include, klass.workflow_adapter
-    else
-      if Object.const_defined?(:ActiveRecord) && klass < ActiveRecord::Base
-        klass.send :include, Adapter::ActiveRecord
-      end
-      if Object.const_defined?(:Remodel) && klass < Adapter::Remodel::Entity
-        klass.send :include, Adapter::Remodel::InstanceMethods
-      end
     end
   end
 end

data/lib/workflow/adapters/active_record.rb

@@ -15,13 +15,8 @@ module Workflow
         # On transition the new workflow state is immediately saved in the
         # database.
         def persist_workflow_state(new_value)
-          if self.respond_to? :update_column
-            # Rails 3.1 or newer
-            update_column self.class.workflow_column, new_value
-          else
-            # older Rails; beware of side effect: other (pending) attribute changes will be persisted too
-            update_attribute self.class.workflow_column, new_value
-          end
+          # Rails 3.1 or newer
+          update_column self.class.workflow_column, new_value
         end
 
         private
@@ -42,8 +37,10 @@ module Workflow
       # Examples:
       #
       # Article.with_pending_state # => ActiveRecord::Relation
-      #
-      # Example above just adds `where(:state_column_name => 'pending')` to AR query and returns
+      # Payment.without_refunded_state # => ActiveRecord::Relation
+      #`
+      # Example above just adds `where(:state_column_name => 'pending')` or
+      # `where.not(:state_column_name => 'pending')` to AR query and returns
       # ActiveRecord::Relation.
       module Scopes
         def self.extended(object)
@@ -55,17 +52,19 @@ module Workflow
 
         def workflow_with_scopes(&specification)
           workflow_without_scopes(&specification)
-          states     = workflow_spec.states.values
-          eigenclass = class << self; self; end
+          states = workflow_spec.states.values
 
           states.each do |state|
-            # Use eigenclass instead of `define_singleton_method`
-            # to be compatible with Ruby 1.8+
-            eigenclass.send(:define_method, "with_#{state}_state") do
+            define_singleton_method("with_#{state}_state") do
               where("#{table_name}.#{self.workflow_column.to_sym} = ?", state.to_s)
             end
+
+            define_singleton_method("without_#{state}_state") do
+              where.not("#{table_name}.#{self.workflow_column.to_sym} = ?", state.to_s)
+            end
           end
         end
+
       end
     end
   end

data/lib/workflow/draw.rb

@@ -1,15 +1,3 @@
-begin
-  require 'rubygems'
-
-  gem 'ruby-graphviz', '~> 1.0.0'
-  gem 'activesupport'
-
-  require 'graphviz'
-  require 'active_support/inflector'
-rescue LoadError => e
-  $stderr.puts "Could not load the ruby-graphiz or active_support gems for rendering: #{e.message}"
-end
-
 module Workflow
   module Draw
 
@@ -41,16 +29,19 @@ module Workflow
     # @param [String] target_dir Directory, where to save the dot and the pdf files
     # @param [String] graph_options You can change graph orientation, size etc. See graphviz documentation
     def self.workflow_diagram(klass, options={})
+      # TODO: find some replacement for ActiveSupport::Inflector.tableize
+      # or make it usage optional
       options = {
-        :name => "#{klass.name.tableize}_workflow".gsub('/', '_'),
+        # :name => "#{klass.name.tableize}_workflow".gsub('/', '_'),
+        :name => "#{klass.name}_workflow".gsub('/', '_'),
         :path => '.',
         :orientation => "landscape",
         :ratio => "fill",
         :format => 'png',
         :font => 'Helvetica'
-        }.merge options
+      }.merge options
 
-        graph = ::GraphViz.new('G', :rankdir => options[:orientation] == 'landscape' ? 'LR' : 'TB', :ratio => options[:ratio])
+      graph = ::GraphViz.new('G', :rankdir => options[:orientation] == 'landscape' ? 'LR' : 'TB', :ratio => options[:ratio])
 
       # Add nodes
       klass.workflow_spec.states.each do |_, state|
@@ -66,7 +57,7 @@ module Workflow
       # Generate the graph
       filename = File.join(options[:path], "#{options[:name]}.#{options[:format]}")
 
-      graph.output options[:format] => "'#{filename}'"
+      graph.output options[:format] => filename
 
       puts "
       Please run the following to open the generated file:

data/lib/workflow/errors.rb

@@ -1,5 +1,7 @@
 module Workflow
-  class TransitionHalted < StandardError
+  class Error < StandardError; end
+
+  class TransitionHalted < Error
 
     attr_reader :halted_because
 
@@ -10,9 +12,9 @@ module Workflow
 
   end
 
-  class NoTransitionAllowed < StandardError; end
+  class NoTransitionAllowed < Error; end
 
-  class WorkflowError < StandardError; end
+  class WorkflowError < Error; end
 
-  class WorkflowDefinitionError < StandardError; end
+  class WorkflowDefinitionError < Error; end
 end

data/lib/workflow/event.rb

@@ -8,15 +8,23 @@ module Workflow
       @transitions_to = transitions_to.to_sym
       @meta = meta
       @action = action
-      @condition = if condition.nil? || condition.respond_to?(:call)
+      @condition = if condition.nil? || condition.is_a?(Symbol) || condition.respond_to?(:call)
                      condition
                    else
-                     raise TypeError, 'condition must be nil or callable (eg. a proc or lambda)'
+                     raise TypeError, 'condition must be nil, an instance method name symbol or a callable (eg. a proc or lambda)'
                    end
     end
 
     def condition_applicable?(object)
-      condition ? condition.call(object) : true
+      if condition
+        if condition.is_a?(Symbol)
+          object.send(condition)
+        else
+          condition.call(object)
+        end
+      else
+        true
+      end
     end
 
     def draw(graph, from_state)

data/lib/workflow/version.rb

@@ -1,3 +1,3 @@
 module Workflow
-  VERSION = "1.2.0"
+  VERSION = "2.0.0.pre"
 end

metadata

@@ -1,119 +1,104 @@
 --- !ruby/object:Gem::Specification
 name: workflow
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0.pre
 platform: ruby
 authors:
 - Vladimir Dobriakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-20 00:00:00.000000000 Z
+date: 2019-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: ruby-graphviz
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: ruby-graphviz
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-description: |2
-      Workflow is a finite-state-machine-inspired API for modeling and interacting
+description: |
+  Workflow is a finite-state-machine-inspired API for modeling and interacting
       with what we tend to refer to as 'workflow'.
 
       * nice DSL to describe your states, events and transitions
-      * robust integration with ActiveRecord and non relational data stores
       * various hooks for single transitions, entering state etc.
       * convenient access to the workflow specification: list states, possible events
         for particular state
@@ -124,16 +109,7 @@ extensions: []
 extra_rdoc_files:
 - README.markdown
 files:
-- .gitignore
-- .travis.yml
-- Gemfile
-- MIT-LICENSE
 - README.markdown
-- Rakefile
-- gemfiles/Gemfile.rails-2.3.x
-- gemfiles/Gemfile.rails-3.x
-- gemfiles/Gemfile.rails-4.0
-- gemfiles/Gemfile.rails-edge
 - lib/workflow.rb
 - lib/workflow/adapters/active_record.rb
 - lib/workflow/adapters/remodel.rb
@@ -144,26 +120,9 @@ files:
 - lib/workflow/specification.rb
 - lib/workflow/state.rb
 - lib/workflow/version.rb
-- orders_workflow.png
-- test/active_record_scopes_test.rb
-- test/adapter_hook_test.rb
-- test/advanced_examples_test.rb
-- test/advanced_hooks_and_validation_test.rb
-- test/attr_protected_test.rb
-- test/before_transition_test.rb
-- test/couchtiny_example.rb
-- test/inheritance_test.rb
-- test/main_test.rb
-- test/multiple_workflows_test.rb
-- test/new_versions/compare_states_test.rb
-- test/new_versions/persistence_test.rb
-- test/on_error_test.rb
-- test/readme_example.rb
-- test/test_helper.rb
-- test/without_active_record_test.rb
-- workflow.gemspec
 homepage: http://www.geekq.net/workflow/
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -171,34 +130,18 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A replacement for acts_as_state_machine.
-test_files:
-- test/active_record_scopes_test.rb
-- test/adapter_hook_test.rb
-- test/advanced_examples_test.rb
-- test/advanced_hooks_and_validation_test.rb
-- test/attr_protected_test.rb
-- test/before_transition_test.rb
-- test/couchtiny_example.rb
-- test/inheritance_test.rb
-- test/main_test.rb
-- test/multiple_workflows_test.rb
-- test/new_versions/compare_states_test.rb
-- test/new_versions/persistence_test.rb
-- test/on_error_test.rb
-- test/readme_example.rb
-- test/test_helper.rb
-- test/without_active_record_test.rb
+test_files: []