business_flow 0.20.0 → 0.21.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629b01be7c90cd6bd0d11524bda269fc640863487e2a45a59d739497938d0ac9
-  data.tar.gz: 7e3b3799817d2e8d451da79b266ebb9329f6db311c707ae1608471813f5ecb9f
+  metadata.gz: 58b3100df6d7fe1c1a09846cec4cd3df8692e7c8ab6a1a5f59387bddd116adf9
+  data.tar.gz: cc3a48bc0b5cb9932b921ebabfab8ceaf5ce64b292f7eed5e2c48e58f37912c7
 SHA512:
-  metadata.gz: 1b9affb629f4994fe84655c081d429ef056e221c59739d926ee87205d2febb7ab314beda318f0f7f94b38f215ddcd3588b4f813be38918d43496ad6ce0fa066c
-  data.tar.gz: 2fa9f60dd2d93f674ccf0473ebeb44ac8545d3a2f34cf2a815111a8bc934311bb0b07a205d6d5bd3ef7b84830859c2daa3e4bc07c7ad9819650127050e1c8124
+  metadata.gz: a50eaa3074e7369e57ff20f715f77c332fbea9dc2f2904fb8cbe84e8aafcc20f0b7dc1f7c3d9681642b7b3b6db8106d8ab6bad6367368e93a81145db6a7f6381
+  data.tar.gz: 4ce3770b14b51f01b77e0bbe57d990fe0ea6156539a5154afe99a99436cd07b0ff9787b7da1a4d5757adff719d0bcbe7842f72f996c9b9578ee5eb0453c7143c

data/.circleci/config.yml

@@ -1,24 +1,11 @@
 version: 2.1
 
-setup: true
-
 orbs:
   ruby: circleci/ruby@2.5.3
 
-executors:
-  docker: # Docker using the Base Convenience Image
-    docker:
-      - image: cimg/base:stable
-  # linux: # a Linux VM running Ubuntu 20.04
-  #   machine:
-  #     image: ubuntu-2004:202107-02
-  # macos: # macos executor running Xcode
-  #   macos:
-  #     xcode: 14.2.0
-
 references:
   RUBY_IMAGE: &RUBY_IMAGE
-    cimg/ruby:3.3.7
+    cimg/ruby:3.3.9
   RUBY_DEPS: &RUBY_DEPS
     include-branch-in-cache-key: false
     clean-bundle: true
@@ -57,19 +44,22 @@ jobs:
       - run: bundle exec reek
   rspec:
     parameters:
-      os:
-        type: executor
       ruby-version:
         type: string
-    executor: << parameters.os >>
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
     steps:
       - checkout
-      - run: 'rm .ruby-*'
-      - ruby/install:
-          version: << parameters.ruby-version >>
-      - run: bundle
-      - run: appraisal install
-      - run: appraisal rspec --format p
+      - restore_cache:
+          key: v3-business_flow-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+      - run: bundle config set --local path 'vendor/bundle'
+      - run: bundle install
+      - run: bundle exec appraisal install --path 'vendor/bundle'
+      - save_cache:
+          key: v3-business_flow-<< parameters.ruby-version >>-{{ checksum "Gemfile.lock" }}-{{ checksum "Appraisals" }}
+          paths:
+            - ~/project/vendor/bundle
+      - run: bundle exec appraisal rspec --format p
 
 workflows:
   full:
@@ -84,12 +74,8 @@ workflows:
       - rspec:
           matrix:
             parameters:
-              os:
-                - docker
-                # - linux
-                # - macos # Disabled because macOS testing isn't worth sorting out why GPG isn't present.
               ruby-version:
-                - "3.1.7"
-                - "3.2.8"
-                - "3.3.8"
-                - "3.4.3"
+                - "3.1.6"
+                - "3.2.9"
+                - "3.3.9"
+                - "3.4.6"

data/.ruby-version

