statesman 3.5.0 → 6.0.0

data/spec/statesman/machine_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Statesman::Machine do
@@ -57,7 +59,11 @@ describe Statesman::Machine do
         expect(instance).
           to receive(:transition_to).once.
           and_raise(StandardError)
-        transition_state rescue nil # rubocop:disable RescueModifier
+        begin
+          transition_state
+        rescue StandardError
+          nil
+        end
       end
 
       it "re-raises the exception" do
@@ -86,7 +92,11 @@ describe Statesman::Machine do
             to receive(:transition_to).
             exactly(retry_attempts + 1).times.
             and_raise(Statesman::TransitionConflictError)
-          transition_state rescue nil # rubocop:disable RescueModifier
+          begin
+            transition_state
+          rescue StandardError
+            nil
+          end
         end
 
         it "re-raises the conflict" do
@@ -320,6 +330,16 @@ describe Statesman::Machine do
     it_behaves_like "a callback store", :guard_transition, :guards
   end
 
+  describe ".after_transition_failure" do
+    it_behaves_like "a callback store",
+                    :after_transition_failure,
+                    :after_transition_failure
+  end
+
+  describe ".after_guard_failure" do
+    it_behaves_like "a callback store", :after_guard_failure, :after_guard_failure
+  end
+
   describe "#initialize" do
     it "accepts an object to manipulate" do
       machine_instance = machine.new(my_model)
@@ -609,8 +629,12 @@ describe Statesman::Machine do
 
     context "when the state cannot be transitioned to" do
       it "raises an error" do
+        # Hardcoding error message here to ensure backward
+        # compatibility as people may have been parsing the string
+        # to figure out the transitions involved.
         expect { instance.transition_to!(:z) }.
-          to raise_error(Statesman::TransitionFailedError)
+          to raise_error(Statesman::TransitionFailedError,
+                         "Cannot transition from 'x' to 'z'")
       end
     end
 
@@ -658,6 +682,24 @@ describe Statesman::Machine do
           end
         end
 
+        context "which covers all transitions" do
+          let(:result) { true }
+          let(:guard_cb) { ->(*_args) { false } }
+
+          before { machine.guard_transition(from: :x, to: :y, &guard_cb) }
+
+          it "raises an exception with the transition information" do
+            expect(guard_cb).to receive(:call).once.with(
+              my_model, instance.last_transition, {}
+            ).and_return(false)
+            expect { instance.transition_to!(:y) }.
+              to raise_error(
+                an_instance_of(Statesman::GuardFailedError).
+                and(having_attributes(from: "x", to: ["y"])),
+              )
+          end
+        end
+
         context "which passes" do
           it "changes state" do
             instance.transition_to!(:y)
@@ -672,6 +714,39 @@ describe Statesman::Machine do
             expect { instance.transition_to!(:y) }.
               to raise_error(Statesman::GuardFailedError)
           end
+
+          context "and a guard failed callback defined" do
+            let(:guard_failure_result) { true }
+            let(:guard_failure_cb) { ->(*_args) { guard_failure_result } }
+
+            before { machine.after_guard_failure(from: :x, to: :y, &guard_failure_cb) }
+
+            it "calls the failure callback" do
+              expect(guard_failure_cb).to receive(:call).once.with(
+                my_model, instance_of(Statesman::GuardFailedError)
+              ).and_return(guard_failure_result)
+              expect { instance.transition_to!(:y) }.
+                to raise_error(Statesman::GuardFailedError)
+            end
+          end
+        end
+      end
+
+      context "with a transition failed callback" do
+        let(:result) { true }
+        let(:transition_failed_cb) { ->(*_args) { result } }
+        let(:instance) { machine.new(my_model) }
+
+        before do
+          machine.after_transition_failure(&transition_failed_cb)
+        end
+
+        it "raises and exception and calls the callback" do
+          expect(transition_failed_cb).to receive(:call).once.with(
+            my_model, instance_of(Statesman::TransitionFailedError)
+          ).and_return(true)
+          expect { instance.transition_to!(:z) }.
+            to raise_error(Statesman::TransitionFailedError)
         end
       end
     end
@@ -695,7 +770,7 @@ describe Statesman::Machine do
     context "when it is unsuccesful" do
       before do
         allow(instance).to receive(:transition_to!).
-          and_raise(Statesman::GuardFailedError)
+          and_raise(Statesman::GuardFailedError.new(:x, :some_state))
       end
 
       it { is_expected.to be_falsey }

data/spec/statesman/utils_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "spec_helper"
 
 describe Statesman::Utils do

