flow 0.10.2 → 0.10.7.1.pre1

data/lib/flow/{spec_helper → rspec}/custom_matchers.rb

@@ -6,3 +6,6 @@ require_relative "custom_matchers/handle_error"
 require_relative "custom_matchers/use_operations"
 require_relative "custom_matchers/wrap_in_transaction"
 require_relative "custom_matchers/have_on_state"
+require_relative "custom_matchers/read_state"
+require_relative "custom_matchers/write_state"
+require_relative "custom_matchers/access_state"

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `ApplicationOperation.state_accessor` (or use of both `state_(reader|writer)`)
+#
+#     class SomeTask < ApplicationOperation
+#       state_accessor :foo
+#       state_accessor :bar
+#
+#       state_reader :baz
+#       state_writer :baz
+#     end
+#
+#     RSpec.describe SomeTask, type: :operation do
+#       subject { described_class.new(state) }
+#
+#       let(:state) { Class.new(ApplicationState).new }
+#
+#       it { is_expected.to access_state :foo }
+#       it { is_expected.to access_state :bar }
+#       it { is_expected.to access_state :baz }
+#     end
+
+RSpec::Matchers.define :access_state do |field|
+  match { |operation| expect(operation._state_accessors).to include field }
+  description { "access state" }
+  failure_message { "expected #{described_class} to access state #{field}" }
+end

data/lib/flow/{spec_helper → rspec}/custom_matchers/have_on_state.rb

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

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `ApplicationOperation.state_reader`
+#
+#     class SomeTask < ApplicationOperation
+#       state_reader :foo
+#       state_reader :bar
+#     end
+#
+#     RSpec.describe SomeTask, type: :operation do
+#       subject { described_class.new(state) }
+#
+#       let(:state) { Class.new(ApplicationState).new }
+#
+#       it { is_expected.to read_state :foo }
+#       it { is_expected.to read_state :bar }
+#     end
+
+RSpec::Matchers.define :read_state do |field|
+  match { |operation| expect(operation._state_readers).to include field }
+  description { "read state" }
+  failure_message { "expected #{described_class} to read state #{field}" }
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# RSpec matcher that tests usage of `ApplicationOperation.state_writer`
+#
+#     class SomeTask < ApplicationOperation
+#       state_writer :foo
+#       state_writer :bar
+#     end
+#
+#     RSpec.describe SomeTask, type: :operation do
+#       subject { described_class.new(state) }
+#
+#       let(:state) { Class.new(ApplicationState).new }
+#
+#       it { is_expected.to write_state :foo }
+#       it { is_expected.to write_state :bar }
+#     end
+
+RSpec::Matchers.define :write_state do |field|
+  match { |operation| expect(operation._state_writers).to include field }
+  description { "write state" }
+  failure_message { "expected #{described_class} to write state #{field}" }
+end

data/lib/flow/spec_helper.rb

@@ -2,7 +2,7 @@
 
 require "spicerack/spec_helper"
 
-require_relative "spec_helper/custom_matchers"
-require_relative "spec_helper/shared_contexts"
-require_relative "spec_helper/shoulda_matcher_helper"
-require_relative "spec_helper/rspec_configuration"
+require_relative "rspec/custom_matchers"
+require_relative "rspec/shared_contexts"
+require_relative "rspec/shoulda_matcher_helper"
+require_relative "rspec/configuration"

data/lib/flow/state/output.rb

@@ -38,7 +38,7 @@ module Flow
 
         def ensure_validation_before(method)
           around_method method do |*arguments|
-            raise Flow::State::Errors::NotValidated unless validated?
+            raise NotValidatedError unless validated?
 
             super(*arguments)
           end

data/lib/flow/state_base.rb

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

data/lib/flow/state_proxy.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# A **StateProxy** adapts a **State** to an **Operation** through an Operation's `state_*` accessors.
+module Flow
+  class StateProxy
+    def initialize(state)
+      @_state = state
+    end
+
+    # @deprecated
+    def method_missing(method_name, *arguments, &block)
+      return super unless _state.respond_to?(method_name)
+
+      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"
+      )
+      _state.public_send(method_name, *arguments, &block)
+    end
+
+    # @deprecated
+    def respond_to_missing?(method_name, include_private = false)
+      _state.respond_to?(method_name) || super
+    end
+
+    private
+
+    attr_reader :_state
+  end
+end

data/lib/flow/version.rb

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

data/lib/generators/flow/operation/templates/operation.rb.erb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 class <%= class_name %> < ApplicationOperation
+  # state_accessor :foo
+  # state_reader :bar
+  # state_writer :baz
+
   def behavior
     # Define what this operation does here
   end

data/lib/generators/rspec/application_operation/templates/application_operation_spec.rb

@@ -3,15 +3,19 @@
 require "rails_helper"
 
 RSpec.describe ApplicationOperation, type: :operation do
