rails_state_machine 3.0.0 released

Updated . Posted . Visible to the public. Auto-destruct in 58 days

We released a new version of our rails_state_machine Show archive.org snapshot gem. The release contains mainly a breaking change on how errors in state transitions are handled.

Please have a look at the changelog Show archive.org snapshot for more details and an upgrade guide:

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 and 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:

order.update(state_event: 'finish') # => RailsStateMachine::Event::TransitionNotFoundError
order.finish # => RailsStateMachine::Event::TransitionNotFoundError
order.finish! # => RailsStateMachine::Event::TransitionNotFoundError

After:

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:

# 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
github.com
Emanuel
makandra.de
Say thanks1
Last edit
Henning Koch
License
Source code in this card is licensed under the MIT License.

Related cards:

RailsStateMachine 2.2.0 released

  • Added: State machine can now use the :prefix-option to avoid name collision if you define multiple state machines on the same model, and use state names more than once
    • Previously state_machine-definitions like this: 
       ...

state_machine 0.10.0 was released

Now allows to list transition paths from and to arbitrary states.

Rails 3.1.0 has been released!

jQuery as new default Javascript library, streaming response support, attr_accessible with roles, prepared statements, easier migrations.

How to make changes to a Ruby gem (as a Rails developer)

At makandra, we've built a few gems over the years. Some of these are quite popular: spreewald (> 1M downloads), active_type (> 1M downloads), and geordi (> 200k downloads)

Developing a Ruby gem is different from developing Rails applications, w...

Riding Rails: Rails 4.0: Final version released!

Rails 4.0 is finally ready after a thorough process of betas and release candidates. It's an amazing new version packed with new goodies and farewells to old features past their expiration date.

rails_state_machine 1.1.2 released

Fixed bugs where calling valid? would change the record's state.

Testing state_machine callbacks without touching the database

You should test the callback methods and its correct invocation in two separate tests. Understand the ActiveRecord note before you move on with this note.

Say this is you...

MongoMapper for Rails 2 on Ruby 1.9

MongoMapper is a MongoDB adapter for Ruby. We've forked it so it works for Rails 2.3.x applications running on Ruby 1.9. [1]

makandra/mongomapper is based on the "official" rails2 branch [2] which contains commits t...

Upgrade guide for moving a Rails app from Webpack 3 to Webpack 4

Webpacker is Rails' way of integrating Webpack, and version 4 has been released just a few days ago, allowing us to use Webpack 4.

I successfully upgraded an existing real-world Webpack 3 application. Below are notes on everything that I encounte...

rspec_candy 0.4.0 released

  • Now supports RSpec 3 and Rails 4
  • Drops support for state_machine, which has some issues with Rails 4 and isn't actively maintained
Posted by Emanuel to makandra dev (2024-06-24 06:02)
This website uses short-lived cookies to improve usability.
or learn more