business_flow 0.19.6 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e3d7a4e0a69860a84583948ad6d3b6189619629e2b6b8a3dac4bdc10c5467c8d
-  data.tar.gz: b3ae0a3456b06ad06826cd55f1c0a7b0c1f5d2789d5d4514b8a155603fb28388
+  metadata.gz: d9d5e39246745984117d29b635e976b219dd98849fa878925c740b9abdd0f499
+  data.tar.gz: bc30bd5baf31d6ed5305b830506bbf6ae777ccd4f001c74faa0971498af31ec8
 SHA512:
-  metadata.gz: '08d17ede87236b175510b8e08d9f09815e77f24dd922d3abd5bbd22f447a6a6abbde9f7a3ab36158b70a9dbde879c0ab7949524c39da2162dd66cf16149c87cd'
-  data.tar.gz: e738a183b1fc48a0632eb4db0f6c3212b1e270d1e36f3fcdee7bbe1b1c2e0c6655de48036f66f25e7aa289f7b46cbe561e7f9b524534a05e1b9c836719a7e937
+  metadata.gz: efc19e3d43bdb141d74450bcb303b668fd8a6b50077cd7174f2ad71fa76a6218c22a015295f8e95639e1752342b16633ab3e84c793c8417d6ada013f52cfeee0
+  data.tar.gz: 2c231d90e0b1e32f8ff1eb15f844f1d563065c5ed34d533b2be3852d007d677bfaf22b395b98a696e2415599e78c463470735f4bb83a60955cc78cb08644c3dd

data/.circleci/config.yml

@@ -0,0 +1,81 @@
+version: 2.1
+
+orbs:
+  ruby: circleci/ruby@2.5.3
+
+references:
+  RUBY_IMAGE: &RUBY_IMAGE
+    cimg/ruby:3.3.9
+  RUBY_DEPS: &RUBY_DEPS
+    include-branch-in-cache-key: false
+    clean-bundle: true
+    key: gems-v2
+
+jobs:
+  refresh_ruby_deps:
+    docker:
+      - image: *RUBY_IMAGE
+    environment:
+      BUNDLE_JOBS: '2'
+      MALLOC_ARENA_MAX: '2'
+      BUNDLE_RETRY: '3'
+    steps:
+      - checkout
+      - run: 'rm .ruby-*'
+      - ruby/install-deps:
+          <<: *RUBY_DEPS
+  rubocop:
+    docker:
+      - image: *RUBY_IMAGE
+    steps:
+      - checkout
+      - run: 'rm .ruby-*'
+      - ruby/install-deps:
+          <<: *RUBY_DEPS
+      - run: bundle exec rubocop
+  reek:
+    docker:
+      - image: *RUBY_IMAGE
+    steps:
+      - checkout
+      - run: 'rm .ruby-*'
+      - ruby/install-deps:
+          <<: *RUBY_DEPS
+      - run: bundle exec reek
+  rspec:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    steps:
+      - checkout
+      - 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:
+    jobs:
+      - refresh_ruby_deps
+      - rubocop:
+          requires:
+            - refresh_ruby_deps
+      - reek:
+          requires:
+            - refresh_ruby_deps
+      - rspec:
+          matrix:
+            parameters:
+              ruby-version:
+                - "3.1.6"
+                - "3.2.9"
+                - "3.3.9"
+                - "3.4.6"

data/.reek.yml

@@ -1,6 +1,9 @@
 # Auto generated by Reeks --todo flag
 ---
 detectors:
+  ControlParameter:
+    exclude:
+    - BusinessFlow::ClusterLock#read_attribute_for_validation
   FeatureEnvy:
     exclude:
     - BusinessFlow::ClusterLock::ClassMethods::LockFailure#add_to
@@ -11,3 +14,5 @@ detectors:
     # N.B. If we want to enable this, we need to tweak the RuboCop config.  In particular, RuboCop
     # prefers `e` for exceptions.
     enabled: false
+exclude_paths:
+  - vendor # For CircleCI.

data/.rubocop.yml

@@ -1,11 +1,15 @@
-require:
+plugins:
 - rubocop-rspec
+- rubocop-rspec_rails
+- rubocop-rake
 
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
   NewCops: enable
   Exclude:
     - coverage/**/*
+    - gemfiles/**/*
+    - vendor/bundle/**/* # For CircleCI.  Siiiiigh.
 
 # Excluding specs here because of RSpec's tendency to look at the line-number info on a backtrace to
 # decide what to show you when a matcher fails.  I.E. a very long line may be needed to ensure you
