active_interaction 1.4.1 → 2.0.0

data/lib/active_interaction/backports.rb

@@ -1,8 +1,7 @@
 # coding: utf-8
 
-# rubocop:disable Documentation
 module ActiveInteraction
-  class GroupedInput
+  class GroupedInput # rubocop:disable Style/Documentation
     # Required for Ruby <= 1.9.3.
     def [](name)
       send(name)
@@ -14,20 +13,66 @@ module ActiveInteraction
     end unless method_defined?(:[]=)
   end
 
-  class Errors
+  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
+    # for ActiveModel 3.2.0.
+    module Details
+      extend ActiveSupport::Concern
+
+      CALLBACKS_OPTIONS = ::ActiveModel::Errors::CALLBACKS_OPTIONS
+      private_constant :CALLBACKS_OPTIONS
+
+      included do
+        attr_reader :details
+
+        %w[initialize initialize_dup add clear delete].each do |method|
+          alias_method_chain method, :details
+        end
+      end
+
+      def initialize_with_details(base)
+        @details = Hash.new { |details, attribute| details[attribute] = [] }
+        initialize_without_details(base)
+      end
+
+      def initialize_dup_with_details(other)
+        @details = other.details.deep_dup
+        initialize_dup_without_details(other)
+      end
+
+      def add_with_details(attribute, message = :invalid, options = {})
+        message = message.call if message.respond_to?(:call)
+        error = options.except(*CALLBACKS_OPTIONS).merge(error: message)
+        details[attribute].push(error)
+        add_without_details(attribute, message, options)
+      end
+
+      def clear_with_details
+        details.clear
+        clear_without_details
+      end
+
+      def delete_with_details(attribute)
+        details.delete(attribute)
+        delete_without_details(attribute)
+      end
+    end
+    include Details unless method_defined?(:details)
   end
-end
 
-# @private
-class Hash
-  # Required for Rails < 4.0.0.
-  def transform_keys
-    result = {}
-    each_key do |key|
-      result[yield(key)] = self[key]
+  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
-    result
-  end unless method_defined?(:transform_keys)
+  end
 end

data/lib/active_interaction/base.rb

@@ -29,6 +29,7 @@ module ActiveInteraction
   #   end
   class Base
     include ActiveModelable
+    include ActiveRecordable
     include Runnable
 
     define_callbacks :type_check
@@ -58,28 +59,6 @@ module ActiveInteraction
       #
       #   @raise (see ActiveInteraction::Runnable::ClassMethods#run!)
 
-      # @!method transaction(enable, options = {})
-      #   Configure transactions by enabling or disabling them and setting
-      #   their options.
-      #
-      #   @example Disable transactions
-      #     Class.new(ActiveInteraction::Base) do
-      #       transaction false
-      #     end
-      #
-      #   @example Use different transaction options
-      #     Class.new(ActiveInteraction::Base) do
-      #       transaction true, isolation: :serializable
-      #     end
-      #
-      #   @param enable [Boolean] Should transactions be enabled?
-      #   @param options [Hash] Options to pass to
-      #     `ActiveRecord::Base.transaction`.
-      #
-      #   @return [nil]
-      #
-      #   @since 1.2.0
-
       # Get or set the description.
       #
       # @example
@@ -120,6 +99,11 @@ module ActiveInteraction
         end
       end
 
+      def model(*)
+        super
+      end
+      ActiveInteraction.deprecate self, :model, 'use `object` instead'
+
       private
 
       # @param klass [Class]
@@ -168,7 +152,13 @@ module ActiveInteraction
         attr_accessor filter.name
         define_method("#{filter.name}?") { !public_send(filter.name).nil? }
 
-        filter.default if filter.default?
+        eagerly_evaluate_default(filter)
+      end
+
+      # @param filter [Filter]
+      def eagerly_evaluate_default(filter)
+        default = filter.options[:default]
+        filter.default if default && !default.is_a?(Proc)
       end
     end
 
@@ -181,31 +171,6 @@ module ActiveInteraction
       process_inputs(inputs.symbolize_keys)
     end
 
-    # Returns the column object for the named filter.
-    #
-    # @param name [Symbol] The name of a filter.
-    #
-    # @example
-    #   class Interaction < ActiveInteraction::Base
-    #     string :email, default: nil
-    #
-    #     def execute; end
-    #   end
-    #
-    #   Interaction.new.column_for_attribute(:email)
-    #   # => #<ActiveInteraction::FilterColumn:0x007faebeb2a6c8 @type=:string>
-    #
-    #   Interaction.new.column_for_attribute(:not_a_filter)
-    #   # => nil
-    #
-    # @return [FilterColumn, nil]
-    #
-    # @since 1.2.0
-    def column_for_attribute(name)
-      filter = self.class.filters[name]
-      FilterColumn.intern(filter.database_column_type) if filter
-    end
-
     # @!method compose(other, inputs = {})
     #   Run another interaction and return its result. If the other interaction
     #     fails, halt execution.
