state_machine_job 3.0.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a7f675ec564eb009278abd23d975cc4a90a8227547f4a6b52d892ff68ea9a09
-  data.tar.gz: 3edbe769acda3301a5727296f9658d7dfd38733b04e95e66033e0c0f8e8c2db2
+  metadata.gz: ac9e3a5fff6839a9d6163a9364ac64a259aef40bb8ceb15f9229e1de1e5d3e10
+  data.tar.gz: 1e4f1a6b4fee4f35e723f33b99ad0cf3ac0039e2bdb2e9e307523aaf76ccfc2b
 SHA512:
-  metadata.gz: ae3afe431ed7a0b271ba445a613f57b0bb065c77cc0f8f4c97031ca82d2e9ee44cb1496ecff65accc838d9706445a589f9c5148682f4d3e9a55cfe40aa311c7a
-  data.tar.gz: 8b4bc3f88b24bee08753119de4aca55e03cee70a7d883365d9d7ebbfeaa2a65476c58c8353ff270bd5fa14eb0c05512b034fdeb73d494df0cfa2c1d32602ce17
+  metadata.gz: c48d231892c18e97eed3d2a1bb15728999b348dfefaae2c720144bba4548be10c63c6b3204d65c45cd310f619d5cb1befeb60337e76874405ab4fb95ae655dc4
+  data.tar.gz: 8549de2a218b54be88f429a913e014ada04a34a5d85db107813954f7a9295e64d5199aa3586df230050c97e591729798e44328fcb0b55ca3bdc25b9ecbe2e375

data/.github/workflows/tests.yml

@@ -0,0 +1,18 @@
+name: tests
+on:
+  push:
+  pull_request:
+  schedule:
+    - cron: '0 2 * * *'
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.2
+          bundler-cache: true
+      - run: bundle exec rspec

data/CHANGELOG.md

@@ -1,14 +1,16 @@
 # CHANGELOG
 
-### Version 3.0.0
+### Version 3.2.0
 
-2018-07-31
+2023-09-04
 
-[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-1-stable...v3.2.0)
 
-- Migrate to `state_machines` gem
-  ([#10](https://github.com/codevise/state_machine_job/pull/10))
+- Support Rails 6 and 7
+  ([#12](https://github.com/codevise/state_machine_job/pull/12))
+- Migrate to GitHub actions
+  ([#13](https://github.com/codevise/state_machine_job/pull/13))
 
 See
-[2-x-stable branch](http://github.com/codevise/state_machine_job/blob/2-x-stable/CHANGELOG.md)
+[3-1-stable branch](http://github.com/codevise/state_machine_job/blob/3-1-stable/CHANGELOG.md)
 for previous changes.

data/README.md

@@ -1,7 +1,7 @@
 # State Machine Job
 
 [![Gem Version](https://badge.fury.io/rb/state_machine_job.svg)](http://badge.fury.io/rb/state_machine_job)
-[![Build Status](https://travis-ci.org/codevise/state_machine_job.svg?branch=master)](https://travis-ci.org/codevise/state_machine_job)
+[![Build Status](https://github.com/codevise/state_machine_job/actions/workflows/tests.yml/badge.svg)](https://github.com/codevise/state_machine_job/actions)
 
 Enqueue jobs on state machine transitions and change state according
 to job result.
@@ -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/version.rb

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

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/spec/state_machine_job/macro_spec.rb

@@ -25,6 +25,10 @@ module StateMachineJob
       def self.find(id)
         instances.fetch(id.to_i)
       end
+
+      def self.primary_key
+        :id
+      end
     end
 
     before do

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

data/state_machine_job.gemspec

@@ -18,15 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'state_machines-activemodel', '~> 0.5.0'
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '< 13'
-  spec.add_development_dependency 'rspec-rails', '~> 3.7'
-  spec.add_development_dependency 'activesupport', '< 6'
-  spec.add_development_dependency 'activemodel', '< 6'
+  spec.add_development_dependency 'state_machines-activemodel', '~> 0.9.0'
+  spec.add_development_dependency 'bundler', ['>= 1.3', '< 3']
+  spec.add_development_dependency 'rake', '< 14'
+  spec.add_development_dependency 'rspec-rails', '~> 6.0'
   spec.add_development_dependency 'semmy', '~> 1.0'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 
-  spec.add_runtime_dependency 'activejob', ['>= 4.2', '< 6']
-  spec.add_runtime_dependency 'state_machines', '~> 0.5.0'
+  spec.add_runtime_dependency 'activejob', ['>= 4.2', '< 8']
+  spec.add_runtime_dependency 'state_machines', ['>= 0.5', '< 0.7']
 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.2.0
 platform: ruby
 authors:
 - Codevise Solutions Ltd.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2023-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: state_machines-activemodel
@@ -16,84 +16,62 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: '13'
+        version: '14'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-- !ruby/object:Gem::Dependency
-  name: activemodel
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: semmy
   requirement: !ruby/object:Gem::Requirement
@@ -131,7 +109,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -141,21 +119,27 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: state_machines
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.5'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: '0.7'
 description: State Machine + Active Job
 email:
 - info@codevise.de
@@ -163,8 +147,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/tests.yml"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -196,8 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Trigger jobs via Rails state machines.

data/.travis.yml

@@ -1,4 +0,0 @@
-rvm:
-  - 2.1.0
-
-script: "bundle exec rspec"