stepper_motor 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2496495ef6f6748068d2a726432ef1e23c8c17880b464da61530457396342701
-  data.tar.gz: 003f7998b41ccf526038de029a0e839ebc9a413ddc7cf1fed47c2f2ec07e96e5
+  metadata.gz: 7846dbc38d7f5d10b018f8e052e33f2347598e59bcf04dfcc4b49c3bcd247fd6
+  data.tar.gz: 947b3810bff07dd61b72c86319d83f1ef93341986541a8b8ff9bfd8fe0230461
 SHA512:
-  metadata.gz: d522012c349187573966dacf65f90ecc476ccc1f34e20d818d7c4619b6804881491b9058361f16cf2eeb020a15b837645c76e2a951f8c5620dd3c9d6ba79e42f
-  data.tar.gz: 97a05abbd99ef244d5de94f37f50d10338e4618dd4b103a7efeffa5de4957e3e0dce854ebd8122f51b6e8c15d7a8735c108950df5f24adf6456f6136f767128e
+  metadata.gz: eab053515d0672cdd23065e0c7c13276cd6c972d07df6340755052cc8412e447d5d37ad31a34fac9c0ddb587c73b050a0571bab7a521544963c2a2149f1c069d
+  data.tar.gz: d4041d89eb0cb2abf39721ff426ea99f33548576cd510fd8cbf5b5723f1f920075dbda0b692323afc89715eb266957d0d21907219c0a06aab7848237d1db1ddf

data/.standard.yml

@@ -1,8 +1,4 @@
 ruby_version: 3.1
 ignore:
-  - 'spec/**/*':
-    - Lint/ConstantDefinitionInBlock
-    - Style/GlobalVars
-  - 'lib/zip_kit/rack_body.rb': # Erroneous detection
-    - Lint/OrderedMagicComments
-    - Layout/EmptyLineAfterMagicComment
+  - 'spec/app/db/**/*':
+    - Layout/TrailingWhitespace # Templated migrations have whitespace

data/CHANGELOG.md

@@ -1,3 +1,3 @@
-## [0.1.1] - 2025-01-01
+## [0.1.x] - 2025-01-01
 
-- Initial release. Expect bugs of mysterious kinds.
+- Development versions. Expect bugs of mysterious kinds.

data/Rakefile

@@ -2,9 +2,12 @@
 
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
-
-RSpec::Core::RakeTask.new(:spec)
-
 require "standard/rake"
 
+task :format do
+  `bundle exec standardrb --fix`
+  `bundle exec magic_frozen_string_literal .`
+end
+
+RSpec::Core::RakeTask.new(:spec)
 task default: %i[spec standard]

data/lib/stepper_motor/cyclic_scheduler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The cyclic scheduler is designed to be run regularly via a cron job. On every
 # cycle, it is going to look for Journeys which are going to come up for step execution
 # before the next cycle is supposed to run. Then it is going to enqueue jobs to perform

data/lib/stepper_motor/forward_scheduler.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The forward scheduler enqueues a job for every Journey that
 # gets sent to the `#schedule`. The job is then stored in the queue
 # and gets picked up by the ActiveJob worker normally. This is the simplest
@@ -13,6 +15,8 @@
 # this scheduler is not a good fit for you, and you will need to use the {CyclicScheduler} instead.
 class StepperMotor::ForwardScheduler
   def schedule(journey)
-    StepperMotor::PerformStepJob.set(scheduled_at: journey.next_step_to_be_performed_at).perform_later(journey.to_global_id.to_s)
+    StepperMotor::PerformStepJobV2
+      .set(wait_until: journey.next_step_to_be_performed_at)
+      .perform_later(journey_id: journey.id, journey_class_name: journey.class.to_s)
   end
 end

data/lib/stepper_motor/perform_step_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "active_job"
 
 class StepperMotor::PerformStepJob < ActiveJob::Base

data/lib/stepper_motor/perform_step_job_v2.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "active_job"
+
+class StepperMotor::PerformStepJobV2 < ActiveJob::Base
+  def perform(journey_id:, journey_class_name:, **)
+    journey = StepperMotor::Journey.find(journey_id)
+    journey.perform_next_step!
+  rescue ActiveRecord::RecordNotFound
+    # The journey has been canceled and destroyed previously or elsewhere
+  end
+end

data/lib/stepper_motor/reap_hung_journeys_job.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The purpose of this job is to find journeys which have, for whatever reason, remained in the
 # `performing` state for far longer than the journey is supposed to. At the moment it assumes
 # any journey that stayed in `performing` for longer than 1 hour has hung. Add this job to your

data/lib/stepper_motor/step.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Describes a step in a journey. These objects get stored inside the `step_definitions`
 # array of the Journey subclass. When the step gets performed, the block passed to the
 # constructor will be instance_exec'd with the Journey model being the context

data/lib/stepper_motor/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module StepperMotor::TestHelper
   # Allows running a given Journey to completion, skipping across the waiting periods.
   # This is useful to evaluate all side effects of a Journey. The helper will ensure

data/lib/stepper_motor/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module StepperMotor
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/stepper_motor.rb

@@ -13,6 +13,7 @@ module StepperMotor
   autoload :Journey, File.dirname(__FILE__) + "/stepper_motor/journey.rb"
   autoload :Step, File.dirname(__FILE__) + "/stepper_motor/step.rb"
   autoload :PerformStepJob, File.dirname(__FILE__) + "/stepper_motor/perform_step_job.rb"
