FSM — Ruby: Реальный Rails

Программа урока

• Конфигурация AASM в проекте
• AASM + ActiveRecord
• Условия смены состояния
• Транзакции и состояние гонки (race condition)
• Тесты и AASM
• AASM вне Rails

Пример класса с AASM.

class Job
  include AASM

  aasm do
    # Начальное состояние
    state :sleeping, initial: true
    state :running, :cleaning

    # Событие и переходы
    event :run do
      transitions from: :sleeping, to: :running
    end

    event :clean do
      transitions from: :running, to: :cleaning
    end

    event :sleep do
      # Одинаковое событие для перехода из нескольких состояний
      transitions from: [:running, :cleaning], to: :sleeping
    end
  end

end

job = Job.new
# У модели появляются функции-предикаты, которые позволяют определить состояние
job.sleeping? # => true
job.may_run?  # => true
job.run
job.running?  # => true
job.sleeping? # => false
job.may_run?  # => false
job.run       # => raises AASM::InvalidTransition

class CreateExamples < ActiveRecord::Migration[6.1]
  def change
    create_table :examples do |t|
      По дефолту используется имя колонки aasm_state
      t.string :aasm_state

      t.timestamps
    end
  end
end

job = Job.new
job.run   # not saved
# События с ! сохраняют модель
job.run!  # saved

# or
job.aasm.fire(:run) # not saved
job.aasm.fire!(:run) # saved

resources :vacancies do
  # Запрос на изменение состояния выполняется с глаголом PATCH
  # https://www.restapitutorial.com/lessons/httpmethods.html
  member do
    patch :run
  end
end

Самостоятельная работа

Если у вас нет Rails-проекта, то создайте его.

Подключите в проект гем aasm. С помощью конечного автомата опишите жизненный цикл для существующей или новой сущности.

Пример конечного автомата для статей в блоге.

      +------------------+
      |     Черновик     |
      +------------------+
             |
             | Отправить на проверку
             v
      +------------------+
      |   На рассмотрении |
      +------------------+
             |
      +------+-------+
      |              |
      |              |
      v              | Предложить правки
+------------------+ |
|   Опубликовано   |<+
+------------------+
      |
      | Архивировать
      v
+------------------+
|   Архивировано   |
+------------------+

Состояния

1. Черновик (Draft): Статья создается и редактируется. В этом состоянии автор может вносить изменения и сохранять их.

2. На рассмотрении (Under Review): Статья отправлена на проверку редактору или другому автору. В этом состоянии могут быть предложены правки.

3. Опубликовано (Published): Статья прошла проверку и была опубликована на сайте блога. Она доступна для чтения пользователям.

4. Архивировано (Archived): Статья устарела или больше не актуальна.

Переходы

• Создание: Переход из состояния "Черновик" в "На рассмотрении" (например, после нажатия кнопки "Отправить на проверку").

• Правка: Переход из состояния "На рассмотрении" обратно в "Черновик" (если редактор или автор предлагает правки).

• Утверждение: Переход из состояния "На рассмотрении" в "Опубликовано" (если статья одобрена).

• Архивирование: Переход из состояния "Опубликовано" в "Архивировано" (например, если статья устарела).

Дополнительные материалы

1. Гем aasm
2. Guides Rails - дополнительные методы для ресурсного роутинга