active_interaction 0.10.2 → 1.0.0

data/lib/active_interaction/filters/abstract_date_time_filter.rb

@@ -1,22 +1,22 @@
 # coding: utf-8
 
 module ActiveInteraction
+  # @abstract
+  #
+  # Common logic for filters that handle `Date`, `DateTime`, and `Time`
+  #   objects.
+  #
   # @private
-  class AbstractDateTimeFilter < Filter
+  class AbstractDateTimeFilter < AbstractFilter
+    alias_method :_cast, :cast
+    private :_cast
+
     def cast(value)
       case value
       when *klasses
         value
       when String
-        begin
-          if has_format?
-            klass.strptime(value, format)
-          else
-            klass.parse(value)
-          end
-        rescue ArgumentError
-          super
-        end
+        convert(value)
       else
         super
       end
@@ -24,18 +24,27 @@ module ActiveInteraction
 
     private
 
+    def convert(value)
+      if format?
+        klass.strptime(value, format)
+      else
+        klass.parse(value)
+      end
+    rescue ArgumentError
+      _cast(value)
+    end
+
+    # @return [String]
     def format
       options.fetch(:format)
     end
 
-    def has_format?
+    # @return [Boolean]
+    def format?
       options.key?(:format)
     end
 
-    def klass
-      self.class.slug.to_s.camelize.constantize
-    end
-
+    # @return [Array<Class>]
     def klasses
       [klass]
     end

data/lib/active_interaction/filters/abstract_filter.rb

@@ -0,0 +1,18 @@
+# coding: utf-8
+
+module ActiveInteraction
+  # @abstract
+  #
+  # Common logic for filters that can guess the class they operator on based on
+  #   their name.
+  #
+  # @private
+  class AbstractFilter < Filter
+    private
+
+    # @return [Class]
+    def klass
+      self.class.slug.to_s.camelize.constantize
+    end
+  end
+end

data/lib/active_interaction/filters/abstract_numeric_filter.rb

@@ -1,18 +1,21 @@
 # coding: utf-8
 
 module ActiveInteraction
+  # @abstract
+  #
+  # Common logic for filters that handle numeric objects.
+  #
   # @private
-  class AbstractNumericFilter < Filter
+  class AbstractNumericFilter < AbstractFilter
+    alias_method :_cast, :cast
+    private :_cast
+
     def cast(value)
       case value
       when klass
         value
       when Numeric, String
-        begin
-          send(klass.name, value)
-        rescue ArgumentError
-          super
-        end
+        convert(value)
       else
         super
       end
@@ -20,8 +23,10 @@ module ActiveInteraction
 
     private
 
-    def klass
-      fail NotImplementedError
+    def convert(value)
+      Kernel.public_send(klass.name, value)
+    rescue ArgumentError
+      _cast(value)
     end
   end
 end

data/lib/active_interaction/filters/array_filter.rb

@@ -2,61 +2,68 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Arrays.
+    # @!method self.array(*attributes, options = {}, &block)
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Arrays.
     #
-    # @macro filter_method_params
-    # @param block [Proc] filter method to apply to each element
+    #   @!macro filter_method_params
+    #   @param block [Proc] filter method to apply to each element
     #
-    # @example
-    #   array :ids
-    #
-    # @example An Array of Integers
-    #   array :ids do
-    #     integer
-    #   end
-    #
-    # @example An Array of Integers where some or all are nil
-    #   array :ids do
-    #     integer default: nil
-    #   end
-    #
-    # @since 0.1.0
-    #
-    # @method self.array(*attributes, options = {}, &block)
+    #   @example
+    #     array :ids
+    #   @example
+    #     array :ids do
+    #       integer
+    #     end
+    #   @example
+    #     array :ids do
+    #       integer default: nil
+    #     end
   end
 
   # @private
   class ArrayFilter < Filter
-    include MethodMissing
+    include Missable
 
     def cast(value)
       case value
       when Array
-        return value if filters.none?
+        return value if filters.empty?
 
-        filter = filters.first
+        filter = filters.values.first
         value.map { |e| filter.clean(e) }
       else
         super
       end
     end
 
-    def method_missing(*_, &block)
+    def method_missing(*, &block)
       super do |klass, names, options|
         filter = klass.new(name, options, &block)
 
-        if filters.any?
-          fail InvalidFilterError, 'multiple filters in array block'
-        end
-        unless names.empty?
-          fail InvalidFilterError, 'attribute names in array block'
-        end
-        if filter.has_default?
-          fail InvalidDefaultError, 'default values in array block'
-        end
-
-        filters.add(filter)
+        validate(filter, names)
+
+        filters[name] = filter
+      end
+    end
+
+    private
+
+    # @param filter [Filter]
+    # @param names [Array<Symbol>]
+    #
+    # @raise [InvalidFilterError]
+    def validate(filter, names)
+      unless filters.empty?
+        fail InvalidFilterError, 'multiple filters in array block'
+      end
+
+      unless names.empty?
+        fail InvalidFilterError, 'attribute names in array block'
+      end
+
+      if filter.default?
+        fail InvalidDefaultError, 'default values in array block'
       end
     end
   end

data/lib/active_interaction/filters/boolean_filter.rb

@@ -2,19 +2,16 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Booleans. The strings `"1"` and `"true"`
-    #   (case-insensitive) are converted to `true` while the strings `"0"` and
-    #   `"false"` are converted to `false`.
+    # @!method self.boolean(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Booleans. The strings `"1"` and `"true"`
+    #     (case-insensitive) are converted to `true` while the strings `"0"`
+    #     and `"false"` are converted to `false`.
     #
-    # @macro filter_method_params
+    #   @!macro filter_method_params
     #
