rails_state_machine 2.2.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f07991f6a0bc2dab134bc8518199885d79d0ee49d1865043a5e805e71c04b2b8
-  data.tar.gz: b4d3ba7b43eaed7a95522df3b385147f6feefbfac8a7b9dd7c49c6089731d037
+  metadata.gz: 5461e8b6079aa65b23429567e03e5bcabb68ccb1887899d68de7102ac86ff120
+  data.tar.gz: 610999ac7316bbdd129614387e92a0898e8845406a40d72859f702e9addf24dd
 SHA512:
-  metadata.gz: 1a5c81c9136fc6181974e7de5cd4a664f481c965098f39af45a3998b5cc3f29c9a46e0e983d5ca2cb724915505143c09643b93ade5a6bf3d47590af6ab716147
-  data.tar.gz: af45d14e32f278bc0a4e1d1dc76b9f7863300e178d87b032f7217c7aa4df1987740a5fb895b055058b6fb7fb1ca4e08cc3021c2d6b2bafc62c44ac1f15f23d94
+  metadata.gz: b165ba8d60b65d476d1319e4572bdddc236a0f02fe6c6ea9c9565de3fbd48ea1d6fe36562aa10002949d22ba7805b9d7ca83c433135ab57fc231e87dacd4235f
+  data.tar.gz: 56f440e86a4c264b831ad37e4e33196eaf739a3f262dfb68d9bb2a0907aef09943085e2355129526352aa02da0f623e2559591ddddcc6e23b42693b7019893aa

data/.github/workflows/test.yml

@@ -9,10 +9,10 @@ name: Tests
     - master
 jobs:
   test_pg:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     services:
       postgres:
-        image: postgres:9.3
+        image: postgres:14.15
         env:
           POSTGRES_PASSWORD: postgres
         options: "--health-cmd pg_isready --health-interval 10s --health-timeout 5s
@@ -25,25 +25,47 @@ jobs:
         include:
         - ruby: 2.5.6
           gemfile: Gemfile.5.2.pg
+          bundler: 2.3.0
         - ruby: 2.5.6
           gemfile: Gemfile.6.0.pg
+          bundler: 2.3.11
 
         - ruby: 2.6.6
           gemfile: Gemfile.5.2.pg
+          bundler: 2.3.0
         - ruby: 2.6.6
           gemfile: Gemfile.6.0.pg
+          bundler: 2.3.11
 
         - ruby: 2.7.2
           gemfile: Gemfile.6.0.pg
+          bundler: 2.3.11
         - ruby: 2.7.2
           gemfile: Gemfile.6.1.pg
+          bundler: 2.2.25
         - ruby: 2.7.2
           gemfile: Gemfile.7.0.pg
+          bundler: 2.3.0
 
-        - ruby: 3.0.0
+        - ruby: 3.2.0
           gemfile: Gemfile.6.1.pg
-        - ruby: 3.0.0
+          bundler: 2.2.25
+        - ruby: 3.2.0
           gemfile: Gemfile.7.0.pg
+          bundler: 2.3.0
+        - ruby: 3.2.0
+          gemfile: Gemfile.8.0.pg
+          bundler: 2.5.23
+
+        - ruby: 3.4.1
+          gemfile: Gemfile.6.1.pg
+          bundler: 2.5.23
+        - ruby: 3.4.1
+          gemfile: Gemfile.7.0.pg
+          bundler: 2.5.23
+        - ruby: 3.4.1
+          gemfile: Gemfile.8.0.pg
+          bundler: 2.5.23
     env:
       BUNDLE_GEMFILE: "${{ matrix.gemfile }}"
     steps:
@@ -58,7 +80,7 @@ jobs:
         PGPASSWORD=postgres psql -c 'create database rails_state_machine_test;' -U postgres -p 5432 -h localhost
     - name: Bundle
       run: |
-        gem install bundler:2.1.4
-        bundle install --no-deployment
+        gem install bundler:${{ matrix.bundler }}
+        bundle _${{ matrix.bundler }}_ install --no-deployment
     - name: Run tests
-      run: bundle exec rspec
+      run: bundle _${{ matrix.bundler }}_ exec rspec

data/.ruby-version

@@ -1 +1 @@
-2.4.6
+3.4.1

data/CHANGELOG.md

@@ -9,6 +9,69 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ### Breaking changes
 