data/spec/support/active_record.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 MIGRATION_CLASS = if Rails.version.split(".").map(&:to_i).first >= 5
@@ -94,14 +96,12 @@ class CreateMyActiveRecordModelTransitionMigration < MIGRATION_CLASS
                 %i[my_active_record_model_id most_recent],
                 unique: true,
                 where: "most_recent",
-                name: "index_my_active_record_model_transitions_"\
-                      "parent_most_recent"
+                name: "index_my_active_record_model_transitions_parent_latest"
     else
       add_index :my_active_record_model_transitions,
                 %i[my_active_record_model_id most_recent],
                 unique: true,
-                name: "index_my_active_record_model_transitions_"\
-                      "parent_most_recent"
+                name: "index_my_active_record_model_transitions_parent_latest"
     end
   end
 end
@@ -173,13 +173,13 @@ class CreateOtherActiveRecordModelTransitionMigration < MIGRATION_CLASS
                 unique: true,
                 where: "most_recent",
                 name: "index_other_active_record_model_transitions_"\
-                      "parent_most_recent"
+                      "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_"\
-                      "parent_most_recent"
+                      "parent_latest"
     end
   end
 end
@@ -188,8 +188,7 @@ end
 class DropMostRecentColumn < MIGRATION_CLASS
   def change
     remove_index :my_active_record_model_transitions,
-                 name: "index_my_active_record_model_transitions_"\
-                       "parent_most_recent"
+                 name: "index_my_active_record_model_transitions_parent_latest"
     remove_column :my_active_record_model_transitions, :most_recent
   end
 end
@@ -270,14 +269,12 @@ class CreateNamespacedARModelTransitionMigration < MIGRATION_CLASS
                 %i[my_active_record_model_id most_recent],
                 unique: true,
                 where: "most_recent",
-                name: "index_namespace_model_transitions_"\
-                      "parent_most_recent"
+                name: "index_namespace_model_transitions_parent_latest"
     else
       add_index :my_namespace_my_active_record_model_transitions,
                 %i[my_active_record_model_id most_recent],
                 unique: true,
-                name: "index_namespace_model_transitions_"\
-                      "parent_most_recent"
+                name: "index_namespace_model_transitions_parent_latest"
     end
   end
   # rubocop:enable MethodLength

data/spec/support/generators_shared_examples.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/version"
 require "rspec/rails"
 require "ammeter/init"

data/statesman.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "statesman/version"
@@ -22,15 +24,15 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "ammeter", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "gc_ruboconfig", "~> 2.3.9"
-  spec.add_development_dependency "mysql2", "~> 0.4.0"
+  spec.add_development_dependency "mysql2", ">= 0.4", "< 0.6"
   spec.add_development_dependency "pg", "~> 0.18"
   spec.add_development_dependency "pry"
   spec.add_development_dependency "rails", ">= 3.2"
-  spec.add_development_dependency "rake", "~> 12.3.0"
+  spec.add_development_dependency "rake", "~> 13.0.0"
   spec.add_development_dependency "rspec", "~> 3.1"
   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"
+  spec.add_development_dependency "sqlite3", "~> 1.3.6"
   spec.add_development_dependency "timecop", "~> 0.9.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 6.0.0
 platform: ruby
 authors:
 - GoCardless
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-02 00:00:00.000000000 Z
+date: 2019-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -56,16 +56,22 @@ dependencies:
   name: mysql2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: '0.4'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +120,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 12.3.0
+        version: 13.0.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -184,14 +190,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -228,10 +234,8 @@ files:
 - lib/generators/statesman/active_record_transition_generator.rb
 - lib/generators/statesman/generator_helpers.rb
 - lib/generators/statesman/migration_generator.rb
-- lib/generators/statesman/mongoid_transition_generator.rb
 - lib/generators/statesman/templates/active_record_transition_model.rb.erb
 - lib/generators/statesman/templates/create_migration.rb.erb
-- lib/generators/statesman/templates/mongoid_transition_model.rb.erb
 - lib/generators/statesman/templates/update_migration.rb.erb
 - lib/statesman.rb
 - lib/statesman/adapters/active_record.rb
@@ -239,8 +243,6 @@ files:
 - lib/statesman/adapters/active_record_transition.rb
 - lib/statesman/adapters/memory.rb
 - lib/statesman/adapters/memory_transition.rb
-- lib/statesman/adapters/mongoid.rb
-- lib/statesman/adapters/mongoid_transition.rb
 - lib/statesman/callback.rb
 - lib/statesman/config.rb
 - lib/statesman/exceptions.rb
