Class: RspecApiDocumentation::Writers::CombinedTextExample

Inherits:
Object
  • Object
show all
Defined in:
lib/rspec_api_documentation/writers/combined_text_writer.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(example) ⇒ CombinedTextExample

Returns a new instance of CombinedTextExample.



42
43
44
 
# File 'lib/rspec_api_documentation/writers/combined_text_writer.rb', line 42

def initialize(example)
  @example = example
end

Instance Attribute Details

#example ⇒ Object (readonly)

Returns the value of attribute example.



40
41
42
 
# File 'lib/rspec_api_documentation/writers/combined_text_writer.rb', line 40

def example
  @example
end

Instance Method Details

#description ⇒ Object 



50
51
52
 
# File 'lib/rspec_api_documentation/writers/combined_text_writer.rb', line 50

def description
  example.description + "\n" + "-" * example.description.length + "\n\n"
end

#parameters ⇒ Object 



54
55
56
57
58
59
 
# File 'lib/rspec_api_documentation/writers/combined_text_writer.rb', line 54

def parameters
  return "" unless example.metadata[:parameters]
  "Parameters:\n" + example.metadata[:parameters].inject("") do |out, parameter|
    out << "  * #{parameter[:name]} - #{parameter[:description]}\n"
  end + "\n"
end

#requests ⇒ Object 



61
62
63
64
65
66
 
# File 'lib/rspec_api_documentation/writers/combined_text_writer.rb', line 61

def requests
  return [] unless example.metadata[:requests]
  example.metadata[:requests].map do |request|
    [format_request(request), format_response(request)]
  end
end

#resource_name ⇒ Object 



46
47
48
 
# File 'lib/rspec_api_documentation/writers/combined_text_writer.rb', line 46

def resource_name
  example.resource_name.to_s.downcase.gsub(/\s+/, '_')
end