active_interaction 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 29e4b39bc19f6cbe5c7480b4bf43498e7d3013e5
-  data.tar.gz: 4e705bc6abe8355b03c3c7818869aec7797bd4d4
+  metadata.gz: bcb762bfdc148c4eeb1e277f07e13c60fb3944d8
+  data.tar.gz: 7676378a761abeadec3fecc6e350dd27a7fbdd37
 SHA512:
-  metadata.gz: ea5472b8cbf5ad563b43e0e8b5cd97da6a9c7284bd3c5134271ef7ed92bc7342b3c5e1f5b5e48805bac7f9dc4c8ca977798704cd914f4488f7759630e25b5ac2
-  data.tar.gz: 046f316bd5cf3962bd083a6afb4876bbf2c73c7a78b7ad47fb8aefa2f7d38301a4c198711c1bcef2c300e5e0c2b2989f50790bd79c09f421d3b68c5587a625ec
+  metadata.gz: 4abdb88c3887e65abed055d535a49ebf8ff9ccd42fba9798315c3f0cb7646461c60007381867c32a8a5f8b4c87082bd4a8bedd3905e3fec041cd0457daed94e9
+  data.tar.gz: b8c6e2b73a547575e9eaa92c3d412044174e3ea1196dd6a868ad17fb657cdbb495a5455f9411ba5bba9f1c76350bf7505ac78f576cae5b8a7080e0e5a751751b

data/README.md

@@ -3,12 +3,11 @@
 ActiveInteraction manages application-specific business logic.
 It's an implementation of the command pattern in Ruby.
 