@@ -1 +1 @@
-ruby-3.1.6
+ruby-3.3.9

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+## 0.21.1
+
+ENHANCEMENTS:
+
+* Added #failure_exception= to flow classes for setting an exception causing a failure. Setting an exception also fails the flow execution.
+* Added #exception to flow result classes for reading the exception causing a failure.
+* Set #exception as the cause: on FlowFailedException.
+* ClusterLock now propogates Zookeeper errors through failure_exception and the case on its LockFailure exception.
+
+## 0.21.0
+
+BUG FIXES:
+
+* Resolved issue that could result in ClusterLock continuing to hold lock in the event of a Zookeeper error during the unlock process.

data/business_flow.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(test|spec|features|gemfiles)/|(Appraisals|Gemfile)})
   end
   spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }

data/lib/business_flow/cluster_lock.rb

@@ -3,6 +3,35 @@
 module BusinessFlow
   # Mixin for business flow to acquire and retain a cluster lock.
   module ClusterLock
+    # Error raised when there is an internal issue with acquiring a lock.
+    class LockFailure < StandardError
+      attr_reader :error_type
+
+      def initialize(error_type, message)
+        @error_type = error_type
+        super(message)
+      end
+
+      def add_to(flow)
+        errors = flow.errors
+        unless errors.key?(:cluster_lock)
+          BusinessFlow.add_error(errors, :cluster_lock, error_type, message)
+        end
+        flow.failure_exception = self
+        flow
+      end
+    end
+
+    # Holder for information about the lock
+    class LockInfo
+      attr_reader :lock_name, :zookeeper_servers
+
+      def initialize(lock_name, zookeeper_servers)
+        @lock_name = lock_name
+        @zookeeper_servers = zookeeper_servers
+      end
+    end
+
     def self.included(klass)
       klass.extend(ClassMethods)
     end
@@ -51,34 +80,6 @@ module BusinessFlow
 
     # DSL Methods
     module ClassMethods # rubocop:disable Metrics/ModuleLength
-      # Error raised when there is an internal issue with acquiring a lock.
-      class LockFailure < StandardError
-        attr_reader :error_type
-
-        def initialize(error_type, message)
-          @error_type = error_type
-          super(message)
-        end
-
-        def add_to(flow)
-          errors = flow.errors
-          unless errors.key?(:cluster_lock)
-            BusinessFlow.add_error(errors, :cluster_lock, error_type, message)
-          end
-          flow
-        end
-      end
-
-      # Holder for information about the lock
-      class LockInfo
-        attr_reader :lock_name, :zookeeper_servers
-
-        def initialize(lock_name, zookeeper_servers)
-          @lock_name = lock_name
-          @zookeeper_servers = zookeeper_servers
-        end
-      end
-
       def with_cluster_lock(lock_name = nil, opts = {}, &blk)
         if lock_name.is_a?(String)
           @lock_name = Step.new(Callable.new(proc { lock_name }), {})
@@ -186,11 +187,10 @@ module BusinessFlow
       end
 
       def self.cleanup(lock, zk_connection)
-        begin
-          lock&.unlock
-        rescue ZK::Exceptions::OperationTimeOut
-          # Just let the connection close handle this.
-        end
+        lock&.unlock
+      rescue ZK::Exceptions::OperationTimeOut
+        # Just let the connection close handle this.
+      ensure
         zk_connection&.close!
       end
 
@@ -217,7 +217,7 @@ module BusinessFlow
       rescue ZK::Exceptions::LockAssertionFailedError, ZK::Exceptions::OperationTimeOut => e
         # This would occur if we asserted a cluster lock while executing the flow.
         # This will have set an error on the flow, so we can carry on.
-        raise LockFailure.new(exception_to_error_type(e), e.message)
+        raise LockFailure.new(exception_to_error_type(e), e.message), cause: e
       ensure
         cleanup(lock, zk_connection)
       end

data/lib/business_flow/dsl.rb

