statesman 10.0.0 → 10.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 172b3bbeecd2cbd2df8fc9a5485c548c0d729cf0994fda1771d25c8e44f41877
-  data.tar.gz: 3556cc13e2433e920ce9bd275bce155a095f6a0e64547a5ff003e0f5fa4dfc74
+  metadata.gz: 0cc749949e382ced6f27722a0eb033efc0383ba11a06265a84e1da3b593eb02d
+  data.tar.gz: f2dd851b5c9ccb0aacbde8076c10fcf23bfe8a00926e58acfb9dd714c5d61b99
 SHA512:
-  metadata.gz: 21f91dd2537c3e5e480dc0f5adb592ebbeaef9974cfbede1d94aa8b6946c26e9394199029e0281372a2ec4452e1173cb5cba86f0bf1507de19677c398df20350
-  data.tar.gz: 58ee880508df011be1caea1f85a475760cf79e07c1ad60f241f4ef4146983997560f17fe1d3a93f5856c6e519831d71eae6c4bd8f7e70f6d0d4ce49253f1ac3f
+  metadata.gz: 4ac72394722dc0d193874967e79bb30df1a1c7ba63e4eccd20294f2298b2e78637b3c7ffff7fe4ef4f4ad5d3ca522efe89444400fa09231684622848754a7683
+  data.tar.gz: e995d62de4ec4471ec1a66fea6e290bfbc5f0a3420c3bd915117a0e92f08ca20994b59e84ed5f73a93d091156ea47ef35548ea61f50ad52a1942a69438d4f446

data/.github/workflows/tests.yml

@@ -0,0 +1,106 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - "master"
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - run: bundle exec rubocop --extra-details --display-style-guide --parallel --force-exclusion
+
+  postgres:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
+        rails-version:
+          - "6.1.5"
+          - "7.0.4"
+          - "main"
+        postgres-version: ["9.6", "11", "14"]
+        exclude:
+          - ruby-version: "3.2"
+            rails-version: "6.1.5"
+    runs-on: ubuntu-latest
+    services:
+      postgres:
+        image: postgres:${{ matrix.postgres-version }}
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_DB: statesman_test
+          POSTGRES_PASSWORD: statesman
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 10
+    env:
+      DATABASE_URL: postgres://postgres:statesman@localhost/statesman_test
+      DATABASE_DEPENDENCY_PORT: "5432"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: "${{ matrix.ruby-version }}"
+      - name: Run specs
+        run: |
+          bundle exec rspec --profile --format progress --format RSpec::Github::Formatter
+
+  mysql:
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
+        rails-version:
+          - "6.1.5"
+          - "7.0.4"
+          - "main"
+        mysql-version: ["5.7", "8.0"]
+        exclude:
+          - ruby-version: 3.2
+            rails-version: "6.1.5"
+    runs-on: ubuntu-latest
+    services:
+      mysql:
+        image: mysql:${{ matrix.mysql-version }}
+        env:
+          MYSQL_ROOT_PASSWORD: password
+          MYSQL_USER: foobar
+          MYSQL_PASSWORD: password
+          MYSQL_DATABASE: statesman_test
+        ports:
+          - "3306:3306"
+        options: >-
+          --health-cmd "mysqladmin ping"
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+    env:
+      DATABASE_URL: mysql2://foobar:password@127.0.0.1/statesman_test
+      DATABASE_DEPENDENCY_PORT: "3306"
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: "${{ matrix.ruby-version }}"
+      - name: Run specs
+        run: |
+          bundle exec rspec --profile --format progress --format RSpec::Github::Formatter

data/.rubocop.yml

@@ -4,7 +4,8 @@ inherit_gem:
   gc_ruboconfig: rubocop.yml
 
 AllCops:
-  TargetRubyVersion: 3.0
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
 Metrics/AbcSize:
   Max: 60
@@ -14,3 +15,6 @@ Metrics/CyclomaticComplexity:
 
 Metrics/PerceivedComplexity:
   Max: 11
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false

data/.ruby-version