@@ -220,8 +185,7 @@ module ActiveInteraction
     #
     #   Runs the business logic associated with the interaction. This method is
     #   only run when there are no validation errors. The return value is
-    #   placed into {#result}. By default, this method is run in a transaction
-    #   if ActiveRecord is available (see {.transaction}).
+    #   placed into {#result}.
     #
     #   @raise (see ActiveInteraction::Runnable#execute)
 
@@ -264,7 +228,7 @@ module ActiveInteraction
       self.class.filters.each do |name, filter|
         begin
           public_send("#{name}=", filter.clean(inputs[name]))
-        rescue InvalidValueError, MissingValueError, InvalidNestedValueError
+        rescue Error
           # #type_check will add errors if appropriate.
         end
       end
@@ -273,7 +237,7 @@ module ActiveInteraction
     def type_check
       run_callbacks(:type_check) do
         Validation.validate(self.class.filters, inputs).each do |error|
-          errors.add_sym(*error)
+          errors.add(*error)
         end
       end
     end

data/lib/active_interaction/concerns/active_recordable.rb

@@ -0,0 +1,57 @@
+# coding: utf-8
+
+module ActiveInteraction
+  # Implement the minimal ActiveRecord interface.
+  #
+  # @private
+  module ActiveRecordable
+    # Returns the column object for the named filter.
+    #
+    # @param name [Symbol] The name of a filter.
+    #
+    # @example
+    #   class Interaction < ActiveInteraction::Base
+    #     string :email, default: nil
+    #
+    #     def execute; end
+    #   end
+    #
+    #   Interaction.new.column_for_attribute(:email)
+    #   # => #<ActiveInteraction::FilterColumn:0x007faebeb2a6c8 @type=:string>
+    #
+    #   Interaction.new.column_for_attribute(:not_a_filter)
+    #   # => nil
+    #
+    # @return [FilterColumn, nil]
+    #
+    # @since 1.2.0
+    def column_for_attribute(name)
+      filter = self.class.filters[name]
+      FilterColumn.intern(filter.database_column_type) if filter
+    end
+
+    # Returns true if a filter of that name exists.
+    #
+    # @param name [String, Symbol] The name of a filter.
+    #
+    # @example
+    #   class Interaction < ActiveInteraction::Base
+    #     string :email, default: nil
+    #
+    #     def execute; end
+    #   end
+    #
+    #   Interaction.new.has_attribute?(:email)
+    #   # => true
+    #
+    #   Interaction.new.has_attribute?(:not_a_filter)
+    #   # => false
+    #
+    # @return [Boolean]
+    #
+    # @since 1.5.0
+    def has_attribute?(name) # rubocop:disable Style/PredicateName
+      self.class.filters.key?(name.to_sym)
+    end
+  end
+end

data/lib/active_interaction/concerns/runnable.rb

@@ -6,14 +6,12 @@ module ActiveInteraction
   #
   # @note Must be included after `ActiveModel::Validations`.
   #
-  # Runs code in transactions and only provides the result if there are no
-  #   validation errors.
+  # Runs code and provides the result.
   #
   # @private
   module Runnable
     extend ActiveSupport::Concern
     include ActiveModel::Validations
-    include ActiveInteraction::Transactable
 
     included do
       define_callbacks :execute
@@ -41,13 +39,8 @@ module ActiveInteraction
     #
     # @return (see #result)
     def result=(result)
-      if errors.empty?
-        @_interaction_result = result
-        @_interaction_valid = true
-      else
-        @_interaction_result = nil
-        @_interaction_valid = false
-      end
+      @_interaction_result = result
+      @_interaction_valid = errors.empty?
     end
 
     # @return [Boolean]
@@ -82,15 +75,12 @@ module ActiveInteraction
     def run
       return unless valid?
 
-      self.result = transaction do
+      self.result =
         begin
           run_callbacks(:execute) { execute }
         rescue Interrupt => interrupt
           merge_errors_onto_base(interrupt.outcome.errors)
-
-          raise ActiveRecord::Rollback if self.class.transaction?
         end
-      end
     end
 
     def merge_errors_onto_base(new_errors)

data/lib/active_interaction/errors.rb

@@ -67,7 +67,7 @@ module ActiveInteraction
     # @param filter_name [Symbol]
     # @param input_value [Object]
     def initialize(filter_name, input_value)
-      super()
+      super("#{filter_name}: #{input_value.inspect}")
 
       @filter_name = filter_name
       @input_value = input_value
@@ -89,72 +89,20 @@ module ActiveInteraction
   end
   private_constant :Interrupt
 
