active_interaction 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2eca96d7ec5eccc82c4321445f7c0e009a0d8e6
-  data.tar.gz: '048a0f22cd8c0e2071eb1428aff2cd9c88be0482'
+  metadata.gz: f61c20e8e7ee4f4f1d84d6244f11e4efae82a8b6
+  data.tar.gz: 5164aa102d888aa3405cf66be6b7a72a809fac83
 SHA512:
-  metadata.gz: a67fa88d500066873e6c4626d21fd76c5cf322989fab2fb9ab52f076ce7353d2e22856c4b40b204f23570bfd2d9f218f2c5d2289c77207f43d2a5c21dd557eb7
-  data.tar.gz: 24daf7828183f8093ea7aa19709a0b49f5f8f9f263cf997dd9c5ed32ae5e45beb7267ad892efff27d5318a67c5c6e75f1f31d9048e734284aabf0da4fbdbb65a
+  metadata.gz: 36e0b36fed1473f0a3c4f3a5008d6a8bb40186923b20122570f8df517c82495d6cfd9fdceea6c5924dbb481b62461f19f9447152d1d1f6f8a499c9935f85312a
+  data.tar.gz: cd74144ec70e28fc1c23fc530edf2195e275333838fed2f22037bb838cf5aaf8323cfb80a984feb0bc23e4c11cbd62352a915c10fc0dc380ac82fcf74c2ba38c

data/README.md

