statesman 7.4.0 → 10.2.3

data/spec/statesman/machine_spec.rb

@@ -27,6 +27,112 @@ describe Statesman::Machine do
     end
   end
 
+  describe ".remove_state" do
+    subject(:remove_state) { machine.remove_state(:x) }
+
+    before do
+      machine.class_eval do
+        state :x
+        state :y
+        state :z
+      end
+    end
+
+    it "removes the state" do
+      expect { remove_state }.
+        to change(machine, :states).
+        from(match_array(%w[x y z])).
+        to(%w[y z])
+    end
+
+    context "with a transition from the removed state" do
+      before { machine.transition from: :x, to: :y }
+
+      it "removes the transition" do
+        expect { remove_state }.
+          to change(machine, :successors).
+          from({ "x" => ["y"] }).
+          to({})
+      end
+
+      context "with multiple transitions" do
+        before { machine.transition from: :x, to: :z }
+
+        it "removes all transitions" do
+          expect { remove_state }.
+            to change(machine, :successors).
+            from({ "x" => %w[y z] }).
+            to({})
+        end
+      end
+    end
+
+    context "with a transition to the removed state" do
+      before { machine.transition from: :y, to: :x }
+
+      it "removes the transition" do
+        expect { remove_state }.
+          to change(machine, :successors).
+          from({ "y" => ["x"] }).
+          to({})
+      end
+
+      context "with multiple transitions" do
+        before { machine.transition from: :z, to: :x }
+
+        it "removes all transitions" do
+          expect { remove_state }.
+            to change(machine, :successors).
+            from({ "y" => ["x"], "z" => ["x"] }).
+            to({})
+        end
+      end
+    end
+
+    context "with a callback from the removed state" do
+      before do
+        machine.class_eval do
+          transition from: :x, to: :y
+          transition from: :x, to: :z
+          guard_transition(from: :x) { return false }
+          guard_transition(from: :x, to: :z) { return true }
+        end
+      end
+
+      let(:guards) do
+        [having_attributes(from: "x", to: []), having_attributes(from: "x", to: ["z"])]
+      end
+
+      it "removes the guard" do
+        expect { remove_state }.
+          to change(machine, :callbacks).
+          from(a_hash_including(guards: match_array(guards))).
+          to(a_hash_including(guards: []))
+      end
+    end
+
+    context "with a callback to the removed state" do
+      before do
+        machine.class_eval do
+          transition from: :y, to: :x
+          guard_transition(to: :x) { return false }
+          guard_transition(from: :y, to: :x) { return true }
+        end
+      end
+
+      let(:guards) do
+        [having_attributes(from: nil, to: ["x"]), having_attributes(from: "y", to: ["x"])]
+      end
+
+      it "removes the guard" do
+        expect { remove_state }.
+          to change(machine, :callbacks).
+          from(a_hash_including(guards: match_array(guards))).
+          to(a_hash_including(guards: []))
+      end
+    end
+  end
+
   describe ".retry_conflicts" do
     subject(:transition_state) do
       described_class.retry_conflicts(retry_attempts) do
@@ -170,6 +276,42 @@ describe Statesman::Machine do
     end
   end
 
+  describe ".remove_transitions" do
+    before do
+      machine.class_eval do
+        state :x
+        state :y
+        state :z
+        transition from: :x, to: :y
+        transition from: :x, to: :z
+        transition from: :y, to: :z
+      end
+    end
+
+    let(:initial_successors) { { "x" => %w[y z], "y" => ["z"] } }
+
+    it "removes the correct transitions when given a from state" do
+      expect { machine.remove_transitions(from: :x) }.
+        to change(machine, :successors).
+        from(initial_successors).
+        to({ "y" => ["z"] })
+    end
+
+    it "removes the correct transitions when given a to state" do
+      expect { machine.remove_transitions(to: :z) }.
+        to change(machine, :successors).
+        from(initial_successors).
+        to({ "x" => ["y"] })
+    end
+
+    it "removes the correct transitions when given a from and to state" do
+      expect { machine.remove_transitions(from: :x, to: :z) }.
+        to change(machine, :successors).
+        from(initial_successors).
+        to({ "x" => ["y"], "y" => ["z"] })
+    end
+  end
+
   describe ".validate_callback_condition" do
     before do
       machine.class_eval do
@@ -234,11 +376,9 @@ describe Statesman::Machine do
 
       it "does not add a callback" do
         expect do