-  # An extension that provides symbolic error messages to make introspection
-  #   and testing easier.
+  # An extension that provides the ability to merge other errors into itself.
   class Errors < ActiveModel::Errors
-    # Maps attributes to arrays of symbolic messages.
-    #
-    # @return [Hash{Symbol => Array<Symbol>}]
-    attr_reader :symbolic
-
-    # Adds a symbolic error message to an attribute.
-    #
-    # @example
-    #   errors.add_sym(:attribute)
-    #   errors.symbolic
-    #   # => {:attribute=>[:invalid]}
-    #   errors.messages
-    #   # => {:attribute=>["is invalid"]}
-    #
-    # @param attribute [Symbol] The attribute to add an error to.
-    # @param symbol [Symbol, nil] The symbolic error to add.
-    # @param message [String, Symbol, Proc, nil] The message to add.
-    # @param options [Hash]
-    #
-    # @return (see #symbolic)
-    #
-    # @see ActiveModel::Errors#add
-    def add_sym(attribute, symbol = :invalid, message = nil, options = {})
-      add(attribute, message || symbol, options)
-
-      symbolic[attribute] += [symbol]
-    end
-
-    # @see ActiveModel::Errors#initialize
-    #
-    # @private
-    def initialize(*)
-      @symbolic = Hash.new([]).with_indifferent_access
-
-      super
-    end
-
-    # @see ActiveModel::Errors#initialize_dup
-    #
-    # @private
-    def initialize_dup(other)
-      @symbolic = other.symbolic.with_indifferent_access
-
-      super
-    end
-
-    # @see ActiveModel::Errors#clear
-    #
-    # @private
-    def clear
-      symbolic.clear
-
-      super
-    end
-
     # Merge other errors into this one.
     #
     # @param other [Errors]
     #
     # @return [Errors]
     def merge!(other)
-      merge_messages!(other)
-      merge_symbolic!(other) if other.respond_to?(:symbolic)
+      if other.respond_to?(:details)
+        merge_details!(other)
+      else
+        merge_messages!(other)
+      end
+
       self
     end
 
@@ -168,12 +116,12 @@ module ActiveInteraction
       end
     end
 
-    def merge_symbolic!(other)
-      other.symbolic.each do |attribute, symbols|
-        symbols.each do |symbol|
-          next if symbolic[attribute].include?(symbol)
-
-          symbolic[attribute] += [symbol]
+    def merge_details!(other)
+      other.details.each do |attribute, details|
+        details.each do |detail|
+          detail = detail.dup
+          error = detail.delete(:error)
+          add(attribute, error, detail) unless added?(attribute, error, detail)
         end
       end
     end

data/lib/active_interaction/filters/array_filter.rb

@@ -48,30 +48,33 @@ module ActiveInteraction
       super do |klass, names, options|
         filter = klass.new(name.to_s.singularize.to_sym, options, &block)
 
-        validate(filter, names)
+        validate!(filter, names)
 
         filters[filter.name] = filter
       end
     end
 
+    def model(*)
+      super
+    end
+    ActiveInteraction.deprecate self, :model, 'use `object` instead'
+
     private
 
     # @return [Array<Class>]
     def classes
       result = [Array]
+      return result unless Object.const_defined?(:ActiveRecord)
+      return result unless ActiveRecord.const_defined?(:Relation)
 
-      if ActiveRecord.const_defined?(:Relation)
-        result.push(ActiveRecord::Relation)
-      end
-
-      result
+      result.push(ActiveRecord::Relation)
     end
 
     # @param filter [Filter]
     # @param names [Array<Symbol>]
     #
     # @raise [InvalidFilterError]
-    def validate(filter, names)
+    def validate!(filter, names)
       unless filters.empty?
         fail InvalidFilterError, 'multiple filters in array block'
       end
@@ -80,11 +83,11 @@ module ActiveInteraction
         fail InvalidFilterError, 'attribute names in array block'
       end
 
-      # rubocop:disable GuardClause
       if filter.default?
         fail InvalidDefaultError, 'default values in array block'
       end
-      # rubocop:enable GuardClause
+
+      nil
     end
   end
 end

data/lib/active_interaction/filters/file_filter.rb

@@ -4,9 +4,8 @@ module ActiveInteraction
   class Base
     # @!method self.file(*attributes, options = {})
     #   Creates accessors for the attributes and ensures that values passed to
-    #     the attributes are Files or Tempfiles. It will also extract a file
-    #     from any object with a `tempfile` method. This is useful when passing
-    #     in Rails params that include a file upload.
+    #   the attributes respond to the `eof?` method. This is useful when passing
+    #   in Rails params that include a file upload or another generic IO object.
     #
     #   @!macro filter_method_params
     #
@@ -15,35 +14,17 @@ module ActiveInteraction
   end
 
   # @private
-  class FileFilter < Filter
+  class FileFilter < InterfaceFilter
     register :file
 