@@ -28,6 +28,7 @@ Read more on [the project page][] or check out [the full documentation][].
   - [Hash](#hash)
   - [Interface](#interface)
   - [Object](#object)
+  - [Record](#record)
   - [String](#string)
   - [Symbol](#symbol)
   - [Dates and times](#dates-and-times)
@@ -66,13 +67,13 @@ Read more on [the project page][] or check out [the full documentation][].
 Add it to your Gemfile:
 
 ``` rb
-gem 'active_interaction', '~> 3.5'
+gem 'active_interaction', '~> 3.6'
 ```
 
 Or install it manually:
 
 ``` sh
-$ gem install active_interaction --version '~> 3.5'
+$ gem install active_interaction --version '~> 3.6'
 ```
 
 This project uses [Semantic Versioning][]. Check out [GitHub releases][] for a
@@ -418,6 +419,61 @@ object :dolly3,
   class: :Sheep
 ```
 
+If you have value objects or you would like to build one object from another,
+you can use the `converter` option. It is only called if the value provided does
+not pass `#is_a?` and `.===` for the object class. The `converter` option
+accepts a symbol that specifies a class method on the object class or a proc.
+Both will be passed the value and any errors thrown inside the converter will
+cause the value to be considered invalid. Any returned value that is not the
+correct class will also be treated as invalid. The value given to the `default`
+option will also be converted.
+
+``` rb
+class ObjectInteraction < ActiveInteraction::Base
+  object :ip_address,
+    class: IPAddr,
+    converter: :new
+
+  def execute
+    ip_address
+  end
+end
+
+ObjectInteraction.run!(ip_address: '192.168.1.1')
+# #<IPAddr: IPv4:192.168.1.1/255.255.255.255>
+
+ObjectInteraction.run!(ip_address: 1)
+# ActiveInteraction::InvalidInteractionError: Ip address is not a valid object
+```
+
+### Record
+
+Record filters allow you to require an instance of a particular class or a value
+that can be used to locate an instance of the object. It checks either `#is_a?`
+on the instance or `.===` on the class. If the value does not match, it will
+call `find` on the class of the record. This is particularly useful when working
+with ActiveRecord objects. Like an object filter, the class is derived from the
+name passed but can be specified with the `class` option. The value given to the
+`default` option will also be found.
+
+``` rb
+class RecordInteraction < ActiveInteraction::Base
+  record :encoding
+
+  def execute
+    encoding
+  end
+end
+
+> RecordInteraction.run!(encoding: Encoding::US_ASCII)
+=> #<Encoding:US-ASCII>
+
+> RecordInteraction.run!(encoding: 'ascii')
+=> #<Encoding:US-ASCII>
+```
+
+A different method can be specified by providing a symbol to the `finder` option.
+
 ### String
 
 String filters define inputs that only accept strings.
@@ -1389,8 +1445,7 @@ I18nInteraction.run(name: false).errors.messages[:name]
 ## Credits
 
 ActiveInteraction is brought to you by [Aaron Lasseigne][] and
-[Taylor Fausak][] from [OrgSync][]. We were inspired by the fantastic work done
-by [Jonathan Novak][] on [Mutations][].
+[Taylor Fausak][] and was originally built at [OrgSync][].
 
 If you want to contribute to ActiveInteraction, please read
 [our contribution guidelines][]. A [complete list of contributors][] is
@@ -1408,8 +1463,6 @@ ActiveInteraction is licensed under [the MIT License][].
 [aaron lasseigne]: https://github.com/AaronLasseigne
 [taylor fausak]: https://github.com/tfausak
 [orgsync]: https://github.com/orgsync
-[jonathan novak]: https://github.com/cypriss
-[mutations]: https://github.com/cypriss/mutations
 [our contribution guidelines]: CONTRIBUTING.md
 [complete list of contributors]: https://github.com/orgsync/active_interaction/graphs/contributors
 [the mit license]: LICENSE.md

data/lib/active_interaction/base.rb

@@ -2,7 +2,6 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/hash/indifferent_access'
-require 'set'
 
 module ActiveInteraction
   # @abstract Subclass and override {#execute} to implement a custom
@@ -233,17 +232,17 @@ module ActiveInteraction
     # @return [Boolean]
     #
     # @since 2.1.0
-    def given?(input, *rest)
+    def given?(input, *rest) # rubocop:disable Metrics/CyclomaticComplexity
       filter_level = self.class
       input_level = @_interaction_inputs
 
       [input, *rest].map(&:to_sym).each do |key|
         filter_level = filter_level.filters[key]
-        if !filter_level || input_level.nil? || !input_level.key?(key)
-          break false
-        end
 
-        input_level = input_level[key]
+        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] || input_level[key.to_s]
       end && true
     end
 
@@ -277,9 +276,7 @@ module ActiveInteraction
       @_interaction_inputs = inputs
 
       inputs.each do |key, value|
-        raise InvalidValueError, key.inspect if InputProcessor.reserved?(key)
-
-        populate_reader(key, value)
+        populate_reader(key, value) unless InputProcessor.reserved?(key)
       end
 
       populate_filters(InputProcessor.process(inputs))

data/lib/active_interaction/errors.rb

@@ -13,6 +13,11 @@ module ActiveInteraction
   # @return [Class]
   InvalidClassError = Class.new(Error)
 
+  # Raised if a converter is invalid.
+  #
+  # @return [Class]
+  InvalidConverterError = Class.new(Error)
+
   # Raised if a default value is invalid.
   #
   # @return [Class]
@@ -48,13 +53,6 @@ module ActiveInteraction
   # @return [Class]
   NoDefaultError = Class.new(Error)
 
-  # Raised if a reserved name is used.
-  #
-  # @return [Class]
-  #
-  # @since 1.2.0
-  ReservedNameError = Class.new(Error)
-
   # Raised if a user-supplied value to a nested hash input is invalid.
   #
   # @return [Class]
@@ -133,7 +131,7 @@ module ActiveInteraction
     end
 
     def merge_detail!(other, attribute, detail, error)
-      if attribute?(attribute)
+      if attribute?(attribute) || attribute == :base
         add(attribute, error, detail) unless added?(attribute, error, detail)
       else
         translated_error = translate(other, attribute, error)

data/lib/active_interaction/filters/object_filter.rb

@@ -10,6 +10,14 @@ module ActiveInteraction
     #   @!macro filter_method_params
     #   @option options [Class, String, Symbol] :class (use the attribute name)
     #     Class name used to ensure the value.
+    #   @option options [Proc, Symbol] :converter A symbol specifying the name
+    #     of a class method of `:class` or a Proc that is called when a new
+    #     value is assigned to the value object. The converter is passed the
+    #     single value that is used in the assignment and is only called if the
+    #     new value is not an instance of `:class`. The class method or proc
+    #     are passed the value. Any error thrown inside the converter is trapped
+    #     and the value provided is treated as invalid. Any returned value that
+    #     is not the correct class will also be treated as invalid.
     #
     #   @example
     #     object :account
@@ -21,18 +29,29 @@ module ActiveInteraction
   class ObjectFilter < Filter
     register :object
 
-    def cast(value, context, reconstantize = true)
+    # rubocop:disable Metrics/MethodLength
+    def cast(value, context, reconstantize: true, convert: true)
       @klass ||= klass
 
       if matches?(value)
         value
-      else
-        return super(value, context) unless reconstantize
-
+      elsif reconstantize
         @klass = klass
-        cast(value, context, false)
+        public_send(__method__, value, context,
+          reconstantize: false,
+          convert: convert
+        )
+      elsif !value.nil? && convert && (converter = options[:converter])
+        value = convert(klass, value, converter)
+        public_send(__method__, value, context,
+          reconstantize: reconstantize,
+          convert: false
+        )
+      else
+        super(value, context)
       end
     end
+    # rubocop:enable Metrics/MethodLength
 
     private
 
@@ -53,5 +72,26 @@ module ActiveInteraction
       @klass === value || # rubocop:disable Style/CaseEquality
         value.is_a?(@klass)
     end
+
+    def convert(klass, value, converter) # rubocop:disable Metrics/MethodLength
+      result =
+        case converter
+        when Proc
+          converter.call(value)
+        when Symbol
+          klass.public_send(converter, value)
+        else
+          raise InvalidConverterError,
+            "#{converter.inspect} is not a valid converter"
+        end
+
+      raise InvalidValueError if result.nil?
+
+      result
+    rescue StandardError => e
+      raise e if e.is_a?(InvalidConverterError)
+
+      raise InvalidValueError
+    end
   end
 end

data/lib/active_interaction/filters/record_filter.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module ActiveInteraction
+  class Base
+    # @!method self.record(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are the correct class.
+    #
+    #   @!macro filter_method_params
+    #   @option options [Class, String, Symbol] :class (use the attribute name)
+    #     Class name used to ensure the value.
+    #   @option options [Symbol] :finder A symbol specifying the name of a
+    #     class method of `:class` that is called when a new value is assigned
+    #     to the object. The finder is passed the single value that is used in
+    #     the assignment and is only called if the new value is not an instance
+    #     of `:class`. The class method is passed the value. Any error thrown
+    #     inside the finder is trapped and the value provided is treated as
+    #     invalid. Any returned value that is not the correct class will also
+    #     be treated as invalid.
+    #
+    #   @example
+    #     record :account
+    #   @example
+    #     record :account, class: User
+  end
+
+  # @private
+  class RecordFilter < Filter
+    register :record
+
+    # rubocop:disable Metrics/MethodLength
+    def cast(value, context, reconstantize: true, convert: true)
+      @klass ||= klass
+
+      if matches?(value)
+        value
+      elsif reconstantize
+        @klass = klass
+        public_send(__method__, value, context,
+          reconstantize: false,
+          convert: convert
+        )
+      elsif !value.nil? && convert
+        finder = options.fetch(:finder, :find)
+        value = find(klass, value, finder)
+        public_send(__method__, value, context,
+          reconstantize: reconstantize,
+          convert: false
+        )
+      else
+        super(value, context)
+      end
+    end
+    # rubocop:enable Metrics/MethodLength
+
+    private
+
+    # @return [Class]
+    #
+    # @raise [InvalidClassError]
+    def klass
+      klass_name = options.fetch(:class, name).to_s.camelize
+      Object.const_get(klass_name)
+    rescue NameError
+      raise InvalidClassError, "class #{klass_name.inspect} does not exist"
+    end
+
+    # @param value [Object]
+    #
+    # @return [Boolean]
+    def matches?(value)
+      @klass === value || # rubocop:disable Style/CaseEquality
+        value.is_a?(@klass)
+    end
+
+    def find(klass, value, finder)
+      result = klass.public_send(finder, value)
+
+      raise InvalidValueError if result.nil?
+
+      result
+    rescue StandardError => e
+      raise e if e.is_a?(InvalidConverterError)
+
+      raise InvalidValueError
+    end
+  end
+end

data/lib/active_interaction/locale/en.yml

@@ -18,6 +18,7 @@ en:
       integer: integer
       interface: interface
       object: object
+      record: record
       string: string
       symbol: symbol
       time: time

data/lib/active_interaction/locale/fr.yml

@@ -18,6 +18,7 @@ fr:
       integer: nombre entier
       interface: interface
       object: objet
+      record: record
       string: chaîne de caractères
       symbol: symbole
       time: temps

data/lib/active_interaction/locale/pt-BR.yml

@@ -18,6 +18,7 @@ pt-BR:
       integer: integer
       interface: interface
       object: object
+      record: record
       string: string
       symbol: symbol
       time: time

data/lib/active_interaction/modules/input_processor.rb

@@ -14,13 +14,13 @@ module ActiveInteraction
 
       def reserved?(name)
         name.to_s.start_with?('_interaction_') ||
-          Base.instance_methods.include?(name) ||
-          Base.private_instance_methods.include?(name)
+          Base.method_defined?(name) ||
+          Base.private_method_defined?(name)
       end
 
       def process(inputs)
         inputs.stringify_keys.sort.each_with_object({}) do |(k, v), h|
-          raise ReservedNameError, k.inspect if reserved?(k)
+          next if reserved?(k)
 
           if (match = GROUPED_INPUT_PATTERN.match(k))
             assign_to_group!(h, *match.captures, v)

data/lib/active_interaction/version.rb

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

data/lib/active_interaction.rb

@@ -42,6 +42,7 @@ require 'active_interaction/filters/float_filter'
 require 'active_interaction/filters/hash_filter'
 require 'active_interaction/filters/integer_filter'
 require 'active_interaction/filters/object_filter'
+require 'active_interaction/filters/record_filter'
 require 'active_interaction/filters/string_filter'
 require 'active_interaction/filters/symbol_filter'
 require 'active_interaction/filters/time_filter'

data/spec/active_interaction/base_spec.rb

@@ -35,20 +35,11 @@ describe ActiveInteraction::Base do
   subject(:interaction) { described_class.new(inputs) }
 
   describe '.new(inputs = {})' do
-    it 'does not allow :_interaction_* as an option' do
-      key = :"_interaction_#{SecureRandom.hex}"
+    it 'does not set instance vars for reserved input names' do
+      key = :execute
       inputs[key] = nil
-      expect do
-        interaction
-      end.to raise_error ActiveInteraction::InvalidValueError
-    end
 
-    it 'does not allow "_interaction_*" as an option' do
-      key = "_interaction_#{SecureRandom.hex}"
-      inputs[key] = nil
-      expect do
-        interaction
-      end.to raise_error ActiveInteraction::InvalidValueError
+      expect(interaction.instance_variable_defined?(:"@#{key}")).to be false
     end
 
     context 'with invalid inputs' do
@@ -449,7 +440,7 @@ describe ActiveInteraction::Base do
         end
       end
 
-      it 'is true when the nested input is given' do
+      it 'is true when the nested inputs symbols are given' do
         described_class.class_exec do
           def execute
             given?(:x, :y)
@@ -460,6 +451,17 @@ describe ActiveInteraction::Base do
         expect(result).to be true
       end
 
+      it 'is true when the nested inputs strings are given' do
+        described_class.class_exec do
+          def execute
+            given?(:x, :y)
+          end
+        end
+
+        inputs['x'] = { 'y' => false }
+        expect(result).to be true
+      end
+
       it 'is false when the nested input is not given' do
         described_class.class_exec do
           def execute

data/spec/active_interaction/errors_spec.rb

@@ -68,6 +68,17 @@ describe ActiveInteraction::Errors do
         end
       end
 
+      context 'that is a symbol on base' do
+        before do
+          other.add(:base)
+        end
+
+        it 'adds the error' do
+          errors.merge!(other)
+          expect(errors.details[:base]).to eql [{ error: :invalid }]
+        end
+      end
+
       context 'that is a string' do
         let(:message) { SecureRandom.hex }
 
@@ -97,7 +108,8 @@ describe ActiveInteraction::Errors do
                 }
               }
             }
-          })
+          }
+        )
 
         other.add(:attribute, :invalid_type, type: nil)
       end

