stepper_motor 0.1.12 → 0.1.15

data/test/dummy/db/migrate/20250609221201_stepper_motor_migration_005.rb

@@ -0,0 +1,58 @@
+class StepperMotorMigration005 < ActiveRecord::Migration[7.2]
+  def up
+    unless mysql?
+      say "Skipping migration as it is only used with MySQL (mysql2 or trilogy)"
+      return
+    end
+
+    # Add generated column that combines the state, type, hero_id, and hero_type
+    # The column will be NULL if any of the components is NULL
+    execute <<-SQL
+      ALTER TABLE stepper_motor_journeys
+      ADD COLUMN journey_uniq_col_generated VARCHAR(255) GENERATED ALWAYS AS (
+        CASE 
+          WHEN state IN ('ready', 'performing', 'paused') 
+          AND allow_multiple = 0 
+          AND type IS NOT NULL 
+          AND hero_id IS NOT NULL 
+          AND hero_type IS NOT NULL
+          THEN CONCAT(type, ':', hero_id, ':', hero_type)
+          ELSE NULL
+        END
+      ) STORED
+    SQL
+
+    # Add unique index on the generated column with MySQL-specific name
+    add_index :stepper_motor_journeys, :journey_uniq_col_generated, 
+              unique: true, 
+              name: :idx_journeys_one_per_hero_mysql_generated
+
+    # Remove old indexes that include 'ready', 'performing', and 'paused' states
+    remove_index :stepper_motor_journeys, name: :idx_journeys_one_per_hero_with_paused
+  end
+
+  def down
+    unless mysql?
+      say "Skipping migration as it is only used with MySQL (mysql2 or trilogy)"
+      return
+    end
+
+    # Remove the generated column and its index
+    remove_index :stepper_motor_journeys, name: :idx_journeys_one_per_hero_mysql_generated
+    remove_column :stepper_motor_journeys, :journey_uniq_col_generated
+
+    # Recreate old indexes
+    quoted_false = connection.quote(false)
+    add_index :stepper_motor_journeys, [:type, :hero_id, :hero_type], 
+              where: "allow_multiple = '#{quoted_false}' AND state IN ('ready', 'performing', 'paused')", 
+              unique: true, 
+              name: :idx_journeys_one_per_hero_with_paused
+  end
+
+  private
+
+  def mysql?
+    adapter = connection.adapter_name.downcase
+    adapter == "mysql2" || adapter == "trilogy"
+  end
+end

data/test/dummy/db/schema.rb

@@ -10,8 +10,8 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.2].define(version: 2025_05_28_141038) do
-  create_table "stepper_motor_journeys", force: :cascade do |t|
+ActiveRecord::Schema[7.2].define(version: 2025_06_09_221201) do
+  create_table "stepper_motor_journeys", charset: "utf8mb4", collation: "utf8mb4_uca1400_ai_ci", force: :cascade do |t|
     t.string "type", null: false
     t.string "state", default: "ready"
     t.string "hero_type"
@@ -25,12 +25,13 @@ ActiveRecord::Schema[7.2].define(version: 2025_05_28_141038) do
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
     t.string "idempotency_key"
+    t.virtual "journey_uniq_col_generated", type: :string, as: "case when `state` in ('ready','performing','paused') and `allow_multiple` = 0 and `type` is not null and `hero_id` is not null and `hero_type` is not null then concat(`type`,':',`hero_id`,':',`hero_type`) else NULL end", stored: true
     t.index ["hero_type", "hero_id"], name: "index_stepper_motor_journeys_on_hero_type_and_hero_id"
-    t.index ["next_step_to_be_performed_at"], name: "index_stepper_motor_journeys_on_next_step_to_be_performed_at", where: "state = 'ready' /*application='Dummy'*/"
-    t.index ["type", "hero_id", "hero_type"], name: "idx_journeys_one_per_hero_with_paused", unique: true, where: "allow_multiple = '0' AND state IN ('ready', 'performing', 'paused') /*application='Dummy'*/"
+    t.index ["journey_uniq_col_generated"], name: "idx_journeys_one_per_hero_mysql_generated", unique: true
+    t.index ["next_step_to_be_performed_at"], name: "index_stepper_motor_journeys_on_next_step_to_be_performed_at"
     t.index ["type", "hero_type", "hero_id"], name: "index_stepper_motor_journeys_on_type_and_hero_type_and_hero_id"
     t.index ["type"], name: "index_stepper_motor_journeys_on_type"