@@ -18,6 +22,9 @@ Layout/LineLength:
 RSpec/MultipleMemoizedHelpers:
   Enabled: false
 
+RSpec/IncludeExamples:
+  Enabled: false
+
 RSpec/IndexedLet:
   # We have specs that are describing process steps, so... numbers are kinda the best way to describe that.
   Enabled: false
@@ -48,10 +55,6 @@ Style/RescueModifier:
 Style/DocumentDynamicEvalDefinition:
   Enabled: false
 
-# Explicit is bettr than implicit.
-FactoryBot/SyntaxMethods:
-  Enabled: false
-
 # For `match(hash_including(...))`, in specs, this rule would make things pretty unreadable.
 Layout/ClosingParenthesisIndentation:
   Exclude:

data/.ruby-version

@@ -1 +1 @@
-ruby-2.7.4
+ruby-3.3.9

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## 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/README.md

@@ -30,9 +30,23 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Running Tests
+
+```bash
+# To test against all supported ActiveModel versions:
+appraisal rspec
+
+# To test against a specific ActiveModel version:
+appraisal activemodel-5.2 rspec
+
+# Validate code quality:
+rubocop
+reek # N.B. RSpec runs _some_ reek tests, but not _all_!
+```
+
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/business_flow.
+Bug reports and pull requests are welcome on GitHub at <https://github.com/GoCarrot/business_flow>.
 
 ## License
 

data/bin/setup

@@ -5,4 +5,10 @@ set -vx
 
 bundle install
 
+if which rbenv >/dev/null; then
+  rbenv rehash
+fi
+
+appraisal install
+
 # Do any other automated setup that you need to do here

data/business_flow.gemspec

@@ -15,16 +15,16 @@ 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) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activemodel', '>= 4.2', '< 8'
-  spec.add_dependency 'activesupport', '>= 4.2', '< 8'
+  spec.add_dependency 'activemodel', '>= 4.2', '< 8.1'
+  spec.add_dependency 'activesupport', '>= 4.2', '< 8.1'
 
   spec.metadata['rubygems_mfa_required'] = 'true'
 
-  spec.required_ruby_version = '>= 2.7.0'
+  spec.required_ruby_version = '>= 3.1.0'
 end

data/lib/business_flow/cacheable.rb

@@ -108,7 +108,7 @@ module BusinessFlow
         instrument(:cache, flow) do |payload|
           payload[:cache_hit] = true if payload
           cache_store.fetch(flow.cache_key,
-                            cache_options.to_store_options(flow)) do
+                            cache_options.to_store_options(flow)) do # rubocop:disable Lint/UselessDefaultValueArgument
             payload[:cache_hit] = false if payload
             yield
           end

data/lib/business_flow/callable.rb

@@ -55,7 +55,7 @@ module BusinessFlow
       instance_eval %{
         def call(instance, inputs)
           instance.instance_exec(
-            #{@callable.arity.zero? ? '' : 'inputs, '}&@callable
+            #{'inputs, ' unless @callable.arity.zero?}&@callable
           )
         end
       }, __FILE__, __LINE__ - 6

data/lib/business_flow/cluster_lock.rb

@@ -45,7 +45,7 @@ module BusinessFlow
       if key == :cluster_lock
         ClassMethods.lock_name(self)
       else
-        super(key)
+        super
       end
     end
 
@@ -107,7 +107,7 @@ module BusinessFlow
 
       def build(parameter_object)
         add_cluster_luck_info_to_result_class
-        super(parameter_object)
+        super
       end
 
       def execute(flow)
@@ -186,11 +186,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
 
@@ -208,7 +207,7 @@ module BusinessFlow
         end
       end
 
-      def self.with_lock(flow, lock_info, &_blk)
+      def self.with_lock(flow, lock_info, &)
         unless BusinessFlow::ClusterLock.disabled?
           zk_connection, lock =
             instrumented_acquire_lock(flow, lock_info)

data/lib/business_flow/dsl.rb

@@ -65,10 +65,10 @@ module BusinessFlow
       end
 
       # Allows a field to be retrieved from the initialiaztion parameters
-      def wants(field, default = nil, opts = {}, &blk)
+      def wants(field, default = nil, opts = {}, &)
         internal_name = :"wants_#{field}"
         default = proc {} unless default || block_given?
-        uses(internal_name, default, opts, &blk)
+        uses(internal_name, default, opts, &)
         inputs.add_wants(ParameterField.new(field, internal_name))
       end
 
