statesman 7.0.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3e43186830b499468b2a68209d617f21c2d69039ce77e2e91182de63b617bd63
-  data.tar.gz: 1bd2c4b13efbed3525e9bb03fe301c6695b21d4d6228a906276acbb0198010d4
+  metadata.gz: f0dbcc9fe3c29e715be585f2ddae96bdea9b80ca104daf00ee3378feab681b8e
+  data.tar.gz: c5824ece991650b8e6e979a9899dbdabc38b18209a79260f2aa9e9f4fda67da2
 SHA512:
-  metadata.gz: 9caf345cd2c806be717407e9ee4cf4a15e2bec5e583f7b5f2ba1bee7cf6ef531d2e32a0cf9196cc1e2af0e2a168e584c09d5eea076a0381837cd769bf13f9814
-  data.tar.gz: af376684100920894aca78bbee1cb4e7e17bc3202bb8aa649a29c40789f3545455e78c9d61ceb6dc99e37aafd5b8f78421cd8813e53c7e77c099a46aac150968
+  metadata.gz: 98fe2966e48e912b33f1c6d842aa6090782dd32be726532d8178377ffb0f1a551ee3d83eee291de0723c756eb0b1bda65dae73d695a47f8b6bd38106b127615f
+  data.tar.gz: 6be77a7114e2c3d59e76cfa71de583213ead8a171c5039941698c1e4b0b28b68500acba91d498fb488d33d0e31b3274fa5e373ce81a55f9f70e8e229132de1cf

data/.circleci/config.yml

@@ -12,7 +12,7 @@ references:
     - type: cache-restore
       key: statesman-{{ checksum "Gemfile" }}-{{ checksum "~/RAILS_VERSION.txt" }}
 
-    - run: gem install bundler -v 1.3
+    - run: gem install bundler -v 2.1.4
 
     - run: bundle install --path vendor/bundle
 
@@ -31,6 +31,34 @@ references:
       path: /tmp/test-results
 
 jobs:
+  build-ruby249-rails-524-mysql:
+    docker:
+      - image: circleci/ruby:2.4.9-node
+        environment:
+          - RAILS_VERSION=5.2.4
+          - DATABASE_URL=mysql2://root@127.0.0.1/statesman_test
+          - DATABASE_DEPENDENCY_PORT=3306
+      - image: circleci/mysql:5.7.18
+        environment:
+          - MYSQL_ALLOW_EMPTY_PASSWORD=true
+          - MYSQL_USER=root
+          - MYSQL_PASSWORD=
+          - MYSQL_DATABASE=statesman_test
+    steps: *steps
+  build-ruby249-rails-524-postgres:
+    docker:
+      - image: circleci/ruby:2.4.9-node
+        environment:
+          - RAILS_VERSION=5.2.4
+          - DATABASE_URL=postgres://postgres@localhost/statesman_test
+          - DATABASE_DEPENDENCY_PORT=5432
+      - image: circleci/postgres:9.6
+        environment:
+          - POSTGRES_USER=postgres
+          - POSTGRES_DB=statesman_test
+          - POSTGRES_PASSWORD=statesman
+    steps: *steps
+
   build-ruby265-rails-602-mysql:
     docker:
       - image: circleci/ruby:2.6.5-node
@@ -56,6 +84,7 @@ jobs:
         environment:
           - POSTGRES_USER=postgres
           - POSTGRES_DB=statesman_test
+          - POSTGRES_PASSWORD=statesman
     steps: *steps
   build-ruby265-rails-master-mysql:
     docker:
@@ -83,12 +112,14 @@ jobs:
         environment:
           - POSTGRES_USER=postgres
           - POSTGRES_DB=statesman_test
+          - POSTGRES_PASSWORD=statesman
     steps: *steps
-  build-ruby249-rails-524-mysql:
+
+  build-ruby270-rails-602-mysql:
     docker:
-      - image: circleci/ruby:2.4.9-node
+      - image: circleci/ruby:2.7.0-node
         environment:
-          - RAILS_VERSION=5.2.4
+          - RAILS_VERSION=6.0.2
           - DATABASE_URL=mysql2://root@127.0.0.1/statesman_test
           - DATABASE_DEPENDENCY_PORT=3306
       - image: circleci/mysql:5.7.18
@@ -98,19 +129,47 @@ jobs:
           - MYSQL_PASSWORD=
           - MYSQL_DATABASE=statesman_test
     steps: *steps
