workflow 2.0.0.pre → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f86a2a059cb997a5c36395d7f8bab2b572e3468cd7e93819daa37ddb33dd7685
-  data.tar.gz: af05dfbb7fbcb238641acb8bad34e78c47afbcbb078dbc71fcd217027b487209
+  metadata.gz: 60901ed58fefbe1ef7c4e6b4ec5f06c307c3b6c1669f6838d9990bd15ef452ad
+  data.tar.gz: d4f5f51c86f382b65ae4850ede4a7749f9dcc2153e544cdf3c068a0af7561799
 SHA512:
-  metadata.gz: 79e6e4f70e76e0bce0bfaebfba3e6f20def8b0da4eb9ed6dd8493ae10efe8c5baed5a40ae5d9a7c2c0b1489fdcd2d76445a7f39b8e087998d506635478a9797c
-  data.tar.gz: ba55dc2332a66ad167e2522b20fff129dc6eff37778a996acb74c44e931864cf2e321079136a1b41bd96ad590b4fb66ae1ef3b9ad08a0ef9c5a52d61924c7607
+  metadata.gz: dd5fc9eeb0062c0dd432406be66c47bf64530c5f89b95364af6cc92821199c821e895ad16eab361939f02c6ccbbf21bcba33048e2014f56dd920a7bb22219382
+  data.tar.gz: 7d9ca2e0b4e8873bb3802944f29879f0606ccf14adc392cb6a63e5ba2fe2a5c70245fc78e4a4026b374f9b39b4d3330630df2398f22187c86ae2be32da17d78d

data/README.markdown

@@ -10,17 +10,9 @@ 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.
+**Note: Workflow 2.0 is a major refactoring of the library.
+For different options/troubleshooting using it with your Rails application see
+[State persistence with ActiveRecord](#state-persistence-with-activerecord).**
 
 What is workflow?
 -----------------
@@ -91,8 +83,8 @@ of possible events and other meta information:
         @transitions_to=:awaiting_review, @name=:submit, @meta={}>},
       name:new, meta{}
 
-On Ruby 1.9 and above, you can check whether a state comes before or
-after another state (by the order they were defined):
+You can also check, whether a state comes before or after another state (by the
+order they were defined):
 
     article.current_state
     => being_reviewed
@@ -129,16 +121,6 @@ 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).
 
-Ruby 1.9
---------
-
-Workflow gem does not work with some Ruby 1.9
-builds due to a known bug in Ruby 1.9. Either
-
-* use newer ruby build, 1.9.2-p136 and -p180 tested to work
-* or compile your Ruby 1.9 from source
-* or [comment out some lines in workflow](http://github.com/geekq/workflow/issues#issue/6)
-(reduces functionality).
 
 Examples
 --------
@@ -208,73 +190,29 @@ due to a deep nesting. We tried (and dismissed) lambdas for this. Eventually
 we decided to invoke an optional user defined callback method with the same
 name as the event (convention over configuration) as explained before.
 
+State persistence with ActiveRecord
+-----------------------------------
 
-Integration with ActiveRecord
------------------------------
-
-Workflow library can handle the state persistence fully automatically. You
-only need to define a string field on the table called `workflow_state`
-and include the workflow mixin in your model class as usual:
-
-    class Order < ActiveRecord::Base
-      include Workflow
-      workflow do
-        # list states and transitions here
-      end
-    end
-
-On a database record loading all the state check methods e.g.
-`article.state`, `article.awaiting_review?` are immediately available.
-For new records or if the `workflow_state` field is not set the state
-defaults to the first state declared in the workflow specification. In
-our example it is `:new`, so `Article.new.new?` returns true and
-`Article.new.approved?` returns false.
-
-At the end of a successful state transition like `article.approve!` the
-new state is immediately saved in the database.
-
-You can change this behaviour by overriding `persist_workflow_state`
-method.
-
-### Scopes
-
-Workflow library also adds automatically generated scopes with names based on
-states names:
-
-    class Order < ActiveRecord::Base
-      include Workflow
-      workflow do
-        state :approved
-        state :pending
-      end
-    end
-
-    # returns all orders with `approved` state
-    Order.with_approved_state
-
-    # returns all orders with `pending` state
-    Order.with_pending_state
-
-
-### Custom workflow database column
+Note: Workflow 2.0 is a major refactoring for the `worklow` library.
+If your application suddenly breaks after the workflow 2.0 release, you've
+probably got your Gemfile wrong ;-). workflow uses [semantic versioning][]. For
+highest compatibility please reference the desired major+minor version.
 
