flow 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8e881d33993ef70f023c82f8c595d77780487a67625c050849e1688c02dc4ccd
-  data.tar.gz: 7624fed517717e114ba494ce5ae93f252329ee704730a7579f02d4e20f7a53c7
+  metadata.gz: 6bb7054475f94b6d73503adf9168e31222098af20a36c048cdf72b68b3e0a7a5
+  data.tar.gz: 3a6feb462916f4d24dd180d88e63527ad1e18a4d99e8cbb5ecae664d919e744a
 SHA512:
-  metadata.gz: 6a07515e6214de6df0e568d18d3a04692d59d99aa50d8b3fb2ed5f89d394ed4ee0d78dcff05aabd86780df8484f240ca3cb2213bb37ad4e4bc5f8a17ec48454e
-  data.tar.gz: 2d09e0ca74029c270ae49a73287eef064669a5924cfec2fcd8d72ccf959edc6fa49f9625a4aad393213f24a39d498f990ddb3b451d6e08e84e67699c9c1afe9e
+  metadata.gz: 467c98e3ab094d2af99c8c27b72cd493c4efb70bec3980c8dbe6c37d3f6101b829ded1fd80445adf4cbd83195d6143c97c4be3ddf1d1f9c87a19ab875aea07da
+  data.tar.gz: 2bcb846816f4f3ad8599dd14970e7ffe6e5d8d0bae9b171ca6b763a6940be1105331bab14e9391c2e2d2dd5b2468cb15d15a1797351259f06af57fc09e3fa133

data/README.md

@@ -131,6 +131,14 @@ class ExampleFlow < ApplicationState
 end
 ```
 
+If you _already have_ an instance of a state class that you want to execute a Flow on, you can simply pass it directly to trigger:
+
+```ruby
+state_instance = ExampleState.new(...)
+
+CalculateTimetablesFlow.trigger(state_instance)
+```
+
 ### Operations
 
 An **Operation** is a service object which is executed with a **State**.
@@ -299,7 +307,7 @@ If the default value is static, it can be specified in the class definition.
 
 If the default value is dynamic, you may provide a block to compute the default value.
 
-⚠️‍ **Heads Up**: The default value blocks **DO NOT** provide access to the state or it's other variables!
+⚠️‍ **Heads Up**: The default value blocks **DO NOT** provide access to the state or its other variables!
 
 ```ruby
 class ExampleFlow < ApplicationFlow; end

data/lib/flow.rb

@@ -4,9 +4,7 @@ require "active_model"
 require "active_record"
 require "active_support"
 
-require "instructor"
-require "short_circu_it"
-require "technologic"
+require "spicerack"
 
 require "flow/version"
 

data/lib/flow/flow/core.rb

@@ -18,8 +18,10 @@ module Flow
       attr_reader :state
     end
 
-    def initialize(**input)
-      run_callbacks(:initialize) { @state = state_class.new(**input) }
+    def initialize(state_instance = nil, **options)
+      run_callbacks(:initialize) do
+        @state = state_instance || state_class.new(**options)
+      end
     end
   end
 end

data/lib/flow/spec_helper.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-require "instructor/spec_helper"
+require "spicerack/spec_helper"
 
-require_relative "custom_matchers"
-require_relative "shoulda_matcher_helper"
-require_relative "rspec_configuration"
+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"

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

@@ -29,26 +29,28 @@
 #   it { is_expected.to have_on_state foo: "some data", bar: "some other data" }
 # end
 
-module CustomMatchers
-  def have_on_state(expectations)
-    HaveOnState.new(expectations)
-  end
+module Flow
+  module CustomMatchers
+    def have_on_state(expectations)
+      HaveOnState.new(expectations)
+    end
 
-  class HaveOnState
-    include RSpec::Matchers
+    class HaveOnState
+      include RSpec::Matchers
 
-    def initialize(state_expectations)
-      @state_expectations = state_expectations
-    end
+      def initialize(state_expectations)
+        @state_expectations = state_expectations
+      end
 
-    def matches?(object)
-      @state_expectations.all? do |key, value|
-        expect(object.state.public_send(key)).to match value
+      def matches?(object)
+        @state_expectations.all? do |key, value|
+          expect(object.state.public_send(key)).to match value
+        end
       end
-    end
 
-    def description
-      "have the expected data on state"
+      def description
+        "have the expected data on state"
+      end
     end
   end
 end

data/lib/flow/{rspec_configuration.rb → spec_helper/rspec_configuration.rb}

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 RSpec.configure do |config|
-  config.include CustomMatchers
+  config.include Flow::CustomMatchers
 end

data/lib/flow/spec_helper/shared_contexts.rb

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

data/lib/flow/spec_helper/shared_contexts/with_failing_operation.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Stubs a given flow to always fail when triggered.
+#
+# Usage:
+#   describe SomeFlow do
+#     let(:flow) { described_class.new }
+#     let(:failing_flow_class) { described_class }
+#
+#     include_context "with failing operation"
+#
+#     before { flow.trigger }
+#
+#     it "is failed" do
+#       expect(flow).to be_failed
+#       expect(flow.failed_operation.operation_failure.problem).to eq failing_problem
+#     end
+#   end
+#
+# Requires let variables to be defined in the inclusion context:
+# * failing_flow_class
+#
+# Defines the following variable:
+# * failure_problem
+RSpec.shared_context "with failing operation" do
+  let(:failure_problem) { Faker::Lorem.words.join("-").parameterize.underscore }
+  let(:failing_operation) do
+    Class.new(Flow::OperationBase).tap do |klass|
+      klass.instance_exec(self) do |spec_context|
+        failure spec_context.failure_problem
+
+        define_method :behavior do
+          instance_eval("#{spec_context.failure_problem}_failure!")
+        end
+      end
+    end
+  end
+
+  before do
+    allow(failing_flow_class).to receive(:_operations).and_return([ failing_operation ])
+    stub_const("FailingOperation", failing_operation)
+  end
+end

data/lib/flow/state_base.rb

@@ -7,7 +7,7 @@ require_relative "state/output"
 
 # A **State** is an aggregation of input and derived data.
 module Flow
-  class StateBase < Instructor::Base
+  class StateBase < Spicerack::InputModel
     include Flow::State::Status
     include Flow::State::Output
   end

data/lib/flow/version.rb

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

metadata

@@ -1,17 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: flow
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Eric Garside
 - Allen Rettberg
 - Jordan Minneti
 - Vinod Lala
+- Andrew Cross
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-13 00:00:00.000000000 Z
+date: 2019-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -59,16 +60,22 @@ dependencies:
   name: spicerack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.13.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -171,30 +178,42 @@ dependencies:
   name: rspice
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: 0.13.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.3
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
@@ -221,13 +240,6 @@ files:
 - README.md
 - lib/flow.rb
 - lib/flow/concerns/transaction_wrapper.rb
-- lib/flow/custom_matchers.rb
-- lib/flow/custom_matchers/define_failure.rb
-- lib/flow/custom_matchers/define_output.rb
-- lib/flow/custom_matchers/handle_error.rb
-- lib/flow/custom_matchers/have_on_state.rb
-- lib/flow/custom_matchers/use_operations.rb
-- lib/flow/custom_matchers/wrap_in_transaction.rb
 - lib/flow/flow/callbacks.rb
 - lib/flow/flow/core.rb
 - lib/flow/flow/errors/state_invalid.rb
@@ -248,9 +260,18 @@ files:
 - lib/flow/operation/status.rb
 - lib/flow/operation/transactions.rb
 - lib/flow/operation_base.rb
-- lib/flow/rspec_configuration.rb
-- lib/flow/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