-    def cast(value)
-      value = extract_file(value)
-
-      case value
-      when File, Tempfile
-        value
-      else
-        super
-      end
-    end
-
     def database_column_type
       self.class.slug
     end
 
     private
 
-    # @param value [File, #tempfile]
-    #
-    # @return [File]
-    def extract_file(value)
-      if value.respond_to?(:tempfile)
-        value.tempfile
-      else
-        value
-      end
+    def methods
+      [:eof?]
     end
   end
 end

data/lib/active_interaction/filters/hash_filter.rb

@@ -8,17 +8,13 @@ module ActiveInteraction
     #
     #   @!macro filter_method_params
     #   @param block [Proc] filter methods to apply for select keys
-    #   @option options [Boolean] :strip (true) strip unknown keys (Note: All
-    #     keys are symbolized. Ruby does not GC symbols so this can cause
-    #     memory bloat. Setting this option to `false` and passing in non-safe
-    #     input (e.g. Rails `params`) opens your software to a denial of
-    #     service attack.)
+    #   @option options [Boolean] :strip (true) remove unknown keys
     #
     #   @example
     #     hash :order
     #   @example
     #     hash :order do
-    #       model :item
+    #       object :item
     #       integer :quantity, default: 1
     #     end
   end
@@ -32,11 +28,12 @@ module ActiveInteraction
     def cast(value)
       case value
       when Hash
-        value = stringify_the_symbol_keys(value)
+        value = value.with_indifferent_access
+        initial = strip? ? ActiveSupport::HashWithIndifferentAccess.new : value
 
-        filters.each_with_object(strip? ? {} : value) do |(name, filter), h|
+        filters.each_with_object(initial) do |(name, filter), h|
           clean_value(h, name.to_s, filter, value)
-        end.symbolize_keys
+        end
       else
         super
       end
@@ -52,6 +49,11 @@ module ActiveInteraction
       end
     end
 
+    def model(*)
+      super
+    end
+    ActiveInteraction.deprecate self, :model, 'use `object` instead'
+
     private
 
     def clean_value(h, name, filter, value)
@@ -74,9 +76,5 @@ module ActiveInteraction
     def strip?
       options.fetch(:strip, true)
     end
-
-    def stringify_the_symbol_keys(hash)
-      hash.transform_keys { |key| key.is_a?(Symbol) ? key.to_s : key }
-    end
   end
 end

data/lib/active_interaction/filters/interface_filter.rb

@@ -7,8 +7,8 @@ module ActiveInteraction
     #   the attributes implement an interface.
     #
     #   @!macro filter_method_params
-    #   @option options [Array<Symbol>] :methods ([]) the methods that objects
-    #     conforming to this interface should respond to
+    #   @option options [Array<String,Symbol>] :methods ([]) the methods that
+    #     objects conforming to this interface should respond to
     #
     #   @example
     #     interface :anything

data/lib/active_interaction/filters/{model_filter.rb → object_filter.rb}

@@ -2,7 +2,7 @@
 
 module ActiveInteraction
   class Base
-    # @!method self.model(*attributes, options = {})
+    # @!method self.object(*attributes, options = {})
     #   Creates accessors for the attributes and ensures that values passed to
     #     the attributes are the correct class.
     #
@@ -11,14 +11,14 @@ module ActiveInteraction
     #     Class name used to ensure the value.
     #
     #   @example
-    #     model :account
+    #     object :account
     #   @example
-    #     model :account, class: User
+    #     object :account, class: User
   end
 
   # @private
-  class ModelFilter < Filter
-    register :model
+  class ObjectFilter < Filter
+    register :object
 
     def cast(value, reconstantize = true)
       @klass ||= klass
@@ -49,7 +49,7 @@ module ActiveInteraction
     #
     # @return [Boolean]
     def matches?(value)
-      @klass === value || # rubocop:disable CaseEquality
+      @klass === value || # rubocop:disable Style/CaseEquality
         value.is_a?(@klass)
     end
   end

data/lib/active_interaction/locale/en.yml

@@ -17,7 +17,7 @@ en:
       hash: hash
       integer: integer
       interface: interface
-      model: model
+      object: object
       string: string
       symbol: symbol
       time: time

data/lib/active_interaction/modules/validation.rb

@@ -25,10 +25,10 @@ module ActiveInteraction
       def error_args(filter, error)
         case error
         when InvalidNestedValueError
-          [filter.name, :invalid_nested, nil,
+          [filter.name, :invalid_nested,
            name: error.filter_name.inspect, value: error.input_value.inspect]
         when InvalidValueError
-          [filter.name, :invalid_type, nil, type: type(filter)]
+          [filter.name, :invalid_type, type: type(filter)]
         when MissingValueError
           [filter.name, :missing]
         end

data/lib/active_interaction/version.rb

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