-    t.index ["updated_at"], name: "index_stepper_motor_journeys_on_updated_at", where: "state = 'canceled' OR state = 'finished' /*application='Dummy'*/"
-    t.index ["updated_at"], name: "stuck_journeys_index", where: "state = 'performing' /*application='Dummy'*/"
+    t.index ["updated_at"], name: "index_stepper_motor_journeys_on_updated_at"
+    t.index ["updated_at"], name: "stuck_journeys_index"
   end
 end

data/test/stepper_motor/journey/if_condition_test.rb

@@ -0,0 +1,286 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "minitest/mock"
+
+class IfConditionTest < ActiveSupport::TestCase
+  include ActiveJob::TestHelper
+  include SideEffects::TestHelper
+  include StepperMotor::TestHelper
+
+  test "supports if: with symbol condition that returns true" do
+    journey_class = create_journey_subclass do
+      step :one, if: :should_run do
+        SideEffects.touch!("step executed")
+      end
+
+      def should_run
+        true
+      end
+    end
+
+    journey = journey_class.create!
+    assert_produced_side_effects("step executed") do
+      journey.perform_next_step!
+    end
+    assert journey.finished?
+  end
+
+  test "supports if: with symbol condition that returns false" do
+    journey_class = create_journey_subclass do
+      step :one, if: :should_run do
+        SideEffects.touch!("step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+      end
+
+      def should_run
+        false
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "supports if: with block condition that returns true" do
+    journey_class = create_journey_subclass do
+      step :one, if: -> { hero.present? } do
+        SideEffects.touch!("step executed")
+      end
+    end
+
+    journey = journey_class.create!(hero: create_journey_subclass.create!)
+    assert_produced_side_effects("step executed") do
+      journey.perform_next_step!
+    end
+    assert journey.finished?
+  end
+
+  test "supports if: with block condition that returns false" do
+    journey_class = create_journey_subclass do
+      step :one, if: -> { hero.nil? } do
+        SideEffects.touch!("step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+      end
+    end
+
+    journey = journey_class.create!(hero: create_journey_subclass.create!)
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "supports if: with block condition that accesses journey instance variables" do
+    journey_class = create_journey_subclass do
+      step :one, if: -> { @condition_met } do
+        SideEffects.touch!("step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+      end
+
+      def initialize(*args)
+        super
+        @condition_met = false
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "supports if: with block condition that can be changed during journey execution" do
+    journey_class = create_journey_subclass do
+      step :one, if: -> { @condition_met } do
+        SideEffects.touch!("first step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+        @condition_met = true
+      end
+
+      step :three, if: -> { @condition_met } do
+        SideEffects.touch!("third step executed")
+      end
+
+      def initialize(*args)
+        super
+        @condition_met = false
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    assert SideEffects.produced?("third step executed")
+    refute SideEffects.produced?("first step executed")
+  end
+
+  test "skips step when if: condition is false and continues to next step" do
+    journey_class = create_journey_subclass do
+      step :one, if: :false_condition do
+        SideEffects.touch!("first step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+      end
+
+      step :three do
+        SideEffects.touch!("third step executed")
+      end
+
+      def false_condition
+        false
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    assert SideEffects.produced?("third step executed")
+    refute SideEffects.produced?("first step executed")
+  end
+
+  test "skips step when if: condition is false and finishes journey if no more steps" do
+    journey_class = create_journey_subclass do
+      step :one, if: :false_condition do
+        SideEffects.touch!("step executed")
+      end
+
+      def false_condition
+        false
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "supports if: with literal true" do
+    journey_class = create_journey_subclass do
+      step :one, if: true do
+        SideEffects.touch!("step executed")
+      end
+    end
+
+    journey = journey_class.create!
+    assert_produced_side_effects("step executed") do
+      journey.perform_next_step!
+    end
+    assert journey.finished?
+  end
+
+  test "supports if: with literal false" do
+    journey_class = create_journey_subclass do
+      step :one, if: false do
+        SideEffects.touch!("step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "supports if: with literal false and finishes journey if no more steps" do
+    journey_class = create_journey_subclass do
+      step :one, if: false do
+        SideEffects.touch!("step executed")
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "defaults to true when if: is not specified" do
+    journey_class = create_journey_subclass do
+      step :one do
+        SideEffects.touch!("step executed")
+      end
+    end
+
+    journey = journey_class.create!
+    assert_produced_side_effects("step executed") do
+      journey.perform_next_step!
+    end
+    assert journey.finished?
+  end
+
+  test "treats nil as false in if condition" do
+    journey_class = create_journey_subclass do
+      step :one, if: nil do
+        SideEffects.touch!("step executed")
+      end
+
+      step :two do
+        SideEffects.touch!("second step executed")
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    assert SideEffects.produced?("second step executed")
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "treats nil as false and finishes journey if no more steps" do
+    journey_class = create_journey_subclass do
+      step :one, if: nil do
+        SideEffects.touch!("step executed")
+      end
+    end
+
+    journey = journey_class.create!
+    speedrun_journey(journey)
+    refute SideEffects.produced?("step executed")
+  end
+
+  test "raises ArgumentError when if: condition is neither symbol nor callable" do
+    assert_raises(ArgumentError) do
+      create_journey_subclass do
+        step :one, if: "not a symbol or callable" do
+          # noop
+        end
+      end
+    end
+  end
+
+  test "passes if: parameter to step definition" do
+    step_def = StepperMotor::Step.new(name: "a_step", seq: 1, on_exception: :reattempt!)
+    assert_if_parameter = ->(**options) {
+      assert options.key?(:if)
+      assert_equal :test_condition, options[:if]
+      # Return the original definition
+      step_def
+    }
+
+    StepperMotor::Step.stub :new, assert_if_parameter do
+      create_journey_subclass do
+        step :test_step, if: :test_condition do
+          # noop
+        end
+      end
+    end
+  end
+end

data/test/stepper_motor/journey/step_definition_test.rb

@@ -6,6 +6,7 @@ require "minitest/mock"
 class StepDefinitionTest < ActiveSupport::TestCase
   include ActiveJob::TestHelper
   include SideEffects::TestHelper
+  include StepperMotor::TestHelper
 
   test "requires either a block or a name" do
     assert_raises(StepperMotor::StepConfigurationError) do

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: stepper_motor
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.15
 platform: ruby
 authors:
 - Julik Tarkhanov
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-08 00:00:00.000000000 Z
+date: 2025-06-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -94,6 +93,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +233,7 @@ files:
 - lib/generators/stepper_motor_migration_002.rb.erb
 - lib/generators/stepper_motor_migration_003.rb.erb
 - lib/generators/stepper_motor_migration_004.rb.erb
+- lib/generators/stepper_motor_migration_005.rb.erb
 - lib/stepper_motor.rb
 - lib/stepper_motor/base_job.rb
 - lib/stepper_motor/cyclic_scheduler.rb
@@ -246,6 +274,9 @@ files:
 - test/dummy/config/application.rb
 - test/dummy/config/boot.rb
 - test/dummy/config/cable.yml
+- test/dummy/config/database.mysql2.yml
+- test/dummy/config/database.postgres.yml
+- test/dummy/config/database.sqlite3.yml
 - test/dummy/config/database.yml
 - test/dummy/config/environment.rb
 - test/dummy/config/environments/development.rb
@@ -263,6 +294,7 @@ files:
 - test/dummy/db/migrate/20250525132524_stepper_motor_migration_002.rb
 - test/dummy/db/migrate/20250525132525_stepper_motor_migration_003.rb
 - test/dummy/db/migrate/20250528141038_stepper_motor_migration_004.rb
+- test/dummy/db/migrate/20250609221201_stepper_motor_migration_005.rb
 - test/dummy/db/schema.rb
 - test/dummy/public/400.html
 - test/dummy/public/404.html
@@ -280,6 +312,7 @@ files:
 - test/stepper_motor/journey/exception_handling_test.rb
 - test/stepper_motor/journey/flow_control_test.rb
 - test/stepper_motor/journey/idempotency_test.rb
+- test/stepper_motor/journey/if_condition_test.rb
 - test/stepper_motor/journey/step_definition_test.rb
 - test/stepper_motor/journey/uniqueness_test.rb
 - test/stepper_motor/journey_test.rb
@@ -297,7 +330,6 @@ metadata:
   homepage_uri: https://steppermotor.dev
   source_code_uri: https://github.com/stepper-motor/stepper_motor
   changelog_uri: https://github.com/stepper-motor/stepper_motor/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -312,8 +344,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.6
 specification_version: 4
 summary: Effortless step workflows that embed nicely inside Rails
 test_files: []