active_interaction 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f6687ab2fb463ecc05f0e785e9c05cf0b5d1172
-  data.tar.gz: d75174715db45471c960c5e1bb4effffb2ab9b7d
+  metadata.gz: 1139d1df0d150418f22b231b09423c894ba98c41
+  data.tar.gz: c53767591c098f28c46ffa8ae77fb31ac714e310
 SHA512:
-  metadata.gz: 113199ae4863c2a7d78764179c9bd5caec7d516af78c921f1e788b5e9b1a2e251814b3e82786e790facc45d616f069e8a7b4e9e226a4d96b160e98e0c019e180
-  data.tar.gz: 5fefc55875416c15613c3edf28ca86d65996404ddb297037980360bab4f27a87bba7bad61b0eb6b9d51eaebce3fb337cee7234574b31a45d3b2356ec78514ef9
+  metadata.gz: 5524134f37f76b6252d1ee82a2fe9d879aae1debec5d46679b66eb608e42bd49668c59532c5e2fda8f64999b5582649fb090c78e0c9c7048df2d05cd7e729474
+  data.tar.gz: 591d0b74feed33a7a7d39ebe67f61adea4c7f5721541d9c570ef39c8dd06b53f4cfd74ee8bac8dc8a78508c447d942a7e0cacbb80813392640ddce8d79f9b512

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # [Master][]
 
+# [0.9.0][] (2013-12-02)
+
+- Add experimental composition implementation
+  (`ActiveInteraction::Base#compose`).
+- Remove `ActiveInteraction::Pipeline`.
+
 # [0.8.0][] (2013-11-14)
 
 - Add ability to document interactions and filters.
@@ -8,7 +14,6 @@
 
 - Add ability to chain a series of interactions together with
   `ActiveInteraction::Pipeline`.
-- Refactor internals (abstract filters & core class).
 
 # [0.6.1][] (2013-11-14)
 
@@ -16,18 +21,17 @@
 
 # [0.6.0][] (2013-11-14)
 
-- Error class now end with `Error`.
-- By default, strip unlisted keys from hashes. To retain the old behavior, set
-  `strip: false` on a hash filter.
-- Prevent specifying defaults (other than `nil` or `{}`) on hash filters. Set
-  defaults on the nested filters instead.
+- **Error class now end with `Error`.**
+- **By default, strip unlisted keys from hashes. To retain the old behavior,
+  set `strip: false` on a hash filter.**
+- **Prevent specifying defaults (other than `nil` or `{}`) on hash filters. Set
+  defaults on the nested filters instead.**
 - Add ability to introspect interactions with `filters`.
 - Fix bug that prevented listing multiple attributes in a hash filter.
 - Allow getting all of the user-supplied inputs in an interaction with
   `inputs`.
 - Fix bug that prevented hash filters from being nested in array filters.
 - Replace `allow_nil: true` with `default: nil`.
-- Refactor internals.
 - Add a symbol filter.
 - Allow adding symbolic errors with `errors.add_sym` and retrieving them with
   `errors.symbolic`.
@@ -76,11 +80,12 @@
 
 - Correct gemspec dependencies on activemodel.
 
-# [0.1.0][] (2013-08-12)
+# [0.1.0][] (2013-07-12)
 
 - Initial release.
 
-  [master]: https://github.com/orgsync/active_interaction/compare/v0.8.0...master
+  [master]: https://github.com/orgsync/active_interaction/compare/v0.9.0...master
+  [0.9.0]: https://github.com/orgsync/active_interaction/compare/v0.9.0...0.9.0
   [0.8.0]: https://github.com/orgsync/active_interaction/compare/v0.7.0...v0.8.0
   [0.7.0]: https://github.com/orgsync/active_interaction/compare/v0.6.1...v0.7.0
   [0.6.1]: https://github.com/orgsync/active_interaction/compare/v0.6.0...v0.6.1

data/README.md

@@ -25,7 +25,7 @@ This project uses [semantic versioning][].
 Add it to your Gemfile:
 
 ```ruby
-gem 'active_interaction', '~> 0.8.0'
+gem 'active_interaction', '~> 0.9.0'
 ```
 
 And then execute:
