Contents

require 'parameters/types/object'

module Parameters
  module Types
    class Array < Object

      # The type to coerce all Array elements with
      attr_reader :element_type

      #
      # Initializes the Array type.
      #
      # @param [Type, nil] element_type
      #   Optional type for the elements of the Array.
      #
      def initialize(element_type)
        @element_type = element_type
      end

      #
      # Coerces a value into an Array.
      #
      # @param [#to_a, ::Object] value
      #   The value to coerce.
      #
      # @return [::Array]
      #   The coerced Array.
      #
      def self.coerce(value)
        if value.respond_to?(:to_a)
          value.to_a
        elsif value.respond_to?(:to_ary)
          value.to_ary
        else
          [value]
        end
      end

      #
      # The Ruby Type for the Array Type instance.
      #
      # @return [Array<Class>]
      #   A singleton Array containing the element-type.
      #
      def to_ruby
        self.class.to_ruby[@element_type.to_ruby]
      end

      #
      # Determines if the value is an Array.
      #
      # @param [::Object] value
      #   The value to inspect.
      #
      # @return [::Boolean]
      #
      def ===(value)
        (self.class === value) && value.all? { |element|
          @element_type === element
        }
      end

      #
      # Coerces a value into an Array, and coerces the elements of the Array.
      #
      # @param [#to_a, ::Object] value
      #   The value to coerce.
      #
      # @return [::Array]
      #   The coerced Array.
      #
      # @see coerce
      #
      def coerce(value)
        array = super(value)
        array.map! { |element| @element_type.coerce(element) }

        return array
      end

    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
parameters-0.3.1	lib/parameters/types/array.rb
parameters-0.3.0	lib/parameters/types/array.rb