data/spec/active_interaction/filters/object_filter_spec.rb

@@ -2,19 +2,28 @@
 
 require 'spec_helper'
 
-class Thing; end
-class Things; end
+class ObjectThing
+  def self.converter(_)
+    @converter ||= new
+  end
+
+  def self.converter_with_error(_)
+    raise 'error'
+  end
+end
+class ObjectThings; end
+BackupObjectThing = ObjectThing
 
 describe ActiveInteraction::ObjectFilter, :filter do
   include_context 'filters'
   it_behaves_like 'a filter'
 
   before do
-    options[:class] = Thing
+    options[:class] = ObjectThing
   end
 
   describe '#cast' do
-    let(:value) { Thing.new }
+    let(:value) { ObjectThing.new }
     let(:result) { filter.cast(value, nil) }
 
     context 'with class as a Class' do
@@ -25,9 +34,9 @@ describe ActiveInteraction::ObjectFilter, :filter do
       it 'handles reconstantizing' do
         expect(result).to eql value
 
-        Object.send(:remove_const, :Thing)
-        class Thing; end
-        value = Thing.new
+        Object.send(:remove_const, :ObjectThing)
+        ObjectThing = BackupObjectThing
+        value = ObjectThing.new
 
         expect(filter.cast(value, nil)).to eql value
       end