@@ -238,7 +238,7 @@ module BusinessFlow
         key
       end
 
-      # Provides the miniimum necessary instance methods to support the use of
+      # Provides the minimum necessary instance methods to support the use of
       # ActiveMode::Errors, outside of what's provided by ActiveModel::Naming
       module InstanceMethods
         def read_attribute_for_validation(key)
@@ -270,11 +270,33 @@ module BusinessFlow
       klass.step_executor.new(klass.step_queue, self).call
     end
 
+    def errors
+      @errors ||= ActiveModel::Errors.new(self)
+    end
+
+    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&.present?
+    end
+
+    def valid?(_context = nil)
+      # We're explicitly using the instance variable here so that if no
+      # errors have been created, we don't initialize the error object.
+      @errors.blank?
+    end
+
+    def invalid?(context = nil)
+      !valid?(context)
+    end
+
+    private
+
     # Responsible for setting the parameter object and validating inputs.
     # This is a method directly on the object instead of something we
     # handle through instance_eval/exec for performance reasons.
     # :reek:NilCheck This is where we ensure that our needs are non-nil.
-    private def _business_flow_dsl_initialize(parameter_object, needs)
+    def _business_flow_dsl_initialize(parameter_object, needs)
       @parameter_object = parameter_object
       needs.each do |need|
         if send(need).nil?
@@ -286,7 +308,7 @@ module BusinessFlow
     end
 
     # :reek:NilCheck
-    private def _business_flow_parameter_fetch(key)
+    def _business_flow_parameter_fetch(key)
       value = _business_flow_parameter_inner_fetch(key)
       # We only want to fall back to a default if we were
       # given nil. Other falsy vlues should be directly used.
@@ -295,7 +317,7 @@ module BusinessFlow
       value
     end
 
-    private def _business_flow_parameter_inner_fetch(key)
+    def _business_flow_parameter_inner_fetch(key)
       if @parameter_object.is_a?(Hash) && @parameter_object.key?(key)
         @parameter_object[key]
       else
@@ -305,31 +327,11 @@ module BusinessFlow
       nil
     end
 
-    private def _business_flow_dsl_parameters
+    def _business_flow_dsl_parameters
       @_business_flow_dsl_parameters ||=
         self.class.inputs.all.to_h { |input| [input, _business_flow_parameter_inner_fetch(input)] }
     end
 
-    def errors
-      @errors ||= ActiveModel::Errors.new(self)
-    end
-
-    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&.present?
-    end
-
-    def valid?(_context = nil)
-      # We're explicitly using the instance variable here so that if no
-      # errors have been created, we don't initialize the error object.
-      @errors.blank?
-    end
-
-    def invalid?(context = nil)
-      !valid?(context)
-    end
-
     # Responsible for creating fields on one or more classes and noting the of
     # field
     class FieldList

data/lib/business_flow/instrument.rb

@@ -17,7 +17,8 @@ module BusinessFlow
         if payload.is_a?(Hash)
           @payload = Step.new(Callable.new(proc { payload }), {})
         elsif payload || blk
-          @payload = Step.new(Callable.new(payload || blk), { default_output: :instrument_payload}.merge(opts))
+          @payload = Step.new(Callable.new(payload || blk),
+                              { default_output: :instrument_payload }.merge(opts))
         else
           @payload ||= Step.new(Callable.new(proc { {} }), opts)
         end

data/lib/business_flow/instrumented_step_executor.rb

@@ -7,7 +7,10 @@ module BusinessFlow
 
     def execute_step(step)
       i_name = event_name(step)
-      i_payload = { flow: flow, step: step }.merge(::BusinessFlow::Instrument::ClassMethods.instrument_payload(flow))
+      i_payload = { flow: flow,
+                    step: step }.merge(
+                      ::BusinessFlow::Instrument::ClassMethods.instrument_payload(flow)
+                    )
       ActiveSupport::Notifications.instrument(i_name, i_payload) do |payload|
         payload[:step_result] = super
       end
@@ -22,8 +25,6 @@ module BusinessFlow
       "business_flow.step.#{step_event_name(step)}"
     end
 
-  protected
-
     def flow_name
       @flow_name ||= flow.class.instrumentation_name
     end

data/lib/business_flow/step.rb

@@ -229,8 +229,6 @@ module BusinessFlow
       @callable.to_s
     end
 
