statesman 9.0.1 → 10.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 145d2a6b60abe5fb64e8010676cb63b62ba1869daa4343eb538bdf1d261c885e
-  data.tar.gz: cbcc8f735327409a89a2b238fefdfb6ef4b9e9595b983f7a648df800ca8c2aed
+  metadata.gz: 172b3bbeecd2cbd2df8fc9a5485c548c0d729cf0994fda1771d25c8e44f41877
+  data.tar.gz: 3556cc13e2433e920ce9bd275bce155a095f6a0e64547a5ff003e0f5fa4dfc74
 SHA512:
-  metadata.gz: 9eeef7b26150628a370117dccbcde1e40bc1dbd15957fca96f18232e167b5bcca58a42f47a2718a6927bfcb08449b4f7515fa48ef68ed281f79e12fad96d40f2
-  data.tar.gz: b793c7af514ce22564326d697880179caceadff2bebc6c03b02aa5a523e040ffd17e5dff8475b9fad7ed567f6f0f8849fe97ddb6745a7b3d86cd7aceb71e0264
+  metadata.gz: 21f91dd2537c3e5e480dc0f5adb592ebbeaef9974cfbede1d94aa8b6946c26e9394199029e0281372a2ec4452e1173cb5cba86f0bf1507de19677c398df20350
+  data.tar.gz: 58ee880508df011be1caea1f85a475760cf79e07c1ad60f241f4ef4146983997560f17fe1d3a93f5856c6e519831d71eae6c4bd8f7e70f6d0d4ce49253f1ac3f

data/.circleci/config.yml

@@ -46,15 +46,15 @@ references:
         path: /tmp/circle_artifacts/
 
   ruby_versions: &ruby_versions
-    - "2.5"
-    - "2.6"
     - "2.7"
     - "3.0"
+    - "3.1"
 
   rails_versions: &rails_versions
-    - "5.2.6"
+    - "5.2.7"
     - "6.0.4"
-    - "6.1.4"
+    - "6.1.5"
+    - "7.0.2"
     - "main"
 
   mysql_versions: &mysql_versions

data/.gitignore

@@ -1,18 +1,71 @@
 *.gem
 *.rbc
-.bundle
-.config
-.rspec
-.yardoc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*
+
+# Project-specific ignores
+.rspec
+
+# VSCode
+.vscode
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+# JetBrains
+.idea

data/.rubocop.yml

@@ -5,3 +5,12 @@ inherit_gem:
 
 AllCops:
   TargetRubyVersion: 3.0