+## 3.1.0 2025-01-21
+
+### Compatible changes
+
+- Added support for Ruby 3.4
+
+## 3.0.0 2024-06-21
+
+### Breaking changes
+
+- Changed: Setting the `<state_name>_event` to an invalid event adds an error to the attribute instead of raising a `TransitionNotFoundError` error.
+- Changed: Calling `<event_name>` with an invalid event adds an error to the `<state_name>_event` attribute instead of raising a `TransitionNotFoundError` error.
+- Changed: Calling `<event_name>!` with an invalid event adds an error to the `<state_name>_event` attribute an raises a `ActiveRecord::RecordInvalid` error instead of a `TransitionNotFoundError` error.
+- Changed: The `<state_name>_event` type was changed to `ActiveModel::Attributes`.
+- Changed: `#find_event` returns `nil` in case the event is missing, previously it raised a `KeyError` error.
+- Changed: The transition of a `<state_name>_event` is executed in a prepended `before_validation` callback. If the transition is possible, the `<state_attribute>` is changed and the `<state_name>_event` is set to `nil` afterwards. If the transition is not possible, the `<state_attribute>` is not changed and the `<state_name>_event` keeps the set value.
+
+Before:
+
+```ruby
+order.update(state_event: 'finish') # => RailsStateMachine::Event::TransitionNotFoundError
+order.finish # => RailsStateMachine::Event::TransitionNotFoundError
+order.finish! # => RailsStateMachine::Event::TransitionNotFoundError
+```
+
+After:
+
+```ruby
+order.update(state_event: 'finish') # => false (state_event has the error :invalid)
+order.finish # => false (state_event has the error :invalid)
+order.finish! # => ActiveRecord::RecordInvalid (state_event has the error :invalid)
+```
+
+Upgrade examples:
+
+```ruby
+# Before the upgrade you might have rescued RailsStateMachine::Event::TransitionNotFoundError in e.g. a controller
+def update
+  build_user
+  if @user.save
+    flash[:success] = 'User saved!'
+    redirect_to @user
+  else
+    flash.now[:error] = 'User could not be saved!'
+    render(:edit, status: :unprocessable_entity)
+  end
+rescue RailsStateMachine::Event::TransitionNotFoundError
+  flash.now[:error] = 'State event not valid anymore, maybe reload the page?'
+  render(:edit, status: :unprocessable_entity)
+end
+
+# After upgrade you can either show a flash message or show an error message in your view for the <state>_event attribute
+def update
+  build_user
+  if @user.save
+    flash[:success] = 'User saved!'
+    redirect_to @user
+  else
+    flash.now[:error] = @user.errors.include?(:state_event) ? 'State event not valid anymore, maybe reload the page?' : 'User could not be saved!'
+    render(:edit, status: :unprocessable_entity)
+  end
+end
+```
 
 ## 2.2.0 2023-12-06
 

data/Gemfile

@@ -1 +1 @@
-./Gemfile.5.1.pg
+Gemfile.8.0.pg

data/Gemfile.5.2.pg

@@ -7,8 +7,8 @@ gem 'pg'
 # Development dependencies
 gem 'rspec', '~>3.5'
 gem 'rake'
-gem 'pry-byebug'
-gem 'gemika'
+gem 'pry'
+gem 'gemika', '>= 0.8.1'
 gem 'database_cleaner'
 
 # Gem under test

data/Gemfile.5.2.pg.lock

@@ -1,155 +1,175 @@
 PATH
   remote: .
   specs:
-    rails_state_machine (2.2.0)
+    rails_state_machine (3.1.0)
       activerecord
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (5.2.1)
-      actionpack (= 5.2.1)
+    actioncable (5.2.8.1)
+      actionpack (= 5.2.8.1)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailer (5.2.1)
-      actionpack (= 5.2.1)
-      actionview (= 5.2.1)
-      activejob (= 5.2.1)
+    actionmailer (5.2.8.1)
+      actionpack (= 5.2.8.1)
+      actionview (= 5.2.8.1)
+      activejob (= 5.2.8.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 2.0)
-    actionpack (5.2.1)
-      actionview (= 5.2.1)
-      activesupport (= 5.2.1)
-      rack (~> 2.0)
+    actionpack (5.2.8.1)
+      actionview (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
+      rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (5.2.1)
-      activesupport (= 5.2.1)
+    actionview (5.2.8.1)
+      activesupport (= 5.2.8.1)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.0.3)
-    activejob (5.2.1)
-      activesupport (= 5.2.1)
+    activejob (5.2.8.1)
+      activesupport (= 5.2.8.1)
       globalid (>= 0.3.6)
