Class: RSpec::DocumentRequests::Writers::Markdown

Inherits:
Base
  • Object
show all
Defined in:
lib/rspec/document_requests/writers/markdown.rb

Defined Under Namespace

Modules: ParametersTable Classes: Request, Response

Constant Summary collapse

EXTENSION = 
".md"

Instance Attribute Summary

Attributes inherited from Base

#request, #response

Instance Method Summary collapse

Methods inherited from Base

#close, #initialize

Constructor Details

This class inherits a constructor from RSpec::DocumentRequests::Writers::Base

Instance Method Details



7
8
9
10
11
12
13
14
15
 
# File 'lib/rspec/document_requests/writers/markdown.rb', line 7

def breadcrumb(description:, filename:, last:)
  @file.write "[#{description}](#{filename})"
  if not last
    @file.write " > "
  else
    @file.puts
    @file.puts
  end
end

#child(description:, filename:, last:) ⇒ Object 



26
27
28
29
 
# File 'lib/rspec/document_requests/writers/markdown.rb', line 26

def child(description:, filename:, last:)
  @file.puts "* [#{description}](#{filename})"
  @file.puts if last
end

#example_title(description:, explanation:, missing_levels:) ⇒ Object 



31
32
33
34
35
36
37
38
 
# File 'lib/rspec/document_requests/writers/markdown.rb', line 31

def example_title(description:, explanation:, missing_levels:)
  @file.puts "## #{missing_levels.map { |l| "#{l[:description]} > " }.join}#{description}"
  @file.puts
  if explanation
    @file.puts explanation
    @file.puts
  end
end

#title(description:, explanation:) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/rspec/document_requests/writers/markdown.rb', line 17

def title(description:, explanation:)
  @file.puts "# #{description}"
  @file.puts
  if explanation
    @file.puts explanation
    @file.puts
  end
end