Class: RDoc::Parser::Simple

Inherits:
RDoc::Parser show all
Includes:
Text
Defined in:
lib/rdoc/parser/simple.rb

Overview

Parse a non-source file. We basically take the whole thing as one big comment.

Instance Attribute Summary collapse

Attributes inherited from RDoc::Parser

#file_name

Instance Method Summary collapse

Methods inherited from RDoc::Parser

alias_extension, binary?, can_parse, can_parse_by_name, check_modeline, for, #handle_tab_width, parse_files_matching, remove_modeline, use_markup, zip?

Constructor Details

#initialize(top_level, file_name, content, options, stats) ⇒ Simple

Prepare to parse a plain file



17
18
19
20
21
22
23
 
# File 'lib/rdoc/parser/simple.rb', line 17

def initialize(top_level, file_name, content, options, stats)
  super

  preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include

  @content = preprocess.handle @content, @top_level
end

Instance Attribute Details

#content ⇒ Object (readonly)

:nodoc:



12
13
14
 
# File 'lib/rdoc/parser/simple.rb', line 12

def content
  @content
end

Instance Method Details

#remove_coding_comment(text) ⇒ Object

Removes the encoding magic comment from text



41
42
43
 
# File 'lib/rdoc/parser/simple.rb', line 41

def remove_coding_comment text
  text.sub(/\A# .*coding[=:].*$/, '')
end

#remove_private_comment(comment) ⇒ Object

Removes private comments.

Unlike RDoc::Comment#remove_private this implementation only looks for two dashes at the beginning of the line. Three or more dashes are considered to be a rule and ignored.



52
53
54
55
56
57
58
59
 
# File 'lib/rdoc/parser/simple.rb', line 52

def remove_private_comment comment
  # Workaround for gsub encoding for Ruby 1.9.2 and earlier
  empty = ''
  empty = RDoc::Encoding.change_encoding empty, comment.encoding

  comment = comment.gsub(%r%^--\n.*?^\+\+\n?%m, empty)
  comment.sub(%r%^--\n.*%m, empty)
end

#scan ⇒ Object

Extract the file contents and attach them to the TopLevel as a comment



28
29
30
31
32
33
34
35
36
 
# File 'lib/rdoc/parser/simple.rb', line 28

def scan
  comment = remove_coding_comment @content
  comment = remove_private_comment comment

  comment = RDoc::Comment.new comment, @top_level

  @top_level.comment = comment
  @top_level
end