flow 0.9.3 → 0.10.0

data/lib/flow/custom_matchers/define_argument.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# RSpec matcher for flow state arguments.
-#
-# Usage:
-#
-# RSpec.describe ExampleState, type: :state do
-#   subject { described_class.new(**input) }
-#
-#   let(:input) { {} }
-#
-#   it { is_expected.to define_argument :foo }
-# end
-
-RSpec::Matchers.define :define_argument do |argument|
-  match { |state| expect(state._arguments).to include argument }
-  description { "has argument #{argument}" }
-  failure_message { |state| "expected #{state.class.name}# to have argument #{argument}" }
-end

data/lib/flow/custom_matchers/define_attribute.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-# RSpec matcher for flow state attributes.
-#
-# Usage:
-#
-# RSpec.describe ExampleState, type: :state do
-#   subject { described_class.new(**input) }
-#
-#   let(:input) { {} }
-#
-#   it { is_expected.to define_attribute :foo }
-# end
-
-RSpec::Matchers.define :define_attribute do |attribute|
-  match { |state| expect(state.class._attributes).to include attribute }
-  description { "has attribute #{attribute}" }
-  failure_message { |state| "expected #{state.class.name}# to have attribute #{attribute}" }
-end

data/lib/flow/custom_matchers/define_option.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-# RSpec matcher for flow state options.
-#
-# Usage:
-#
-# RSpec.describe ExampleState, type: :state do
-#   subject { described_class.new(**input) }
-#
-#   let(:input) { {} }
-#
-#   it { is_expected.to define_option :foo }
-#   it { is_expected.to define_option :foo, default_value }
-# end
-
-RSpec::Matchers.define :define_option do |option, default_value = nil|
-  match { |state| expect(state._options[option].default_value).to eq default_value }
-  description { "has option #{option}" }
-  failure_message { |state| "expected #{state.class.name}# to have option #{option}, #{for_default(default_value)}" }
-
-  def for_default(default_value)
-    return "without a default value" if default_value.nil?
-
-    "with default value #{default_value}"
-  end
-end

data/lib/flow/flow/ebb.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-# When a `#revert` is called on a Flow, `#rewind` is called on Operations in reverse of the order they were executed.
-module Flow
-  module Ebb
-    extend ActiveSupport::Concern
-
-    included do
-      set_callback(:initialize, :after) { @rewound_operations = [] }
-
-      private
-
-      attr_reader :rewound_operations
-
-      def _ebb
-        rewindable_operations.reverse_each { |executed_operation| rewound_operations << executed_operation.rewind }
-      end
-
-      def rewindable_operations
-        executed_operations - rewound_operations
-      end
-    end
-
-    def ebb
-      run_callbacks(:ebb) { _ebb }
-    end
-  end
-end

data/lib/flow/flow/revert.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-# Reverting a Flow rewinds all its executed operations in reverse order (see `Flow::Ebb`).
-module Flow
-  module Revert
-    extend ActiveSupport::Concern
-
-    included do
-      set_callback :revert, :around, ->(_, block) { surveil(:revert) { block.call } }
-    end
-
-    def revert
-      run_callbacks(:revert) { ebb }
-
-      state
-    end
-  end
-end

data/lib/flow/operation/rewind.rb

@@ -1,25 +0,0 @@
-# frozen_string_literal: true
-
-# When something goes wrong in Flow, `#rewind` is called on all executed Operations to `#undo` their behavior.
-module Operation
-  module Rewind
-    extend ActiveSupport::Concern
-
-    included do
-      set_callback :rewind, :around, ->(_, block) { surveil(:rewind) { block.call } }
-      set_callback :rewind, :before, -> { raise Operation::Errors::AlreadyRewound }, if: :rewound?
-    end
-
-    def rewind
-      run_callbacks(:rewind) do
-        run_callbacks(:undo) { undo }
-      end
-
-      self
-    end
-
-    def undo
-      # abstract method which should be defined by descendants to undo the functionality of the `#behavior` method
-    end
-  end
-end

