state_machine_job 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a7f675ec564eb009278abd23d975cc4a90a8227547f4a6b52d892ff68ea9a09
-  data.tar.gz: 3edbe769acda3301a5727296f9658d7dfd38733b04e95e66033e0c0f8e8c2db2
+  metadata.gz: 1da48595f1508f1bcadd9c3f342893b1b2e902df7768c2bc84cde8047581b150
+  data.tar.gz: 46fe342256ddab39e39c233cd8036b60c8bb73cac2f1a9b456e1a92aca3965c7
 SHA512:
-  metadata.gz: ae3afe431ed7a0b271ba445a613f57b0bb065c77cc0f8f4c97031ca82d2e9ee44cb1496ecff65accc838d9706445a589f9c5148682f4d3e9a55cfe40aa311c7a
-  data.tar.gz: 8b4bc3f88b24bee08753119de4aca55e03cee70a7d883365d9d7ebbfeaa2a65476c58c8353ff270bd5fa14eb0c05512b034fdeb73d494df0cfa2c1d32602ce17
+  metadata.gz: dce23a6e924e89b36c9a1d745be3f47643a058e0ac27337ac288bd348df876a3d6d51abc99311da82ab35e6e947e2fda88994566f2cfd6a0db967a6e86670bd3
+  data.tar.gz: 6cb757643ff20b9a18e29a875ca7f059a9cf6860faa40dea07f69384f2a9107a26638f18e2b02786c7dbde0777bafa9a12a47c0547697c072bf122bfa1a3cf37

data/CHANGELOG.md

@@ -1,14 +1,14 @@
 # CHANGELOG
 
-### Version 3.0.0
+### Version 3.1.0
 
-2018-07-31
+2019-07-22
 
-[Compare changes](http://github.com/codevise/state_machine_job/compare/2-x-stable...v3.0.0)
+[Compare changes](http://github.com/codevise/state_machine_job/compare/3-0-stable...v3.1.0)
 
-- Migrate to `state_machines` gem
-  ([#10](https://github.com/codevise/state_machine_job/pull/10))
+- Ensure error state can be persisted if job leaves record invalid.
+  ([#11](https://github.com/codevise/state_machine_job/pull/11))
 
 See
-[2-x-stable branch](http://github.com/codevise/state_machine_job/blob/2-x-stable/CHANGELOG.md)
+[3-0-stable branch](http://github.com/codevise/state_machine_job/blob/3-0-stable/CHANGELOG.md)
 for previous changes.

data/README.md

@@ -56,9 +56,15 @@ When the `state` attribute changes to `'running'` (either by the `run`
 event or by manually updateing the attribute), `SomeJob` will
 automatically be enqueued. If `perform_with_result` returns `:ok`, the
 state machine transitions to the `'done'` state. You can specify as
-many results as you want. Note that any exception raised by
-`perform_with_result` leads to a state machine transition as if the
-result had been `:error`. The exception is not rescued, though.
+many results as you want.
+
+Note that any exception raised by `perform_with_result` leads to a
+state machine transition as if the result had been `:error`. The
+exception is not rescued, though. If `perform_with_result` raises an
+exception and the record is invalid, previous attribute values will be
+restored before invoking the transition. That way the transition to
+the error state can be persisted by rolling back the changes that led
+to the records invalidity during job execution.
 
 ### Passing custom Payload
 

data/lib/state_machine_job.rb

@@ -9,6 +9,7 @@ module StateMachineJob
     begin
       result = perform_with_result(record, payload)
     rescue StandardError
+      record.restore_attributes unless record.valid?
       result = :error
       raise
     ensure

data/lib/state_machine_job/version.rb

@@ -1,3 +1,3 @@
 module StateMachineJob
-  VERSION = '3.0.0'.freeze
+  VERSION = '3.1.0'.freeze
 end

data/spec/state_machine_job_spec.rb

@@ -8,6 +8,9 @@ describe StateMachineJob do
   end
 
   class Model
+    include ActiveModel::Dirty
+    include ActiveModel::Validations
+
     def id
       3
     end
@@ -17,6 +20,23 @@ describe StateMachineJob do
     def test_job_error!; end
   end
 
+  class ModelRequiringName < Model
+    attr_reader :name
+
+    validates_presence_of :name
+    define_attribute_methods :name
+
+    def initialize(name: nil)
+      @name = name
+      changes_applied
+    end
+
+    def name=(value)
+      name_will_change! unless value == @name
+      @name = value
+    end
+  end
+
   class SomeError < StandardError; end
 
   it 'passes record and payload to perform_with_result method' do
@@ -61,4 +81,20 @@ describe StateMachineJob do
     rescue SomeError # rubocop:disable Lint/HandleExceptions
     end
   end
+
+  it 'restores attributes of invalid record before invoking job result event ' \
+     'if perform_with_result raises to ensure state transition can be persisted' do
+    record = ModelRequiringName.new(name: 'Susan')
+    job = TestJob.new
+
+    record.name = ''
+    allow(job).to receive(:perform_with_result).and_raise(SomeError)
+
+    begin
+      job.perform(record)
+    rescue SomeError # rubocop:disable Lint/HandleExceptions
+    ensure
+      expect(record).to be_valid
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: state_machine_job
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2019-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines-activemodel