-    private
-
     PARAMETERS_NO_INPUT = 'parameter_source'
     PARAMETERS_WITH_INPUT =
       '@input_object.parameters_from_source(parameter_source)'
@@ -244,7 +242,9 @@ module BusinessFlow
       else
         CONDITION_FAILED
       end
-    )
+    ).freeze
+
+    private
 
     def update_call_method
       params = @input_object ? PARAMETERS_WITH_INPUT : PARAMETERS_NO_INPUT

data/lib/business_flow/version.rb

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

data/lib/business_flow.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'active_model'
 require 'active_support/core_ext'
 require 'business_flow/compat'

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: business_flow
 version: !ruby/object:Gem::Version
-  version: 0.19.6
+  version: 0.21.0
 platform: ruby
 authors:
 - Alex Scarborough
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-09-17 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -19,7 +18,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +28,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -39,7 +38,7 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,14 +48,14 @@ dependencies:
         version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
-description:
+        version: '8.1'
 email:
 - alex@teak.io
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rspec"
@@ -64,8 +63,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
-- Gemfile
-- Gemfile.lock
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -93,7 +91,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,15 +98,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: General purpose management of service object flows
 test_files: []

data/Gemfile

@@ -1,18 +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.14.2'
-gem 'rake', '~> 13.0'
-gem 'reek', '~> 6.1'
-gem 'retryable', '~> 3.0.4'
-gem 'rspec', '~> 3.0'
-gem 'rubocop', '~> 1.59.0'
-gem 'rubocop-rspec', '~> 2.29.1'
-gem 'simplecov', '~> 0.22.0'
-gem 'timecop', '~> 0.9.1'

data/Gemfile.lock

@@ -1,122 +0,0 @@
-PATH
-  remote: .
-  specs:
-    business_flow (0.19.6)
-      activemodel (>= 4.2, < 8)
-      activesupport (>= 4.2, < 8)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (7.1.4)
-      activesupport (= 7.1.4)
-    activesupport (7.1.4)
-      base64
-      bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      connection_pool (>= 2.2.5)
-      drb
-      i18n (>= 1.6, < 2)
-      minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    ast (2.4.2)
-    base64 (0.2.0)
-    bigdecimal (3.1.8)
-    coderay (1.1.3)
-    concurrent-ruby (1.3.4)
-    connection_pool (2.4.1)
-    diff-lcs (1.5.1)
-    docile (1.4.1)
-    drb (2.2.1)
-    i18n (1.14.6)
-      concurrent-ruby (~> 1.0)
-    json (2.7.2)
-    kwalify (0.7.2)
-    language_server-protocol (3.17.0.3)
-    method_source (1.1.0)
-    minitest (5.25.1)
-    mutex_m (0.2.0)
-    parallel (1.26.3)
-    parser (3.2.2.4)
-      ast (~> 2.4.1)
-      racc
-    pry (0.14.2)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
-    racc (1.8.1)
-    rainbow (3.1.1)
-    rake (13.2.1)
-    reek (6.1.4)
-      kwalify (~> 0.7.0)
-      parser (~> 3.2.0)
-      rainbow (>= 2.0, < 4.0)
-    regexp_parser (2.9.2)
-    retryable (3.0.5)
-    rexml (3.3.7)
-    rspec (3.13.0)
-      rspec-core (~> 3.13.0)
-      rspec-expectations (~> 3.13.0)
-      rspec-mocks (~> 3.13.0)
-    rspec-core (3.13.1)
-      rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.3)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
-    rubocop (1.59.0)
-      json (~> 2.3)
-      language_server-protocol (>= 3.17.0)
-      parallel (~> 1.10)
-      parser (>= 3.2.2.4)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.30.0)
-      parser (>= 3.2.1.0)
-    rubocop-capybara (2.21.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.26.0)
-      rubocop (~> 1.41)
-    rubocop-rspec (2.29.2)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.29.0)
-      rubocop (~> 1.40)
-    ruby-progressbar (1.13.0)
-    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)
-    timecop (0.9.10)
-    tzinfo (2.0.6)
-      concurrent-ruby (~> 1.0)
-    unicode-display_width (2.6.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  business_flow!
-  pry (~> 0.14.2)
-  rake (~> 13.0)
-  reek (~> 6.1)
-  retryable (~> 3.0.4)
-  rspec (~> 3.0)
-  rubocop (~> 1.59.0)
-  rubocop-rspec (~> 2.29.1)
-  simplecov (~> 0.22.0)
-  timecop (~> 0.9.1)
-
-BUNDLED WITH
-   2.3.6