@@ -35,29 +44,17 @@ describe ActiveInteraction::ObjectFilter, :filter do
       it 'handles reconstantizing subclasses' do
         filter
 
-        Object.send(:remove_const, :Thing)
-        class Thing; end
-        class SubThing < Thing; end
-        value = SubThing.new
+        Object.send(:remove_const, :ObjectThing)
+        ObjectThing = BackupObjectThing
+        class SubObjectThing < ObjectThing; end
+        value = SubObjectThing.new
 
         expect(filter.cast(value, nil)).to eql value
       end
 
-      it 'does not overflow the stack' do
-        klass = Class.new do
-          def self.name
-            Thing.name
-          end
-        end
-
-        expect do
-          filter.cast(klass.new, nil)
-        end.to raise_error ActiveInteraction::InvalidValueError
-      end
-
       context 'without the class available' do
-        before { Object.send(:remove_const, :Thing) }
-        after { class Thing; end }
+        before { Object.send(:remove_const, :ObjectThing) }
+        after { ObjectThing = BackupObjectThing }
 
         it 'does not raise an error on initialization' do
           expect { filter }.to_not raise_error
@@ -69,7 +66,7 @@ describe ActiveInteraction::ObjectFilter, :filter do
         let(:class_equality) { false }
 
         before do