@@ -255,14 +257,12 @@ files:
 - 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/generators/statesman/mongoid_transition_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/mongoid_spec.rb
 - spec/statesman/adapters/shared_examples.rb
 - spec/statesman/callback_spec.rb
 - spec/statesman/config_spec.rb
@@ -271,7 +271,6 @@ files:
 - spec/statesman/utils_spec.rb
 - spec/support/active_record.rb
 - spec/support/generators_shared_examples.rb
-- spec/support/mongoid.rb
 - statesman.gemspec
 homepage: https://github.com/gocardless/statesman
 licenses:
@@ -292,8 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 3.1.1
 signing_key: 
 specification_version: 4
 summary: A statesman-like state machine library
@@ -303,14 +301,12 @@ test_files:
 - 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/generators/statesman/mongoid_transition_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/mongoid_spec.rb
 - spec/statesman/adapters/shared_examples.rb
 - spec/statesman/callback_spec.rb
 - spec/statesman/config_spec.rb
@@ -319,4 +315,3 @@ test_files:
 - spec/statesman/utils_spec.rb
 - spec/support/active_record.rb
 - spec/support/generators_shared_examples.rb
-- spec/support/mongoid.rb

data/lib/generators/statesman/mongoid_transition_generator.rb

@@ -1,25 +0,0 @@
-require "rails/generators"
-require "generators/statesman/generator_helpers"
-
-module Statesman
-  class MongoidTransitionGenerator < Rails::Generators::Base
-    include Statesman::GeneratorHelpers
-
-    desc "Create a Mongoid-based transition model with the required attributes"
-
-    argument :parent, type: :string, desc: "Your parent model name"
-    argument :klass, type: :string, desc: "Your transition model name"
-
-    source_root File.expand_path("templates", __dir__)
-
-    def create_model_file
-      template("mongoid_transition_model.rb.erb", model_file_name)
-    end
-
-    private
-
-    def collection_name
-      klass.underscore.pluralize
-    end
-  end
-end

data/lib/generators/statesman/templates/mongoid_transition_model.rb.erb

@@ -1,14 +0,0 @@
-class <%= klass %>
-  include Mongoid::Document
-  include Mongoid::Timestamps
-
-  field :to_state, type: String
-  field :sort_key, type: Integer
-  field :statesman_metadata, type: Hash
-
-  include Statesman::Adapters::MongoidTransition
-
-  index({ sort_key: 1 })
-
-  belongs_to :<%= parent %><%= class_name_option %>, index: true
-end

data/lib/statesman/adapters/mongoid.rb

@@ -1,66 +0,0 @@
-require_relative "../exceptions"
-
-module Statesman
-  module Adapters
-    class Mongoid
-      attr_reader :transition_class
-      attr_reader :parent_model
-
-      def initialize(transition_class, parent_model, observer, _opts = {})
-        @transition_class = transition_class
-        @parent_model = parent_model
-        @observer = observer
-        unless transition_class_hash_fields.include?("statesman_metadata")
-          raise UnserializedMetadataError, metadata_field_error_message
-        end
-      end
-
-      def create(from, to, metadata = {})
-        from = from.to_s
-        to = to.to_s
-        transition = transitions_for_parent.build(to_state: to,
-                                                  sort_key: next_sort_key,
-                                                  statesman_metadata: metadata)
-
-        @observer.execute(:before, from, to, transition)
-        transition.save!
-        @last_transition = transition
-        @observer.execute(:after, from, to, transition)
-        @observer.execute(:after_commit, from, to, transition)
-        transition
-      ensure
-        @last_transition = nil
-      end
-
-      def history(*)
-        transitions_for_parent.asc(:sort_key)
-      end
-
-      def last(force_reload: false)
-        if force_reload
-          @last_transition = history.last
-        else
-          @last_transition ||= history.last
-        end
-      end
-
-      private
-
-      def transition_class_hash_fields
-        transition_class.fields.select { |_, v| v.type == Hash }.keys
-      end
-
-      def metadata_field_error_message
-        "#{transition_class.name}#statesman_metadata is not of type 'Hash'"
-      end
-
-      def transitions_for_parent
-        @parent_model.send(@transition_class.collection_name)
-      end
-
-      def next_sort_key
-        (last && last.sort_key + 10) || 10
-      end
-    end
-  end
-end

data/lib/statesman/adapters/mongoid_transition.rb

