active_interaction 3.7.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af64e2c9d517eda9f5f86be8927f2d8d82b53f905112379ca49bb6e42e487e99
-  data.tar.gz: 9f59937f4722d923d79611a9c99b81a0ee920e405352ee48cf01050000bc06d3
+  metadata.gz: 46534b15fa7a2aa90e5dcaa3917d63ac4c5aa2b1b06b265dfd284437c1d9de0e
+  data.tar.gz: f9c562732b0bc2335876a6325a959b9d7b440825224359eecfe6446cb32e92f9
 SHA512:
-  metadata.gz: eb7c7b81e0105785bba793aa3ca5466daea5f49e197a5461689c45b1b5f637fdd18f1d58ed394afa7f23a28a1d8a39d16c7c146ad05055e577f89760508ee879
-  data.tar.gz: 277a4bebd07bb0c8465851104a95b0ea9c3d7d07de4386c20082551b4bd2ce09a822687d9d891322825625daf76ec5e4606b19b97308475ec735a5ad73f42356
+  metadata.gz: ec99ac3c5b256f9645902a467b838567a57172d97712e2eeebf1ef6952bed1c48d48706080b122d168a682182ad8999ada7d26a5964946e3d2718dad5ad1fabe
+  data.tar.gz: 2749a5436350022dc15e625e24159f05e8d3205adf7a6568754aaea2c3c93aab62f82d8848549ea6a2c96611130fbb64ad424a79dd9368a696101705dad4468c

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [3.8.0][] (2020-02-28)
+
+## Added
+
+- [#477][] `InvalidInteractionError` now provides access to the failing interaction by calling `interaction`.
+- [#476][] Update `given?` to check for items in an array by passing an index.
+
 # [3.7.1][] (2019-03-20)
 
 ## Fixed
@@ -752,6 +759,7 @@ Example.run
 
 - Initial release.
 
+  [3.8.0]: https://github.com/AaronLasseigne/active_interaction/compare/v3.7.1...v3.8.0
   [3.7.1]: https://github.com/AaronLasseigne/active_interaction/compare/v3.7.0...v3.7.1
   [3.7.0]: https://github.com/AaronLasseigne/active_interaction/compare/v3.6.2...v3.7.0
   [3.6.2]: https://github.com/AaronLasseigne/active_interaction/compare/v3.6.1...v3.6.2
@@ -946,3 +954,5 @@ Example.run
   [#454]: https://github.com/AaronLasseigne/active_interaction/pull/454
   [#455]: https://github.com/AaronLasseigne/active_interaction/pull/455
   [#457]: https://github.com/AaronLasseigne/active_interaction/issues/457
+  [#477]: https://github.com/AaronLasseigne/active_interaction/issues/477
+  [#476]: https://github.com/AaronLasseigne/active_interaction/issues/476

data/README.md

@@ -66,13 +66,13 @@ handles your verbs.
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 3.7'
+gem 'active_interaction', '~> 3.8'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 3.7'
+$ gem install active_interaction --version '~> 3.8'
 ```
 
 This project uses [Semantic Versioning][]. Check out [GitHub releases][] for a
@@ -378,6 +378,25 @@ InterfaceInteraction.run!(serializer: JSON)
 # => "{\"is_json\":true}"
 ```
 
+NOTE: The `methods` option is optional.
+
+```rb
+class InterfaceInteraction < ActiveInteraction::Base
+  interface :anything
+
+  def execute
+    anything.class
+  end
+end
+
+require 'json'
+
+InterfaceInteraction.run!(anything: Hash.new)
+# => Hash
+InterfaceInteraction.run!
+# => NilClass
+```
+
 ### Object
 
 Object filters allow you to require an instance of a particular class. It
@@ -668,7 +687,7 @@ sensible (e.g. `base: 10`).
 class IntegerInteraction < ActiveInteraction::Base
   integer :limit1, base: 10
   integer :limit2
-  
+
   def execute
     [limit1, limit2]
   end
@@ -1322,7 +1341,8 @@ whether a value was passed to `run` or the result of a filter default. In
 particular, it is useful when `nil` is an acceptable value. For example, you
 may optionally track your users' birthdays. You can use the `given?` predicate
 to see if an input was even passed to `run`. With `given?` you can also check
-the input of a hash filter by passing a series of keys to check.
+the input of a hash or array filter by passing a series of keys or indexes to
+check.
 
 ``` rb
 class UpdateUser < ActiveInteraction::Base

data/lib/active_interaction/base.rb

@@ -28,7 +28,7 @@ module ActiveInteraction
   #   else
   #     outcome.errors
   #   end
-  class Base
+  class Base # rubocop:disable Metrics/ClassLength
     include ActiveModelable
     include ActiveRecordable
     include Runnable
@@ -203,7 +203,8 @@ module ActiveInteraction
     # Returns `true` if the given key was in the hash passed to {.run}.
     # Otherwise returns `false`. Use this to figure out if an input was given,
     # even if it was `nil`. Keys within nested hash filter can also be checked
-    # by passing them in series.
+    # by passing them in series. Arrays can be checked in the same manor as
+    # hashes by passing an index.
     #
     # @example
     #   class Example < ActiveInteraction::Base
@@ -219,32 +220,49 @@ module ActiveInteraction
     #     hash :x, default: {} do
     #       integer :y, default: nil
     #     end
-    #     def execute; given?(:x, :y) end
+    #     array :a, default: [] do
+    #       integer
+    #     end
+    #     def execute; given?(:x, :y) || given?(:a, 2) end
     #   end
     #   Example.run!()               # => false
     #   Example.run!(x: nil)         # => false
     #   Example.run!(x: {})          # => false
     #   Example.run!(x: { y: nil })  # => true
     #   Example.run!(x: { y: rand }) # => true
+    #   Example.run!(a: [1, 2])      # => false
+    #   Example.run!(a: [1, 2, 3])   # => true
     #
     # @param input [#to_sym]
     #
     # @return [Boolean]
     #
     # @since 2.1.0
-    def given?(input, *rest) # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable all
+    def given?(input, *rest)
       filter_level = self.class
       input_level = @_interaction_inputs
 
-      [input, *rest].map(&:to_sym).each do |key|
-        filter_level = filter_level.filters[key]
+      [input, *rest].each do |key_or_index|
+        if key_or_index.is_a?(Symbol) || key_or_index.is_a?(String)
+          key_or_index = key_or_index.to_sym
+          filter_level = filter_level.filters[key_or_index]
+
+          break false if filter_level.nil? || input_level.nil?
+          break false unless input_level.key?(key_or_index) || input_level.key?(key_or_index.to_s)
 
-        break false if filter_level.nil? || input_level.nil?
-        break false unless input_level.key?(key) || input_level.key?(key.to_s)
+          input_level = input_level[key_or_index] || input_level[key_or_index.to_s]
+        else
+          filter_level = filter_level.filters.first.last
 
-        input_level = input_level[key] || input_level[key.to_s]
+          break false if filter_level.nil? || input_level.nil?
+          break false unless key_or_index.between?(-input_level.size, input_level.size - 1)
+
+          input_level = input_level[key_or_index]
+        end
       end && true
     end
+    # rubocop:enable all
 
     protected
 

data/lib/active_interaction/concerns/runnable.rb

@@ -97,11 +97,9 @@ module ActiveInteraction
     def run!
       run
 
-      unless valid?
-        raise InvalidInteractionError, errors.full_messages.join(', ')
-      end
+      return result if valid?
 
-      result
+      raise InvalidInteractionError, self
     end
 
     #

data/lib/active_interaction/errors.rb

@@ -31,7 +31,15 @@ module ActiveInteraction
   # Raised if an interaction is invalid.
   #
   # @return [Class]
-  InvalidInteractionError = Class.new(Error)
+  class InvalidInteractionError < Error
+    attr_reader :interaction
+
+    def initialize(interaction)
+      @interaction = interaction
+
+      super(interaction.errors.full_messages.join(', '))
+    end
+  end
 
   # Raised if a user-supplied value is invalid.
   #

data/lib/active_interaction/locale/ja.yml

@@ -0,0 +1,24 @@
+ja:
+  active_interaction:
+    errors:
+      messages:
+        invalid: は無効です
+        invalid_nested: は無効なネストされた値です (%{name} => %{value})
+        invalid_type: は無効な %{type} です
+        missing: が必要です
+    types:
+      array: 配列
+      boolean: ブール
+      date: 日付
+      date_time: 日時
+      decimal: 10進数
+      file: ファイル
+      float: 浮動小数点数
+      hash: ハッシュ
+      integer: 整数
+      interface: インターフェース
+      object: オブジェクト
+      record: レコード
+      string: 文字
+      symbol: シンボル
+      time: 時間

data/lib/active_interaction/modules/input_processor.rb

@@ -17,8 +17,14 @@ module ActiveInteraction
       def reserved?(name)
         name.to_s.start_with?('_interaction_') ||
           name == :syscall ||
-          Base.method_defined?(name) ||
-          Base.private_method_defined?(name)
+          (
+            Base.method_defined?(name) &&
+            !Object.method_defined?(name)
+          ) ||
+          (
+            Base.private_method_defined?(name) &&
+            !Object.private_method_defined?(name)
+          )
       end
 
       def process(inputs)

data/lib/active_interaction/version.rb

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

data/spec/active_interaction/base_spec.rb

@@ -505,6 +505,79 @@ describe ActiveInteraction::Base do
         expect(result).to be false
       end
     end
+
+    context 'nested array values' do
+      let(:described_class) do
+        Class.new(TestInteraction) do
+          array :x do
+            hash do
+              boolean :y, default: true
+            end
+          end
+
+          def execute; end
+        end
+      end
+
+      context 'has a positive index' do
+        it 'returns true if found' do
+          described_class.class_exec do
+            def execute
+              given?(:x, 0, :y)
+            end
+          end
+
+          inputs[:x] = [{ y: true }]
+          expect(result).to be true
+        end
+
+        it 'returns false if not found' do
+          described_class.class_exec do
+            def execute
+              given?(:x, 0, :y)
+            end
+          end
+
+          inputs[:x] = []
+          expect(result).to be false
+        end
+      end
+
+      context 'has a negative index' do
+        it 'returns true if found' do
+          described_class.class_exec do
+            def execute
+              given?(:x, -1, :y)
+            end
+          end
+
+          inputs[:x] = [{ y: true }]
+          expect(result).to be true
+        end
+
+        it 'returns false if not found' do
+          described_class.class_exec do
+            def execute
+              given?(:x, -1, :y)
+            end
+          end
+
+          inputs[:x] = []
+          expect(result).to be false
+        end
+      end
+
+      it 'returns false if you go too far' do
+        described_class.class_exec do
+          def execute
+            given?(:x, 10, :y)
+          end
+        end
+
+        inputs[:x] = [{}]
+        expect(result).to be false
+      end
+    end
   end
 
   context 'inheritance' do

data/spec/active_interaction/concerns/runnable_spec.rb

@@ -107,11 +107,11 @@ describe ActiveInteraction::Runnable do
           context 'using if' do
             it 'yields errors to the if' do
               has_run = false
-              # rubocop:disable Metic/LineLength
+              # rubocop:disable Metrics/LineLength
               WithFailingCompose.set_callback :execute, :after, if: -> { errors.any? } do
                 has_run = true
               end
-              # rubocop:enable Metic/LineLength
+              # rubocop:enable Metrics/LineLength
 
               WithFailingCompose.run
               expect(has_run).to be_truthy
@@ -369,6 +369,12 @@ describe ActiveInteraction::Runnable do
             result
           end.to raise_error ActiveInteraction::InvalidInteractionError
         end
+
+        it 'adds interaction instance to this error' do
+          expect { result }.to raise_error do |error|
+            expect(error.interaction).to be_a klass
+          end
+        end
       end
     end
   end

data/spec/active_interaction/errors_spec.rb

@@ -1,6 +1,17 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'active_record'
+unless defined?(JRUBY_VERSION) # rubocop:disable Style/IfUnlessModifier
+  require 'sqlite3'
+end
+
+unless defined?(JRUBY_VERSION)
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:'
+  )
+end
 
 describe ActiveInteraction::Errors do
   let(:klass) do
@@ -148,5 +159,42 @@ describe ActiveInteraction::Errors do
         expect(errors.messages[:base]).to include message
       end
     end
+
+    unless defined?(JRUBY_VERSION)
+      context 'with nested errors' do
+        before do
+          # suppress create_table output
+          allow($stdout).to receive(:puts)
+          ActiveRecord::Schema.define do
+            create_table(:as)
+            create_table(:bs) do |t|
+              t.column :a_id, :integer
+              t.column :name, :string
+            end
+          end
+
+          class A < ActiveRecord::Base
+            has_one :b
+            accepts_nested_attributes_for :b
+          end
+
+          class B < ActiveRecord::Base
+            belongs_to :a
+
+            validates :name, presence: true
+          end
+        end
+
+        let(:a) { A.create(b_attributes: { name: nil }) }
+
+        it 'merges the nested errors' do
+          a.valid?
+          expect(a.errors.messages).to eql(:'b.name' => ["can't be blank"])
+          expect(a.errors.size).to eql 1
+          expect { errors.merge!(a.errors) }.to_not raise_error
+          expect(errors.size).to eql 1
+        end
+      end
+    end
   end
 end

data/spec/active_interaction/integration/array_interaction_spec.rb

@@ -1,14 +1,28 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'active_record'
+unless defined?(JRUBY_VERSION) # rubocop:disable Style/IfUnlessModifier
+  require 'sqlite3'
+end
+
+unless defined?(JRUBY_VERSION)
+  ActiveRecord::Base.establish_connection(
+    adapter: 'sqlite3',
+    database: ':memory:'
+  )
 
-module ActiveRecord
-  class Relation
+  ActiveRecord::Schema.define do
+    create_table(:lists)
+    create_table(:elements) { |t| t.column(:list_id, :integer) }
   end
 
-  module Associations
-    class CollectionProxy
-    end
+  class List < ActiveRecord::Base
+    has_many :elements
+  end
+
+  class Element < ActiveRecord::Base
+    belongs_to :list
   end
 end
 
@@ -24,9 +38,10 @@ end
 describe ArrayInteraction do
   include_context 'interactions'
   it_behaves_like 'an interaction', :array, -> { [] }
-  it_behaves_like 'an interaction', :array, -> { ActiveRecord::Relation.new }
-  it_behaves_like 'an interaction', :array,
-    -> { ActiveRecord::Associations::CollectionProxy.new }
+  unless defined?(JRUBY_VERSION)
+    it_behaves_like 'an interaction', :array, -> { Element.where('1 = 1') }
+    it_behaves_like 'an interaction', :array, -> { List.create!.elements }
+  end
 
   context 'with inputs[:a]' do
     let(:a) { [[]] }

data/spec/active_interaction/modules/input_processor_spec.rb

@@ -8,14 +8,16 @@ describe ActiveInteraction::InputProcessor do
       expect(described_class.reserved?('_interaction_')).to be_truthy
     end
 
+    # rubocop:disable Metrics/LineLength
     it 'returns true for existing instance methods' do
       (
-        ActiveInteraction::Base.instance_methods +
-        ActiveInteraction::Base.private_instance_methods
+        (ActiveInteraction::Base.instance_methods - Object.instance_methods) +
+        (ActiveInteraction::Base.private_instance_methods - Object.private_instance_methods)
       ).each do |method|
         expect(described_class.reserved?(method)).to be_truthy
       end
     end
+    # rubocop:enable Metrics/LineLength
 
     it 'returns false for anything else' do
       expect(described_class.reserved?(SecureRandom.hex)).to be_falsey

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.8.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2020-02-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -45,6 +45,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 description: |2
       ActiveInteraction manages application-specific business logic. It is an
       implementation of the command pattern in Ruby.
@@ -190,6 +218,7 @@ files:
 - lib/active_interaction/locale/en.yml
 - lib/active_interaction/locale/fr.yml
 - lib/active_interaction/locale/it.yml
+- lib/active_interaction/locale/ja.yml
 - lib/active_interaction/locale/pt-BR.yml
 - lib/active_interaction/modules/input_processor.rb
 - lib/active_interaction/modules/validation.rb
@@ -264,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Manage application specific business logic.