interactor-rails Documentation

Use the interactor:organizer generator to create an organizer. An organizer is used to wrap multiple interactors into a single transaction-like sequence. You can pass multiple interactor names to the generator to pre-populate the organize list.

rails generate interactor:organizer place_order charge_card send_thank_you fulfill_order

Use the Rails generator to create a new interactor. This automatically includes the Interactor module and places the file in app/interactors/ (which is added to your autoload paths).

rails generate interactor authenticate_user

Add interactor-rails to your application's Gemfile to enable Rails support for the Interactor gem.

Compatibility Note:

• For Ruby 3.1+ and Rails 7.0+, use version ~> 2.0.
• For older versions of Ruby and Rails, use version 2.2.1.

gem "interactor-rails", "~> 2.0"

An organizer includes Interactor::Organizer and uses the organize method to define the sequence of interactors to be executed.

class PlaceOrder
  include Interactor::Organizer

  organize ChargeCard, SendThankYou, FulfillOrder
end

A standard interactor includes the Interactor module and implements a call method. This is where the business logic resides.

class AuthenticateUser
  include Interactor

  def call
    # TODO
  end
end

Use the interactor:organizer Rails generator to create a new organizer class. You can pass one or more interactor names as arguments to specify which interactors this organizer should include.

Arguments:

• interactors: An array of names (e.g., name1 name2) representing the interactors to be organized.

rails generate interactor:organizer interactor1 interactor2