-    activemodel (5.2.1)
-      activesupport (= 5.2.1)
-    activerecord (5.2.1)
-      activemodel (= 5.2.1)
-      activesupport (= 5.2.1)
+    activemodel (5.2.8.1)
+      activesupport (= 5.2.8.1)
+    activerecord (5.2.8.1)
+      activemodel (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
       arel (>= 9.0)
-    activestorage (5.2.1)
-      actionpack (= 5.2.1)
-      activerecord (= 5.2.1)
-      marcel (~> 0.3.1)
-    activesupport (5.2.1)
+    activestorage (5.2.8.1)
+      actionpack (= 5.2.8.1)
+      activerecord (= 5.2.8.1)
+      marcel (~> 1.0.0)
+    activesupport (5.2.8.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
     arel (9.0.0)
-    builder (3.2.3)
-    byebug (10.0.2)
-    coderay (1.1.2)
-    concurrent-ruby (1.0.5)
-    crass (1.0.4)
-    database_cleaner (1.7.0)
-    diff-lcs (1.3)
-    erubi (1.7.1)
-    gemika (0.5.0)
-    globalid (0.4.1)
-      activesupport (>= 4.2.0)
-    i18n (1.1.0)
+    builder (3.3.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.3.3)
+    crass (1.0.6)
+    database_cleaner (2.0.2)
+      database_cleaner-active_record (>= 2, < 3)
+    database_cleaner-active_record (2.1.0)
+      activerecord (>= 5.a)
+      database_cleaner-core (~> 2.0.0)
+    database_cleaner-core (2.0.1)
+    diff-lcs (1.5.1)
+    digest (3.1.1)
+    erubi (1.13.0)
+    gemika (0.8.3)
+    globalid (1.1.0)
+      activesupport (>= 5.0)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.2)
+    io-wait (0.3.1)
+    loofah (2.22.0)
       crass (~> 1.0.2)
-      nokogiri (>= 1.5.9)
-    mail (2.7.0)
+      nokogiri (>= 1.12.0)
+    mail (2.8.1)
       mini_mime (>= 0.1.1)
-    marcel (0.3.2)
-      mimemagic (~> 0.3.2)
-    method_source (0.9.0)
-    mimemagic (0.3.10)
-      nokogiri (~> 1)
-      rake
-    mini_mime (1.0.1)
-    mini_portile2 (2.3.0)
-    minitest (5.11.3)
-    nio4r (2.3.1)
-    nokogiri (1.8.4)
-      mini_portile2 (~> 2.3.0)
-    pg (1.1.2)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-byebug (3.6.0)
-      byebug (~> 10.0)
-      pry (~> 0.10)
-    rack (2.0.5)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (5.2.1)
-      actioncable (= 5.2.1)
-      actionmailer (= 5.2.1)
-      actionpack (= 5.2.1)
-      actionview (= 5.2.1)
-      activejob (= 5.2.1)
-      activemodel (= 5.2.1)
-      activerecord (= 5.2.1)
-      activestorage (= 5.2.1)
-      activesupport (= 5.2.1)
+      net-imap
+      net-pop
+      net-smtp
+    marcel (1.0.4)
+    method_source (1.1.0)
+    mini_mime (1.1.2)
+    mini_portile2 (2.6.1)
+    minitest (5.15.0)
+    net-imap (0.2.2)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.2)
+      net-protocol
+    net-protocol (0.1.2)
+      io-wait
+      timeout
+    net-smtp (0.3.0)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.7.3)
+    nokogiri (1.12.5)
+      mini_portile2 (~> 2.6.1)
+      racc (~> 1.4)
+    pg (1.5.6)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    racc (1.8.0)
+    rack (2.2.9)
+    rack-test (2.1.0)
+      rack (>= 1.3)
+    rails (5.2.8.1)
+      actioncable (= 5.2.8.1)
+      actionmailer (= 5.2.8.1)
+      actionpack (= 5.2.8.1)
+      actionview (= 5.2.8.1)
+      activejob (= 5.2.8.1)
+      activemodel (= 5.2.8.1)
+      activerecord (= 5.2.8.1)
+      activestorage (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
       bundler (>= 1.3.0)
-      railties (= 5.2.1)
+      railties (= 5.2.8.1)
       sprockets-rails (>= 2.0.0)
-    rails-dom-testing (2.0.3)
-      activesupport (>= 4.2.0)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
-      loofah (~> 2.2, >= 2.2.2)
-    railties (5.2.1)
-      actionpack (= 5.2.1)
-      activesupport (= 5.2.1)
+    rails-html-sanitizer (1.5.0)
+      loofah (~> 2.19, >= 2.19.1)
+    railties (5.2.8.1)
+      actionpack (= 5.2.8.1)
+      activesupport (= 5.2.8.1)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.19.0, < 2.0)
-    rake (12.3.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rake (13.2.1)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    sprockets (3.7.2)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    sprockets (4.2.1)
       concurrent-ruby (~> 1.0)
-      rack (> 1, < 3)
-    sprockets-rails (3.2.1)
-      actionpack (>= 4.0)
-      activesupport (>= 4.0)
+      rack (>= 2.2.4, < 4)
+    sprockets-rails (3.4.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
       sprockets (>= 3.0.0)
-    thor (0.20.0)
+    strscan (3.1.0)
+    thor (1.2.2)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    timeout (0.4.0)
+    tzinfo (1.2.11)
       thread_safe (~> 0.1)
-    websocket-driver (0.7.0)
+    websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)
-    websocket-extensions (0.1.3)
+    websocket-extensions (0.1.5)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   database_cleaner
-  gemika
+  gemika (>= 0.8.1)
   pg
-  pry-byebug
+  pry
   rails (~> 5.2.0)
   rails_state_machine!
   rake

data/Gemfile.6.0.pg

@@ -7,8 +7,8 @@ gem 'pg'
 # Development dependencies
 gem 'rspec', '~>3.5'
 gem 'rake'
-gem 'pry-byebug'
-gem 'gemika'
+gem 'pry'
+gem 'gemika', '>= 0.8.1'
 gem 'database_cleaner'
 
 # Gem under test