@@ -1,10 +0,0 @@
-module Statesman
-  module Adapters
-    module MongoidTransition
-      def self.included(base)
-        base.send(:alias_method, :metadata, :statesman_metadata)
-        base.send(:alias_method, :metadata=, :statesman_metadata=)
-      end
-    end
-  end
-end

data/spec/generators/statesman/mongoid_transition_generator_spec.rb

@@ -1,23 +0,0 @@
-require "spec_helper"
-require "support/generators_shared_examples"
-require "generators/statesman/mongoid_transition_generator"
-
-describe Statesman::MongoidTransitionGenerator, type: :generator do
-  describe "the model contains the correct words" do
-    subject { file("app/models/yummy/bacon_transition.rb") }
-
-    before { run_generator %w[Yummy::Bacon Yummy::BaconTransition] }
-
-    it { is_expected.to_not contain(%r{:yummy/bacon}) }
-    it { is_expected.to contain(/class_name: 'Yummy::Bacon'/) }
-  end
-
-  describe "the model contains the correct words" do
-    subject { file("app/models/bacon_transition.rb") }
-
-    before { run_generator %w[Bacon BaconTransition] }
-
-    it { is_expected.to_not contain(/class_name:/) }
-    it { is_expected.to_not contain(/CreateYummy::Bacon/) }
-  end
-end

data/spec/statesman/adapters/mongoid_spec.rb

@@ -1,86 +0,0 @@
-require "spec_helper"
-require "statesman/adapters/shared_examples"
-require "statesman/exceptions"
-require "support/mongoid"
-require "mongoid"
-
-describe Statesman::Adapters::Mongoid, mongo: true do
-  after { Mongoid.purge! }
-
-  let(:observer) { double(Statesman::Machine, execute: nil) }
-  let(:model) { MyMongoidModel.create(current_state: :pending) }
-
-  it_behaves_like "an adapter", described_class, MyMongoidModelTransition
-
-  describe "#initialize" do
-    context "with unserialized metadata" do
-      before do
-        allow_any_instance_of(described_class).
-          to receive_messages(transition_class_hash_fields: [])
-      end
-
-      it "raises an exception if metadata is not serialized" do
-        expect do
-          described_class.new(MyMongoidModelTransition, MyMongoidModel,
-                              observer)
-        end.to raise_exception(Statesman::UnserializedMetadataError)
-      end
-    end
-  end
-
-  describe "#last" do
-    let(:adapter) do
-      described_class.new(MyMongoidModelTransition, model, observer)
-    end
-
-    context "with a previously looked up transition" do
-      before { adapter.create(:x, :y) }
-
-      before { adapter.last }
-
-      it "caches the transition" do
-        expect_any_instance_of(MyMongoidModel).
-          to_not receive(:my_mongoid_model_transitions)
-        adapter.last
-      end
-
-      context "and a new transition" do
-        before { adapter.create(:y, :z) }
-
-        it "retrieves the new transition from the database" do
-          expect(adapter.last.to_state).to eq("z")
-        end
-      end
-    end
-
-    context "when a new transition has been created elsewhere" do
-      let(:alternate_adapter) do
-        described_class.new(MyMongoidModelTransition, model, observer)
-      end
-
-      context "when explicitly not using the cache" do
-        context "when the transitions are in memory" do
-          before do
-            model.my_mongoid_model_transitions.entries
-            alternate_adapter.create(:y, :z)
-          end
-
-          it "reloads the value" do
-            expect(adapter.last(force_reload: true).to_state).to eq("z")
-          end
-        end
-
-        context "when the transitions are not in memory" do
-          before do
-            model.my_mongoid_model_transitions.reset
-            alternate_adapter.create(:y, :z)
-          end
-
-          it "reloads the value" do
-            expect(adapter.last(force_reload: true).to_state).to eq("z")
-          end
-        end
-      end
-    end
-  end
-end

data/spec/support/mongoid.rb

@@ -1,28 +0,0 @@
-require "mongoid"
-
-Mongoid.configure do |config|
-  config.connect_to("statesman_test")
-end
-
-class MyMongoidModel
-  include Mongoid::Document
-
-  field :current_state, type: String
-
-  has_many :my_mongoid_model_transitions
-end
-
-class MyMongoidModelTransition
-  include Mongoid::Document
-  include Mongoid::Timestamps
-
-  field :to_state, type: String
-  field :sort_key, type: Integer
-  field :statesman_metadata, type: Hash
-
-  index(sort_key: 1)
-
-  belongs_to :my_mongoid_model, index: true
-
-  include Statesman::Adapters::MongoidTransition
-end