Class: ApiCanon::DocumentedParam

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of DocumentedParam.



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

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

Instance Attribute Details

#default ⇒ Object

Returns the value of attribute default.



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

def default
  @default
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#example_values ⇒ Object

Returns the value of attribute example_values.



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

def example_values
  @example_values
end

#multiple=(value) ⇒ Object (writeonly)

Sets the attribute multiple

Parameters:

  • value —

    the value to set the attribute multiple to.



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

def multiple=(value)
  @multiple = value
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#values ⇒ Object

Returns the value of attribute values.



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

def values
  @values
end

Instance Method Details

#example_values_field(f, doco_prefix) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
 
# File 'lib/api_canon/documented_param.rb', line 29

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 



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

def form_values
  values.presence || example_values.presence
end

#multiple? ⇒ Boolean

Returns:

  • (Boolean) 


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

def multiple?
  !!@multiple
end

#to_field(f, doco_prefix) ⇒ Object 



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/api_canon/documented_param.rb', line 19

def to_field(f, doco_prefix)
  # TODO: This doco_prefix thing sucks. Get rid of it.
  if type == :array
    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 



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

def values_for_example
  example_values || values || ""
end