class RspecApiDocumentation::Writers::SlateWriter

Constants

EXTENSION
FILENAME

Public Class Methods

clear_docs(docs_dir) click to toggle source
# File lib/rspec_api_documentation/writers/slate_writer.rb, line 8
def self.clear_docs(docs_dir)
  FileUtils.mkdir_p(docs_dir)
  FileUtils.rm Dir[File.join docs_dir, "#{FILENAME}.*"]
end

Public Instance Methods

extension() click to toggle source
# File lib/rspec_api_documentation/writers/slate_writer.rb, line 40
def extension
  EXTENSION
end
markup_example_class() click to toggle source
# File lib/rspec_api_documentation/writers/slate_writer.rb, line 17
def markup_example_class
  RspecApiDocumentation::Views::SlateExample
end
markup_index_class() click to toggle source
# File lib/rspec_api_documentation/writers/slate_writer.rb, line 13
def markup_index_class
  RspecApiDocumentation::Views::SlateIndex
end
write() click to toggle source
# File lib/rspec_api_documentation/writers/slate_writer.rb, line 21
def write
  File.open(configuration.docs_dir.join("#{FILENAME}.#{extension}"), 'w+') do |file|

    file.write markup_index_class.new(index, configuration).render

    IndexHelper.sections(index.examples, @configuration).each do |section|
      file.write "# #{section[:resource_name]}\n\n"
      file.write "#{section[:resource_explanation]}\n\n"

      section[:examples].each do |example|
        markup_example = markup_example_class.new(example, configuration)
        file.write markup_example.render
      end

    end

  end
end