@@ -128,7 +128,7 @@ module BusinessFlow
 
       def call!(*args)
         flow = call(*args)
-        raise FlowFailedException, flow if flow.errors?
+        raise FlowFailedException, flow, cause: flow.exception if flow.errors?
 
         flow
       end
@@ -154,7 +154,8 @@ module BusinessFlow
         # We use instance_variable_get here instead of making it part of
         # from_flow to ensure that we do not create the errors object unless
         # we need it.
-        result = const_get(:Result).new(flow.instance_variable_get(:@errors))
+        result = const_get(:Result).new(flow.instance_variable_get(:@errors),
+                                        flow.send(:failure_exception))
         result.from_flow(flow) if @result_copy
         result
       end
@@ -205,8 +206,11 @@ module BusinessFlow
 
     RESULT_DEF = %(
       class Result
-        def initialize(errors)
+        attr_reader :exception
+
+        def initialize(errors, exception)
           @errors = errors
+          @exception = exception
         end
 
         def errors
@@ -216,7 +220,7 @@ module BusinessFlow
         def errors?
           # We're explicitly using the instance variable here so that if no
           # errors have been created, we don't initialize the error object.
-          !!@errors && @errors.present?
+          (!!@errors && @errors.present?) || !exception.nil?
         end
 
         def valid?(_context = nil)
@@ -263,6 +267,9 @@ module BusinessFlow
     attr_reader :parameter_object
     private :parameter_object
 
+    attr_accessor :failure_exception
+    private :failure_exception
+
     def call
       return if invalid?
 

data/lib/business_flow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BusinessFlow
-  VERSION = '0.20.0'
+  VERSION = '0.21.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.1
 platform: ruby
 authors:
 - Alex Scarborough
@@ -63,30 +63,13 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
-- Appraisals
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - business_flow.gemspec
-- gemfiles/.bundle/config
-- gemfiles/activemodel_4.2.gemfile
-- gemfiles/activemodel_4.2.gemfile.lock
-- gemfiles/activemodel_5.2.gemfile
-- gemfiles/activemodel_5.2.gemfile.lock
-- gemfiles/activemodel_6.1.gemfile
-- gemfiles/activemodel_6.1.gemfile.lock
-- gemfiles/activemodel_7.0.gemfile
-- gemfiles/activemodel_7.0.gemfile.lock
-- gemfiles/activemodel_7.1.gemfile
-- gemfiles/activemodel_7.1.gemfile.lock
-- gemfiles/activemodel_7.2.gemfile
-- gemfiles/activemodel_7.2.gemfile.lock
-- gemfiles/activemodel_8.0.gemfile
-- gemfiles/activemodel_8.0.gemfile.lock
 - lib/business_flow.rb
 - lib/business_flow/base.rb
 - lib/business_flow/cacheable.rb
@@ -122,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: General purpose management of service object flows
 test_files: []

data/Appraisals

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-if RUBY_ENGINE == 'ruby' && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.4.0')
-  appraise 'activemodel-4.2' do
-    source 'https://teak_io_199:6YKvtYgoo5R8_zxD@gems.railslts.com' do
-      gem 'activemodel', '~> 4.2.11'
-      gem 'activesupport', '~> 4.2.11'
-    end
-  end
-
-  appraise 'activemodel-5.2' do
-    source 'https://teak_io_199:6YKvtYgoo5R8_zxD@gems.railslts.com' do
-      gem 'activemodel', '~> 5.2.8'
-      gem 'activesupport', '~> 5.2.8'
-    end
-  end
-end
-
-appraise 'activemodel-6.1' do
-  source 'https://teak_io_199:6YKvtYgoo5R8_zxD@gems.railslts.com' do
-    gem 'activemodel', '~> 6.1.7'
-    gem 'activesupport', '~> 6.1.7'
-  end
-end
-
-if RUBY_ENGINE == 'ruby' && Gem::Version.new(RUBY_VERSION) < Gem::Version.new('3.4.0')
-  appraise 'activemodel-7.0' do
-    gem 'activemodel', '~> 7.0.8'
-    gem 'activesupport', '~> 7.0.8'
-  end
-end
-
-appraise 'activemodel-7.1' do
-  gem 'activemodel', '~> 7.1.3'
-  gem 'activesupport', '~> 7.1.3'
-end
-
-appraise 'activemodel-7.2' do
-  gem 'activemodel', '~> 7.2.1'
-  gem 'activesupport', '~> 7.2.1'
-end
-
-if RUBY_ENGINE == 'ruby' && Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('3.2.0')
-  appraise 'activemodel-8.0' do
-    gem 'activemodel', '~> 8.0.0'
-    gem 'activesupport', '~> 8.0.0'
-  end
-end

data/Gemfile

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in business_flow.gemspec
-gemspec
-
-gem 'pry', '~> 0.15.2'
-gem 'rake', '~> 13.0'
-gem 'reek', '~> 6.1'
-gem 'retryable', '~> 3.0.4'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.59'
-gem 'rubocop-factory_bot', '~> 2.27'
-gem 'rubocop-rspec', '~> 3.0'
-gem 'rubocop-rspec_rails', '~> 2.31'
-gem 'rubocop-rake', '~> 0.7.0'
-gem 'simplecov', '~> 0.22.0'
-gem 'timecop', '~> 0.9.1'
-
-gem 'ruby3-backward-compatibility'
-
-gem 'appraisal', '~> 2.5.0'

data/Gemfile.lock

@@ -1,175 +0,0 @@
-PATH
-  remote: .
-  specs:
-    business_flow (0.20.0)
-      activemodel (>= 4.2, < 8.1)
-      activesupport (>= 4.2, < 8.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.1.5.1)
-      activesupport (= 7.1.5.1)
-    activesupport (7.1.5.1)
-      base64
-      benchmark (>= 0.3)
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      logger (>= 1.4.2)
-      minitest (>= 5.1)
-      mutex_m
-      securerandom (>= 0.3)
-      tzinfo (~> 2.0)
-    appraisal (2.5.0)
-      bundler
-      rake
-      thor (>= 0.14.0)
-    ast (2.4.3)
-    base64 (0.3.0)
-    benchmark (0.4.1)
-    bigdecimal (3.2.2)
-    coderay (1.1.3)
-    concurrent-ruby (1.3.5)
-    connection_pool (2.5.3)
-    diff-lcs (1.6.2)
-    docile (1.4.1)
-    drb (2.2.3)
-    dry-configurable (1.3.0)
-      dry-core (~> 1.1)
-      zeitwerk (~> 2.6)
-    dry-core (1.1.0)
-      concurrent-ruby (~> 1.0)
-      logger
-      zeitwerk (~> 2.6)
-    dry-inflector (1.2.0)
-    dry-initializer (3.2.0)
-    dry-logic (1.6.0)
-      bigdecimal
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.1)
-      zeitwerk (~> 2.6)
-    dry-schema (1.14.1)
-      concurrent-ruby (~> 1.0)
-      dry-configurable (~> 1.0, >= 1.0.1)
-      dry-core (~> 1.1)
-      dry-initializer (~> 3.2)
-      dry-logic (~> 1.5)
-      dry-types (~> 1.8)
-      zeitwerk (~> 2.6)
-    dry-types (1.8.3)
-      bigdecimal (~> 3.0)
-      concurrent-ruby (~> 1.0)
-      dry-core (~> 1.0)
-      dry-inflector (~> 1.0)
-      dry-logic (~> 1.4)
-      zeitwerk (~> 2.6)
-    i18n (1.14.7)
-      concurrent-ruby (~> 1.0)
-    json (2.12.2)
-    language_server-protocol (3.17.0.5)
-    lint_roller (1.1.0)
-    logger (1.7.0)
-    method_source (1.1.0)
-    minitest (5.25.5)
-    mutex_m (0.3.0)
-    parallel (1.27.0)
-    parser (3.3.8.0)
-      ast (~> 2.4.1)
-      racc
-    prism (1.4.0)
-    pry (0.15.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.3.0)
-    reek (6.5.0)
-      dry-schema (~> 1.13)
-      logger (~> 1.6)
-      parser (~> 3.3.0)
-      rainbow (>= 2.0, < 4.0)
-      rexml (~> 3.1)
-    regexp_parser (2.10.0)
-    retryable (3.0.5)
-    rexml (3.4.1)
-    rspec (3.13.1)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.5)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.5)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.4)
-    rubocop (1.78.0)
-      json (~> 2.3)
-      language_server-protocol (~> 3.17.0.2)
-      lint_roller (~> 1.1.0)
-      parallel (~> 1.10)
-      parser (>= 3.3.0.2)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 2.9.3, < 3.0)
-      rubocop-ast (>= 1.45.1, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.45.1)
-      parser (>= 3.3.7.2)
-      prism (~> 1.4)
-    rubocop-factory_bot (2.27.1)
-      lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
-    rubocop-rake (0.7.1)
-      lint_roller (~> 1.1)
-      rubocop (>= 1.72.1)
-    rubocop-rspec (3.6.0)
-      lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
-    rubocop-rspec_rails (2.31.0)
-      lint_roller (~> 1.1)
-      rubocop (~> 1.72, >= 1.72.1)
-      rubocop-rspec (~> 3.5)
-    ruby-progressbar (1.13.0)
-    ruby3-backward-compatibility (1.5.0)
-    securerandom (0.3.2)
-    simplecov (0.22.0)
-      docile (~> 1.1)
-      simplecov-html (~> 0.11)
-      simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.13.1)
-    simplecov_json_formatter (0.1.4)
-    thor (1.3.2)
-    timecop (0.9.10)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
-    zeitwerk (2.6.18)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  appraisal (~> 2.5.0)
-  business_flow!
-  pry (~> 0.15.2)
-  rake (~> 13.0)
-  reek (~> 6.1)
-  retryable (~> 3.0.4)
-  rspec (~> 3.0)
-  rubocop (~> 1.59)
-  rubocop-factory_bot (~> 2.27)
-  rubocop-rake (~> 0.7.0)
-  rubocop-rspec (~> 3.0)
-  rubocop-rspec_rails (~> 2.31)
-  ruby3-backward-compatibility
-  simplecov (~> 0.22.0)
-  timecop (~> 0.9.1)
-
-BUNDLED WITH
-   2.6.9

data/gemfiles/.bundle/config

@@ -1,2 +0,0 @@
----
-BUNDLE_RETRY: "1"

data/gemfiles/activemodel_4.2.gemfile

@@ -1,24 +0,0 @@
-# This file was generated by Appraisal
-
-source "https://rubygems.org"
-
-gem "pry", "~> 0.15.2"
-gem "rake", "~> 13.0"
-gem "reek", "~> 6.1.0"
-gem "retryable", "~> 3.0.4"
-gem "rspec", "~> 3.0"
-gem "rubocop", "~> 1.59"
-gem "rubocop-factory_bot", "~> 2.24"
-gem "rubocop-rspec", "~> 2.29"
-gem "rubocop-rspec_rails", "~> 2.28"
-gem "simplecov", "~> 0.22.0"
-gem "timecop", "~> 0.9.1"
-gem "appraisal", "~> 2.5.0"
-gem "ruby3-backward-compatibility"
-
-source 'https://teak_io_199:6YKvtYgoo5R8_zxD@gems.railslts.com' do
-  gem "activemodel", "~> 4.2.11"
-  gem "activesupport", "~> 4.2.11"
-end
-
-gemspec path: "../"