-[![Version](https://img.shields.io/gem/v/active_interaction.svg?label=version)](https://rubygems.org/gems/active_interaction)
-[![Build](https://img.shields.io/travis/orgsync/active_interaction/master.svg?label=build)](https://travis-ci.org/orgsync/active_interaction)
-[![Coverage](https://img.shields.io/coveralls/orgsync/active_interaction/master.svg?label=coverage)](https://coveralls.io/r/orgsync/active_interaction)
-[![Climate](https://img.shields.io/codeclimate/github/orgsync/active_interaction.svg?label=climate)](https://codeclimate.com/github/orgsync/active_interaction)
-[![Grade](https://img.shields.io/badge/grade-A-brightgreen.svg)](http://www.libgrader.com/libraries/ruby/active_interaction)
-[![Dependencies](https://img.shields.io/gemnasium/orgsync/active_interaction.svg?label=dependencies)](https://gemnasium.com/orgsync/active_interaction)
+[![Version](https://badge.fury.io/rb/active_interaction.svg)](https://rubygems.org/gems/active_interaction)
+[![Build](https://travis-ci.org/orgsync/active_interaction.svg?branch=master)](https://travis-ci.org/orgsync/active_interaction)
+[![Coverage](https://coveralls.io/repos/github/orgsync/active_interaction/badge.svg?branch=master)](https://coveralls.io/r/orgsync/active_interaction)
+[![Climate](https://codeclimate.com/github/orgsync/active_interaction/badges/gpa.svg)](https://codeclimate.com/github/orgsync/active_interaction)
+[![Dependencies](https://gemnasium.com/orgsync/active_interaction.svg)](https://gemnasium.com/orgsync/active_interaction)
 
 ---
 
@@ -67,23 +66,22 @@ Read more on [the project page][] or check out [the full documentation][].
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 3.0'
+gem 'active_interaction', '~> 3.2'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 3.0'
+$ gem install active_interaction --version '~> 3.2'
 ```
 
 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.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.
+ActiveInteraction works with Ruby 2.0 through 2.3 and ActiveModel 4.0 through
+5.0. If you want to use ActiveInteraction with an older version of Ruby or
+ActiveModel, use ActiveInteraction < 3.0.0.
 
 ## Basic usage
 
@@ -172,9 +170,9 @@ class SayHello < ActiveInteraction::Base
 end
 ```
 
-When you run this interaction, two things will happen. **First ActiveInteraction
-will type check your inputs. Then ActiveModel will validate them.** If both of
-those are happy, it will be executed.
+When you run this interaction, two things will happen. **First
+ActiveInteraction will type check your inputs. Then ActiveModel will validate
+them.** If both of those are happy, it will be executed.
 
 ``` rb
 SayHello.run!(name: nil)
@@ -189,14 +187,14 @@ SayHello.run!(name: 'Taylor')
 
 ## Filters
 
-You can define filters inside an interaction using the appropriate class method.
-Each method has the same signature:
+You can define filters inside an interaction using the appropriate class
+method. Each method has the same signature:
 
 - Some symbolic names. These are the attributes to create.
 
 - An optional hash of options. Each filter supports at least these two options:
 
-  - `default` is the fallback value to use if `nil` is give. To make a filter
+  - `default` is the fallback value to use if `nil` is given. To make a filter
     optional, set `default: nil`.
 
   - `desc` is a human-readable description of the input. This can be useful for
@@ -218,7 +216,7 @@ array :x, :y, :z,
   end
 ```
 
-In general, filters accept values of the type the correspond to, plus a few
+In general, filters accept values of the type they correspond to, plus a few
 alternatives that can be reasonably coerced. Typically the coercions come from
 Rails, so `"1"` can be interpreted as the boolean value `true`, the string
 `"1"`, or the number `1`.
@@ -875,8 +873,10 @@ 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.
-In order to use this structure add `config.autoload_paths += Dir.glob("#{config.root}/app/interactions/*")` in your `application.rb`
+`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`
 
 ```
 - app/
@@ -1306,6 +1306,11 @@ SayHello.run!(name: 'Taylor')
 # => "Hello, Taylor!"
 ```
 
+This can be confusing for boolean inputs. If you have some boolean input `foo`,
+then the actual value of that input is available through `foo`. The associated
+predicate method, `#foo?`, will tell you if that value is not `nil`. So it will
+only be `false` if the input is optional and happens to be `nil`.
+
 See [the optional inputs section][] for help on determining if an input was
 present in the input hash instead of just `nil`.
 

data/lib/active_interaction/base.rb

@@ -93,7 +93,7 @@ module ActiveInteraction
       end
 
       # @private
-      def method_missing(*args, &block)
+      def method_missing(*args, &block) # rubocop:disable Style/MethodMissing
         super do |klass, names, options|
           raise InvalidFilterError, 'missing attribute name' if names.empty?
 
@@ -107,7 +107,9 @@ module ActiveInteraction
       # @param name [Symbol]
       # @param options [Hash]
       def add_filter(klass, name, options, &block)
-        raise InvalidFilterError, name.inspect if InputProcessor.reserved?(name)
+        if InputProcessor.reserved?(name)
+          raise InvalidFilterError, %("#{name}" is a reserved name)
+        end
 
         initialize_filter(klass.new(name, options, &block))
       end
@@ -167,8 +169,7 @@ module ActiveInteraction
     #
     # @private
     def initialize(inputs = {})
-      raise ArgumentError, 'inputs must be a hash' unless inputs.is_a?(Hash)
-
+      inputs = normalize_inputs!(inputs)
       process_inputs(inputs.symbolize_keys)
     end
 
@@ -232,6 +233,21 @@ module ActiveInteraction
 
     private
 
+    # We want to allow both `Hash` objects and `ActionController::Parameters`
+    # objects. In Rails < 5, parameters are a subclass of hash and calling
+    # `#symbolize_keys` returns the entire hash, not just permitted values. In
+    # Rails >= 5, parameters are not a subclass of hash but calling
+    # `#to_unsafe_h` returns the entire hash.
+    def normalize_inputs!(inputs)
+      return inputs if inputs.is_a?(Hash)
+
+      parameters = 'ActionController::Parameters'
+      klass = parameters.safe_constantize
+      return inputs.to_unsafe_h if klass && inputs.is_a?(klass)
+
+      raise ArgumentError, "inputs must be a hash or #{parameters}"
+    end
+
     # @param inputs [Hash{Symbol => Object}]
     def process_inputs(inputs)
       @_interaction_keys = inputs.keys.to_set & self.class.filters.keys

data/lib/active_interaction/filters/array_filter.rb

@@ -40,7 +40,7 @@ module ActiveInteraction
       end
     end
 
-    def method_missing(*, &block)
+    def method_missing(*, &block) # rubocop:disable Style/MethodMissing
       super do |klass, names, options|
         filter = klass.new(name.to_s.singularize.to_sym, options, &block)
 

data/lib/active_interaction/filters/hash_filter.rb

@@ -40,7 +40,7 @@ module ActiveInteraction
       end
     end
 
-    def method_missing(*args, &block)
+    def method_missing(*args, &block) # rubocop:disable Style/MethodMissing
       super(*args) do |klass, names, options|
         raise InvalidFilterError, 'missing attribute name' if names.empty?
 

data/lib/active_interaction/locale/fr.yml

@@ -3,21 +3,21 @@ fr:
     errors:
       messages:
         invalid: est invalide
-        invalid_nested: possède une nested value invalide (%{name} => %{value})
-        invalid_type: n'est pas un %{type}
+        invalid_nested: contient une valeur imbriquée invalide (%{name} => %{value})
+        invalid_type: a un type invalide (%{type})
         missing: est obligatoire
     types:
-      array: array
-      boolean: boolean
+      array: tableau
+      boolean: booléen
       date: date
-      date_time: date time
-      decimal: decimal
-      file: file
-      float: float
-      hash: hash
-      integer: integer
+      date_time: date et heure
+      decimal: nombre décimal
+      file: fichier
+      float: nombre à virgule flottante
+      hash: tableau associatif
+      integer: nombre entier
       interface: interface
-      object: object
-      string: string
-      symbol: symbol
-      time: time
+      object: objet
+      string: chaîne de caractères
+      symbol: symbole
+      time: temps

data/lib/active_interaction/modules/input_processor.rb

@@ -13,7 +13,9 @@ module ActiveInteraction
       private_constant :GROUPED_INPUT_PATTERN
 
       def reserved?(name)
-        name.to_s.start_with?('_interaction_')
+        name.to_s.start_with?('_interaction_') ||
+          Base.instance_methods.include?(name) ||
+          Base.private_instance_methods.include?(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.2.0')
+  VERSION = Gem::Version.new('3.3.0')
 end

data/spec/active_interaction/base_spec.rb

@@ -1,6 +1,7 @@
 # coding: utf-8
 
 require 'spec_helper'
+require 'action_controller'
 
 InteractionWithFilter = Class.new(TestInteraction) do
   float :thing
@@ -58,6 +59,22 @@ describe ActiveInteraction::Base do
       end
     end
 
+    context 'with non-hash inputs' do
+      let(:inputs) { [[:k, :v]] }
+
+      it 'raises an error' do
+        expect { interaction }.to raise_error ArgumentError
+      end
+    end
+
+    context 'with ActionController::Parameters inputs' do
+      let(:inputs) { ActionController::Parameters.new }
+
+      it 'does not raise an error' do
+        expect { interaction }.to_not raise_error
+      end
+    end
+
     context 'with a reader' do
       let(:described_class) do
         Class.new(TestInteraction) do

data/spec/active_interaction/modules/input_processor_spec.rb

@@ -8,6 +8,15 @@ describe ActiveInteraction::InputProcessor do
       expect(described_class.reserved?('_interaction_')).to be_truthy
     end
 
+    it 'returns true for existing instance methods' do
+      (
+        ActiveInteraction::Base.instance_methods +
+        ActiveInteraction::Base.private_instance_methods
+      ).each do |method|
+        expect(described_class.reserved?(method)).to be_truthy
+      end
+    end
+
     it 'returns false for anything else' do
       expect(described_class.reserved?(SecureRandom.hex)).to be_falsey
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-07 00:00:00.000000000 Z
+date: 2016-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -51,28 +51,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -93,70 +93,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11.1'
+        version: '11.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.42.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: 0.42.0
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.9'
 description: |2
       ActiveInteraction manages application-specific business logic. It is an
       implementation of the command pattern in Ruby.
@@ -325,4 +325,3 @@ test_files:
 - spec/support/concerns.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb
-has_rdoc: