statesman 11.0.0 → 12.1.0

data/lib/statesman/callback.rb

@@ -40,11 +40,11 @@ module Statesman
     end
 
     def matches_from_state(from, to)
-      (from == self.from && (to.nil? || self.to.empty?))
+      from == self.from && (to.nil? || self.to.empty?)
     end
 
     def matches_to_state(from, to)
-      ((from.nil? || self.from.nil?) && self.to.include?(to))
+      (from.nil? || self.from.nil?) && self.to.include?(to)
     end
 
     def matches_both_states(from, to)

data/lib/statesman/config.rb

@@ -15,17 +15,10 @@ module Statesman
       @adapter_class = adapter_class
     end
 
-    def mysql_gaplock_protection?
-      return @mysql_gaplock_protection unless @mysql_gaplock_protection.nil?
-
+    def mysql_gaplock_protection?(connection)
       # If our adapter class suggests we're using mysql, enable gaplock protection by
       # default.
-      enable_mysql_gaplock_protection if mysql_adapter?(adapter_class)
-      @mysql_gaplock_protection
-    end
-
-    def enable_mysql_gaplock_protection
-      @mysql_gaplock_protection = true
+      mysql_adapter?(connection)
     end
 
     private
@@ -34,7 +27,7 @@ module Statesman
       adapter_name = adapter_name(adapter_class)
       return false unless adapter_name
 
-      adapter_name.start_with?("mysql")
+      adapter_name.downcase.start_with?("mysql", "trilogy")
     end
 
     def adapter_name(adapter_class)

data/lib/statesman/machine.rb

@@ -233,12 +233,20 @@ module Statesman
     def initialize(object,
                    options = {
                      transition_class: Statesman::Adapters::MemoryTransition,
+                     initial_transition: false,
                    })
       @object = object
       @transition_class = options[:transition_class]
       @storage_adapter = adapter_class(@transition_class).new(
         @transition_class, object, self, options
       )
+
+      if options[:initial_transition]
+        if history.empty? && self.class.initial_state
+          @storage_adapter.create(nil, self.class.initial_state)
+        end
+      end
+
       send(:after_initialize) if respond_to? :after_initialize
     end
 

data/lib/statesman/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Statesman
-  VERSION = "11.0.0"
+  VERSION = "12.1.0"
 end

data/lib/statesman.rb

@@ -6,7 +6,7 @@ module Statesman
   autoload :Callback,   "statesman/callback"
   autoload :Guard,      "statesman/guard"
   autoload :Utils,      "statesman/utils"
-  autoload :Version,    "statesman/version"
+  autoload :VERSION,    "statesman/version"
   module Adapters
     autoload :Memory,       "statesman/adapters/memory"
     autoload :ActiveRecord, "statesman/adapters/active_record"
@@ -34,10 +34,8 @@ module Statesman
     @storage_adapter || Adapters::Memory
   end
 
-  def self.mysql_gaplock_protection?
-    return @mysql_gaplock_protection unless @mysql_gaplock_protection.nil?
-
-    @mysql_gaplock_protection = config.mysql_gaplock_protection?
+  def self.mysql_gaplock_protection?(connection)
+    config.mysql_gaplock_protection?(connection)
   end
 
   def self.config

data/lib/tasks/statesman.rake

@@ -21,8 +21,8 @@ namespace :statesman do
     batch_size = 500
 
     parent_class.find_in_batches(batch_size: batch_size) do |models|
-      ActiveRecord::Base.transaction(requires_new: true) do
-        if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+      transition_class.transaction(requires_new: true) do
+        if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?(transition_class)
           # Set all transitions' most_recent to FALSE
           transition_class.where(parent_fk => models.map(&:id)).
             update_all(most_recent: false, updated_at: updated_at)

data/spec/generators/statesman/active_record_transition_generator_spec.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
-require "spec_helper"
 require "support/generators_shared_examples"
 require "generators/statesman/active_record_transition_generator"
 
 describe Statesman::ActiveRecordTransitionGenerator, type: :generator do
+  before do
+    stub_const("Bacon", Class.new(ActiveRecord::Base))
+    stub_const("BaconTransition", Class.new(ActiveRecord::Base))
+    stub_const("Yummy::Bacon", Class.new(ActiveRecord::Base))
+    stub_const("Yummy::BaconTransition", Class.new(ActiveRecord::Base))
+  end
+
   it_behaves_like "a generator" do
     let(:migration_name) { "db/migrate/create_bacon_transitions.rb" }
   end

