statesman 7.4.0 → 12.1.0

data/spec/support/active_record.rb

@@ -20,10 +20,21 @@ class MyStateMachine
   transition from: :failed,  to: :initial
 end
 
+class MyActiveRecordModelTransition < ActiveRecord::Base
+  include Statesman::Adapters::ActiveRecordTransition
+
+  belongs_to :my_active_record_model
+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,18 +46,15 @@ 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"
 
   belongs_to :my_active_record_model
-  serialize :metadata, JSON
+  if ::ActiveRecord.gem_version >= Gem::Version.new("7.1")
+    serialize :metadata, coder: JSON
+  else
+    serialize :metadata, JSON
+  end
 end
 
 class CreateMyActiveRecordModelMigration < MIGRATION_CLASS
@@ -59,7 +67,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|
@@ -74,7 +81,7 @@ class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
         t.text :metadata, default: "{}"
       end
 
-      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(ActiveRecord::Base)
         t.boolean :most_recent, default: true, null: false
       else
         t.boolean :most_recent, default: true
@@ -91,7 +98,7 @@ class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
               %i[my_active_record_model_id sort_key],
               unique: true, name: "sort_key_index"
 
-    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(ActiveRecord::Base)
       add_index :my_active_record_model_transitions,
                 %i[my_active_record_model_id most_recent],
                 unique: true,
@@ -105,7 +112,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
@@ -126,7 +132,48 @@ class OtherActiveRecordModelTransition < ActiveRecord::Base
   include Statesman::Adapters::ActiveRecordTransition
 
   belongs_to :other_active_record_model
-  serialize :metadata, JSON
+end
+
+class SecondaryRecord < ActiveRecord::Base
+  self.abstract_class = true
+
+  connects_to database: { writing: :secondary, reading: :secondary }
+end
+
+class SecondaryActiveRecordModelTransition < SecondaryRecord
+  self.table_name = "my_active_record_model_transitions"
+
+  include Statesman::Adapters::ActiveRecordTransition
+
+  belongs_to :my_active_record_model,
+             class_name: "SecondaryActiveRecordModel",
+             foreign_key: "my_active_record_model_transition_id"
+end
+
+class SecondaryActiveRecordModel < SecondaryRecord
+  self.table_name = "my_active_record_models"
+
+  has_many :my_active_record_model_transitions,
+           class_name: "SecondaryActiveRecordModelTransition",
+           foreign_key: "my_active_record_model_id",
+           autosave: false
+
+  alias_method :transitions, :my_active_record_model_transitions
+
+  include Statesman::Adapters::ActiveRecordQueries[
+            transition_class: SecondaryActiveRecordModelTransition,
+            initial_state: :initial
+          ]
+
+  def state_machine
+    @state_machine ||= MyStateMachine.new(
+      self, transition_class: SecondaryActiveRecordModelTransition
+    )
+  end
+
+  def metadata
+    super || {}
+  end
 end
 
 class CreateOtherActiveRecordModelMigration < MIGRATION_CLASS
@@ -139,7 +186,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|
@@ -154,7 +200,7 @@ class CreateOtherActiveRecordModelTransitionMigration < MIGRATION_CLASS
         t.text :metadata, default: "{}"
       end
 
-      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(ActiveRecord::Base)
         t.boolean :most_recent, default: true, null: false
       else
         t.boolean :most_recent, default: true
@@ -167,23 +213,22 @@ class CreateOtherActiveRecordModelTransitionMigration < MIGRATION_CLASS
               %i[other_active_record_model_id sort_key],
               unique: true, name: "other_sort_key_index"
 
-    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(ActiveRecord::Base)
       add_index :other_active_record_model_transitions,
                 %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
@@ -220,7 +265,6 @@ module MyNamespace
 
     belongs_to :my_active_record_model,
                class_name: "MyNamespace::MyActiveRecordModel"
-    serialize :metadata, JSON
 
     def self.table_name_prefix
       "my_namespace_"
@@ -237,7 +281,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|
@@ -252,7 +295,7 @@ class CreateNamespacedARModelTransitionMigration < MIGRATION_CLASS
         t.text :metadata, default: "{}"
       end
 
-      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+      if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(ActiveRecord::Base)
         t.boolean :most_recent, default: true, null: false
       else
         t.boolean :most_recent, default: true
@@ -264,7 +307,7 @@ class CreateNamespacedARModelTransitionMigration < MIGRATION_CLASS
     add_index :my_namespace_my_active_record_model_transitions, :sort_key,
               unique: true, name: "my_namespaced_key"
 
-    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(ActiveRecord::Base)
       add_index :my_namespace_my_active_record_model_transitions,
                 %i[my_active_record_model_id most_recent],
                 unique: true,
@@ -277,5 +320,94 @@ 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
+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?(ActiveRecord::Base)
+        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?(ActiveRecord::Base)
+      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/spec/support/exactly_query_databases.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+# `expected_dbs` should be a Hash of the form:
+# {
+#   primary: [:writing, :reading],
+#   replica: [:reading],
+# }
+RSpec::Matchers.define :exactly_query_databases do |expected_dbs|
+  match do |block|
+    @expected_dbs = expected_dbs.transform_values(&:to_set).with_indifferent_access
+    @actual_dbs = Hash.new { |h, k| h[k] = Set.new }.with_indifferent_access
+
+    ActiveSupport::Notifications.
+      subscribe("sql.active_record") do |_name, _start, _finish, _id, payload|
+      pool = payload.fetch(:connection).pool
+
+      next if pool.is_a?(ActiveRecord::ConnectionAdapters::NullPool)
+
+      name = pool.db_config.name
+      role = pool.role
+
+      @actual_dbs[name] << role
+    end
+
+    block.call
+
+    @actual_dbs == @expected_dbs
+  end
+
+  failure_message do |_block|
+    "expected to query exactly #{@expected_dbs}, but queried #{@actual_dbs}"
+  end
+
+  supports_block_expectations
+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 = ">= 3.0"
 
   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", "~> 4.4.1"
   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.6"
   spec.add_development_dependency "rails", ">= 5.2"
-  spec.add_development_dependency "rake", "~> 13.0.0"
+  spec.add_development_dependency "rake", "~> 13.1.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.7.0"
   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: 12.1.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-26 00:00:00.000000000 Z
+date: 2024-01-09 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: 4.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.3.9
+        version: 4.4.1
 - !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.6'
   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.6'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -126,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 13.0.0
+        version: 13.1.0
 - !ruby/object:Gem::Dependency
   name: rspec
   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.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: 1.7.0
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -225,10 +211,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/tests.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -249,6 +238,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 +260,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
@@ -277,6 +268,7 @@ files:
 - spec/statesman/machine_spec.rb
 - spec/statesman/utils_spec.rb
 - spec/support/active_record.rb
+- spec/support/exactly_query_databases.rb
 - spec/support/generators_shared_examples.rb
 - statesman.gemspec
 homepage: https://github.com/gocardless/statesman
@@ -288,6 +280,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 +289,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.2'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.1
+rubygems_version: 3.4.10
 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: []