@@ -117,7 +117,7 @@ Or, you can do this:
 ```ruby
 result = UserSignup.run!(params)
 # Either returns the result of execute,
-# or raises ActiveInteraction::InteractionInvalid
+# or raises ActiveInteraction::InvalidInteractionError
 ```
 
 ## What can I pass to an interaction?
@@ -202,26 +202,36 @@ Check out the [documentation][] for a full list of methods.
 
 ## How do I compose interactions?
 
-You can run many interactions in series by setting up a pipeline. Simply list
-the interactions you want to run with `pipe`. Transforming the output of an
-interaction into the input of the next one is accomplished with lambdas.
+(Note: this feature is experimental. See [#41][] & [#79][].)
+
+You can run interactions from within other interactions by calling `compose`.
+If the interaction is successful, it'll return the result (just like if you had
+called it with `run!`). If something went wrong, execution will halt
+immediately and the errors will be moved onto the caller.
 
 ```ruby
-pipeline = ActiveInteraction::Pipeline.new do
-  pipe Add
-  pipe Square, :x
-  pipe Add, -> result { { x: result, y: result } }
+class DoSomeMath < ActiveInteraction::Base
+  integer :x, :y
+  def execute
+    sum = compose(Add, inputs)
+    square = compose(Square, x: sum)
+    compose(Add, x: square, y: square)
+  end
 end
-outcome = pipeline.run(x: 3, y: 5)
-outcome.result
-# => 128 # ((3 + 5) ** 2) * 2
+DoSomeMath.run!(x: 3, y: 5)
+# 128 => ((3 + 5) ** 2) * 2
 ```
 
-The whole pipeline executes in a single transaction. The pipeline returns the
-outcome of the last successful interaction. An error in the pipeline will
-short-circuit and stop execution immediately.
-
-While pipelines are similar to interactions, the two are not substitutable.
+```ruby
+class AddThree < ActiveInteraction::Base
+  integer :y
+  def execute
+    compose(Add, x: 3, y: y)
+  end
+end
+AddThree.run!(y: nil)
+# => ActiveInteraction::InvalidInteractionError: Y is required
+```
 
 ## How do I translate an interaction?
 
@@ -270,6 +280,8 @@ p Interaction.run.errors.messages
 
 This project was inspired by the fantastic work done in [Mutations][].
 
+  [#41]: https://github.com/orgsync/active_interaction/issues/41
+  [#79]: https://github.com/orgsync/active_interaction/issues/79
   [1]: https://badge.fury.io/rb/active_interaction "Gem Version"
   [2]: https://travis-ci.org/orgsync/active_interaction "Build Status"
   [3]: https://coveralls.io/r/orgsync/active_interaction "Coverage Status"
@@ -283,4 +295,4 @@ This project was inspired by the fantastic work done in [Mutations][].
   [gem version]: https://badge.fury.io/rb/active_interaction.png
   [mutations]: https://github.com/cypriss/mutations
   [project page]: http://orgsync.github.io/active_interaction/
-  [semantic versioning]: http://semver.org
+  [semantic versioning]: http://semver.org/spec/v2.0.0.html

data/lib/active_interaction.rb

@@ -27,7 +27,6 @@ require 'active_interaction/filters/symbol_filter'
 require 'active_interaction/filters/time_filter'
 
 require 'active_interaction/base'
-require 'active_interaction/pipeline'
 
 I18n.backend.load_translations(
   Dir.glob(File.join(%w(lib active_interaction locale *.yml)))

data/lib/active_interaction/base.rb

@@ -54,6 +54,7 @@ module ActiveInteraction
         begin
           send("#{filter.name}=", filter.clean(options[filter.name]))
         rescue InvalidValueError, MissingValueError
+          # Validators (#input_errors) will add errors if appropriate.
         end
       end
     end
@@ -86,8 +87,7 @@ module ActiveInteraction
     # Returns the output from {#execute} if there are no validation errors or
     #   `nil` otherwise.
     #
-    # @return [Nil] if there are validation errors.
-    # @return [Object] if there are no validation errors.
+    # @return [Object, nil] the output or nil if there were validation errors
     def result
       @_interaction_result
     end
@@ -120,7 +120,13 @@ module ActiveInteraction
     def self.run(*args)
       new(*args).tap do |interaction|
         if interaction.valid?
-          result = transaction { interaction.execute }
+          result = transaction do
+            begin
+              interaction.execute
+            rescue Interrupt
+              # Inner interaction failed. #compose handles merging errors.
+            end
+          end
 
           if interaction.errors.empty?
             interaction.instance_variable_set(:@_interaction_result, result)
@@ -162,15 +168,22 @@ module ActiveInteraction
     end
 
     def runtime_errors
-      return unless @_interaction_runtime_errors
-
-      @_interaction_runtime_errors.symbolic.each do |attribute, symbols|
-        symbols.each { |symbol| errors.add_sym(attribute, symbol) }
+      if @_interaction_runtime_errors
+        errors.merge!(@_interaction_runtime_errors)
       end
+    end
 
-      @_interaction_runtime_errors.messages.each do |attribute, messages|
-        messages.each { |message| errors.add(attribute, message) }
+    def compose(interaction, options = {})
+      outcome = interaction.run(options)
+      return outcome.result if outcome.valid?
+
+      # This can't use Errors#merge! because the errors have to be added to
+      # base.
+      outcome.errors.full_messages.each do |message|
+        errors.add(:base, message) unless errors.added?(:base, message)
       end
+
+      raise Interrupt
     end
   end
 end

data/lib/active_interaction/errors.rb

@@ -2,9 +2,6 @@ module ActiveInteraction
   # Top-level error class. All other errors subclass this.
   Error = Class.new(StandardError)
 
-  # Raised when trying to run an empty pipeline.
-  EmptyPipelineError = Class.new(Error)
-
   # Raised if a class name is invalid.
   InvalidClassError = Class.new(Error)
 
@@ -29,6 +26,10 @@ module ActiveInteraction
   # Raised if there is no default value.
   NoDefaultError = Class.new(Error)
 
+  # @private
+  Interrupt = Class.new(::Interrupt)
+  private_constant :Interrupt
+
   # A small extension to provide symbolic error messages to make introspecting
   #   and testing easier.
   #
@@ -80,5 +81,28 @@ module ActiveInteraction
       symbolic.clear
       super
     end
+
+    # Merge other errors into this one.
+    #
+    # @param other [Errors]
+    #
+    # @return [Errors]
+    def merge!(other)
+      other.symbolic.each do |attribute, symbols|
+        symbols.each do |symbol|
+          add_sym(attribute, symbol)
+        end
+      end
+
+      other.messages.each do |attribute, messages|
+        messages.each do |message|
+          unless added?(attribute, message)
+            add(attribute, message)
+          end
+        end
+      end
+
+      self
+    end
   end
 end

data/lib/active_interaction/filter.rb

@@ -85,6 +85,7 @@ module ActiveInteraction
         begin
           CLASSES[klass.slug] = klass
         rescue InvalidClassError
+          # Ignore classes with invalid slugs.
         end
       end
     end

data/lib/active_interaction/filters/array_filter.rb

@@ -40,7 +40,7 @@ module ActiveInteraction
       end
     end
 
-    def method_missing(*args, &block)
+    def method_missing(*_, &block)
       super do |klass, names, options|
         filter = klass.new(name, options, &block)
 

data/lib/active_interaction/modules/core.rb

@@ -1,13 +1,13 @@
 begin
   require 'active_record'
 rescue LoadError
+  # ActiveRecord is an optional dependency.
 end
 
 module ActiveInteraction
-  # Functionality common between {Base} and {Pipeline}.
+  # Functionality common between {Base}.
   #
   # @see Base
-  # @see Pipeline
   module Core
     # Get or set the description.
     #

data/lib/active_interaction/version.rb

@@ -1,3 +1,3 @@
 module ActiveInteraction
-  VERSION = Gem::Version.new('0.8.0')
+  VERSION = Gem::Version.new('0.9.0')
 end

data/spec/active_interaction/base_spec.rb

@@ -272,6 +272,55 @@ describe ActiveInteraction::Base do
     end
   end
 
+  describe '#compose' do
+    let(:described_class) { InterruptInteraction }
+    let(:x) { rand }
+    let(:y) { rand }
+
+    AddInteraction = Class.new(ActiveInteraction::Base) do
+      float :x, :y
+
+      def execute
+        x + y
+      end
+    end
+
+    InterruptInteraction = Class.new(ActiveInteraction::Base) do
+      model :x, :y,
+        class: Object,
+        default: nil
+
+      def execute
+        compose(AddInteraction, inputs)
+      end
+    end
+
+    context 'with valid composition' do
+      before do
+        options.merge!(x: x, y: y)
+      end
+
+      it 'is valid' do
+        expect(outcome).to be_valid
+      end
+
+      it 'returns the sum' do
+        expect(result).to eq x + y
+      end
+    end
+
+    context 'with invalid composition' do
+      it 'is invalid' do
+        expect(outcome).to be_invalid
+      end
+
+      it 'has the correct errors' do
+        expect(outcome.errors[:base]).
+          to match_array ['X is required', 'Y is required']
+      end
+    end
+  end
+
   describe '#execute' do
     it 'raises an error' do
       expect { interaction.execute }.to raise_error NotImplementedError

data/spec/active_interaction/integration/hash_interaction_spec.rb

@@ -18,7 +18,7 @@ describe HashInteraction do
   it_behaves_like 'an interaction', :hash, -> { {} }
 
   context 'with options[:a]' do
-    let(:a) { { 'x' => {} } }
+    let(:a) { { x: {} } }
 
     before { options.merge!(a: a) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-14 00:00:00.000000000 Z
+date: 2013-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -174,7 +174,6 @@ files:
 - lib/active_interaction/modules/method_missing.rb
 - lib/active_interaction/modules/overload_hash.rb
 - lib/active_interaction/modules/validation.rb
-- lib/active_interaction/pipeline.rb
 - lib/active_interaction/version.rb
 - lib/active_interaction.rb
 - spec/active_interaction/base_spec.rb
@@ -211,7 +210,6 @@ files:
 - spec/active_interaction/modules/method_missing_spec.rb
 - spec/active_interaction/modules/overload_hash_spec.rb
 - spec/active_interaction/modules/validation_spec.rb
-- spec/active_interaction/pipeline_spec.rb
 - spec/spec_helper.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb
@@ -277,7 +275,6 @@ test_files:
 - spec/active_interaction/modules/method_missing_spec.rb
 - spec/active_interaction/modules/overload_hash_spec.rb
 - spec/active_interaction/modules/validation_spec.rb
-- spec/active_interaction/pipeline_spec.rb
 - spec/spec_helper.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb

data/lib/active_interaction/pipeline.rb

@@ -1,92 +0,0 @@
-begin
-  require 'active_record'
-rescue LoadError
-end
-
-module ActiveInteraction
-  # Compose interactions by piping them together.
-  #
-  # @since 0.7.0
-  class Pipeline
-    include Core
-
-    # Set up a pipeline with a series of interactions.
-    #
-    # @example
-    #   ActiveInteraction::Pipeline.new do
-    #     pipe InteractionOne
-    #     pipe InteractionTwo
-    #   end
-    def initialize(&block)
-      @steps = []
-      instance_eval(&block) if block_given?
-    end
-
-    # Add an interaction to the end of the pipeline.
-    #
-    # @example With a lambda
-    #   pipe Interaction, -> result { { a: result, b: result } }
-    #
-    # @example With a symbol
-    #   pipe Interaction, :thing
-    #   # -> result { { thing: result } }
-    #
-    # @example With nil
-    #   pipe Interaction
-    #   # -> result { result }
-    #
-    # @param interaction [Base] the interaction to add
-    # @param function [Proc] a function to convert the output of an interaction
-    #   into the input for the next one
-    # @param function [Symbol] a shortcut for creating a function that puts the
-    #   output into a hash with this key
-    # @param function [nil] a shortcut for creating a function that passes the
-    #   output straight through
-    #
-    # @return [Pipeline]
-    def pipe(interaction, function = nil)
-      @steps << [lambdafy(function), interaction]
-      self
-    end
-
-    # Run all the interactions in the pipeline. If any interaction fails, stop
-    #   and return immediately without running any more interactions.
-    #
-    # @param (see Base.run)
-    #
-    # @return [Base] an instance of the last successful interaction in the
-    #   pipeline
-    #
-    # @raise [EmptyPipelineError] if nothing is in the pipeline
-    def run(*args)
-      raise EmptyPipelineError if @steps.empty?
-
-      transaction do
-        function, interaction = @steps.first
-        outcome = interaction.run(function.call(*args))
-        @steps.drop(1).reduce(outcome) { |o, (f, i)| bind(o, f, i) }
-      end
-    end
-
-    private
-
-    def bind(outcome, function, interaction)
-      if outcome.valid?
-        interaction.run(function.call(outcome.result))
-      else
-        outcome
-      end
-    end
-
-    def lambdafy(thing)
-      case thing
-      when NilClass
-        -> result { result }
-      when Symbol
-        -> result { { thing => result } }
-      else
-        thing
-      end
-    end
-  end
-end

data/spec/active_interaction/pipeline_spec.rb

@@ -1,117 +0,0 @@
-require 'spec_helper'
-
-describe ActiveInteraction::Pipeline do
-  let(:invalid_interaction) do
-    Class.new(TestInteraction) do
-      float :a
-      validates :a, inclusion: { in: [] }
-      def execute; a end
-    end
-  end
-
-  let(:square_interaction) do
-    Class.new(TestInteraction) do
-      float :a
-      def execute; a ** 2 end
-    end
-  end
-
-  let(:swap_interaction) do
-    Class.new(TestInteraction) do
-      float :a, :b
-      def execute; { a: b, b: a } end
-    end
-  end
-
-  it 'raises an error with no pipes' do
-    pipeline = described_class.new
-    expect {
-      pipeline.run
-    }.to raise_error ActiveInteraction::EmptyPipelineError
-  end
-
-  it 'returns an invalid outcome with one invalid pipe' do
-    interaction = invalid_interaction
-    pipeline = described_class.new do
-      pipe interaction
-    end
-
-    options = { a: rand }
-    expect(pipeline.run(options)).to be_invalid
-  end
-
-  it 'succeeds with one pipe' do
-    interaction = swap_interaction
-    pipeline = described_class.new do
-      pipe interaction
-    end
-
-    options = { a: rand, b: rand }
-    expect(pipeline.run(options).result).to eq(a: options[:b], b: options[:a])
-  end
-
-  it 'succeeds with two pipes' do
-    interaction = swap_interaction
-    pipeline = described_class.new do
-      pipe interaction
-      pipe interaction
-    end
-
-    options = { a: rand, b: rand }
-    expect(pipeline.run(options).result).to eq options
-  end
-
-  it 'succeeds with an implicit transformation' do
-    interaction = square_interaction
-    pipeline = described_class.new do
-      pipe interaction
-    end
-
-    options = { a: rand }
-    expect(pipeline.run(options).result).to eq options[:a] ** 2
-  end
-
-  it 'succeeds with a symbolic transformation' do
-    interaction = square_interaction
-    pipeline = described_class.new do
-      pipe interaction, :a
-    end
-
-    options = rand
-    expect(pipeline.run(options).result).to eq options ** 2
-  end
-
-  it 'succeeds with a lambda transformation' do
-    interaction = square_interaction
-    pipeline = described_class.new do
-      pipe interaction, -> result { { a: 2 * result } }
-    end
-
-    options = rand
-    expect(pipeline.run(options).result).to eq (2 * options) ** 2
-  end
-
-  describe '#run!' do
-    it 'raises an error with one invalid pipe' do
-      interaction = invalid_interaction
-      pipeline = described_class.new do
-        pipe interaction
-      end
-
-      options = { a: rand }
-      expect {
-        pipeline.run!(options)
-      }.to raise_error ActiveInteraction::InvalidInteractionError
-    end
-
-    it 'returns the outcome with one valid pipe' do
-      interaction = square_interaction
-      pipeline = described_class.new do
-        pipe interaction
-      end
-
-      options = { a: rand }
-      expect(pipeline.run!(options)).to eq options[:a] ** 2
-    end
-  end
-end