data/spec/generators/statesman/migration_generator_spec.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
-require "spec_helper"
 require "support/generators_shared_examples"
 require "generators/statesman/migration_generator"
 
 describe Statesman::MigrationGenerator, type: :generator do
+  before do
+    stub_const("Yummy::Bacon", Class.new(ActiveRecord::Base))
+    stub_const("Yummy::BaconTransition", Class.new(ActiveRecord::Base))
+  end
+
   it_behaves_like "a generator" do
     let(:migration_name) { "db/migrate/add_statesman_to_bacon_transitions.rb" }
   end

data/spec/spec_helper.rb

@@ -5,13 +5,14 @@ require "sqlite3"
 require "mysql2"
 require "pg"
 require "active_record"
+require "active_record/database_configurations"
 # We have to include all of Rails to make rspec-rails work
 require "rails"
 require "action_view"
 require "action_dispatch"
 require "action_controller"
 require "rspec/rails"
-require "support/active_record"
+require "support/exactly_query_databases"
 require "rspec/its"
 require "pry"
 
@@ -28,10 +29,31 @@ RSpec.configure do |config|
   if config.exclusion_filter[:active_record]
     puts "Skipping ActiveRecord tests"
   else
-    # Connect to the database for activerecord tests
-    db_conn_spec = ENV["DATABASE_URL"]
-    db_conn_spec ||= { adapter: "sqlite3", database: ":memory:" }
-    ActiveRecord::Base.establish_connection(db_conn_spec)
+    current_env = ActiveRecord::ConnectionHandling::DEFAULT_ENV.call
+
+    # We have to parse this to a hash since ActiveRecord::Base.configurations
+    # will only consider a single URL config.
+    url_config = if ENV["DATABASE_URL"]
+                   ActiveRecord::DatabaseConfigurations::ConnectionUrlResolver.
+                     new(ENV["DATABASE_URL"]).to_hash.merge({ sslmode: "disable" })
+                 end
+
+    db_config = {
+      current_env => {
+        primary: url_config || {
+          adapter: "sqlite3",
+          database: "/tmp/statesman.db",
+        },
+        secondary: url_config || {
+          adapter: "sqlite3",
+          database: "/tmp/statesman.db",
+        },
+      },
+    }
+
+    # Connect to the primary database for activerecord tests.
+    ActiveRecord::Base.configurations = db_config
+    ActiveRecord::Base.establish_connection(:primary)
 
     db_adapter = ActiveRecord::Base.connection.adapter_name
     puts "Running with database adapter '#{db_adapter}'"
@@ -40,6 +62,8 @@ RSpec.configure do |config|
     ActiveRecord::Migration.verbose = false
   end
 
+  # Since our primary and secondary connections point to the same database, we don't
+  # need to worry about applying these actions to both.
   config.before(:each, :active_record) do
     tables = %w[
       my_active_record_models
@@ -53,6 +77,7 @@ RSpec.configure do |config|
     ]
     tables.each do |table_name|
       sql = "DROP TABLE IF EXISTS #{table_name};"
+
       ActiveRecord::Base.connection.execute(sql)
     end
 
@@ -84,3 +109,6 @@ RSpec.configure do |config|
     end
   end
 end
+
+# We have to require this after the databases are configured.
+require "support/active_record"

data/spec/statesman/adapters/active_record_queries_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Adapters::ActiveRecordQueries, :active_record do
   def configure_old(klass, transition_class)
     klass.define_singleton_method(:transition_class) { transition_class }

data/spec/statesman/adapters/active_record_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
 require "timecop"
 require "statesman/adapters/shared_examples"
 require "statesman/exceptions"
@@ -10,8 +9,6 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
     prepare_model_table
     prepare_transitions_table
 
-    # MyActiveRecordModelTransition.serialize(:metadata, JSON)
-
     prepare_sti_model_table
     prepare_sti_transitions_table
 
@@ -26,8 +23,10 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
 
   after { Statesman.configure { storage_adapter(Statesman::Adapters::Memory) } }
 
+  let(:model_class) { MyActiveRecordModel }
+  let(:transition_class) { MyActiveRecordModelTransition }
   let(:observer) { double(Statesman::Machine, execute: nil) }