-          begin
-            set_callback
-          rescue error_type
-            nil
-          end
+          set_callback
+        rescue error_type
+          nil
         end.to_not change(machine.callbacks[callback_store], :count)
       end
     end
@@ -537,6 +677,34 @@ describe Statesman::Machine do
     end
   end
 
+  describe "#last_transition_to" do
+    subject { instance.last_transition_to(:y) }
+
+    before do
+      machine.class_eval do
+        state :x, initial: true
+        state :y
+        state :z
+        transition from: :x, to: :y
+        transition from: :y, to: :z
+        transition from: :z, to: :y
+      end
+
+      instance.transition_to!(:y)
+      instance.transition_to!(:z)
+    end
+
+    let(:instance) { machine.new(my_model) }
+
+    it { is_expected.to have_attributes(to_state: "y") }
+
+    context "when there are 2 transitions to the state" do
+      before { instance.transition_to!(:y) }
+
+      it { is_expected.to eq(instance.last_transition) }
+    end
+  end
+
   describe "#can_transition_to?" do
     subject(:can_transition_to?) { instance.can_transition_to?(new_state, metadata) }
 
@@ -767,10 +935,10 @@ describe Statesman::Machine do
       it { is_expected.to be(:some_state) }
     end
 
-    context "when it is unsuccesful" do
+    context "when it is unsuccessful" do
       before do
         allow(instance).to receive(:transition_to!).
-          and_raise(Statesman::GuardFailedError.new(:x, :some_state))
+          and_raise(Statesman::GuardFailedError.new(:x, :some_state, nil))
       end
 
       it { is_expected.to be_falsey }
@@ -808,20 +976,20 @@ describe Statesman::Machine do
     end
 
     context "with defined callbacks" do
-      let(:callback_1) { -> { "Hi" } }
-      let(:callback_2) { -> { "Bye" } }
+      let(:callback_one) { -> { "Hi" } }
+      let(:callback_two) { -> { "Bye" } }
 
       before do
-        machine.send(definer, from: :x, to: :y, &callback_1)
-        machine.send(definer, from: :y, to: :z, &callback_2)
+        machine.send(definer, from: :x, to: :y, &callback_one)
+        machine.send(definer, from: :y, to: :z, &callback_two)
       end
 
       it "contains the relevant callback" do
-        expect(callbacks.map(&:callback)).to include(callback_1)
+        expect(callbacks.map(&:callback)).to include(callback_one)
       end
 
       it "does not contain the irrelevant callback" do
-        expect(callbacks.map(&:callback)).to_not include(callback_2)
+        expect(callbacks.map(&:callback)).to_not include(callback_two)
       end
     end
   end

data/spec/support/active_record.rb

@@ -20,10 +20,22 @@ class MyStateMachine
   transition from: :failed,  to: :initial
 end
 
+class MyActiveRecordModelTransition < ActiveRecord::Base
+  include Statesman::Adapters::ActiveRecordTransition
+
+  belongs_to :my_active_record_model
+  serialize :metadata, JSON
+end
+
 class MyActiveRecordModel < ActiveRecord::Base
   has_many :my_active_record_model_transitions, autosave: false
   alias_method :transitions, :my_active_record_model_transitions
 
