active_interaction 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ab0b6acaa850b033873f57885ab405bd0617fb1
-  data.tar.gz: fa8014160f12647a93e6630e740a7caea0b6e866
+  metadata.gz: 66bb9089f91627be5b2370b6e68eb216ff3da581
+  data.tar.gz: 0f107c34005d354adb1fc2bad3b72776b588b455
 SHA512:
-  metadata.gz: 7c3ba3db8d3d3f6886e0badc849f80036d7633bdc2e4cfef8da3fcf07c556167181bd182757f0b0aae8fd9fc8d273b75a3bcf88d320310f5f7bc41ea6f8d0490
-  data.tar.gz: 9b0588c2945678a31fbf315bf2b44f2168d5dbfad1e4398e2c07a558f91ae0fa66ac15622a3b4b049ee103b863ed290091963098cccc1c35e74f64a361b8ee22
+  metadata.gz: d17dab874880c2d8b363e749ef785800bece6d567196937968bd20637a8f7c1df5e653583d0397f11b2934d2c00aba16ada93af8e7b0abda6aa53df07de91463
+  data.tar.gz: 09dbd1ee68e85d8a0b49e492eb2043e75350fb6194385f654cb95fed861bfb63046e53ce7f909f83e0b90ea4097b71e2616d2ba11f6968b864b8004f07906d01

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [3.0.0][] (2016-01-13)
+
+## Changed
+
+- [#333][]: Copy symbolic errors when using `compose`.
+
+## Removed
+
+- [#344][]: Support for Ruby 1.9.3.
+- [#346][]: Support for ActiveModel 3.2.
+
 # [2.2.0][] (2015-12-18)
 
 ## Added
@@ -493,6 +504,7 @@ For help upgrading to version 2, please read [the announcement post][].
 
 - Initial release.
 
+  [3.0.0]: https://github.com/orgsync/active_interaction/compare/v2.2.0...v3.0.0
   [2.2.0]: https://github.com/orgsync/active_interaction/compare/v2.1.5...v2.2.0
   [2.1.5]: https://github.com/orgsync/active_interaction/compare/v2.1.4...v2.1.5
   [2.1.4]: https://github.com/orgsync/active_interaction/compare/v2.1.3...v2.1.4
@@ -644,6 +656,9 @@ For help upgrading to version 2, please read [the announcement post][].
   [#320]: https://github.com/orgsync/active_interaction/issues/320
   [#330]: https://github.com/orgsync/active_interaction/pull/330
   [#332]: https://github.com/orgsync/active_interaction/pull/332
+  [#333]: https://github.com/orgsync/active_interaction/pull/333
   [#336]: https://github.com/orgsync/active_interaction/pull/336
+  [#344]: https://github.com/orgsync/active_interaction/pull/344
+  [#346]: https://github.com/orgsync/active_interaction/pull/346
 
   [the announcement post]: http://devblog.orgsync.com/2015/05/06/announcing-active-interaction-2/

data/README.md

@@ -67,21 +67,23 @@ Read more on [the project page][] or check out [the full documentation][].
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 2.2'
+gem 'active_interaction', '~> 3.0'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 2.2'
+$ gem install active_interaction --version '~> 3.0'
 ```
 
 This project uses [Semantic Versioning][]. Check out [the change log][] for a
 detailed list of changes. For help upgrading to version 2, please read [the
 announcement post][].
 
-ActiveInteraction works with all supported versions of Ruby (2.0 through 2.2)
-and ActiveModel (3.2 through 4.2).
+ActiveInteraction works with all supported versions of Ruby (2.0 through 2.3)
+and ActiveModel (4.0 through 4.2).
+
+If you want to use ActiveInteraction with Ruby < 2.0.0 or ActiveModel < 4.0.0, use ActiveInteraction < 3.0.0.
 
 ## Basic usage
 
@@ -873,7 +875,7 @@ end
 
 We recommend putting your interactions in `app/interactions`. It's also very
 helpful to group them by model. That way you can look in
-`app/interactions/accounts` for all the ways you can interact with accounts.  
+`app/interactions/accounts` for all the ways you can interact with accounts.
 In order to use this structure add `config.autoload_paths += Dir.glob("#{config.root}/app/interactions/*")` in your `application.rb`
 
 ```
@@ -981,6 +983,9 @@ class AddAndDouble < ActiveInteraction::Base
 end
 ```
 
+Note that errors in composed interactions have a few tricky cases. See [the
+errors section][] for more information about them.
+
 ### Defaults
 
 The default value for an input can take on many different forms. Setting the
@@ -1100,6 +1105,42 @@ class UpdateThing < ActiveInteraction::Base
 end
 ```
 
+When a composed interaction fails, its errors are merged onto the caller. This
+generally produces good error messages, but there are a few cases to look out
+for.
+
+``` rb
+class Inner < ActiveInteraction::Base
+  boolean :x, :y
+end
+
+class Outer < ActiveInteraction::Base
+  string :x
+  boolean :z, default: nil
+
+  def execute
+    compose(Inner, x: x, y: z)
+  end
+end
+
+outcome = Outer.run(x: 'yes')
+outcome.errors.details
+# => { :x    => [{ :error => :invalid_type, :type => "boolean" }],
+#      :base => [{ :error => "Y is required" }] }
+outcome.errors.full_messages.join(' and ')
+# => "X is not a valid boolean and Y is required"
+```
+
+Since both interactions have an input called `x`, the inner error for that
+input is moved to the `x` error on the outer interaction. This results in a
+misleading error that claims the input `x` is not a valid boolean even though
+it's a string on the outer interaction.
+
+Since only the inner interaction has an input called `y`, the inner error for
+that input is moved to the `base` error on the outer interaction. This results
+in a confusing error that claims the input `y` is required even though it's not
+present on the outer interaction.
+
 ### Forms
 
 The outcome returned by `.run` can be used in forms as though it were an
@@ -1348,6 +1389,7 @@ ActiveInteraction is licensed under [the MIT License][].
 [formtastic]: https://rubygems.org/gems/formtastic
 [simple_form]: https://rubygems.org/gems/simple_form
 [the filters section]: #filters
+[the errors section]: #errors
 [the optional inputs section]: #optional-inputs
 [aire]: example
 [`with_options`]: http://api.rubyonrails.org/classes/Object.html#method-i-with_options

data/lib/active_interaction/backports.rb

@@ -4,22 +4,7 @@
 require 'active_support/core_ext'
 
 module ActiveInteraction
-  class GroupedInput # rubocop:disable Style/Documentation
-    # Required for Ruby <= 1.9.3.
-    def [](name)
-      send(name)
-    end unless method_defined?(:[])
-
-    # Required for Ruby <= 1.9.3.
-    def []=(name, value)
-      send("#{name}=", value)
-    end unless method_defined?(:[]=)
-  end
-
   class Errors # rubocop:disable Style/Documentation
-    # Required for Rails < 3.2.13.
-    protected :initialize_dup
-
     # Required for Rails < 5.
     #
     # Extracted from active_model-errors_details 1.2.0. Modified to add support
@@ -67,15 +52,4 @@ module ActiveInteraction
     end
     include Details unless method_defined?(:details)
   end
-
-  class HashFilter # rubocop:disable Style/Documentation
-    # Required for Rails < 4.0.0.
-    def self.transform_keys(hash, &block)
-      return hash.transform_keys(&block) if hash.respond_to?(:transform_keys)
-
-      result = {}
-      hash.each_key { |key| result[block.call(key)] = hash[key] }
-      result
-    end
-  end
 end

data/lib/active_interaction/concerns/runnable.rb

@@ -80,18 +80,12 @@ module ActiveInteraction
 
       self.result =
         if result_or_errors.is_a?(ActiveInteraction::Errors)
-          merge_errors_onto_base(result_or_errors)
+          errors.merge!(result_or_errors)
         else
           result_or_errors
         end
     end
 
-    def merge_errors_onto_base(new_errors)
-      new_errors.full_messages.each do |message|
-        errors.add(:base, message) unless errors.added?(:base, message)
-      end
-    end
-
     # @return [Object]
     #
     # @raise [InvalidInteractionError] If there are validation errors.

data/lib/active_interaction/errors.rb

@@ -97,6 +97,10 @@ module ActiveInteraction
     def merge_messages!(other)
       other.messages.each do |attribute, messages|
         messages.each do |message|
+          unless attribute?(attribute)
+            message = full_message(attribute, message)
+            attribute = :base
+          end
           add(attribute, message) unless added?(attribute, message)
         end
       end
@@ -107,9 +111,25 @@ module ActiveInteraction
         details.each do |detail|
           detail = detail.dup
           error = detail.delete(:error)
-          add(attribute, error, detail) unless added?(attribute, error, detail)
+
+          merge_detail!(other, attribute, detail, error)
         end
       end
     end
+
+    def merge_detail!(other, attribute, detail, error)
+      if attribute?(attribute)
+        add(attribute, error, detail) unless added?(attribute, error, detail)
+      else
+        message = full_message(
+          attribute, other.generate_message(attribute, error))
+        attribute = :base
+        add(attribute, message) unless added?(attribute, message)
+      end
+    end
+
+    def attribute?(attribute)
+      @base.respond_to?(attribute)
+    end
   end
 end

data/lib/active_interaction/filter_column.rb

@@ -47,7 +47,7 @@ module ActiveInteraction
     #
     # @return [Boolean]
     def number?
-      [:integer, :float].include?(type)
+      %i[integer float].include?(type)
     end
 
     # Returns `true` if the column is of type :string.

data/lib/active_interaction/filters/interface_filter.rb

@@ -15,7 +15,7 @@ module ActiveInteraction
     #     interface :anything
     #   @example
     #     interface :serializer,
-    #       methods: [:dump, :load]
+    #       methods: %i[dump load]
   end
 
   # @private

data/lib/active_interaction/version.rb

@@ -6,5 +6,5 @@ module ActiveInteraction
   # The version number.
   #
   # @return [Gem::Version]
-  VERSION = Gem::Version.new('2.2.0')
+  VERSION = Gem::Version.new('3.0.0')
 end

data/spec/active_interaction/base_spec.rb

@@ -19,12 +19,12 @@ AddInteraction = Class.new(TestInteraction) do
 end
 
 InterruptInteraction = Class.new(TestInteraction) do
-  object :x, :y,
+  object :x, :z,
     class: Object,
     default: nil
 
   def execute
-    compose(AddInteraction, inputs)
+    compose(AddInteraction, x: x, y: z)
   end
 end
 
@@ -337,11 +337,11 @@ describe ActiveInteraction::Base do
   describe '#compose' do
     let(:described_class) { InterruptInteraction }
     let(:x) { rand }
-    let(:y) { rand }
+    let(:z) { rand }
 
     context 'with valid composition' do
       before do
-        inputs.merge!(x: x, y: y)
+        inputs.merge!(x: x, z: z)
       end
 
       it 'is valid' do
@@ -349,7 +349,7 @@ describe ActiveInteraction::Base do
       end
 
       it 'returns the sum' do
-        expect(result).to eql x + y
+        expect(result).to eql x + z
       end
     end
 
@@ -359,8 +359,8 @@ describe ActiveInteraction::Base do
       end
 
       it 'has the correct errors' do
-        expect(outcome.errors[:base])
-          .to match_array ['X is required', 'Y is required']
+        expect(outcome.errors.details)
+          .to eql(x: [{ error: :missing }], base: [{ error: 'Y is required' }])
       end
     end
   end

data/spec/active_interaction/concerns/missable_spec.rb

@@ -67,7 +67,7 @@ describe ActiveInteraction::Missable do
       end
 
       context 'with names' do
-        let(:names) { [:a, :b, :c] }
+        let(:names) { %i[a b c] }
 
         it 'yields' do
           expect do |b|
@@ -87,7 +87,7 @@ describe ActiveInteraction::Missable do
       end
 
       context 'with names & options' do
-        let(:names) { [:a, :b, :c] }
+        let(:names) { %i[a b c] }
         let(:options) { { a: nil, b: false, c: true } }
 
         it 'yields' do

data/spec/active_interaction/concerns/runnable_spec.rb

@@ -47,7 +47,7 @@ describe ActiveInteraction::Runnable do
             end.to_not raise_error
           end
 
-          [:after, :around, :before].each do |type|
+          %i[after around before].each do |type|
             it type do
               has_run = false
 

data/spec/active_interaction/filters/hash_filter_spec.rb

@@ -6,16 +6,6 @@ describe ActiveInteraction::HashFilter, :filter do
   include_context 'filters'
   it_behaves_like 'a filter'
 
-  context 'backports' do
-    describe '.transform_keys' do
-      it 'transforms keys' do
-        original = { 'key' => 'value' }
-        transformed = described_class.transform_keys(original, &:to_sym)
-        expect(transformed).to eql(key: 'value')
-      end
-    end
-  end
-
   context 'with a nested nameless filter' do
     let(:block) { proc { hash } }
 

data/spec/active_interaction/filters/interface_filter_spec.rb

@@ -8,7 +8,7 @@ describe ActiveInteraction::InterfaceFilter, :filter do
   include_context 'filters'
   it_behaves_like 'a filter'
 
-  before { options[:methods] = [:dump, :load] }
+  before { options[:methods] = %i[dump load] }
 
   describe '#cast' do
     let(:result) { filter.cast(value, nil) }

data/spec/active_interaction/integration/interface_interaction_spec.rb

@@ -13,7 +13,7 @@ describe InterfaceInteraction do
   it_behaves_like 'an interaction',
     :interface,
     -> { [JSON, YAML].sample },
-    methods: [:dump, :load]
+    methods: %i[dump load]
 
   it 'succeeds when given nil' do
     expect { result }.to_not raise_error

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-18 00:00:00.000000000 Z
+date: 2016-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -17,40 +17,34 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '4'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.2'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -298,7 +292,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="