+  autoload :PerformStepJobV2, File.dirname(__FILE__) + "/stepper_motor/perform_step_job_v2.rb"
   autoload :InstallGenerator, File.dirname(__FILE__) + "/generators/install_generator.rb"
   autoload :ForwardScheduler, File.dirname(__FILE__) + "/stepper_motor/forward_scheduler.rb"
   autoload :CyclicScheduler, File.dirname(__FILE__) + "/stepper_motor/cyclic_scheduler.rb"

data/spec/helpers/side_effects.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SideEffects
   module SpecHelper
     def self.included(into)

data/spec/spec_helper.rb

@@ -40,7 +40,7 @@ end
 
 module ActiveSupportTestCaseMethodsStub
   def self.included(into)
-    into.before(:each) { before_setup } 
+    into.before(:each) { before_setup }
     into.after(:each) { after_teardown }
   end
 
@@ -85,5 +85,6 @@ RSpec.configure do |config|
     StepperMotorRailtieTestHelpers.establish_test_connection
     StepperMotorRailtieTestHelpers.run_generator
     StepperMotorRailtieTestHelpers.run_migrations
+    ActiveJob::Base.logger.level = Logger::FATAL
   end
 end

data/spec/stepper_motor/cyclic_scheduler_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../spec_helper"
 
 RSpec.describe "StepperMotor::CyclicScheduler" do
@@ -13,11 +15,9 @@ RSpec.describe "StepperMotor::CyclicScheduler" do
   end
 
   def far_future_journey_class
-    @klass ||= begin
-      create_journey_subclass do
-        step :do_thing, wait: 40.minutes do
-          raise "We do not test this so it should never run"
-        end
+    @klass ||= create_journey_subclass do
+      step :do_thing, wait: 40.minutes do
+        raise "We do not test this so it should never run"
       end
     end
   end

data/spec/stepper_motor/forward_scheduler_spec.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "../spec_helper"
+
+RSpec.describe "StepperMotor::ForwardScheduler" do
+  include ActiveJob::TestHelper
+
+  before do
+    @previous_scheduler = StepperMotor.scheduler
+    StepperMotor::Journey.delete_all
+  end
+
+  after do
+    StepperMotor.scheduler = @previous_scheduler
+  end
+
+  def far_future_journey_class
+    @klass ||= create_journey_subclass do
+      step :do_thing, wait: 40.minutes do
+        raise "We do not test this so it should never run"
+      end
+    end
+  end
+
+  it "schedules a journey 40 minutes ahead" do
+    scheduler = StepperMotor::ForwardScheduler.new
+    StepperMotor.scheduler = scheduler
+
+    expect(scheduler).to receive(:schedule).with(instance_of(far_future_journey_class)).once.and_call_original
+    _journey = far_future_journey_class.create!
+
+    expect(enqueued_jobs.size).to eq(1)
+    job = enqueued_jobs.first
+
+    expect(job["job_class"]).to eq("StepperMotor::PerformStepJobV2")
+    expect(job["scheduled_at"]).not_to be_nil
+
+    scheduled_at = Time.parse(job["scheduled_at"])
+    expect(scheduled_at).to be_within(5.seconds).of(40.minutes.from_now)
+  end
+end

data/spec/stepper_motor/generator_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../spec_helper"
 
 RSpec.describe "StepperMotor::InstallGenerator" do

data/spec/stepper_motor/journey_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../spec_helper"
 
 # rubocop:disable Lint/ConstantDefinitionInBlock
@@ -26,8 +28,6 @@ RSpec.describe "StepperMotor::Journey" do
   end
 
   it "allows a journey consisting of multiple named steps to be defined and performed to completion" do
-    step_names = [:step1, :step2, :step3]
-
     multi_step_journey_class = create_journey_subclass do
       [:step1, :step2, :step3].each do |step_name|
         step step_name do
@@ -103,7 +103,7 @@ RSpec.describe "StepperMotor::Journey" do
   end
 
   it "allows a journey where steps are delayed in time using wait:" do
-    timely_journey_class = carrier_journey_class = create_journey_subclass do
+    timely_journey_class = create_journey_subclass do
       step wait: 10.hours do
         SideEffects.touch! "after_10_hours.txt"
       end

data/spec/stepper_motor/test_helper_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative "../spec_helper"
 
 RSpec.describe "StepperMotor::TestHelper" do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stepper_motor
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Julik Tarkhanov
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-02-28 00:00:00.000000000 Z
+date: 2025-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -136,6 +136,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.28.5
+- !ruby/object:Gem::Dependency
+  name: magic_frozen_string_literal
+  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: yard
   requirement: !ruby/object:Gem::Requirement
@@ -188,6 +202,7 @@ files:
 - lib/stepper_motor/forward_scheduler.rb
 - lib/stepper_motor/journey.rb
 - lib/stepper_motor/perform_step_job.rb
+- lib/stepper_motor/perform_step_job_v2.rb
 - lib/stepper_motor/railtie.rb
 - lib/stepper_motor/reap_hung_journeys_job.rb
 - lib/stepper_motor/step.rb
@@ -197,6 +212,7 @@ files:
 - spec/helpers/side_effects.rb
 - spec/spec_helper.rb
 - spec/stepper_motor/cyclic_scheduler_spec.rb
+- spec/stepper_motor/forward_scheduler_spec.rb
 - spec/stepper_motor/generator_spec.rb
 - spec/stepper_motor/journey_spec.rb
 - spec/stepper_motor/test_helper_spec.rb