statesman 3.5.0 → 7.4.0

data/spec/statesman/guard_spec.rb

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

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,7 +1,11 @@
+# frozen_string_literal: true
+
 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
@@ -9,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)
@@ -20,17 +24,25 @@ 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"
-  spec.add_development_dependency "pg", "~> 0.18"
+  spec.add_development_dependency "mysql2", ">= 0.4", "< 0.6"
+  spec.add_development_dependency "pg", ">= 0.18", "<= 1.3"
   spec.add_development_dependency "pry"
-  spec.add_development_dependency "rails", ">= 3.2"
-  spec.add_development_dependency "rake", "~> 12.3.0"
+  spec.add_development_dependency "rails", ">= 5.2"
+  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.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: 3.5.0
+  version: 7.4.0
 platform: ruby
 authors:
 - GoCardless
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-11-02 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
@@ -56,30 +56,42 @@ 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
     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
@@ -100,28 +112,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     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 +196,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: timecop
   requirement: !ruby/object:Gem::Requirement
@@ -228,10 +240,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 +249,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,29 +263,32 @@ 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
+- spec/statesman/exceptions_spec.rb
 - spec/statesman/guard_spec.rb
 - spec/statesman/machine_spec.rb
 - 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:
 - 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
@@ -292,9 +303,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14
-signing_key: 
+rubygems_version: 3.1.1
+signing_key:
 specification_version: 4
 summary: A statesman-like state machine library
 test_files:
@@ -303,20 +313,18 @@ 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
+- spec/statesman/exceptions_spec.rb
 - spec/statesman/guard_spec.rb
 - spec/statesman/machine_spec.rb
 - spec/statesman/utils_spec.rb
 - spec/support/active_record.rb
 - spec/support/generators_shared_examples.rb
-- spec/support/mongoid.rb