-[meuble](http://imeuble.info/) contributed a solution for using
-custom persistence column easily, e.g. for a legacy database schema:
-
-    class LegacyOrder < ActiveRecord::Base
-      include Workflow
-
-      workflow_column :foo_bar # use this legacy database column for
-                               # persistence
-    end
+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** in January 2019 the
+support for ActiveRecord (4.\*, 5.\* and newer) has been extracted into a separate
+gem. Read at [workflow-activerecord][], how to include the right gem.
 
+To use legacy built-in ActiveRecord 2.3 - 4.* support, reference Workflow 1.2 in
+your Gemfile:
 
-### Single table inheritance
+    gem 'workflow', '~> 1.2'
 
-Single table inheritance is also supported. Descendant classes can either
-inherit the workflow definition from the parent or override with its own
-definition.
+[semantic versioning]: https://guides.rubygems.org/patterns/#semantic-versioning
+[workflow-activerecord]: https://github.com/geekq/workflow-activerecord
 
 Custom workflow state persistence
 ---------------------------------
@@ -385,25 +323,6 @@ also know, if you need any interface beyond `load_workflow_state` and
 favorite database.
 
 
-Custom Versions of Existing Adapters
-------------------------------------
-
-Other adapters (such as a custom ActiveRecord plugin) can be selected by adding a `workflow_adapter` class method, eg.
-
-```ruby
-class Example < ActiveRecord::Base
-  def self.workflow_adapter
-    MyCustomAdapter
-  end
-  include Workflow
-
-  # ...
-end
-```
-
-(The above will include `MyCustomAdapter` *instead* of `Workflow::Adapter::ActiveRecord`.)
-
-
 Accessing your workflow specification
 -------------------------------------
 
@@ -548,69 +467,6 @@ The whole event sequence is as follows:
     * after_transition
 
 
-Multiple Workflows
-------------------
-
-I am frequently asked if it's possible to represent multiple "workflows"
-in an ActiveRecord class.
-
-The solution depends on your business logic and how you want to
-structure your implementation.
-
-### Use Single Table Inheritance
-
-One solution can be to do it on the class level and use a class
-hierarchy. You can use [single table inheritance][STI] so there is only
-single `orders` table in the database. Read more in the chapter "Single
-Table Inheritance" of the [ActiveRecord documentation][ActiveRecord].
-Then you define your different classes:
-
-    class Order < ActiveRecord::Base
-      include Workflow
-    end
-
-    class SmallOrder < Order
-      workflow do
-        # workflow definition for small orders goes here
-      end
-    end
-
-    class BigOrder < Order
-      workflow do
-        # workflow for big orders, probably with a longer approval chain
-      end
-    end
-
-
-### Individual workflows for objects
-
-Another solution would be to connect different workflows to object
-instances via metaclass, e.g.
-
-    # Load an object from the database
-    booking = Booking.find(1234)
-
-    # Now define a workflow - exclusively for this object,
-    # probably depending on some condition or database field
-    if # some condition
-      class << booking
-        include Workflow
-        workflow do
-          state :state1
-          state :state2
-        end
-      end
-    # if some other condition, use a different workflow
-
-You can also encapsulate this in a class method or even put in some
-ActiveRecord callback. Please also have a look at [the full working
-example][multiple_workflow_test]!
-
-[STI]: http://www.martinfowler.com/eaaCatalog/singleTableInheritance.html
-[ActiveRecord]: http://api.rubyonrails.org/classes/ActiveRecord/Base.html
-[multiple_workflow_test]: http://github.com/geekq/workflow/blob/master/test/multiple_workflows_test.rb
-
-
 Documenting with diagrams
 -------------------------
 
@@ -639,49 +495,20 @@ Development Setup
     bundle exec rake test
 
 
-Earlier versions
-----------------
-
-The `workflow` library was originally written by Ryan Allen.
-
-The version 0.3 was almost completely (including ActiveRecord
-integration, API for accessing workflow specification,
-method_missing free implementation) rewritten by Vladimir Dobriakov
-keeping the original workflow DSL spirit.
-
-
-Migration from the original Ryan's library
-------------------------------------------
-
-Credit: Michael (rockrep)
-
-Accessing workflow specification
-
-    my_instance.workflow # old
-    MyClass.workflow_spec # new
-
-Accessing states, events, meta, e.g.
-
-    my_instance.workflow.states(:some_state).events(:some_event).meta[:some_meta_tag] # old
-    MyClass.workflow_spec.states[:some_state].events[:some_event].meta[:some_meta_tag] # new
-
-Causing state transitions
-
-    my_instance.workflow.my_event # old
-    my_instance.my_event! # new
-
-when using both a block and a callback method for an event, the block executes prior to the callback
-
-
 Changelog
 ---------
 
-### New in the upcoming version 2.0.0
+### New in the version 2.0.0
 
 * extract Rails/ActiveRecord integration into a separate gem
   workflow-activerecord
 * Remodel integration removed - needs to be a separate gem
 
+Special thanks to [voltechs][] for implementing Rails 5 support
+and helping to revive `workflow`!
+
+[voltechs]: https://github.com/voltechs
+
 ### 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
@@ -814,9 +641,9 @@ Support
 About
 -----
 
-Author: Vladimir Dobriakov, <http://www.mobile-web-consulting.de>, <http://blog.geekq.net/>
+Author: Vladimir Dobriakov, <https://infrastructure-as-code.de>
 
-Copyright (c) 2010-2014 Vladimir Dobriakov, www.mobile-web-consulting.de
+Copyright (c) 2010-2019 Vladimir Dobriakov and Contributors
 
 Copyright (c) 2008-2009 Vodafone
 

data/lib/workflow.rb

@@ -15,6 +15,9 @@ module Workflow
   module ClassMethods
     attr_reader :workflow_spec
 
+    # Workflow does not provide any state persistence - it is the job of particular
+    # persistence libraries for workflow and activerecord or remodel.
+    # But it still makes sense to provide a default name and override feature.
     def workflow_column(column_name=nil)
       if column_name
         @workflow_state_column_name = column_name.to_sym

data/lib/workflow/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: workflow
 version: !ruby/object:Gem::Version
-  version: 2.0.0.pre
+  version: 2.0.0
 platform: ruby
 authors:
 - Vladimir Dobriakov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2019-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdoc
@@ -135,9 +135,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.7.6