-  let(:model) { MyActiveRecordModel.create(current_state: :pending) }
+  let(:model) { model_class.create(current_state: :pending) }
 
   it_behaves_like "an adapter", described_class, MyActiveRecordModelTransition
 
@@ -36,8 +35,8 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
       before do
         metadata_column = double
         allow(metadata_column).to receive_messages(sql_type: "")
-        allow(MyActiveRecordModelTransition).to receive_messages(columns_hash:
-                                           { "metadata" => metadata_column })
+        allow(MyActiveRecordModelTransition).
+          to receive_messages(columns_hash: { "metadata" => metadata_column })
         expect(MyActiveRecordModelTransition).
           to receive(:type_for_attribute).with("metadata").
           and_return(ActiveRecord::Type::Value.new)
@@ -105,13 +104,15 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
   describe "#create" do
     subject(:transition) { create }
 
-    let!(:adapter) do
-      described_class.new(MyActiveRecordModelTransition, model, observer)
-    end
+    let!(:adapter) { described_class.new(transition_class, model, observer) }
     let(:from) { :x }
     let(:to) { :y }
     let(:create) { adapter.create(from, to) }
 
+    it "only connects to the primary database" do
+      expect { create }.to exactly_query_databases({ primary: [:writing] })
+    end
+
     context "when there is a race" do
       it "raises a TransitionConflictError" do
         adapter2 = adapter.dup
@@ -119,7 +120,8 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
         adapter.last
         adapter2.create(:y, :z)
         expect { adapter.create(:y, :z) }.
-          to raise_exception(Statesman::TransitionConflictError)
+          to raise_exception(Statesman::TransitionConflictError).
+          and exactly_query_databases({ primary: [:writing] })
       end
 
       it "does not pollute the state when the transition fails" do
@@ -343,12 +345,34 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
         end
       end
     end
+
+    context "when using the secondary database" do
+      let(:model_class) { SecondaryActiveRecordModel }
+      let(:transition_class) { SecondaryActiveRecordModelTransition }
+
+      it "doesn't connect to the primary database" do
+        expect { create }.to exactly_query_databases({ secondary: [:writing] })
+        expect(adapter.last.to_state).to eq("y")
+      end
+
+      context "when there is a race" do
+        it "raises a TransitionConflictError and uses the correct database" do
+          adapter2 = adapter.dup
+          adapter2.create(:x, :y)
+          adapter.last
+          adapter2.create(:y, :z)
+
+          expect { adapter.create(:y, :z) }.
+            to raise_exception(Statesman::TransitionConflictError).
+            and exactly_query_databases({ secondary: [:writing] })
+        end
+      end
+    end
   end
 
   describe "#last" do
-    let(:adapter) do
-      described_class.new(MyActiveRecordModelTransition, model, observer)
-    end
+    let(:transition_class) { MyActiveRecordModelTransition }
+    let(:adapter) { described_class.new(transition_class, model, observer) }
 
     context "with a previously looked up transition" do
       before { adapter.create(:x, :y) }
@@ -365,8 +389,19 @@ describe Statesman::Adapters::ActiveRecord, :active_record do
         before { adapter.create(:y, :z, []) }
 
         it "retrieves the new transition from the database" do
+          expect { adapter.last.to_state }.to exactly_query_databases({ primary: [:writing] })
           expect(adapter.last.to_state).to eq("z")
         end
+
+        context "when using the secondary database" do
+          let(:model_class) { SecondaryActiveRecordModel }
+          let(:transition_class) { SecondaryActiveRecordModelTransition }
+
+          it "retrieves the new transition from the database" do
+            expect { adapter.last.to_state }.to exactly_query_databases({ secondary: [:writing] })
+            expect(adapter.last.to_state).to eq("z")
+          end
+        end
       end
 
       context "when a new transition has been created elsewhere" do

data/spec/statesman/adapters/active_record_transition_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
 require "json"
 
 describe Statesman::Adapters::ActiveRecordTransition do

data/spec/statesman/adapters/memory_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
 require "statesman/adapters/shared_examples"
 require "statesman/adapters/memory_transition"
 

data/spec/statesman/adapters/memory_transition_spec.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
 require "statesman/adapters/memory_transition"
 
 describe Statesman::Adapters::MemoryTransition do

data/spec/statesman/adapters/shared_examples.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 # All adpators must define seven methods:
 #   initialize:       Accepts a transition class, parent model and state_attr.
 #   transition_class: Returns the transition class object passed to initialize.