-          allow(Thing).to receive(:===).and_return(case_equality)
+          allow(ObjectThing).to receive(:===).and_return(case_equality)
           allow(value).to receive(:is_a?).and_return(class_equality)
         end
 
@@ -101,7 +98,7 @@ describe ActiveInteraction::ObjectFilter, :filter do
 
     context 'with class as a superclass' do
       before do
-        options[:class] = Thing.superclass
+        options[:class] = ObjectThing.superclass
       end
 
       it 'returns the instance' do
@@ -111,7 +108,7 @@ describe ActiveInteraction::ObjectFilter, :filter do
 
     context 'with class as a String' do
       before do
-        options[:class] = Thing.name
+        options[:class] = ObjectThing.name
       end
 
       it 'returns the instance' do
@@ -120,9 +117,9 @@ describe ActiveInteraction::ObjectFilter, :filter do
     end
 
     context 'with a plural class' do
-      let(:value) { Things.new }
+      let(:value) { ObjectThings.new }
 
-      before { options[:class] = Things }
+      before { options[:class] = ObjectThings }
 
       it 'returns the instance' do
         expect(result).to eql value
@@ -140,6 +137,116 @@ describe ActiveInteraction::ObjectFilter, :filter do
         end.to raise_error ActiveInteraction::InvalidClassError
       end
     end
+
+    context 'with a converter' do
+      let(:value) { '' }
+
+      context 'that is a symbol' do
+        before do
+          options[:converter] = :converter
+        end
+
+        it 'calls the class method' do
+          expect(result).to eql ObjectThing.converter(value)
+        end
+      end
+
+      context 'that is a proc' do
+        before do
+          options[:converter] = ->(x) { ObjectThing.converter(x) }
+        end
+
+        it 'gets called' do
+          expect(result).to eql ObjectThing.converter(value)
+        end
+      end
+
+      context 'with a object of the correct class' do
+        let(:value) { ObjectThing.new }
+
+        it 'does not call the converter' do
+          expect(ObjectThing).to_not receive(:converter)
+          expect(result).to eql value
+        end
+      end
+
+      context 'with a object is a subclass' do
+        let(:subclass) { Class.new(ObjectThing) }
+        let(:value) { subclass.new }
+
+        it 'does not call the converter' do
+          expect(subclass).to_not receive(:converter)
+          expect(result).to eql value
+        end
+      end
+
+      context 'with a nil value' do
+        let(:value) { nil }
+        include_context 'optional'
+
+        it 'returns nil' do
+          expect(ObjectThing).to_not receive(:converter)
+          expect(result).to eql value
+        end
+      end
+
+      context 'that is invalid' do
+        before do
+          options[:converter] = 'invalid converter'
+        end
+
+        it 'raises an error' do
+          expect do
+            result
+          end.to raise_error ActiveInteraction::InvalidConverterError
+        end
+      end
+
+      context 'that throws an error' do
+        before do
+          options[:converter] = :converter_with_error
+        end
+
+        it 'raises an error' do
+          expect do
+            result
+          end.to raise_error ActiveInteraction::InvalidValueError
+        end
+      end
+    end
+  end
+
+  describe '#clean' do
+    context 'with a converter' do
+      context 'that returns a nil' do
+        let(:value) { '' }
+
+        before do
+          options[:default] = ObjectThing.new
+          options[:converter] = ->(_) { nil }
+        end
+
+        it 'raises an error' do
+          expect do
+            filter.clean(value, nil)
+          end.to raise_error ActiveInteraction::InvalidValueError
+        end
+      end
+
+      context 'that returns an invalid value' do
+        let(:value) { '' }
+
+        before do
+          options[:converter] = ->(_) { 'invalid' }
+        end
+
+        it 'raises an error' do
+          expect do
+            filter.clean(value, nil)
+          end.to raise_error ActiveInteraction::InvalidValueError
+        end
+      end
+    end
   end
 
   describe '#database_column_type' do