data/lib/flow/state/arguments.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-# Arguments describe input required to define the initial state.
-module State
-  module Arguments
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :_arguments, instance_writer: false, default: []
-      set_callback :initialize, :after do
-        missing = _arguments.select { |argument| public_send(argument).nil? }
-        raise ArgumentError, "Missing #{"argument".pluralize(missing.length)}: #{missing.join(", ")}" if missing.any?
-      end
-    end
-
-    class_methods do
-      def inherited(base)
-        base._arguments = _arguments.dup
-        super
-      end
-
-      private
-
-      def argument(argument)
-        _arguments << argument
-        define_attribute argument
-      end
-    end
-  end
-end

data/lib/flow/state/attributes.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# A state's attributes provide accessors to the input data it was initialized with.
-module State
-  module Attributes
-    extend ActiveSupport::Concern
-
-    included do
-      include ActiveModel::AttributeMethods
-
-      class_attribute :_attributes, instance_writer: false, default: []
-    end
-
-    class_methods do
-      def inherited(base)
-        base._attributes = _attributes.dup
-        super
-      end
-
-      private
-
-      def define_attribute(attribute)
-        _attributes << attribute
-
-        attr_accessor attribute
-        define_attribute_methods attribute
-      end
-      alias_method :attribute, :define_attribute
-    end
-  end
-end

data/lib/flow/state/callbacks.rb

@@ -1,13 +0,0 @@
-# frozen_string_literal: true
-
-# Callbacks provide an extensible mechanism for hooking into a State.
-module State
-  module Callbacks
-    extend ActiveSupport::Concern
-
-    included do
-      include ActiveSupport::Callbacks
-      define_callbacks :initialize
-    end
-  end
-end

data/lib/flow/state/core.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-# A state accepts input represented by arguments and options which initialize it.
-module State
-  module Core
-    extend ActiveSupport::Concern
-
-    def initialize(**input)
-      run_callbacks(:initialize) do
-        input.each { |key, value| __send__("#{key}=".to_sym, value) }
-      end
-    end
-  end
-end

data/lib/flow/state/options.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-# Options describe input which may be provided to define or override the initial state.
-module State
-  module Options
-    extend ActiveSupport::Concern
-
-    included do
-      class_attribute :_options, instance_writer: false, default: {}
-
-      set_callback :initialize, :after do
-        _options.each do |option, info|
-          __send__("#{option}=".to_sym, info.default_value.dup) if public_send(option).nil?
-        end
-      end
-    end
-
-    class_methods do
-      def inherited(base)
-        dup = _options.dup
-        base._options = dup.each { |k, v| dup[k] = v.dup }
-        super
-      end
-
-      private
-
-      def option(option, default: nil, &block)
-        _options[option] = Option.new(default: default, &block)
-        define_attribute option
-      end
-    end
-
-    class Option
-      def initialize(default:, &block)
-        @default_value = (default.nil? && block_given?) ? block : default
-      end
-
-      def default_value
-        return instance_eval(&@default_value) if @default_value.respond_to?(:call)
-
-        @default_value
-      end
-    end
-  end
-end

data/lib/flow/state/string.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-# Formats the state as a string.
-module State
-  module String
-    extend ActiveSupport::Concern
-
-    def to_s
-      string_for(__method__)
-    end
-
-    def inspect
-      string_for(__method__)
-    end
-
-    private
-
-    def stringable_attributes
-      self.class._attributes
-    end
-
-    def string_for(method)
-      "#<#{self.class.name} #{attribute_string(method)}>"
-    end
-
-    def attribute_string(method)
-      stringable_attribute_values.map { |attribute, value| "#{attribute}=#{value.public_send(method)}" }.join(" ")
-    end
-
-    def stringable_attribute_values
-      stringable_attributes.each_with_object({}) { |attribute, result| result[attribute] = public_send(attribute) }
-    end
-  end
-end