Class: ApiCanon::DocumentedParam

Inherits:
Object
  • Object
show all
Includes:
ActionView::Helpers, ActiveModel::Serialization
Defined in:
lib/api_canon/documented_param.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, documented_action, opts = {}) ⇒ DocumentedParam

Returns a new instance of DocumentedParam.



14
15
16
17
18
 
# File 'lib/api_canon/documented_param.rb', line 14

def initialize(name, documented_action, opts={})
  @name = name
  @documented_action = documented_action
  opts.each {|k,v| self.send("#{k}=", v) }
end

Instance Attribute Details

#default ⇒ Object

Returns the value of attribute default.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def default
  @default
end

#description ⇒ Object

Returns the value of attribute description.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def description
  @description
end

#documented_action ⇒ Object

Returns the value of attribute documented_action.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def documented_action
  @documented_action
end

#example_values ⇒ Object

Returns the value of attribute example_values.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def example_values
  @example_values
end

#multiple=(value) ⇒ Object (writeonly)

Sets the attribute multiple

Parameters:

  • value —

    the value to set the attribute multiple to.



5
6
7
 
# File 'lib/api_canon/documented_param.rb', line 5

def multiple=(value)
  @multiple = value
end

#name ⇒ Object

Returns the value of attribute name.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def name
  @name
end

#param_type ⇒ Object

Returns the value of attribute param_type.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def param_type
  @param_type
end

#required ⇒ Object

Returns the value of attribute required.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def required
  @required
end

#type ⇒ Object

Returns the value of attribute type.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def type
  @type
end

#values ⇒ Object

Returns the value of attribute values.



4
5
6
 
# File 'lib/api_canon/documented_param.rb', line 4

def values
  @values
end

Instance Method Details

#example_values_field(f, doco_prefix) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
 
# File 'lib/api_canon/documented_param.rb', line 35

def example_values_field(f, doco_prefix)
  if values_for_example.is_a?(Array)
    if type != :array
      select_tag :example_value, options_for_select([""] + values_for_example, default), :class => 'input-block-level',
        :onchange => "jQuery('##{doco_prefix}_#{name}').val(this.value)", :id => "#{doco_prefix}_#{name}_example"
    end
  else
    values_for_example
  end
end

#form_values ⇒ Object 



19
20
21
 
# File 'lib/api_canon/documented_param.rb', line 19

def form_values
  values.presence || example_values.presence
end

#multiple? ⇒ Boolean

Returns:

  • (Boolean) 


11
12
13
 
# File 'lib/api_canon/documented_param.rb', line 11

def multiple?
  !!@multiple
end

#to_field(f, doco_prefix) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'lib/api_canon/documented_param.rb', line 22

def to_field(f, doco_prefix)
  # TODO: This doco_prefix thing sucks. Get rid of it.
  if type == :array
    if form_values.nil?
      raise ArgumentError.new(':values or :example_values must be supplied for :array type params')
    end
    f.select name, form_values, {:selected => default, :include_blank => true}, {:multiple => multiple?, :class => 'input-block-level', :id => "#{doco_prefix}_#{name}"}
  elsif type == :boolean
    f.select name, [true,false], {:selected => default, :include_blank => true}, :class => 'input-block-level', :id => "#{doco_prefix}_#{name}"
  else
    f.text_field name, :value => default, :class => 'input-block-level', :id => "#{doco_prefix}_#{name}"
  end
end

#values_for_example ⇒ Object 



8
9
10
 
# File 'lib/api_canon/documented_param.rb', line 8

def values_for_example
  example_values || values || ""
end