data/spec/active_interaction/filters/record_filter_spec.rb

@@ -0,0 +1,210 @@
+require 'spec_helper'
+
+class RecordThing
+  def self.find(_)
+    raise 'error'
+  end
+
+  def self.finder(_)
+    @record2 ||= new
+  end
+
+  def self.finds_nil(_)
+    nil
+  end
+
+  def self.finds_bad_value(_)
+    ''
+  end
+
+  def self.passthrough(x)
+    x
+  end
+end
+class RecordThings; end
+BackupRecordThing = RecordThing
+
+describe ActiveInteraction::RecordFilter, :filter do
+  include_context 'filters'
+  it_behaves_like 'a filter'
+
+  before do
+    options[:class] = RecordThing
+  end
+
+  describe '#cast' do
+    before do
+      options[:finder] = :finder
+    end
+
+    let(:value) { RecordThing.new }
+    let(:result) { filter.cast(value, nil) }
+
+    context 'with class as a Class' do
+      it 'returns the instance' do
+        expect(result).to eql value
+      end
+
+      it 'handles reconstantizing' do
+        expect(result).to eql value
+
+        Object.send(:remove_const, :RecordThing)
+        RecordThing = BackupRecordThing
+        value = RecordThing.new
+
+        expect(filter.cast(value, nil)).to eql value
+      end
+
+      it 'handles reconstantizing subclasses' do
+        filter
+
+        Object.send(:remove_const, :RecordThing)
+        RecordThing = BackupRecordThing
+        class SubRecordThing < RecordThing; end
+        value = SubRecordThing.new
+
+        expect(filter.cast(value, nil)).to eql value
+      end
+
+      context 'without the class available' do
+        before { Object.send(:remove_const, :RecordThing) }
+        after { RecordThing = BackupRecordThing }
+
+        it 'does not raise an error on initialization' do
+          expect { filter }.to_not raise_error
+        end
+      end
+
+      context 'with bidirectional class comparisons' do
+        let(:case_equality) { false }
+        let(:class_equality) { false }
+
+        before do
+          options[:finder] = :passthrough
+
+          allow(RecordThing).to receive(:===).and_return(case_equality)
+          allow(value).to receive(:is_a?).and_return(class_equality)
+        end
+
+        context 'without case or class equality' do
+          it 'raises an error' do
+            expect do
+              result
+            end.to raise_error ActiveInteraction::InvalidValueError
+          end
+        end
+
+        context 'with case equality' do
+          let(:case_equality) { true }
+
+          it 'returns the instance' do
+            expect(result).to eql value
+          end
+        end
+
+        context 'with class equality' do
+          let(:class_equality) { true }
+
+          it 'returns the instance' do
+            expect(result).to eql value
+          end
+        end
+      end
+    end
+
+    context 'with class as a superclass' do
+      before do
+        options[:class] = RecordThing.superclass
+      end
+
+      it 'returns the instance' do
+        expect(result).to eql value
+      end
+    end
+
+    context 'with class as a String' do
+      before do
+        options[:class] = RecordThing.name
+      end
+
+      it 'returns the instance' do
+        expect(result).to eql value
+      end
+    end
+
+    context 'with a plural class' do
+      let(:value) { RecordThings.new }
+
+      before { options[:class] = RecordThings }
+
+      it 'returns the instance' do
+        expect(result).to eql value
+      end
+    end
+
+    context 'with class as an invalid String' do
+      before do
+        options[:class] = 'invalid'
+      end
+
+      it 'raises an error' do
+        expect do
+          result
+        end.to raise_error ActiveInteraction::InvalidClassError
+      end
+    end
+
+    context 'with a value that does not match the class' do
+      let(:value) { '' }
+
+      it 'calls the finder' do
+        expect(result).to eql RecordThing.finder(value)
+      end
+
+      context 'with a custom finder' do
+        it 'calls the custom finder' do
+          expect(result).to eql RecordThing.finder(value)
+        end
+      end
+    end
+  end
+
+  describe '#clean' do
+    context 'with a value that does not match the class' do
+      context 'that returns a nil' do
+        let(:value) { '' }
+
+        before do
+          options[:default] = RecordThing.new
+          options[:finder] = :finds_nil
+        end
+
+        it 'raises an error' do
+          expect do
+            filter.clean(value, nil)
+          end.to raise_error ActiveInteraction::InvalidValueError
+        end
+      end
+
+      context 'that returns an invalid value' do
+        let(:value) { '' }
+
+        before do
+          options[:finder] = :finds_bad_value
+        end
+
+        it 'raises an error' do
+          expect do
+            filter.clean(value, nil)
+          end.to raise_error ActiveInteraction::InvalidValueError
+        end
+      end
+    end
+  end
+
+  describe '#database_column_type' do
+    it 'returns :string' do
+      expect(filter.database_column_type).to eql :string
+    end
+  end
+end

