class Apipie::Params::Description

Attributes

allow_nil[RW]
desc[RW]
descriptor[RW]
name[RW]
options[RW]
required[RW]

Public Class Methods

define(&block) click to toggle source
# File lib/apipie/params/description.rb, line 9
def self.define(&block)
  param_description = Description.new(nil, nil, {})
  param_description.descriptor = Descriptor::Hash.new(block, {})
  return param_description
end
new(name, descriptor_arg, options = {}, &block) click to toggle source
# File lib/apipie/params/description.rb, line 15
def initialize(name, descriptor_arg, options = {}, &block)
  @options = options
  @name = name
  @desc = @options[:desc]
  # if required is specified, set to boolean of the value, nil
  # otherwise: nil allows us specify the default value later.
  @required = @options.has_key?(:required) ? !!@options[:required] : nil
  @allow_nil = @options.has_key?(:allow_nil) ? !!@options[:allow_nil] : nil

  unless descriptor_arg.nil?
    @descriptor = Params::Descriptor::Base.find(descriptor_arg,
                                                options,
                                                block)
  else
    @descriptor = nil
  end

end

Public Instance Methods

method_missing(method, *args, &block) click to toggle source
Calls superclass method
# File lib/apipie/params/description.rb, line 47
def method_missing(method, *args, &block)
  if respond_to?(method)
    @descriptor.send(method, *args, &block)
  else
    super
  end
end
respond_to?(method) click to toggle source
Calls superclass method
# File lib/apipie/params/description.rb, line 38
def respond_to?(method)
  case method.to_s
  when 'params', 'param'
    @descriptor.respond_to?(method)
  else
    super
  end
end
validate!(value) click to toggle source
# File lib/apipie/params/description.rb, line 34
def validate!(value)
  descriptor.validate!(self, value)
end