summaryrefslogtreecommitdiff
path: root/ruby_2_2/lib/rdoc/parser/simple.rb
diff options
context:
space:
mode:
Diffstat (limited to 'ruby_2_2/lib/rdoc/parser/simple.rb')
-rw-r--r--ruby_2_2/lib/rdoc/parser/simple.rb61
1 files changed, 61 insertions, 0 deletions
diff --git a/ruby_2_2/lib/rdoc/parser/simple.rb b/ruby_2_2/lib/rdoc/parser/simple.rb
new file mode 100644
index 0000000000..65cfc1b2e7
--- /dev/null
+++ b/ruby_2_2/lib/rdoc/parser/simple.rb
@@ -0,0 +1,61 @@
+##
+# Parse a non-source file. We basically take the whole thing as one big
+# comment.
+
+class RDoc::Parser::Simple < RDoc::Parser
+
+ include RDoc::Parser::Text
+
+ parse_files_matching(//)
+
+ attr_reader :content # :nodoc:
+
+ ##
+ # Prepare to parse a plain file
+
+ def initialize(top_level, file_name, content, options, stats)
+ super
+
+ preprocess = RDoc::Markup::PreProcess.new @file_name, @options.rdoc_include
+
+ preprocess.handle @content, @top_level
+ end
+
+ ##
+ # Extract the file contents and attach them to the TopLevel as a comment
+
+ 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
+
+ ##
+ # Removes the encoding magic comment from +text+
+
+ def remove_coding_comment text
+ text.sub(/\A# .*coding[=:].*$/, '')
+ end
+
+ ##
+ # 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.
+
+ def remove_private_comment comment
+ # Workaround for gsub encoding for Ruby 1.9.2 and earlier
+ empty = ''
+ empty.force_encoding comment.encoding if Object.const_defined? :Encoding
+
+ comment = comment.gsub(%r%^--\n.*?^\+\+\n?%m, empty)
+ comment.sub(%r%^--\n.*%m, empty)
+ end
+
+end
+