-  build-ruby249-rails-524-postgres:
+  build-ruby270-rails-602-postgres:
     docker:
-      - image: circleci/ruby:2.4.9-node
+      - image: circleci/ruby:2.7.0-node
         environment:
-          - RAILS_VERSION=5.2.4
+          - RAILS_VERSION=6.0.2
           - DATABASE_URL=postgres://postgres@localhost/statesman_test
           - DATABASE_DEPENDENCY_PORT=5432
       - image: circleci/postgres:9.6
         environment:
           - POSTGRES_USER=postgres
           - POSTGRES_DB=statesman_test
+          - POSTGRES_PASSWORD=statesman
+    steps: *steps
+  build-ruby270-rails-master-mysql:
+    docker:
+      - image: circleci/ruby:2.7.0-node
+        environment:
+          - RAILS_VERSION=master
+          - DATABASE_URL=mysql2://root@127.0.0.1/statesman_test
+          - DATABASE_DEPENDENCY_PORT=3306
+      - image: circleci/mysql:5.7.18
+        environment:
+          - MYSQL_ALLOW_EMPTY_PASSWORD=true
+          - MYSQL_USER=root
+          - MYSQL_PASSWORD=
+          - MYSQL_DATABASE=statesman_test
+    steps: *steps
+  build-ruby270-rails-master-postgres:
+    docker:
+      - image: circleci/ruby:2.7.0-node
+        environment:
+          - RAILS_VERSION=master
+          - DATABASE_URL=postgres://postgres@localhost/statesman_test
+          - EXCLUDE_MONGOID=true
+          - DATABASE_DEPENDENCY_PORT=5432
+      - image: circleci/postgres:9.6
+        environment:
+          - POSTGRES_USER=postgres
+          - POSTGRES_DB=statesman_test
+          - POSTGRES_PASSWORD=statesman
     steps: *steps
-
 
 workflows:
   version: 2
@@ -122,3 +181,7 @@ workflows:
       - build-ruby265-rails-602-postgres
       - build-ruby265-rails-master-mysql
       - build-ruby265-rails-master-postgres
