flow 0.10.8 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b52c5f113180717df9e242c75b51a80cff0ca0d246007c0adf99247f23137ede
-  data.tar.gz: 51245f2c5609c2788c79fa5a29df9201783c0071a8671f464d42d32b381537a8
+  metadata.gz: a2cbf274b4eeeec407044f9e1fa36f9adbb4e764c80fcddf8341faf71e2f579a
+  data.tar.gz: 3ba508665ba607fdabc7fe878199133ac5d194889eb4d911ec5b22656c47ef23
 SHA512:
-  metadata.gz: bb6a28b1fbed617b3143c2905bc6912a72b1847e54bcbfc69a26856b116a783d79b64455544d103a7c5cdcef85ffab2928aa325ea8c7b1dad5f32055f0657bea
-  data.tar.gz: 38db040a5c7d17b287a46c739f75e16b61861005b9a0ca6b08775083372f9b479620b9f78cefe0cfa1b9cab6f8371cc239e4c6119e1f52dbdc4dbecd3fd6fe8e
+  metadata.gz: d18ff6721175ce0189f883775bcc0953375837248ce8645c36ef5684d70f1dd47eb74cf5449c3a1e5d9dd0957058bd73a17dbd806108d2892218d42d40434c08
+  data.tar.gz: 7f60552c0bde342aa962eb6afee720f5d58cfe90ab63794457219c83a63724056833a6b482e81f192ee406288dc434f47ddd3b98e59b3eca0703ba5050d55746

data/README.md

@@ -216,12 +216,12 @@ If the `Flow` fails you can see the failures on the instance:
 
 ## Wiki
 