data/spec/active_interaction/i18n_spec.rb

@@ -101,7 +101,8 @@ describe I18nInteraction do
             }
           },
           types: TYPES.each_with_object({}) { |e, a| a[e] = e.reverse }
-        })
+        }
+      )
     end
   end
 end

data/spec/active_interaction/modules/input_processor_spec.rb

@@ -74,10 +74,8 @@ describe ActiveInteraction::InputProcessor do
     context 'with a reserved name' do
       before { inputs[:_interaction_key] = :value }
 
-      it 'raises an error' do
-        expect do
-          result
-        end.to raise_error ActiveInteraction::ReservedNameError
+      it 'skips the input' do
+        expect(result).to_not have_key(:_interaction_key)
       end
     end
   end

data/spec/support/interactions.rb

@@ -24,11 +24,14 @@ shared_examples_for 'an interaction' do |type, generator, filter_options = {}|
       public_send(type, :required, filter_options)
       public_send(type, :optional, filter_options.merge(default: nil))
       public_send(type, :default,
-        filter_options.merge(default: generator.call))
+        filter_options.merge(default: generator.call)
+      )
       public_send(type, :defaults_1, :defaults_2,
-        filter_options.merge(default: generator.call))
+        filter_options.merge(default: generator.call)
+      )
       public_send(type, :defaults_3,
-        filter_options.merge(default: -> { required }))
+        filter_options.merge(default: -> { required })
+      )
     end
   end
 
@@ -36,7 +39,8 @@ shared_examples_for 'an interaction' do |type, generator, filter_options = {}|
     let(:described_class) do
       Class.new(TestInteraction) do
         public_send(type, :default,
-          filter_options.merge(default: -> { Object.new }))
+          filter_options.merge(default: -> { Object.new })
+        )
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_interaction
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Aaron Lasseigne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-19 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -196,6 +196,7 @@ files:
 - lib/active_interaction/filters/integer_filter.rb
 - lib/active_interaction/filters/interface_filter.rb
 - lib/active_interaction/filters/object_filter.rb
+- lib/active_interaction/filters/record_filter.rb
 - lib/active_interaction/filters/string_filter.rb
 - lib/active_interaction/filters/symbol_filter.rb
 - lib/active_interaction/filters/time_filter.rb
@@ -229,6 +230,7 @@ files:
 - spec/active_interaction/filters/integer_filter_spec.rb
 - spec/active_interaction/filters/interface_filter_spec.rb
 - spec/active_interaction/filters/object_filter_spec.rb
+- spec/active_interaction/filters/record_filter_spec.rb
 - spec/active_interaction/filters/string_filter_spec.rb
 - spec/active_interaction/filters/symbol_filter_spec.rb
 - spec/active_interaction/filters/time_filter_spec.rb
@@ -253,7 +255,7 @@ files:
 - spec/support/concerns.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb
-homepage: http://devblog.orgsync.com/active_interaction/
+homepage: https://github.com/AaronLasseigne/active_interaction
 licenses:
 - MIT
 metadata: {}
@@ -273,55 +275,56 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Manage application specific business logic.
 test_files:
-- spec/active_interaction/base_spec.rb
-- spec/active_interaction/concerns/active_modelable_spec.rb
-- spec/active_interaction/concerns/active_recordable_spec.rb
-- spec/active_interaction/concerns/hashable_spec.rb
-- spec/active_interaction/concerns/missable_spec.rb
-- spec/active_interaction/concerns/runnable_spec.rb
-- spec/active_interaction/errors_spec.rb
-- spec/active_interaction/filter_column_spec.rb
-- spec/active_interaction/filter_spec.rb
+- spec/spec_helper.rb
+- spec/active_interaction/grouped_input_spec.rb
+- spec/active_interaction/filters/hash_filter_spec.rb
 - spec/active_interaction/filters/abstract_date_time_filter_spec.rb