-    # @example
-    #   boolean :subscribed
-    #
-    # @since 0.1.0
-    #
-    # @method self.boolean(*attributes, options = {})
+    #   @example
+    #     boolean :subscribed
   end
 
   # @private

data/lib/active_interaction/filters/date_filter.rb

@@ -2,23 +2,19 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Dates. String values are processed using `parse`
-    #   unless the format option is given, in which case they will be processed
-    #   with `strptime`.
+    # @!method self.date(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Dates. String values are processed using `parse`
+    #     unless the format option is given, in which case they will be
+    #     processed with `strptime`.
     #
-    # @macro filter_method_params
-    # @option options [String] :format parse strings using this format string
+    #   @!macro filter_method_params
+    #   @option options [String] :format parse strings using this format string
     #
-    # @example
-    #   date :birthday
-    #
-    # @example
-    #   date :birthday, format: '%Y-%m-%d'
-    #
-    # @since 0.1.0
-    #
-    # @method self.date(*attributes, options = {})
+    #   @example
+    #     date :birthday
+    #   @example
+    #     date :birthday, format: '%Y-%m-%d'
   end
 
   # @private

data/lib/active_interaction/filters/date_time_filter.rb

@@ -2,23 +2,19 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are DateTimes. String values are processed using `parse`
-    #   unless the format option is given, in which case they will be processed
-    #   with `strptime`.
+    # @!method self.date_time(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are DateTimes. String values are processed using
+    #     `parse` unless the format option is given, in which case they will be
+    #     processed with `strptime`.
     #
-    # @macro filter_method_params
-    # @option options [String] :format parse strings using this format string
+    #   @!macro filter_method_params
+    #   @option options [String] :format parse strings using this format string
     #
-    # @example
-    #   date_time :start_date
-    #
-    # @example
-    #   date_time :start_date, format: '%Y-%m-%dT%H:%M:%S%:z'
-    #
-    # @since 0.1.0
-    #
-    # @method self.date_time(*attributes, options = {})
+    #   @example
+    #     date_time :start_date
+    #   @example
+    #     date_time :start_date, format: '%Y-%m-%dT%H:%M:%SZ'
   end
 
   # @private

data/lib/active_interaction/filters/file_filter.rb

@@ -2,19 +2,16 @@
 
 module ActiveInteraction
   class Base
-    # 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.
+    # @!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.
     #
-    # @macro filter_method_params
+    #   @!macro filter_method_params
     #
-    # @example
-    #   file :image
-    #
-    # @since 0.1.0
-    #
-    # @method self.file(*attributes, options = {})
+    #   @example
+    #     file :image
   end
 
   # @private
@@ -32,6 +29,9 @@ module ActiveInteraction
 
     private
 
+    # @param value [File, #tempfile]
+    #
+    # @return [File]
     def extract_file(value)
       if value.respond_to?(:tempfile)
         value.tempfile

data/lib/active_interaction/filters/float_filter.rb

@@ -2,26 +2,18 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Floats. Integer and String values are converted into
-    #   Floats.
+    # @!method self.float(*attributes, options = {})
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Floats. Integer and String values are converted
+    #     into Floats.
     #
-    # @macro filter_method_params
+    #   @!macro filter_method_params
     #
-    # @example
-    #   float :amount
-    #
-    # @since 0.1.0
-    #
-    # @method self.float(*attributes, options = {})
+    #   @example
+    #     float :amount
   end
 
   # @private
   class FloatFilter < AbstractNumericFilter
-    private
-
-    def klass
-      Float
-    end
   end
 end

data/lib/active_interaction/filters/hash_filter.rb

@@ -2,40 +2,33 @@
 
 module ActiveInteraction
   class Base
-    # Creates accessors for the attributes and ensures that values passed to
-    #   the attributes are Hashes.
+    # @!method self.hash(*attributes, options = {}, &block)
+    #   Creates accessors for the attributes and ensures that values passed to
+    #     the attributes are Hashes.
     #
-    # @macro filter_method_params
-    # @param block [Proc] filter methods to apply for select keys
-    # @option options [Boolean] :strip (true) strip unknown keys
+    #   @!macro filter_method_params
+    #   @param block [Proc] filter methods to apply for select keys
+    #   @option options [Boolean] :strip (true) strip unknown keys
     #
-    # @example
-    #   hash :order
-    #
-    # @example A Hash where certain keys also have their values ensured.
-    #   hash :order do
-    #     model :account
-    #     model :item
-    #     integer :quantity
-    #     boolean :delivered
-    #   end
-    #
-    # @since 0.1.0
-    #
-    # @method self.hash(*attributes, options = {}, &block)
+    #   @example
+    #     hash :order
+    #   @example
+    #     hash :order do
+    #       model :item
+    #       integer :quantity, default: 1
+    #     end
   end
 
   # @private
   class HashFilter < Filter
-    include MethodMissing
+    include Missable
 
     def cast(value)
       case value
       when Hash
         value = value.symbolize_keys
-        filters.each_with_object(strip? ? {} : value) do |filter, h|
-          k = filter.name
-          h[k] = filter.clean(value[k])
+        filters.each_with_object(strip? ? {} : value) do |(name, filter), h|
+          h[name] = filter.clean(value[name])
         end
       else
         super
@@ -55,13 +48,14 @@ module ActiveInteraction
         fail InvalidFilterError, 'missing attribute name' if names.empty?
 
         names.each do |name|
-          filters.add(klass.new(name, options, &block))
+          filters[name] = klass.new(name, options, &block)
         end
       end
     end
 
     private
 
+    # @return [Boolean]
     def strip?
       options.fetch(:strip, true)
     end