-Learn more with our wiki [Getting Started](https://github.com/Freshly/flow/wiki/Getting-Started#installation) page.
+Learn more with our wiki [Getting Started](https://github.com/RubyAfterAll/flow/wiki/Getting-Started#installation) page.
 
 You also can download wiki to have offline access.
 Just simply do:
 
-`git clone git@github.com:Freshly/flow.wiki.git`
+`git clone git@github.com:RubyAfterAll/flow.wiki.git`
 
 
 ## License

data/lib/flow/concerns/transaction_wrapper.rb

@@ -7,6 +7,8 @@ module Flow
 
     class_methods do
       def transaction_provider
+        raise TransactionProviderNotDefined, "must explicitly define a transaction provider if ActiveRecord is not available" unless defined?(ActiveRecord)
+
         ActiveRecord::Base
       end
 

data/lib/flow/flow_base.rb

@@ -10,7 +10,7 @@ require_relative "flow/trigger"
 
 # A **Flow** is a collection of procedurally executed **Operations** sharing a common **State**.
 module Flow
-  class FlowBase < RootObject
+  class FlowBase < Substance::RootObject
     include Conjunction::Junction
     suffixed_with "Flow"
 

data/lib/flow/operation/accessors.rb

@@ -1,58 +1,56 @@
 # frozen_string_literal: true
 
+require "set"
+
 module Flow
   module Operation
     module Accessors
       extend ActiveSupport::Concern
 
       included do
-        class_attribute :_state_readers, instance_writer: false, default: []
-        class_attribute :_state_writers, instance_writer: false, default: []
-        class_attribute :_state_accessors, instance_writer: false, default: []
+        class_attribute :_state_readers, instance_writer: false, default: Set.new
+        class_attribute :_state_writers, instance_writer: false, default: Set.new
+        class_attribute :_state_accessors, instance_writer: false, default: Set.new
       end
 
-      class_methods do
+      module ClassMethods
         protected
 
-        def state_reader(name)
-          return unless _add_state_reader_tracker(name.to_sym)
+        def state_reader(*names, prefix: false)
+          names.each do |name|
+            delegate name, prefix: prefix, to: :state
 
-          delegate name, to: :state
+            _add_state_reader_tracker(name.to_sym)
+          end
         end
 
-        def state_writer(name)
-          return unless _add_state_writer_tracker(name.to_sym)
+        def state_writer(*names, prefix: false)
+          names.each do |name|
+            delegate "#{name}=", prefix: prefix, to: :state
 
-          delegate("#{name}=", to: :state)
+            _add_state_writer_tracker(name.to_sym)
+          end
         end
 
-        def state_accessor(name)
-          state_reader name
-          state_writer name
+        def state_accessor(*names, prefix: false)
+          names.each do |name|
+            state_reader name, prefix: prefix
+            state_writer name, prefix: prefix
+          end
         end
 
         private
 
         def _add_state_reader_tracker(name)
-          return false if _state_readers.include?(name)
-
-          _add_state_accessor_tracker(name) if _state_writers.include?(name)
+          _state_accessors << name if _state_writers.include?(name)
           _state_readers << name
         end
 
         def _add_state_writer_tracker(name)
-          return false if _state_writers.include?(name)
-
-          _add_state_accessor_tracker(name) if _state_readers.include?(name)
+          _state_accessors << name if _state_readers.include?(name)
           _state_writers << name
         end
 
-        def _add_state_accessor_tracker(name)
-          return if _state_accessors.include?(name)
-
-          _state_accessors << name
-        end
-
         def inherited(base)
           base._state_readers = _state_readers.dup
           base._state_writers = _state_writers.dup

data/lib/flow/operation/core.rb

@@ -15,7 +15,7 @@ module Flow
       class_methods do
         def state_proxy_class
           @state_proxy_class ||= Class.new(StateProxy).tap do |proxy_class|
-            delegate_method_names = _state_writers.map { |method_name| "#{method_name}=" } + _state_readers
+            delegate_method_names = _state_writers.map { |method_name| "#{method_name}=" } + _state_readers.to_a
             proxy_class.delegate(*delegate_method_names, to: :_state) if delegate_method_names.any?
           end
         end

data/lib/flow/operation_base.rb

@@ -11,7 +11,7 @@ require_relative "operation/transactions"
 
 # An **Operation** is a service object which is executed with a **State**.
 module Flow
-  class OperationBase < RootObject
+  class OperationBase < Substance::RootObject
     include TransactionWrapper
     include Operation::Accessors
     include Operation::Callbacks

data/lib/flow/rspec/shared_contexts/with_invalid_state.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Stubs a given flow to always fail when triggered.
+#
+# Usage:
+#   describe SomeFlow do
+#     let(:flow) { described_class.new(some: :arguments) }
+#
+#     include_context "with invalid state"
+#
+#     before { flow.trigger }
+#
+#     it "is failed" do
+#       expect(flow).not_to be_successful
+#       expect(flow.state.errors).to be_present
+#     end
+#   end
+#
+# Requires let variables to be defined in the inclusion context:
+# * invalid_state_class - the state class that will be used for the flow
+# * expected_state_errors - a hash in the form of:
+#     { attribute_name: :error_key
+#       # or:
+#       another_attributee: "error message!"
+#     }
+RSpec.shared_context "with invalid state" do
+  before do
+    allow(invalid_state_class).to receive(:new).and_wrap_original do |mtd, **kwargs|
+      mtd.call(**kwargs).tap do |state|
+        allow(state).to receive(:run_validations!).and_wrap_original do |run_validations|
+          run_validations.call
+
+          expected_state_errors.each do |attr, error|
+            state.errors.add(attr, error)
+          end
+
+          false
+        end
+      end
+    end
+  end
+end

data/lib/flow/rspec/shared_contexts.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative "shared_contexts/with_failing_operation"
+require_relative "shared_contexts/with_invalid_state"

data/lib/flow/spec_helper.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "spicerack/spec_helper"
+require "substance/rspec"
 
 require_relative "rspec/custom_matchers"
 require_relative "rspec/shared_contexts"

data/lib/flow/state_base.rb

@@ -1,15 +1,9 @@
 # frozen_string_literal: true
 
-require_relative "state/status"
-require_relative "state/output"
-
 # A **State** is an aggregation of input and derived data.
 module Flow
-  class StateBase < InputModel
+  class StateBase < Substance::OutputObject
     include Conjunction::Junction
     suffixed_with "State"
-
-    include State::Status
-    include State::Output
   end
 end

data/lib/flow/state_proxy.rb

@@ -13,7 +13,7 @@ module Flow
 
       ActiveSupport::Deprecation.warn(
         "Direct state access of `#{method_name}' on #{_state.inspect} will be removed in a future version of flow. "\
-        "Use a state accessor instead - for more information see github/freshly/flow/deprecation_notice"
+        "Use a state accessor instead - for more information see github/RubyAfterAll/flow/deprecation_notice"
       )
       _state.public_send(method_name, *arguments, &block)
     end

data/lib/flow/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Flow
-  VERSION = "0.10.8"
+  VERSION = "0.11.1"
 end

data/lib/flow.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "active_model"
-require "active_record"
 require "active_support"
 
-require "spicerack"
+require "conjunction"
 require "malfunction"
+require "substance"
 
 require_relative "flow/version"
 
@@ -15,10 +15,6 @@ require_relative "flow/concerns/transaction_wrapper"
 
 require_relative "flow/malfunction/base"
 
-# TODO: Remove inheritance nonsense, just use Substance once deprecation is removed from Spicerack
-class Flow::RootObject < (defined?(Substance::RootObject) ? Substance::RootObject : Spicerack::RootObject); end
-class Flow::InputModel < (defined?(Substance::InputModel) ? Substance::InputModel : Spicerack::InputModel); end
-
 require_relative "flow/flow_base"
 require_relative "flow/operation_base"
 require_relative "flow/state_base"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flow
 version: !ruby/object:Gem::Version
-  version: 0.10.8
+  version: 0.11.1
 platform: ruby
 authors:
 - Eric Garside
@@ -9,10 +9,10 @@ authors:
 - Jordan Minneti
 - Vinod Lala
 - Andrew Cross
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -29,7 +29,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.1
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -43,21 +43,27 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.1
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: conjunction
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.2.1
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: spicerack
+  name: short_circu_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -77,12 +83,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: short_circu_it
+  name: substance
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.26.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -92,7 +98,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 0.26.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -136,6 +142,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.2.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -224,16 +244,16 @@ dependencies:
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.0.1
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspice
   requirement: !ruby/object:Gem::Requirement
@@ -318,10 +338,9 @@ files:
 - lib/flow/rspec/custom_matchers/write_state.rb
 - lib/flow/rspec/shared_contexts.rb
 - lib/flow/rspec/shared_contexts/with_failing_operation.rb
+- lib/flow/rspec/shared_contexts/with_invalid_state.rb
 - lib/flow/rspec/shoulda_matcher_helper.rb
 - lib/flow/spec_helper.rb
-- lib/flow/state/output.rb
-- lib/flow/state/status.rb
 - lib/flow/state_base.rb
 - lib/flow/state_proxy.rb
 - lib/flow/version.rb
@@ -363,11 +382,11 @@ files:
 - lib/generators/rspec/state/USAGE
 - lib/generators/rspec/state/state_generator.rb
 - lib/generators/rspec/state/templates/state_spec.rb.erb
-homepage: https://github.com/Freshly/flow
+homepage: https://github.com/RubyAfterAll/flow
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -382,8 +401,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
-signing_key: 
+rubygems_version: 3.3.9
+signing_key:
 specification_version: 4
 summary: Write modular and reusable business logic that's understandable and maintainable.
 test_files: []

data/lib/flow/state/output.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-# Output data is created by Operations during runtime and CANNOT be validated or provided as part of the input.
-module Flow
-  module State
-    module Output
-      extend ActiveSupport::Concern
-
-      included do
-        class_attribute :_outputs, instance_writer: false, default: []
-
-        delegate :_outputs, to: :class
-
-        after_validation do
-          next unless validated?
-
-          _outputs.each do |key|
-            public_send("#{key}=".to_sym, _defaults[key].value) if _defaults.key?(key) && public_send(key).nil?
-          end
-        end
-      end
-
-      class_methods do
-        def inherited(base)
-          base._outputs = _outputs.dup
-          super
-        end
-
-        private
-
-        def output(output, default: nil, &block)
-          _outputs << output
-          define_attribute output
-          define_default output, static: default, &block
-          ensure_validation_before output
-          ensure_validation_before "#{output}=".to_sym
-        end
-
-        def ensure_validation_before(method)
-          around_method method do |*arguments|
-            raise NotValidatedError unless validated?
-
-            super(*arguments)
-          end
-        end
-      end
-
-      def outputs
-        return {} if _outputs.empty?
-
-        output_struct.new(*_outputs.map(&method(:public_send)))
-      end
-
-      def output_struct
-        Struct.new(*_outputs)
-      end
-    end
-  end
-end

data/lib/flow/state/status.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-# The State status is used to ensure and enforce internal consistency.
-module Flow
-  module State
-    module Status
-      extend ActiveSupport::Concern
-
-      included do
-        after_validation { self.was_validated = errors.empty? }
-
-        private
-
-        attr_accessor :was_validated
-      end
-
-      def validated?
-        was_validated.present?
-      end
-    end
-  end
-end