statesman 7.4.1 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9dc585aeecc837bf65850c562c9f41524959bd07c5f7f889284f534c260911c3
-  data.tar.gz: 807ae19092dcce330131916b825964e5f62ff13f8c4bde2e2140dee9d1f9983d
+  metadata.gz: aeab084afcfb068e82eae390dbac202fb8167884b3a58610429ca2efb30a8b46
+  data.tar.gz: 65f10904ea38a716a26f7acd6d6809a484f4cb51eb5458b98f94d2b29acfd746
 SHA512:
-  metadata.gz: 2688beb079f3b1993bd19b4460834a18a4ca1d5eac9733003c7c5f08c1fd2deb19aeb46103a8f799e89c346ac0704368119ff180ed907928c74587b6a6623ea0
-  data.tar.gz: c58db63a374f2474ccc73f0064d9dc089d8e52967b047ef77333fdae9b57eb1798cf428a0e6ec162788eaec99e5758d1bd26118c43944f5edda90261dbcb6845
+  metadata.gz: 36a6a95abb071113a8a17e59982db8c0c1e82cd189d2b5c0d59e4825f894dfde59a0051357a935ff9c3070520541461a69177a08003c7734252c4c1ae42946b6
+  data.tar.gz: 96887197a7551e0fe65269b727cff3cba0318c459e895836d05969120cd22d6b17f1f9052935ce768f91ff4af9a0d33aff43af025e41bba28f24a1948e188056

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## v8.0.0 6th January 2021
+
+### Added
+
+- Use AR Arel table to type cast booleans in order to avoid deprecation warning [#421](https://github.com/gocardless/statesman/pull/421)
+- Support relationships that doesn't use `id` as a Primary Key
+  [#422](https://github.com/gocardless/statesman/pull/422)
+
+## v7.4.1 11th November 2020
+
+### Added
+
+- Add #reset method to state machine and adapter interfaces
+  [#417](https://github.com/gocardless/statesman/pull/417)
+
 ## v7.4.0 26th August 2020
 
 ### Added

data/README.md

@@ -404,10 +404,12 @@ Model.in_state(:state_1).or(
 #### Storing the state on the model object
 
 If you wish to store the model state on the model directly, you can keep it up
-to date using an `after_transition` hook:
+to date using an `after_transition` hook.
+Combine it with the `after_commit` option to ensure the model state will only be
+saved once the transition has made it irreversibly to the database:
 
 ```ruby
-after_transition do |model, transition|
+after_transition(after_commit: true) do |model, transition|
   model.state = transition.to_state
   model.save!
 end

data/lib/generators/statesman/generator_helpers.rb

@@ -39,8 +39,16 @@ module Statesman
     end
 
     def mysql?
-      ActiveRecord::Base.configurations[Rails.env].
-        try(:[], "adapter").try(:match, /mysql/)
+      configuration.try(:[], "adapter").try(:match, /mysql/)
+    end
+
+    # [] is deprecated and will be removed in 6.2
+    def configuration
+      if ActiveRecord::Base.configurations.respond_to?(:configs_for)
+        ActiveRecord::Base.configurations.configs_for(env_name: Rails.env).first
+      else
+        ActiveRecord::Base.configurations[Rails.env]
+      end
     end
 
     def database_supports_partial_indexes?

data/lib/statesman/adapters/active_record.rb

@@ -305,23 +305,21 @@ module Statesman
       end
 
       def db_true
-        value = ::ActiveRecord::Base.connection.type_cast(
-          true,
-          transition_class.columns_hash["most_recent"],
-        )
-        ::ActiveRecord::Base.connection.quote(value)
+        ::ActiveRecord::Base.connection.quote(type_cast(true))
       end
 
       def db_false
-        value = ::ActiveRecord::Base.connection.type_cast(
-          false,
-          transition_class.columns_hash["most_recent"],
-        )
-        ::ActiveRecord::Base.connection.quote(value)
+        ::ActiveRecord::Base.connection.quote(type_cast(false))
       end
 
       def db_null
-        Arel::Nodes::SqlLiteral.new("NULL")
+        type_cast(nil)
+      end
+
+      # Type casting against a column is deprecated and will be removed in Rails 6.2.
+      # See https://github.com/rails/arel/commit/6160bfbda1d1781c3b08a33ec4955f170e95be11
+      def type_cast(value)
+        ::ActiveRecord::Base.connection.type_cast(value)
       end
 
       # Check whether the `most_recent` column allows null values. If it doesn't, set old

data/lib/statesman/adapters/active_record_queries.rb

@@ -104,7 +104,7 @@ module Statesman
 
         def most_recent_transition_join
           "LEFT OUTER JOIN #{model_table} AS #{most_recent_transition_alias} " \
-             "ON #{model.table_name}.id = " \
+             "ON #{model.table_name}.#{model_primary_key} = " \
                   "#{most_recent_transition_alias}.#{model_foreign_key} " \
              "AND #{most_recent_transition_alias}.most_recent = #{db_true}"
         end
@@ -127,6 +127,10 @@ module Statesman
                 "and #{transition_class}."
         end
 
+        def model_primary_key
+          transition_reflection.active_record_primary_key
+        end
+
         def model_foreign_key
           transition_reflection.foreign_key
         end

data/lib/statesman/version.rb

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

data/spec/statesman/adapters/active_record_queries_spec.rb

@@ -154,6 +154,31 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
       end
     end
 
+    context "with a custom primary key for the model" do
+      before do
+        # Switch to using OtherActiveRecordModelTransition, so the existing
+        # relation with MyActiveRecordModelTransition doesn't interfere with
+        # this spec.
+        # Configure the relationship to use a different primary key,
+        MyActiveRecordModel.send(:has_many,
+                                 :custom_name,
+                                 class_name: "OtherActiveRecordModelTransition",
+                                 primary_key: :external_id)
+
+        MyActiveRecordModel.class_eval do
+          def self.transition_class
+            OtherActiveRecordModelTransition
+          end
+        end
+      end
+
+      describe ".in_state" do
+        subject(:query) { MyActiveRecordModel.in_state(:succeeded) }
+
+        specify { expect { query }.to_not raise_error }
+      end
+    end
+
     context "after_commit transactional integrity" do
       before do
         MyStateMachine.class_eval do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 7.4.1
+  version: 8.0.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2021-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -303,7 +303,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.0.rc.1
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: A statesman-like state machine library