+
+Metrics/AbcSize:
+  Max: 60
+
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 11

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v10.0.0 17th May 2022
+
+### Changed
+- Added support for Ruby 3.1 [#462](https://github.com/gocardless/statesman/pull/462)
+- Removed support for Ruby 2.5 and 2.6 [#462](https://github.com/gocardless/statesman/pull/462)
+- Added `remove_state` and `remove_transitions` methods to `Statesman::Machine` [#464](https://github.com/gocardless/statesman/pull/464)
+
 ## v9.0.1 4th February 2021
 
 ### Changed

data/README.md

@@ -30,7 +30,7 @@ protection.
 To get started, just add Statesman to your `Gemfile`, and then run `bundle`:
 
 ```ruby
-gem 'statesman', '~> 8.0.3'
+gem 'statesman', '~> 10.0.0'
 ```
 
 ## Usage
@@ -116,6 +116,52 @@ Order.in_state(:cancelled) # => [#<Order id: "123">]
 Order.not_in_state(:checking_out) # => [#<Order id: "123">]
 ```
 
+If you'd like, you can also define a template for a generic state machine, then alter classes which extend it as required:
+
+```ruby
+module Template
+  def define_states
+    state :a, initial: true
+    state :b
+    state :c
+  end
+
+  def define_transitions
+    transition from: :a, to: :b
+    transition from: :b, to: :c
+    transition from: :c, to: :a
+  end
+end
+
+class Circular
+  include Statesman::Machine
+  extend Template
+  
+  define_states
+  define_transitions
+end
+
+class Linear
+  include Statesman::Machine
+  extend Template
+  
+  define_states
+  define_transitions
+  
+  remove_transitions from: :c, to: :a
+end
+
+class Shorter
+  include Statesman::Machine
+  extend Template
+
+  define_states
+  define_transitions
+
+  remove_state :c
+end
+```
+
 ## Persistence
 
 By default Statesman stores transition history in memory only. It can be

data/lib/statesman/machine.rb

@@ -42,6 +42,17 @@ module Statesman
         states << name
       end
 
+      def remove_state(state_name)
+        state_name = state_name.to_s
+
+        remove_transitions(from: state_name)
+        remove_transitions(to: state_name)
+        remove_callbacks(from: state_name)
+        remove_callbacks(to: state_name)
+
+        @states.delete(state_name.to_s)
+      end
+
       def successors
         @successors ||= {}
       end
@@ -70,6 +81,20 @@ module Statesman
         successors[from] += to
       end
 
+      def remove_transitions(from: nil, to: nil)
+        raise ArgumentError, "Both from and to can't be nil!" if from.nil? && to.nil?
+        return if successors.nil?
+
+        if from.present?
+          @successors[from.to_s].delete(to.to_s) if to.present?
+          @successors.delete(from.to_s) if to.nil? || successors[from.to_s].empty?
+        elsif to.present?
+          @successors.
+            transform_values! { |to_states| to_states - [to.to_s] }.
+            filter! { |_from_state, to_states| to_states.any? }
+        end
+      end
+
       def before_transition(options = {}, &block)
         add_callback(callback_type: :before, callback_class: Callback,
                      from: options[:from], to: options[:to], &block)
@@ -151,6 +176,33 @@ module Statesman
           callback_class.new(from: from, to: to, callback: block)
       end
 
+      def remove_callbacks(from: nil, to: nil)
+        raise ArgumentError, "Both from and to can't be nil!" if from.nil? && to.nil?
+        return if callbacks.nil?
+
+        @callbacks.transform_values! do |callbacks|
+          filter_callbacks(callbacks, from: from, to: to)
+        end
+      end
+
+      def filter_callbacks(callbacks, from: nil, to: nil)
+        callbacks.filter_map do |callback|
+          next if callback.from == from && to.nil?
+
+          if callback.to.include?(to) && (from.nil? || callback.from == from)
+            next if callback.to == [to]
+
+            callback = Statesman::Callback.new({
+              from: callback.from,
+              to: callback.to - [to],
+              callback: callback.callback,
+            })
+          end
+
+          callback
+        end
+      end
+
       def validate_callback_type_and_class(callback_type, callback_class)
         raise ArgumentError, "missing keyword: callback_type" if callback_type.nil?
         raise ArgumentError, "missing keyword: callback_class" if callback_class.nil?

data/lib/statesman/version.rb

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

data/spec/statesman/machine_spec.rb

@@ -27,6 +27,112 @@ describe Statesman::Machine do
     end
   end
 
+  describe ".remove_state" do
+    subject(:remove_state) { -> { machine.remove_state(:x) } }
+
+    before do
+      machine.class_eval do
+        state :x
+        state :y
+        state :z
+      end
+    end
+
+    it "removes the state" do
+      expect(remove_state).
+        to change(machine, :states).
+        from(match_array(%w[x y z])).
+        to(%w[y z])
+    end
+
+    context "with a transition from the removed state" do
+      before { machine.transition from: :x, to: :y }
+
+      it "removes the transition" do
+        expect(remove_state).
+          to change(machine, :successors).
+          from({ "x" => ["y"] }).
+          to({})
+      end
+
+      context "with multiple transitions" do
+        before { machine.transition from: :x, to: :z }
+
+        it "removes all transitions" do
+          expect(remove_state).
+            to change(machine, :successors).
+            from({ "x" => %w[y z] }).
+            to({})
+        end
+      end
+    end
+
+    context "with a transition to the removed state" do
+      before { machine.transition from: :y, to: :x }
+
+      it "removes the transition" do
+        expect(remove_state).
+          to change(machine, :successors).
+          from({ "y" => ["x"] }).
+          to({})
+      end
+
+      context "with multiple transitions" do
+        before { machine.transition from: :z, to: :x }
+
+        it "removes all transitions" do
+          expect(remove_state).
+            to change(machine, :successors).
+            from({ "y" => ["x"], "z" => ["x"] }).
+            to({})
+        end
+      end
+    end
+
+    context "with a callback from the removed state" do
+      before do
+        machine.class_eval do
+          transition from: :x, to: :y
+          transition from: :x, to: :z
+          guard_transition(from: :x) { return false }
+          guard_transition(from: :x, to: :z) { return true }
+        end
+      end
+
+      let(:guards) do
+        [having_attributes(from: "x", to: []), having_attributes(from: "x", to: ["z"])]
+      end
+
+      it "removes the guard" do
+        expect(remove_state).
+          to change(machine, :callbacks).
+          from(a_hash_including(guards: match_array(guards))).
+          to(a_hash_including(guards: []))
+      end
+    end
+
+    context "with a callback to the removed state" do
+      before do
+        machine.class_eval do
+          transition from: :y, to: :x
+          guard_transition(to: :x) { return false }
+          guard_transition(from: :y, to: :x) { return true }
+        end
+      end
+
+      let(:guards) do
+        [having_attributes(from: nil, to: ["x"]), having_attributes(from: "y", to: ["x"])]
+      end
+
+      it "removes the guard" do
+        expect(remove_state).
+          to change(machine, :callbacks).
+          from(a_hash_including(guards: match_array(guards))).
+          to(a_hash_including(guards: []))
+      end
+    end
+  end
+
   describe ".retry_conflicts" do
     subject(:transition_state) do
       described_class.retry_conflicts(retry_attempts) do
@@ -170,6 +276,42 @@ describe Statesman::Machine do
     end
   end
 
+  describe ".remove_transitions" do
+    before do
+      machine.class_eval do
+        state :x
+        state :y
+        state :z
+        transition from: :x, to: :y
+        transition from: :x, to: :z
+        transition from: :y, to: :z
+      end
+    end
+
+    let(:initial_successors) { { "x" => %w[y z], "y" => ["z"] } }
+
+    it "removes the correct transitions when given a from state" do
+      expect { machine.remove_transitions(from: :x) }.
+        to change(machine, :successors).
+        from(initial_successors).
+        to({ "y" => ["z"] })
+    end
+
+    it "removes the correct transitions when given a to state" do
+      expect { machine.remove_transitions(to: :z) }.
+        to change(machine, :successors).
+        from(initial_successors).
+        to({ "x" => ["y"] })
+    end
+
+    it "removes the correct transitions when given a from and to state" do
+      expect { machine.remove_transitions(from: :x, to: :z) }.
+        to change(machine, :successors).
+        from(initial_successors).
+        to({ "x" => ["y"], "y" => ["z"] })
+    end
+  end
+
   describe ".validate_callback_condition" do
     before do
       machine.class_eval do

data/statesman.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = ">= 2.5"
+  spec.required_ruby_version = ">= 2.7"
 
   spec.add_development_dependency "ammeter", "~> 1.1"
   spec.add_development_dependency "bundler", "~> 2"
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   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_junit_formatter", "~> 0.4.0"
+  spec.add_development_dependency "rspec_junit_formatter", "~> 0.5.1"
   spec.add_development_dependency "rspec-rails", "~> 3.1"
   spec.add_development_dependency "sqlite3", "~> 1.4.2"
   spec.add_development_dependency "timecop", "~> 0.9.1"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: statesman
 version: !ruby/object:Gem::Version
-  version: 9.0.1
+  version: 10.0.0
 platform: ruby
 authors:
 - GoCardless
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2022-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ammeter
@@ -168,14 +168,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -298,7 +298,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="