-- spec/active_interaction/filters/abstract_filter_spec.rb
-- spec/active_interaction/filters/abstract_numeric_filter_spec.rb
-- spec/active_interaction/filters/array_filter_spec.rb
 - spec/active_interaction/filters/boolean_filter_spec.rb
-- spec/active_interaction/filters/date_filter_spec.rb
-- spec/active_interaction/filters/date_time_filter_spec.rb
-- spec/active_interaction/filters/decimal_filter_spec.rb
-- spec/active_interaction/filters/file_filter_spec.rb
+- spec/active_interaction/filters/array_filter_spec.rb
+- spec/active_interaction/filters/time_filter_spec.rb
+- spec/active_interaction/filters/abstract_filter_spec.rb
 - spec/active_interaction/filters/float_filter_spec.rb
-- spec/active_interaction/filters/hash_filter_spec.rb
+- spec/active_interaction/filters/date_filter_spec.rb
 - spec/active_interaction/filters/integer_filter_spec.rb
-- spec/active_interaction/filters/interface_filter_spec.rb
 - spec/active_interaction/filters/object_filter_spec.rb
-- spec/active_interaction/filters/string_filter_spec.rb
 - spec/active_interaction/filters/symbol_filter_spec.rb
-- spec/active_interaction/filters/time_filter_spec.rb
-- spec/active_interaction/grouped_input_spec.rb
+- spec/active_interaction/filters/string_filter_spec.rb
+- spec/active_interaction/filters/abstract_numeric_filter_spec.rb
+- spec/active_interaction/filters/decimal_filter_spec.rb
+- spec/active_interaction/filters/file_filter_spec.rb
+- spec/active_interaction/filters/interface_filter_spec.rb
+- spec/active_interaction/filters/record_filter_spec.rb
+- spec/active_interaction/filters/date_time_filter_spec.rb
 - spec/active_interaction/i18n_spec.rb
-- spec/active_interaction/integration/array_interaction_spec.rb
 - spec/active_interaction/integration/boolean_interaction_spec.rb
 - spec/active_interaction/integration/date_interaction_spec.rb
-- spec/active_interaction/integration/date_time_interaction_spec.rb
-- spec/active_interaction/integration/file_interaction_spec.rb
+- spec/active_interaction/integration/symbol_interaction_spec.rb
+- spec/active_interaction/integration/interface_interaction_spec.rb
+- spec/active_interaction/integration/time_interaction_spec.rb
 - spec/active_interaction/integration/float_interaction_spec.rb
-- spec/active_interaction/integration/hash_interaction_spec.rb
 - spec/active_interaction/integration/integer_interaction_spec.rb
-- spec/active_interaction/integration/interface_interaction_spec.rb
-- spec/active_interaction/integration/object_interaction_spec.rb
 - spec/active_interaction/integration/string_interaction_spec.rb
-- spec/active_interaction/integration/symbol_interaction_spec.rb
-- spec/active_interaction/integration/time_interaction_spec.rb
-- spec/active_interaction/modules/input_processor_spec.rb
+- spec/active_interaction/integration/array_interaction_spec.rb
+- spec/active_interaction/integration/hash_interaction_spec.rb
+- spec/active_interaction/integration/date_time_interaction_spec.rb
+- spec/active_interaction/integration/file_interaction_spec.rb
+- spec/active_interaction/integration/object_interaction_spec.rb
+- spec/active_interaction/filter_column_spec.rb
+- spec/active_interaction/errors_spec.rb
 - spec/active_interaction/modules/validation_spec.rb
-- spec/spec_helper.rb
-- spec/support/concerns.rb
+- spec/active_interaction/modules/input_processor_spec.rb
+- spec/active_interaction/filter_spec.rb
+- spec/active_interaction/base_spec.rb
+- spec/active_interaction/concerns/active_modelable_spec.rb
+- spec/active_interaction/concerns/hashable_spec.rb
+- spec/active_interaction/concerns/active_recordable_spec.rb
+- spec/active_interaction/concerns/missable_spec.rb
+- spec/active_interaction/concerns/runnable_spec.rb
 - spec/support/filters.rb
 - spec/support/interactions.rb
+- spec/support/concerns.rb