@@ -1 +1 @@
-3.0.2
+3.2.0

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## v10.2.3 2nd Aug 2023
+
+### Changed
+- Fixed calls to reloading internal cache is the state_machine was made private / protected
+
+## v10.2.2 21st April 2023
+
+### Changed
+- Calling `active_record.reload` resets the adapater's internal cache
+
+## v10.2.1 3rd April 2023
+
+### Changed
+- Fixed an edge case where `adapter.reset` were failing if the cache is empty
+
+## v10.2.0 3rd April 2023
+
+### Changed
+- Fixed caching of `last_transition` [#505](https://github.com/gocardless/statesman/pull/505)
+
+## v10.1.0 10th March 2023
+
+### CHanged
+- Add the source location of the guard callback to `Statesman::GuardFailedError`
+
 ## v10.0.0 17th May 2022
 
 ### Changed

data/Gemfile

@@ -11,5 +11,6 @@ elsif ENV['RAILS_VERSION']
 end
 group :development do
   # test/unit is no longer bundled with Ruby 2.2, but required by Rails
+  gem "pry"
   gem "test-unit", "~> 3.3" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
 end

data/README.md

@@ -611,6 +611,30 @@ describe "some callback" do
 end
 ```
 
+## Compatibility with type checkers
+
+Including ActiveRecordQueries to your model can cause issues with type checkers
+such as Sorbet, this is because this technically is using a dynamic include,
+which is not supported by Sorbet.
+
+To avoid these issues you can instead include the TypeSafeActiveRecordQueries
+module and pass in configuration.
+
+```ruby
+class Order < ActiveRecord::Base
+  has_many :order_transitions, autosave: false
+
+  include Statesman::Adapters::TypeSafeActiveRecordQueries
+
+  configure_state_machine transition_class: OrderTransition,
+                          initial_state: :pending
+
+  def state_machine
+    @state_machine ||= OrderStateMachine.new(self, transition_class: OrderTransition)
+  end
+end
+```
+
 # Third-party extensions
 
 [statesman-sequel](https://github.com/badosu/statesman-sequel) - An adapter to make Statesman work with [Sequel](https://github.com/jeremyevans/sequel)

data/lib/generators/statesman/active_record_transition_generator.rb

@@ -7,7 +7,7 @@ module Statesman
   class ActiveRecordTransitionGenerator < Rails::Generators::Base
     include Statesman::GeneratorHelpers
 
-    desc "Create an ActiveRecord-based transition model"\
+    desc "Create an ActiveRecord-based transition model" \
          "with the required attributes"
 
     argument :parent, type: :string, desc: "Your parent model name"

data/lib/generators/statesman/generator_helpers.rb

@@ -11,7 +11,7 @@ module Statesman
     end
 
     def migration_class_name
-      klass.gsub(/::/, "").pluralize
+      klass.gsub("::", "").pluralize
     end
 
     def next_migration_number

data/lib/statesman/adapters/active_record.rb

@@ -52,7 +52,7 @@ module Statesman
 
         raise
       ensure
-        @last_transition = nil
+        reset
       end
 
       def history(force_reload: false)
@@ -65,23 +65,24 @@ module Statesman
         end
       end
 
-      # rubocop:disable Naming/MemoizedInstanceVariableName
       def last(force_reload: false)
         if force_reload
           @last_transition = history(force_reload: true).last
+        elsif instance_variable_defined?(:@last_transition)
+          @last_transition
         else
-          @last_transition ||= history.last
+          @last_transition = history.last
         end
       end
-      # rubocop:enable Naming/MemoizedInstanceVariableName
 
       def reset
-        @last_transition = nil
+        if instance_variable_defined?(:@last_transition)
+          remove_instance_variable(:@last_transition)
+        end
       end
 
       private
 
-      # rubocop:disable Metrics/MethodLength
       def create_transition(from, to, metadata)
         transition = transitions_for_parent.build(
           default_transition_attributes(to, metadata),
@@ -118,7 +119,6 @@ module Statesman
 
         transition
       end
-      # rubocop:enable Metrics/MethodLength
 
       def default_transition_attributes(to, metadata)
         {
@@ -159,13 +159,24 @@ module Statesman
 
       def most_recent_transitions(most_recent_id = nil)
         if most_recent_id
-          transitions_of_parent.and(
+          concrete_transitions_of_parent.and(
             transition_table[:id].eq(most_recent_id).or(
               transition_table[:most_recent].eq(true),
             ),
           )
         else
-          transitions_of_parent.and(transition_table[:most_recent].eq(true))
+          concrete_transitions_of_parent.and(transition_table[:most_recent].eq(true))
+        end
+      end
+
+      def concrete_transitions_of_parent
+        if transition_sti?
+          transitions_of_parent.and(
+            transition_table[transition_class.inheritance_column].
+              eq(transition_class.name),
+          )
+        else
+          transitions_of_parent
         end
       end
 
@@ -231,7 +242,7 @@ module Statesman
       end
 
       def next_sort_key
-        (last && last.sort_key + 10) || 10
+        (last && (last.sort_key + 10)) || 10
       end
 
       def serialized?(transition_class)
@@ -264,13 +275,18 @@ module Statesman
           end
       end
 
-      def parent_join_foreign_key
-        association =
-          parent_model.class.
-            reflect_on_all_associations(:has_many).
-            find { |r| r.name.to_s == @association_name.to_s }
+      def transition_sti?
+        transition_class.column_names.include?(transition_class.inheritance_column)
+      end
 
-        association_join_primary_key(association)
+      def parent_association
+        parent_model.class.
+          reflect_on_all_associations(:has_many).
+          find { |r| r.name.to_s == @association_name.to_s }
+      end
+
+      def parent_join_foreign_key
+        association_join_primary_key(parent_association)
       end
 
       def association_join_primary_key(association)

data/lib/statesman/adapters/active_record_queries.rb

@@ -49,6 +49,14 @@ module Statesman
 
           define_in_state(base, query_builder)
           define_not_in_state(base, query_builder)
+
+          define_method(:reload) do |*a|
+            instance = super(*a)
+            if instance.respond_to?(:state_machine, true)
+              instance.send(:state_machine).reset
+            end
+            instance
+          end
         end
 
         private
@@ -95,18 +103,18 @@ module Statesman
         def states_where(states)
           if initial_state.to_s.in?(states.map(&:to_s))
             "#{most_recent_transition_alias}.to_state IN (?) OR " \
-            "#{most_recent_transition_alias}.to_state IS NULL"
+              "#{most_recent_transition_alias}.to_state IS NULL"
           else
             "#{most_recent_transition_alias}.to_state IN (?) AND " \
-            "#{most_recent_transition_alias}.to_state IS NOT NULL"
+              "#{most_recent_transition_alias}.to_state IS NOT NULL"
           end
         end
 
         def most_recent_transition_join
           "LEFT OUTER JOIN #{model_table} AS #{most_recent_transition_alias} " \
-             "ON #{model.table_name}.#{model_primary_key} = " \
-                  "#{most_recent_transition_alias}.#{model_foreign_key} " \
-             "AND #{most_recent_transition_alias}.most_recent = #{db_true}"
+            "ON #{model.table_name}.#{model_primary_key} = " \
+            "#{most_recent_transition_alias}.#{model_foreign_key} " \
+            "AND #{most_recent_transition_alias}.most_recent = #{db_true}"
         end
 
         private

data/lib/statesman/adapters/memory.rb

@@ -44,7 +44,7 @@ module Statesman
       private
 
       def next_sort_key
-        (last && last.sort_key + 10) || 10
+        (last && (last.sort_key + 10)) || 10
       end
     end
   end

data/lib/statesman/adapters/type_safe_active_record_queries.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Statesman
+  module Adapters
+    module TypeSafeActiveRecordQueries
+      def configure_state_machine(args = {})
+        transition_class = args.fetch(:transition_class)
+        initial_state = args.fetch(:initial_state)
+
+        include(
+          ActiveRecordQueries::ClassMethods.new(
+            transition_class: transition_class,
+            initial_state: initial_state,
+            most_recent_transition_alias: try(:most_recent_transition_alias),
+            transition_name: try(:transition_name),
+          ),
+        )
+      end
+    end
+  end
+end

data/lib/statesman/exceptions.rb

@@ -28,13 +28,15 @@ module Statesman
   end
 
   class GuardFailedError < StandardError
-    def initialize(from, to)
+    def initialize(from, to, callback)
       @from = from
       @to = to
+      @callback = callback
       super(_message)
+      set_backtrace(callback.source_location.join(":")) if callback&.source_location
     end
 
-    attr_reader :from, :to
+    attr_reader :from, :to, :callback
 
     private
 
@@ -52,8 +54,8 @@ module Statesman
 
     def _message(transition_class_name)
       "#{transition_class_name}#metadata is not serialized. If you " \
-      "are using a non-json column type, you should `include " \
-      "Statesman::Adapters::ActiveRecordTransition`"
+        "are using a non-json column type, you should `include " \
+        "Statesman::Adapters::ActiveRecordTransition`"
     end
   end
 
@@ -66,9 +68,9 @@ module Statesman
 
     def _message(transition_class_name)
       "#{transition_class_name}#metadata column type cannot be json " \
-      "and serialized simultaneously. If you are using a json " \
-      "column type, it is not necessary to `include " \
-      "Statesman::Adapters::ActiveRecordTransition`"
+        "and serialized simultaneously. If you are using a json " \
+        "column type, it is not necessary to `include " \
+        "Statesman::Adapters::ActiveRecordTransition`"
     end
   end
 end

data/lib/statesman/guard.rb

@@ -6,7 +6,7 @@ require_relative "exceptions"
 module Statesman
   class Guard < Callback
     def call(*args)
-      raise GuardFailedError.new(from, to) unless super(*args)
+      raise GuardFailedError.new(from, to, callback) unless super(*args)
     end
   end
 end

data/lib/statesman/version.rb

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

data/lib/statesman.rb

@@ -14,6 +14,8 @@ module Statesman
              "statesman/adapters/active_record_transition"
     autoload :ActiveRecordQueries,
              "statesman/adapters/active_record_queries"
+    autoload :TypeSafeActiveRecordQueries,
+             "statesman/adapters/type_safe_active_record_queries"
   end
   require "statesman/railtie" if defined?(::Rails::Railtie)
 

data/lib/tasks/statesman.rake

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 namespace :statesman do
-  desc "Set most_recent to false for old transitions and to true for the "\
+  desc "Set most_recent to false for old transitions and to true for the " \
        "latest one. Safe to re-run"
   task :backfill_most_recent, [:parent_model_name] => :environment do |_, args|
     parent_model_name = args.parent_model_name
@@ -56,8 +56,8 @@ namespace :statesman do
       end
 
       done_models += batch_size
-      puts "Updated #{transition_class.name.pluralize} for "\
-           "#{[done_models, total_models].min}/#{total_models} "\
+      puts "Updated #{transition_class.name.pluralize} for " \
+           "#{[done_models, total_models].min}/#{total_models} " \
            "#{parent_model_name.pluralize}"
     end
   end

data/spec/spec_helper.rb

@@ -48,6 +48,8 @@ RSpec.configure do |config|
       my_namespace_my_active_record_model_transitions
       other_active_record_models
       other_active_record_model_transitions
+      sti_active_record_models
+      sti_active_record_model_transitions
     ]
     tables.each do |table_name|
       sql = "DROP TABLE IF EXISTS #{table_name};"
@@ -72,6 +74,15 @@ RSpec.configure do |config|
       OtherActiveRecordModelTransition.reset_column_information
     end
 
+    def prepare_sti_model_table
+      CreateStiActiveRecordModelMigration.migrate(:up)
+    end
+
+    def prepare_sti_transitions_table
+      CreateStiActiveRecordModelTransitionMigration.migrate(:up)
+      StiActiveRecordModelTransition.reset_column_information
+    end
+
     MyNamespace::MyActiveRecordModelTransition.serialize(:metadata, JSON)
   end
 end

data/spec/statesman/adapters/active_record_queries_spec.rb

@@ -117,8 +117,8 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
         subject(:not_in_state) { MyActiveRecordModel.not_in_state(:succeeded, :failed) }
 
         it do
-          expect(not_in_state).to match_array([initial_state_model,
-                                               returned_to_initial_model])
+          expect(not_in_state).to contain_exactly(initial_state_model,
+                                                  returned_to_initial_model)
         end
       end
 
@@ -126,8 +126,8 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
         subject(:not_in_state) { MyActiveRecordModel.not_in_state(%i[succeeded failed]) }
 
         it do
-          expect(not_in_state).to match_array([initial_state_model,
-                                               returned_to_initial_model])
+          expect(not_in_state).to contain_exactly(initial_state_model,
+                                                  returned_to_initial_model)
         end
       end
     end
@@ -254,7 +254,7 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
       end
 
       it "does not raise an error" do
-        expect { check_missing_methods! }.to_not raise_exception(NotImplementedError)
+        expect { check_missing_methods! }.to_not raise_exception
       end
     end