flow 0.9.3 → 0.10.0

data/lib/flow/state/output.rb

@@ -0,0 +1,59 @@
+# 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 Flow::State::Errors::NotValidated 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

@@ -0,0 +1,22 @@
+# 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

data/lib/flow/state_base.rb

@@ -1,21 +1,14 @@
 # frozen_string_literal: true
 
-require_relative "state/callbacks"
-require_relative "state/attributes"
-require_relative "state/arguments"
-require_relative "state/options"
-require_relative "state/core"
-require_relative "state/string"
+require_relative "state/errors/not_validated"
+
+require_relative "state/status"
+require_relative "state/output"
 
 # A **State** is an aggregation of input and derived data.
-class StateBase
-  include ShortCircuIt
-  include Technologic
-  include ActiveModel::Model
-  include State::Callbacks
-  include State::Attributes
-  include State::Arguments
-  include State::Options
-  include State::Core
-  include State::String
+module Flow
+  class StateBase < Instructor::Base
+    include Flow::State::Status
+    include Flow::State::Output
+  end
 end

data/lib/flow/version.rb

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

data/lib/generators/flow/application_flow/templates/application_flow.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-class ApplicationFlow < FlowBase; end
+class ApplicationFlow < Flow::FlowBase; end

data/lib/generators/flow/application_operation/templates/application_operation.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-class ApplicationOperation < OperationBase; end
+class ApplicationOperation < Flow::OperationBase; end

data/lib/generators/flow/application_state/templates/application_state.rb

@@ -1,3 +1,3 @@
 # frozen_string_literal: true
 
-class ApplicationState < StateBase; end
+class ApplicationState < Flow::StateBase; end

data/lib/generators/flow/operation/USAGE

@@ -2,7 +2,7 @@ Description:
     Stub a Operation with test.
 
 Example:
-    `rails generate operation foo`
+    `rails generate flow:operation foo`
 
     Generates:
   Operation: app/operations/foo.rb

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

@@ -4,9 +4,4 @@ class <%= class_name %> < ApplicationOperation
   def behavior
     # Define what this operation does here
   end
-
-  def undo
-    # If your operation can be undone, define how here.
-    # Otherwise you can delete this method.
-  end
 end

data/lib/generators/flow/state/USAGE

@@ -2,7 +2,7 @@ Description:
     Stub a State with test.
 
 Example:
-    `rails generate state foo`
+    `rails generate flow:state foo`
 
     Generates:
       State: app/states/foo_state.rb

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

@@ -2,8 +2,9 @@
 
 class <%= class_name %>State < ApplicationState
   # argument :required_input
+  # argument :necessary_input, allow_nil: false
   # option :optional_input
   # option :option_with_default, default: :default_static_value
   # option(:option_with_default_from_block) { required_input.default_dynamic_value }
-  # attribute :some_runtime_value
+  # output :some_runtime_value
 end

data/lib/generators/rspec/application_flow/templates/application_flow_spec.rb

@@ -3,5 +3,5 @@
 require "rails_helper"
 
 RSpec.describe ApplicationFlow, type: :flow do
-  it { is_expected.to inherit_from FlowBase }
+  it { is_expected.to inherit_from Flow::FlowBase }
 end

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

@@ -7,19 +7,11 @@ RSpec.describe ApplicationOperation, type: :operation do
 
   let(:state) { double }
 
-  it { is_expected.to inherit_from OperationBase }
+  it { is_expected.to inherit_from Flow::OperationBase }
 
   describe "#execute" do
     subject(:execute) { operation.execute }
 
     it "has some behavior"
   end
-
-  describe "#rewind" do
-    subject(:rewind) { operation.rewind }
-
-    before { operation.execute }
-
-    it "undoes some behavior"
-  end
 end

data/lib/generators/rspec/application_state/templates/application_state_spec.rb

@@ -3,5 +3,5 @@
 require "rails_helper"
 
 RSpec.describe ApplicationState, type: :state do
-  it { is_expected.to inherit_from StateBase }
+  it { is_expected.to inherit_from Flow::StateBase }
 end

data/lib/generators/rspec/flow/templates/flow_spec.rb.erb

@@ -17,12 +17,4 @@ RSpec.describe <%= class_name %>Flow, type: :flow do
 
     pending "describe the effects of a successful `Flow#flux` (or delete) #{__FILE__}"
   end
-
-  describe "#revert" do
-    before { flow.trigger! }
-
-    subject(:revert) { flow.revert }
-
-    pending "describe the effects of a successful `Flow#ebb` (or delete) #{__FILE__}"
-  end
 end

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

@@ -5,11 +5,13 @@ require "rails_helper"
 RSpec.describe <%= class_name %>, type: :operation do
   subject(:operation) { described_class.new(state) }
 