+  include Statesman::Adapters::ActiveRecordQueries[
+    transition_class: MyActiveRecordModelTransition,
+    initial_state: :initial
+  ]
+
   def state_machine
     @state_machine ||= MyStateMachine.new(
       self, transition_class: MyActiveRecordModelTransition
@@ -35,13 +47,6 @@ class MyActiveRecordModel < ActiveRecord::Base
   end
 end
 
-class MyActiveRecordModelTransition < ActiveRecord::Base
-  include Statesman::Adapters::ActiveRecordTransition
-
-  belongs_to :my_active_record_model
-  serialize :metadata, JSON
-end
-
 class MyActiveRecordModelTransitionWithoutInclude < ActiveRecord::Base
   self.table_name = "my_active_record_model_transitions"
 
@@ -59,7 +64,6 @@ class CreateMyActiveRecordModelMigration < MIGRATION_CLASS
 end
 
 # TODO: make this a module we can extend from the app? Or a generator?
-# rubocop:disable MethodLength, Metrics/AbcSize
 class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
   def change
     create_table :my_active_record_model_transitions do |t|
@@ -105,7 +109,6 @@ class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
     end
   end
 end
-# rubocop:enable MethodLength, Metrics/AbcSize
 
 class OtherActiveRecordModel < ActiveRecord::Base
   has_many :other_active_record_model_transitions, autosave: false
@@ -139,7 +142,6 @@ class CreateOtherActiveRecordModelMigration < MIGRATION_CLASS
   end
 end
 
-# rubocop:disable MethodLength
 class CreateOtherActiveRecordModelTransitionMigration < MIGRATION_CLASS
   def change
     create_table :other_active_record_model_transitions do |t|
@@ -172,18 +174,17 @@ class CreateOtherActiveRecordModelTransitionMigration < MIGRATION_CLASS
                 %i[other_active_record_model_id most_recent],
                 unique: true,
                 where: "most_recent",
-                name: "index_other_active_record_model_transitions_"\
+                name: "index_other_active_record_model_transitions_" \
                       "parent_latest"
     else
       add_index :other_active_record_model_transitions,
                 %i[other_active_record_model_id most_recent],
                 unique: true,
-                name: "index_other_active_record_model_transitions_"\
+                name: "index_other_active_record_model_transitions_" \
                       "parent_latest"
     end
   end
 end
-# rubocop:enable MethodLength
 
 class DropMostRecentColumn < MIGRATION_CLASS
   def change
@@ -237,7 +238,6 @@ class CreateNamespacedARModelMigration < MIGRATION_CLASS
   end
 end
 
-# rubocop:disable MethodLength
 class CreateNamespacedARModelTransitionMigration < MIGRATION_CLASS
   def change
     create_table :my_namespace_my_active_record_model_transitions do |t|
@@ -277,5 +277,95 @@ class CreateNamespacedARModelTransitionMigration < MIGRATION_CLASS
                 name: "index_namespace_model_transitions_parent_latest"
     end
   end
-  # rubocop:enable MethodLength
+end
+
+class StiActiveRecordModel < ActiveRecord::Base
+  has_many :sti_a_active_record_model_transitions, autosave: false
+  has_many :sti_b_active_record_model_transitions, autosave: false
+
+  def state_machine_a
+    @state_machine_a ||= MyStateMachine.new(
+      self, transition_class: StiAActiveRecordModelTransition
+    )
+  end
+
+  def state_machine_b
+    @state_machine_b ||= MyStateMachine.new(
+      self, transition_class: StiBActiveRecordModelTransition
+    )
+  end
+
+  def metadata
+    super || {}
+  end
+
+  def reload(*)
+    state_machine_a.reset
+    state_machine_b.reset
+    super
+  end
+end
+
+class StiActiveRecordModelTransition < ActiveRecord::Base
+  include Statesman::Adapters::ActiveRecordTransition
+
+  belongs_to :sti_active_record_model
+  serialize :metadata, JSON
+end
+
+class StiAActiveRecordModelTransition < StiActiveRecordModelTransition
+end
+
+class StiBActiveRecordModelTransition < StiActiveRecordModelTransition
+end
+
+class CreateStiActiveRecordModelMigration < MIGRATION_CLASS
+  def change
+    create_table :sti_active_record_models do |t|
+      t.timestamps null: false
+    end
+  end
+end
+
+class CreateStiActiveRecordModelTransitionMigration < MIGRATION_CLASS
+  def change
+    create_table :sti_active_record_model_transitions do |t|
+      t.string  :to_state
+      t.integer :sti_active_record_model_id
+      t.integer :sort_key
+      t.string  :type
+
+      # MySQL doesn't allow default values on text fields
+      if ActiveRecord::Base.connection.adapter_name == "Mysql2"
+        t.text :metadata
+      else
+        t.text :metadata, default: "{}"
+      end
+
+      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+        t.boolean :most_recent, default: true, null: false
+      else
+        t.boolean :most_recent, default: true
+      end
+
+      t.timestamps null: false
+    end
+
+    add_index :sti_active_record_model_transitions,
+              %i[type sti_active_record_model_id sort_key],
+              unique: true, name: "sti_sort_key_index"
+
+    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+      add_index :sti_active_record_model_transitions,
+                %i[type sti_active_record_model_id most_recent],
+                unique: true,
+                where: "most_recent",
+                name: "index_sti_active_record_model_transitions_parent_latest"
+    else
+      add_index :sti_active_record_model_transitions,
+                %i[type sti_active_record_model_id most_recent],
+                unique: true,
+                name: "index_sti_active_record_model_transitions_parent_latest"
+    end
+  end
 end

data/statesman.gemspec

@@ -18,24 +18,22 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.2"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_development_dependency "ammeter", "~> 1.1"
-  spec.add_development_dependency "bundler", "~> 2.1.4"
-  spec.add_development_dependency "gc_ruboconfig", "~> 2.3.9"
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "gc_ruboconfig", "~> 3.6.0"
   spec.add_development_dependency "mysql2", ">= 0.4", "< 0.6"
-  spec.add_development_dependency "pg", ">= 0.18", "<= 1.3"
-  spec.add_development_dependency "pry"
+  spec.add_development_dependency "pg", ">= 0.18", "<= 1.5"
   spec.add_development_dependency "rails", ">= 5.2"
   spec.add_development_dependency "rake", "~> 13.0.0"
   spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "rspec-github", "~> 2.4.0"
   spec.add_development_dependency "rspec-its", "~> 1.1"
-  spec.add_development_dependency "rspec-rails", "~> 3.1"
-  spec.add_development_dependency "rspec_junit_formatter", "~> 0.4.0"
-  spec.add_development_dependency "sqlite3", "~> 1.4.2"
+  spec.add_development_dependency "rspec-rails", "~> 6.0"
+  spec.add_development_dependency "sqlite3", "~> 1.6.1"
   spec.add_development_dependency "timecop", "~> 0.9.1"
 
   spec.metadata = {
@@ -44,5 +42,6 @@ Gem::Specification.new do |spec|
     "documentation_uri" => "#{GITHUB_URL}/blob/master/README.md",
     "homepage_uri" => GITHUB_URL,
     "source_code_uri" => GITHUB_URL,
+    "rubygems_mfa_required" => "true",
   }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 10.2.3
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2023-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.4
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: 3.6.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: 3.6.0
 - !ruby/object:Gem::Dependency
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ dependencies:
         version: '0.18'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -91,21 +91,7 @@ dependencies:
         version: '0.18'
     - - "<="
       - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: pry
-  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'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -149,61 +135,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.1'
 - !ruby/object:Gem::Dependency
-  name: rspec-its
+  name: rspec-github
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
-  name: rspec-rails
+  name: rspec-its
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -225,10 +211,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -249,6 +237,7 @@ files:
 - lib/statesman/adapters/active_record_transition.rb
 - lib/statesman/adapters/memory.rb
 - lib/statesman/adapters/memory_transition.rb
+- lib/statesman/adapters/type_safe_active_record_queries.rb
 - lib/statesman/callback.rb
 - lib/statesman/config.rb
 - lib/statesman/exceptions.rb
@@ -270,6 +259,7 @@ files:
 - spec/statesman/adapters/memory_spec.rb
 - spec/statesman/adapters/memory_transition_spec.rb
 - spec/statesman/adapters/shared_examples.rb
+- spec/statesman/adapters/type_safe_active_record_queries_spec.rb
 - spec/statesman/callback_spec.rb
 - spec/statesman/config_spec.rb
 - spec/statesman/exceptions_spec.rb
@@ -288,6 +278,7 @@ metadata:
   documentation_uri: https://github.com/gocardless/statesman/blob/master/README.md
   homepage_uri: https://github.com/gocardless/statesman
   source_code_uri: https://github.com/gocardless/statesman
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -296,35 +287,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: A statesman-like state machine library
-test_files:
-- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_with_partial_index.rb
-- spec/fixtures/add_constraints_to_most_recent_for_bacon_transitions_without_partial_index.rb
-- spec/fixtures/add_most_recent_to_bacon_transitions.rb
-- spec/generators/statesman/active_record_transition_generator_spec.rb
-- spec/generators/statesman/migration_generator_spec.rb
-- spec/spec_helper.rb
-- spec/statesman/adapters/active_record_queries_spec.rb
-- spec/statesman/adapters/active_record_spec.rb
-- spec/statesman/adapters/active_record_transition_spec.rb
-- spec/statesman/adapters/memory_spec.rb
-- spec/statesman/adapters/memory_transition_spec.rb
-- spec/statesman/adapters/shared_examples.rb
-- spec/statesman/callback_spec.rb
-- spec/statesman/config_spec.rb
-- spec/statesman/exceptions_spec.rb
-- spec/statesman/guard_spec.rb
-- spec/statesman/machine_spec.rb
-- spec/statesman/utils_spec.rb
-- spec/support/active_record.rb
-- spec/support/generators_shared_examples.rb
+test_files: []