data/spec/statesman/adapters/type_safe_active_record_queries_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Adapters::TypeSafeActiveRecordQueries, :active_record do
   def configure(klass, transition_class)
     klass.send(:extend, described_class)

data/spec/statesman/callback_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Callback do
   let(:cb_lambda) { -> {} }
   let(:callback) do

data/spec/statesman/config_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Config do
   let(:instance) { described_class.new }
 

data/spec/statesman/exceptions_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe "Exceptions" do
   describe "InvalidStateError" do
     subject(:error) { Statesman::InvalidStateError.new }

data/spec/statesman/guard_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Guard do
   let(:callback) { -> {} }
   let(:guard) { described_class.new(from: nil, to: nil, callback: callback) }

data/spec/statesman/machine_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Machine do
   let(:machine) { Class.new { include Statesman::Machine } }
   let(:my_model) { Class.new { attr_accessor :current_state }.new }
@@ -480,12 +478,83 @@ describe Statesman::Machine do
     it_behaves_like "a callback store", :after_guard_failure, :after_guard_failure
   end
 
+  shared_examples "initial transition is not created" do
+    it "doesn't call .create on storage adapter" do
+      expect_any_instance_of(Statesman.storage_adapter).to_not receive(:create)
+      machine.new(my_model, options)
+    end
+  end
+
+  shared_examples "initial transition is created" do
+    it "calls .create on storage adapter" do
+      expect_any_instance_of(Statesman.storage_adapter).to receive(:create).with(nil, "x")
+      machine.new(my_model, options)
+    end
+
+    it "creates a new transition object" do
+      instance = machine.new(my_model, options)
+
+      expect(instance.history.count).to eq(1)
+      expect(instance.history.first.to_state).to eq("x")
+    end
+  end
+
   describe "#initialize" do
     it "accepts an object to manipulate" do
       machine_instance = machine.new(my_model)
       expect(machine_instance.object).to be(my_model)
     end
 
+    context "initial_transition is not provided" do
+      let(:options) { {} }
+
+      it_behaves_like "initial transition is not created"
+    end
+
+    context "initial_transition is provided" do
+      context "initial_transition is true" do
+        let(:options) do
+          { initial_transition: true,
+            transition_class: Statesman::Adapters::MemoryTransition }
+        end
+
+        context "history is empty" do
+          context "initial state is defined" do
+            before { machine.state(:x, initial: true) }
+
+            it_behaves_like "initial transition is created"
+          end
+
+          context "initial state is not defined" do
+            it_behaves_like "initial transition is not created"
+          end
+        end
+
+        context "history is not empty" do
+          before do
+            allow_any_instance_of(Statesman.storage_adapter).to receive(:history).
+              and_return([{}])
+          end
+
+          context "initial state is defined" do
+            before { machine.state(:x, initial: true) }
+
+            it_behaves_like "initial transition is not created"
+          end
+
+          context "initial state is not defined" do
+            it_behaves_like "initial transition is not created"
+          end
+        end
+      end
+
+      context "initial_transition is false" do
+        let(:options) { { initial_transition: false } }
+
+        it_behaves_like "initial transition is not created"
+      end
+    end
+
     context "transition class" do
       it "sets a default" do
         expect(Statesman.storage_adapter).to receive(:new).once.

data/spec/statesman/utils_spec.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "spec_helper"
-
 describe Statesman::Utils do
   describe ".rails_major_version" do
     subject { described_class.rails_major_version }

data/spec/support/active_record.rb

@@ -81,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
@@ -98,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,
@@ -134,6 +134,48 @@ class OtherActiveRecordModelTransition < ActiveRecord::Base
   belongs_to :other_active_record_model
 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
   def change
     create_table :other_active_record_models do |t|
@@ -158,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
@@ -171,7 +213,7 @@ 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,
@@ -253,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
@@ -265,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,
@@ -342,7 +384,7 @@ class CreateStiActiveRecordModelTransitionMigration < 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
@@ -355,7 +397,7 @@ class CreateStiActiveRecordModelTransitionMigration < MIGRATION_CLASS
               %i[type sti_active_record_model_id sort_key],
               unique: true, name: "sti_sort_key_index"
 
-    if Statesman::Adapters::ActiveRecord.database_supports_partial_indexes?
+    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,