-  let(:state) { example_state_class.new(**state_input) }
+  let(:state) { example_state_class.new(**state_input).tap(&:validate) }
   let(:example_state_class) do
     Class.new(ApplicationState) do
       # argument :foo
       # option :bar
+      # attribute :baz
+      # output :gaz
     end
   end
   let(:state_input) do
@@ -18,17 +20,9 @@ RSpec.describe <%= class_name %>, type: :operation do
 
   it { is_expected.to inherit_from ApplicationOperation }
 
-  describe "#execute!" do
-    subject(:execute!) { operation.execute! }
+  describe "#execute" do
+    subject(:execute) { operation.execute }
 
     pending "describe `Operation#behavior` (or delete) #{__FILE__}"
   end
-
-  describe "#rewind" do
-    before { operation.execute! }
-
-    subject(:execute!) { operation.rewind }
-
-    pending "describe `Operation#undo` (or delete) #{__FILE__}"
-  end
 end

data/lib/generators/rspec/state/templates/state_spec.rb.erb

@@ -3,17 +3,15 @@
 require "rails_helper"
 
 RSpec.describe <%= class_name %>State, type: :state do
-  subject(:state) { described_class.new(**input) }
-
-  let(:input) do
-    {}
-  end
+  subject(:state) { described_class }
 
   it { is_expected.to inherit_from ApplicationState }
-  # it { is_expected.to define_argument :foo }
-  # it { is_expected.to define_option(:foo) }
-  # it { is_expected.to define_option(:foo).with_default_value(:bar) }
-  # it { is_expected.to define_option(:foo).with_default_value_block }
+  # it { is_expected.to define_argument :required_input }
+  # it { is_expected.to define_argument :necessary_input, allow_nil: false }
+  # it { is_expected.to define_option(:optional_input) }
+  # it { is_expected.to define_option(:option_with_default, default: :default_static_value) }
+  # it { is_expected.to define_option(:option_with_default_from_block, default: default_block_value) }
   # it { is_expected.to validate_presence_of ... }
-  # it { is_expected.to define_attribute :foo }
+  # it { is_expected.to define_output :foo }
+  # it { is_expected.to define_output :foo, default: :bar }
 end

metadata

@@ -1,14 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: flow
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 0.10.0
 platform: ruby
 authors:
 - Eric Garside
+- Allen Rettberg
+- Jordan Minneti
+- Vinod Lala
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2019-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -58,28 +61,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.8.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.3
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -123,103 +126,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.16'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: faker
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.58'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.27'
+        version: 3.7.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.27'
+        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.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.3
+        version: 1.3.6
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: rspice
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
-  name: rspice
+  name: spicerack-styleguide
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.8.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 0.8.3
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.0.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.0.0.rc1
+        version: 4.0.1
 description: Tired of kitchen sink services, god-objects, and fat-everything? So were
   we. Get in the flow.
 email:
@@ -233,21 +222,22 @@ files:
 - lib/flow.rb
 - lib/flow/concerns/transaction_wrapper.rb
 - lib/flow/custom_matchers.rb
-- lib/flow/custom_matchers/define_argument.rb
-- lib/flow/custom_matchers/define_attribute.rb
-- lib/flow/custom_matchers/define_option.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/ebb.rb
 - lib/flow/flow/errors/state_invalid.rb
 - lib/flow/flow/flux.rb
 - lib/flow/flow/operations.rb
-- lib/flow/flow/revert.rb
 - lib/flow/flow/status.rb
 - lib/flow/flow/transactions.rb
 - lib/flow/flow/trigger.rb
 - lib/flow/flow_base.rb
+- lib/flow/operation/accessors.rb
 - lib/flow/operation/callbacks.rb
 - lib/flow/operation/core.rb
 - lib/flow/operation/error_handler.rb
@@ -255,18 +245,15 @@ files:
 - lib/flow/operation/errors/already_rewound.rb
 - lib/flow/operation/execute.rb
 - lib/flow/operation/failures.rb
-- lib/flow/operation/rewind.rb
 - 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/state/arguments.rb
-- lib/flow/state/attributes.rb
-- lib/flow/state/callbacks.rb
-- lib/flow/state/core.rb
-- lib/flow/state/options.rb
-- lib/flow/state/string.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/version.rb
 - lib/generators/flow/USAGE
@@ -307,7 +294,7 @@ files:
 - lib/generators/rspec/state/USAGE
 - lib/generators/rspec/state/state_generator.rb
 - lib/generators/rspec/state/templates/state_spec.rb.erb
-homepage: http://www.freshly.com
+homepage: https://github.com/Freshly/flow
 licenses:
 - MIT
 metadata: {}