flow 0.10.7.1 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4b09f37dfcc377db4e42324939c1186fbd03208d5367c5fda86ebcb7fb222cd
-  data.tar.gz: f4f6807de901c271b41ee01f472af93c1f3a9faaf85100716d1c90566ad0c50a
+  metadata.gz: b58b685f68376d3cbb4e00e869d9f1a16d15ffb74fe13ed9c8088c89b5b915ca
+  data.tar.gz: 0a9028c03e0c7196f4feb4a2744f00262d3b2799e8752a87e95484a0344d47ef
 SHA512:
-  metadata.gz: 2f16953afacf89c36edd639732b0f9920627f849d57e8a8e2cf230fce6b0b0d1aaacd1a454c284df4b8d0507e551cf2119726e769034f4325d11b2f86c370d08
-  data.tar.gz: ef6883b589e23ab886982cc0b69a63fae39d2d90bd24cdb09728666f7568ab9d3f9ef6335e16bdb5d33eb4b8f6074c150e9ab352958dd0851003905a920957f6
+  metadata.gz: 9749b0bbbcb7a59ff426c81d0a1e5c05a913a383752afc641d8c90679b24f9a572873ad8efc9e7abaac8f19664f1b5e5e8b7474a71ab88f63abe04fcd1ba5bfa
+  data.tar.gz: ef93d1bd2d6e73f417daebb0c6884fb323677a9ff322eb7be8577506ce75c5b0596a161a56e716b18f049dc3c0625488f90995b00218ce2c648f9d91a10f73e1

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/errors.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Flow
+  class Error < StandardError; end
+
+  class FlowError < Error; end
+  class StateInvalidError < FlowError; end
+
+  class OperationError < Error; end
+  class AlreadyExecutedError < OperationError; end
+
+  class StateError < Error; end
+  class NotValidatedError < StateError; end
+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 < Spicerack::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 < Spicerack::RootObject
+  class OperationBase < Substance::RootObject
     include TransactionWrapper
     include Operation::Accessors
     include Operation::Callbacks

data/lib/flow/rspec/custom_matchers/have_on_state.rb

@@ -45,7 +45,7 @@ module Flow
       def matches?(object)
         @state_expectations.all? do |key, value|
           # If state is actually a StateProxy, we to access the state directly with _state
-          if object.state.respond_to?(:_state)
+          if object.state.respond_to?(:_state, true)
             expect(object.state.__send__(:_state).public_send(key)).to match value
           else
             expect(object.state.public_send(key)).to match value

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 < Spicerack::InputModel
+  class StateBase < Substance::OutputObject
     include Conjunction::Junction
     suffixed_with "State"
-
-    include State::Status
-    include State::Output
   end
 end

data/lib/flow/version.rb

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

data/lib/flow.rb

@@ -1,32 +1,21 @@
 # frozen_string_literal: true
 
 require "active_model"
-require "active_record"
 require "active_support"
 
-require "spicery"
+require "conjunction"
 require "malfunction"
+require "substance"
 
-require "flow/version"
+require_relative "flow/version"
 
-require "flow/concerns/transaction_wrapper"
+require_relative "flow/errors"
 
-require "flow/malfunction/base"
+require_relative "flow/concerns/transaction_wrapper"
 
-require "flow/flow_base"
-require "flow/operation_base"
-require "flow/state_base"
-require "flow/state_proxy"
+require_relative "flow/malfunction/base"
 
-module Flow
-  class Error < StandardError; end
-
-  class FlowError < Error; end
-  class StateInvalidError < FlowError; end
-
-  class OperationError < Error; end
-  class AlreadyExecutedError < OperationError; end
-
-  class StateError < Error; end
-  class NotValidatedError < StateError; end
-end
+require_relative "flow/flow_base"
+require_relative "flow/operation_base"
+require_relative "flow/state_base"
+require_relative "flow/state_proxy"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flow
 version: !ruby/object:Gem::Version
-  version: 0.10.7.1
+  version: 0.11.0
 platform: ruby
 authors:
 - Eric Garside
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-13 00:00:00.000000000 Z
+date: 2021-09-01 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,26 +43,32 @@ 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: spicery
+  name: short_circu_it
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -72,7 +78,47 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.0
+        version: 0.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: substance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.26.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: technologic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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: 0.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -96,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
@@ -184,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
@@ -246,6 +306,7 @@ files:
 - README.md
 - lib/flow.rb
 - lib/flow/concerns/transaction_wrapper.rb
+- lib/flow/errors.rb
 - lib/flow/flow/callbacks.rb
 - lib/flow/flow/core.rb
 - lib/flow/flow/flux.rb
@@ -279,8 +340,6 @@ files:
 - lib/flow/rspec/shared_contexts/with_failing_operation.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
@@ -341,7 +400,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.25
 signing_key: 
 specification_version: 4
 summary: Write modular and reusable business logic that's understandable and maintainable.

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