+      - build-ruby270-rails-602-mysql
+      - build-ruby270-rails-602-postgres
+      - build-ruby270-rails-master-mysql
+      - build-ruby270-rails-master-postgres

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## v7.4.0 26th August 2020
+
+### Added
+
+- [Gem Metadata](https://guides.rubygems.org/specification-reference/#metadata)
+  to make finding changes between releases even easier.
+
+## v7.3.0, 24th August 2020
+
+### Changed
+
+- Use correct Arel for null [#409](https://github.com/gocardless/statesman/pull/#409)
+
+## v7.2.0, 19th May 2020
+
+### Changed
+
+- Set non-empty password for postgres tests [#398](https://github.com/gocardless/statesman/pull/#398)
+- Handle transitions differently for MySQL [#399](https://github.com/gocardless/statesman/pull/#399)
+- pg requirement from >= 0.18, <= 1.1 to >= 0.18, <= 1.3 [#400](https://github.com/gocardless/statesman/pull/#400)
+- Lazily enable mysql gaplock protection [#402](https://github.com/gocardless/statesman/pull/#402)
+
+## v7.1.0, 10th Feb 2020
+
+- Fix `to_s` on `TransitionFailedError` & `GuardFailedError`. `.message` and
+    `.to_s` diverged when `from` and `to` accessors where added in v4.1.3
+
+## v7.0.1, 8th Jan 2020
+
+- Fix deprecation warning with Ruby 2.7 [#386](https://github.com/gocardless/statesman/pull/386)
+
 ## v7.0.0, 8th Jan 2020
 
 **Breaking changes**

data/Gemfile

@@ -14,5 +14,5 @@ end
 
 group :development do
   # test/unit is no longer bundled with Ruby 2.2, but required by Rails
-  gem "test-unit", "~> 3.0" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
+  gem "test-unit", "~> 3.3" if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
 end

data/README.md

@@ -30,7 +30,7 @@ protection.
 To get started, just add Statesman to your `Gemfile`, and then run `bundle`:
 
 ```ruby
-gem 'statesman', '~> 5.2.0'
+gem 'statesman', '~> 7.1.0'
 ```
 
 ## Usage

data/lib/statesman.rb

@@ -20,14 +20,25 @@ module Statesman
   # Example:
   #   Statesman.configure do
   #     storage_adapter Statesman::ActiveRecordAdapter
+  #     enable_mysql_gaplock_protection
   #   end
   #
   def self.configure(&block)
-    config = Config.new(block)
+    @config = Config.new(block)
     @storage_adapter = config.adapter_class
   end
 
   def self.storage_adapter
     @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?
+  end
+
+  def self.config
+    @config ||= Config.new
+  end
 end

data/lib/statesman/adapters/active_record.rb

@@ -5,9 +5,6 @@ require_relative "../exceptions"
 module Statesman
   module Adapters
     class ActiveRecord
-      attr_reader :transition_class
-      attr_reader :parent_model
-
       JSON_COLUMN_TYPES = %w[json jsonb].freeze
 
       def self.database_supports_partial_indexes?
@@ -19,6 +16,10 @@ module Statesman
         end
       end
 
+      def self.adapter_name
+        ::ActiveRecord::Base.connection.adapter_name.downcase
+      end
+
       def initialize(transition_class, parent_model, observer, options = {})
         serialized = serialized?(transition_class)
         column_type = transition_class.columns_hash["metadata"].sql_type
@@ -29,12 +30,15 @@ module Statesman
         end
 
         @transition_class = transition_class
+        @transition_table = transition_class.arel_table
         @parent_model = parent_model
         @observer = observer
         @association_name =
           options[:association_name] || @transition_class.table_name
       end
 
+      attr_reader :transition_class, :transition_table, :parent_model
+
       def create(from, to, metadata = {})
         create_transition(from.to_s, to.to_s, metadata)
       rescue ::ActiveRecord::RecordNotUnique => e
@@ -65,19 +69,36 @@ module Statesman
 
       private
 
+      # rubocop:disable Metrics/MethodLength
       def create_transition(from, to, metadata)
-        transition_attributes = { to_state: to,
-                                  sort_key: next_sort_key,
-                                  metadata: metadata }
-
-        transition_attributes[:most_recent] = true
-
-        transition = transitions_for_parent.build(transition_attributes)
+        transition = transitions_for_parent.build(
+          default_transition_attributes(to, metadata),
+        )
 
         ::ActiveRecord::Base.transaction(requires_new: true) do
           @observer.execute(:before, from, to, transition)
-          unset_old_most_recent
-          transition.save!
+
+          if mysql_gaplock_protection?
+            # We save the transition first with most_recent falsy, then mark most_recent
+            # true after to avoid letting MySQL acquire a next-key lock which can cause
+            # deadlocks.
+            #
+            # To avoid an additional query, we manually adjust the most_recent attribute
+            # on our transition assuming that update_most_recents will have set it to true
+
+            transition.save!
+
+            unless update_most_recents(transition.id).positive?
+              raise ActiveRecord::Rollback, "failed to update most_recent"
+            end
+
+            transition.assign_attributes(most_recent: true)
+          else
+            update_most_recents
+            transition.assign_attributes(most_recent: true)
+            transition.save!
+          end
+
           @last_transition = transition
           @observer.execute(:after, from, to, transition)
           add_after_commit_callback(from, to, transition)
@@ -85,6 +106,16 @@ module Statesman
 
         transition
       end
+      # rubocop:enable Metrics/MethodLength
+
+      def default_transition_attributes(to, metadata)
+        {
+          to_state: to,
+          sort_key: next_sort_key,
+          metadata: metadata,
+          most_recent: not_most_recent_value(db_cast: false),
+        }
+      end
 
       def add_after_commit_callback(from, to, transition)
         ::ActiveRecord::Base.connection.add_transaction_record(
@@ -98,20 +129,92 @@ module Statesman
         parent_model.send(@association_name)
       end
 
-      def unset_old_most_recent
-        most_recent = transitions_for_parent.where(most_recent: true)
+      # Sets the given transition most_recent = t while unsetting the most_recent of any
+      # previous transitions.
+      def update_most_recents(most_recent_id = nil)
+        update = build_arel_manager(::Arel::UpdateManager)
+        update.table(transition_table)
+        update.where(most_recent_transitions(most_recent_id))
+        update.set(build_most_recents_update_all_values(most_recent_id))
 
-        # Check whether the `most_recent` column allows null values. If it
-        # doesn't, set old records to `false`, otherwise, set them to `NULL`.
-        #
-        # Some conditioning here is required to support databases that don't
-        # support partial indexes. By doing the conditioning on the column,
-        # rather than Rails' opinion of whether the database supports partial
-        # indexes, we're robust to DBs later adding support for partial indexes.
-        if transition_class.columns_hash["most_recent"].null == false
-          most_recent.update_all(with_updated_timestamp(most_recent: false))
+        # MySQL will validate index constraints across the intermediate result of an
+        # update. This means we must order our update to deactivate the previous
+        # most_recent before setting the new row to be true.
+        update.order(transition_table[:most_recent].desc) if mysql_gaplock_protection?
+
+        ::ActiveRecord::Base.connection.update(update.to_sql)
+      end
+
+      def most_recent_transitions(most_recent_id = nil)
+        if most_recent_id
+          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))
+        end
+      end
+
+      def transitions_of_parent
+        transition_table[parent_join_foreign_key.to_sym].eq(parent_model.id)
+      end
+
+      # Generates update_all Arel values that will touch the updated timestamp (if valid
+      # for this model) and set most_recent to true only for the transition with a
+      # matching most_recent ID.
+      #
+      # This is quite nasty, but combines two updates (set all most_recent = f, set
+      # current most_recent = t) into one, which helps improve transition performance
+      # especially when database latency is significant.
+      #
+      # The SQL this can help produce looks like:
+      #
+      #   update transitions
+      #      set most_recent = (case when id = 'PA123' then TRUE else FALSE end)
+      #        , updated_at = '...'
+      #      ...
+      #
+      def build_most_recents_update_all_values(most_recent_id = nil)
+        [
+          [
+            transition_table[:most_recent],
+            Arel::Nodes::SqlLiteral.new(most_recent_value(most_recent_id)),
+          ],
+        ].tap do |values|
+          # Only if we support the updated at timestamps should we add this column to the
+          # update
+          updated_column, updated_at = updated_column_and_timestamp
+
+          if updated_column
+            values << [
+              transition_table[updated_column.to_sym],
+              updated_at,
+            ]
+          end
+        end
+      end
+
+      def most_recent_value(most_recent_id)
+        if most_recent_id
+          Arel::Nodes::Case.new.
+            when(transition_table[:id].eq(most_recent_id)).then(db_true).
+            else(not_most_recent_value).to_sql
         else
-          most_recent.update_all(with_updated_timestamp(most_recent: nil))
+          Arel::Nodes::SqlLiteral.new(not_most_recent_value)
+        end
+      end
+
+      # Provide a wrapper for constructing an update manager which handles a breaking API
+      # change in Arel as we move into Rails >6.0.
+      #
+      # https://github.com/rails/rails/commit/7508284800f67b4611c767bff9eae7045674b66f
+      def build_arel_manager(manager)
+        if manager.instance_method(:initialize).arity.zero?
+          manager.new
+        else
+          manager.new(::ActiveRecord::Base)
         end
       end
 
@@ -170,7 +273,8 @@ module Statesman
         end
       end
 
-      def with_updated_timestamp(params)
+      # updated_column_and_timestamp should return [column_name, value]
+      def updated_column_and_timestamp
         # TODO: Once we've set expectations that transition classes should conform to
         # the interface of Adapters::ActiveRecordTransition as a breaking change in the
         # next major version, we can stop calling `#respond_to?` first and instead
@@ -184,21 +288,57 @@ module Statesman
                    ActiveRecordTransition::DEFAULT_UPDATED_TIMESTAMP_COLUMN
                  end
 
-        return params if column.nil?
+        # No updated timestamp column, don't return anything
+        return nil if column.nil?
+
+        [
+          column, ::ActiveRecord::Base.default_timezone == :utc ? Time.now.utc : Time.now
+        ]
+      end
+
+      def mysql_gaplock_protection?
+        Statesman.mysql_gaplock_protection?
+      end
+
+      def db_true
+        value = ::ActiveRecord::Base.connection.type_cast(
+          true,
+          transition_class.columns_hash["most_recent"],
+        )
+        ::ActiveRecord::Base.connection.quote(value)
+      end
 
-        timestamp = if ::ActiveRecord::Base.default_timezone == :utc
-                      Time.now.utc
-                    else
-                      Time.now
-                    end
+      def db_false
+        value = ::ActiveRecord::Base.connection.type_cast(
+          false,
+          transition_class.columns_hash["most_recent"],
+        )
+        ::ActiveRecord::Base.connection.quote(value)
+      end
+
+      def db_null
+        Arel::Nodes::SqlLiteral.new("NULL")
+      end
+
+      # Check whether the `most_recent` column allows null values. If it doesn't, set old
+      # records to `false`, otherwise, set them to `NULL`.
+      #
+      # Some conditioning here is required to support databases that don't support partial
+      # indexes. By doing the conditioning on the column, rather than Rails' opinion of
+      # whether the database supports partial indexes, we're robust to DBs later adding
+      # support for partial indexes.
+      def not_most_recent_value(db_cast: true)
+        if transition_class.columns_hash["most_recent"].null == false
+          return db_cast ? db_false : false
+        end
 
-        params.merge(column => timestamp)
+        db_cast ? db_null : nil
       end
     end
 
     class ActiveRecordAfterCommitWrap
-      def initialize
-        @callback = Proc.new
+      def initialize(&block)
+        @callback = block
         @connection = ::ActiveRecord::Base.connection
       end
 

data/lib/statesman/config.rb

@@ -14,5 +14,31 @@ module Statesman
     def storage_adapter(adapter_class)
       @adapter_class = adapter_class
     end
+
+    def mysql_gaplock_protection?
+      return @mysql_gaplock_protection unless @mysql_gaplock_protection.nil?
+
+      # 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
+    end
+
+    private
+
+    def mysql_adapter?(adapter_class)
+      adapter_name = adapter_name(adapter_class)
+      return false unless adapter_name
+
+      adapter_name.start_with?("mysql")
+    end
+
+    def adapter_name(adapter_class)
+      adapter_class.respond_to?(:adapter_name) && adapter_class&.adapter_name
+    end
   end
 end

data/lib/statesman/exceptions.rb

@@ -4,16 +4,21 @@ module Statesman
   class InvalidStateError < StandardError; end
   class InvalidTransitionError < StandardError; end
   class InvalidCallbackError < StandardError; end
+  class TransitionConflictError < StandardError; end
+  class MissingTransitionAssociation < StandardError; end
 
   class TransitionFailedError < StandardError
     def initialize(from, to)
       @from = from
       @to = to
+      super(_message)
     end
 
     attr_reader :from, :to
 
-    def message
+    private
+
+    def _message
       "Cannot transition from '#{from}' to '#{to}'"
     end
   end
@@ -22,18 +27,18 @@ module Statesman
     def initialize(from, to)
       @from = from
       @to = to
+      super(_message)
     end
 
     attr_reader :from, :to
 
-    def message
+    private
+
+    def _message
       "Guard on transition from: '#{from}' to '#{to}' returned false"
     end
   end
 
-  class TransitionConflictError < StandardError; end
-  class MissingTransitionAssociation < StandardError; end
-
   class UnserializedMetadataError < StandardError
     def initialize(transition_class_name)
       super(_message(transition_class_name))

data/lib/statesman/version.rb

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

data/spec/statesman/adapters/active_record_queries_spec.rb

@@ -20,7 +20,9 @@ describe Statesman::Adapters::ActiveRecordQueries, active_record: true do
     prepare_other_model_table
     prepare_other_transitions_table
 
-    Statesman.configure { storage_adapter(Statesman::Adapters::ActiveRecord) }
+    Statesman.configure do
+      storage_adapter(Statesman::Adapters::ActiveRecord)
+    end
   end
 
   after { Statesman.configure { storage_adapter(Statesman::Adapters::Memory) } }

data/spec/statesman/adapters/active_record_spec.rb

@@ -9,9 +9,19 @@ describe Statesman::Adapters::ActiveRecord, active_record: true do
   before do
     prepare_model_table
     prepare_transitions_table
+
+    MyActiveRecordModelTransition.serialize(:metadata, JSON)
+
+    Statesman.configure do
+      # Rubocop requires described_class to be used, but this block
+      # is instance_eval'd and described_class won't be defined
+      # rubocop:disable RSpec/DescribedClass
+      storage_adapter(Statesman::Adapters::ActiveRecord)
+      # rubocop:enable RSpec/DescribedClass
+    end
   end
 
-  before { MyActiveRecordModelTransition.serialize(:metadata, JSON) }
+  after { Statesman.configure { storage_adapter(Statesman::Adapters::Memory) } }
 
   let(:observer) { double(Statesman::Machine, execute: nil) }
   let(:model) { MyActiveRecordModel.create(current_state: :pending) }

data/spec/statesman/exceptions_spec.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Statesman do
+  describe "InvalidStateError" do
+    subject(:error) { Statesman::InvalidStateError.new }
+
+    its(:message) { is_expected.to eq("Statesman::InvalidStateError") }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "InvalidTransitionError" do
+    subject(:error) { Statesman::InvalidTransitionError.new }
+
+    its(:message) { is_expected.to eq("Statesman::InvalidTransitionError") }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "InvalidCallbackError" do
+    subject(:error) { Statesman::InvalidTransitionError.new }
+
+    its(:message) { is_expected.to eq("Statesman::InvalidTransitionError") }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "TransitionConflictError" do
+    subject(:error) { Statesman::TransitionConflictError.new }
+
+    its(:message) { is_expected.to eq("Statesman::TransitionConflictError") }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "MissingTransitionAssociation" do
+    subject(:error) { Statesman::MissingTransitionAssociation.new }
+
+    its(:message) { is_expected.to eq("Statesman::MissingTransitionAssociation") }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "TransitionFailedError" do
+    subject(:error) { Statesman::TransitionFailedError.new("from", "to") }
+
+    its(:message) { is_expected.to eq("Cannot transition from 'from' to 'to'") }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "GuardFailedError" do
+    subject(:error) { Statesman::GuardFailedError.new("from", "to") }
+
+    its(:message) do
+      is_expected.to eq("Guard on transition from: 'from' to 'to' returned false")
+    end
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "UnserializedMetadataError" do
+    subject(:error) { Statesman::UnserializedMetadataError.new("foo") }
+
+    its(:message) { is_expected.to match(/foo#metadata is not serialized/) }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+
+  describe "IncompatibleSerializationError" do
+    subject(:error) { Statesman::IncompatibleSerializationError.new("foo") }
+
+    its(:message) { is_expected.to match(/foo#metadata column type cannot be json/) }
+    its "string matches its message" do
+      expect(error.to_s).to eq(error.message)
+    end
+  end
+end

data/statesman.gemspec

@@ -4,6 +4,8 @@ lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "statesman/version"
 
+GITHUB_URL = "https://github.com/gocardless/statesman"
+
 Gem::Specification.new do |spec|
   spec.name          = "statesman"
   spec.version       = Statesman::VERSION
@@ -11,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["developers@gocardless.com"]
   spec.description   = "A statesman-like state machine library"
   spec.summary       = spec.description
-  spec.homepage      = "https://github.com/gocardless/statesman"
+  spec.homepage      = GITHUB_URL
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -22,10 +24,10 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.2"
 
   spec.add_development_dependency "ammeter", "~> 1.1"
-  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
   spec.add_development_dependency "gc_ruboconfig", "~> 2.3.9"
   spec.add_development_dependency "mysql2", ">= 0.4", "< 0.6"
-  spec.add_development_dependency "pg", "~> 0.18"
+  spec.add_development_dependency "pg", ">= 0.18", "<= 1.3"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rails", ">= 5.2"
   spec.add_development_dependency "rake", "~> 13.0.0"
@@ -33,6 +35,14 @@ Gem::Specification.new do |spec|
   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.3.6"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
   spec.add_development_dependency "timecop", "~> 0.9.1"
+
+  spec.metadata = {
+    "bug_tracker_uri" => "#{GITHUB_URL}/issues",
+    "changelog_uri" => "#{GITHUB_URL}/blob/master/CHANGELOG.md",
+    "documentation_uri" => "#{GITHUB_URL}/blob/master/README.md",
+    "homepage_uri" => GITHUB_URL,
+    "source_code_uri" => GITHUB_URL,
+  }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.4.0
 platform: ruby
 authors:
 - GoCardless
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-01-08 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: gc_ruboconfig
   requirement: !ruby/object:Gem::Requirement
@@ -76,16 +76,22 @@ dependencies:
   name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.18'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0.18'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -190,14 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -266,6 +272,7 @@ files:
 - 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
@@ -275,8 +282,13 @@ files:
 homepage: https://github.com/gocardless/statesman
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  bug_tracker_uri: https://github.com/gocardless/statesman/issues
+  changelog_uri: https://github.com/gocardless/statesman/blob/master/CHANGELOG.md
+  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
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -291,8 +303,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.1
+signing_key:
 specification_version: 4
 summary: A statesman-like state machine library
 test_files:
@@ -310,6 +322,7 @@ test_files:
 - 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