-  subject(:operation) { described_class.new(state) }
-
-  let(:state) { double }
+  subject { described_class }
 
   it { is_expected.to inherit_from Flow::OperationBase }
 
   describe "#execute" do
     subject(:execute) { operation.execute }
-
-    it "has some behavior"
+    
+    context "when unsuccessful" do
+      pending "describe the effects of an unsuccessful `Operation#execute` (or delete) #{__FILE__}"
+    end
+    
+    context "when successful" do
+      pending "describe the effects of a successful `Operation#execute` (or delete) #{__FILE__}"
+    end
   end
 end

data/lib/generators/rspec/operation/templates/operation_spec.rb.erb

@@ -19,6 +19,10 @@ RSpec.describe <%= class_name %>, type: :operation do
 
   it { is_expected.to inherit_from ApplicationOperation }
 
+  # it { is_expected.to access_state :foo }
+  # it { is_expected.to read_state :bar }
+  # it { is_expected.to write_state :baz }
+
   describe "#execute" do
     subject(:execute) { operation.execute }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flow
 version: !ruby/object:Gem::Version
-  version: 0.10.2
+  version: 0.10.7.1.pre1
 platform: ruby
 authors:
 - Eric Garside
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-19 00:00:00.000000000 Z
+date: 2021-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -57,12 +57,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 5.2.1
 - !ruby/object:Gem::Dependency
-  name: spicerack
+  name: spicery
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -72,7 +72,27 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.21.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: malfunction
+  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'
@@ -80,14 +100,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.0.1
 - !ruby/object:Gem::Dependency
@@ -96,91 +116,91 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 3.7.0
 - !ruby/object:Gem::Dependency
-  name: faker
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: bcrypt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.1.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.1.13
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 4.0.1
 - !ruby/object:Gem::Dependency
   name: rspice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.25.7
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -190,7 +210,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.25.7
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -200,7 +220,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
@@ -210,24 +230,10 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.13.3
+        version: 0.21.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: shoulda-matchers
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.0.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 4.0.1
 description: Tired of kitchen sink services, god-objects, and fat-everything? So were
   we. Get in the flow.
 email:
@@ -242,40 +248,41 @@ files:
 - lib/flow/concerns/transaction_wrapper.rb
 - lib/flow/flow/callbacks.rb
 - lib/flow/flow/core.rb
-- lib/flow/flow/errors/state_invalid.rb
 - lib/flow/flow/flux.rb
 - lib/flow/flow/operations.rb
 - lib/flow/flow/status.rb
 - lib/flow/flow/transactions.rb
 - lib/flow/flow/trigger.rb
 - lib/flow/flow_base.rb
+- lib/flow/malfunction/base.rb
 - lib/flow/operation/accessors.rb
 - lib/flow/operation/callbacks.rb
 - lib/flow/operation/core.rb
 - lib/flow/operation/error_handler.rb
-- lib/flow/operation/errors/already_executed.rb
-- lib/flow/operation/errors/already_rewound.rb
 - lib/flow/operation/execute.rb
 - lib/flow/operation/failures.rb
 - lib/flow/operation/status.rb
 - lib/flow/operation/transactions.rb
 - lib/flow/operation_base.rb
+- lib/flow/rspec/configuration.rb
+- lib/flow/rspec/custom_matchers.rb
+- lib/flow/rspec/custom_matchers/access_state.rb
+- lib/flow/rspec/custom_matchers/define_failure.rb
+- lib/flow/rspec/custom_matchers/define_output.rb
+- lib/flow/rspec/custom_matchers/handle_error.rb
+- lib/flow/rspec/custom_matchers/have_on_state.rb
+- lib/flow/rspec/custom_matchers/read_state.rb
+- lib/flow/rspec/custom_matchers/use_operations.rb
+- lib/flow/rspec/custom_matchers/wrap_in_transaction.rb
+- 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/shoulda_matcher_helper.rb
 - lib/flow/spec_helper.rb
-- lib/flow/spec_helper/custom_matchers.rb
-- lib/flow/spec_helper/custom_matchers/define_failure.rb
-- lib/flow/spec_helper/custom_matchers/define_output.rb
-- lib/flow/spec_helper/custom_matchers/handle_error.rb
-- lib/flow/spec_helper/custom_matchers/have_on_state.rb
-- lib/flow/spec_helper/custom_matchers/use_operations.rb
-- lib/flow/spec_helper/custom_matchers/wrap_in_transaction.rb
-- lib/flow/spec_helper/rspec_configuration.rb
-- lib/flow/spec_helper/shared_contexts.rb
-- lib/flow/spec_helper/shared_contexts/with_failing_operation.rb
-- lib/flow/spec_helper/shoulda_matcher_helper.rb
-- lib/flow/state/errors/not_validated.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
 - lib/generators/flow/USAGE
 - lib/generators/flow/application_flow/USAGE
@@ -330,11 +337,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Write modular and reusable business logic that's understandable and maintainable.