1
0
Fork 0
mirror of https://github.com/ruby/ruby.git synced 2022-11-09 12:17:21 -05:00

* lib/rdoc/encoding.rb: Do not remove #! line from document when

setting encoding.  This allows ruby executables to be parsed as ruby
  files.
* test/rdoc/test_rdoc_encoding.rb:  Test for above.

* lib/rdoc/parser.rb:  Set the parser file name of ruby executables
  correctly.
* test/rdoc/test_rdoc_parser.rb:  Test for above.


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38446 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
This commit is contained in:
drbrain 2012-12-18 08:24:57 +00:00
parent aa233d3f33
commit dff59f6c5d
5 changed files with 37 additions and 4 deletions

View file

@ -1,3 +1,14 @@
Tue Dec 18 17:24:40 2012 Eric Hodel <drbrain@segment7.net>
* lib/rdoc/encoding.rb: Do not remove #! line from document when
setting encoding. This allows ruby executables to be parsed as ruby
files.
* test/rdoc/test_rdoc_encoding.rb: Test for above.
* lib/rdoc/parser.rb: Set the parser file name of ruby executables
correctly.
* test/rdoc/test_rdoc_parser.rb: Test for above.
Tue Dec 18 16:46:15 2012 Eric Hodel <drbrain@segment7.net>
* doc/syntax/literals.rdoc: Used simplified heredoc example that

View file

@ -75,7 +75,9 @@ module RDoc::Encoding
# Sets the encoding of +string+ based on the magic comment
def self.set_encoding string
first_line = string[/\A(?:#!.*\n)?.*\n/]
string =~ /\A(?:#!.*\n)?(.*\n)/
first_line = $1
name = case first_line
when /^<\?xml[^?]*encoding=(["'])(.*?)\1/ then $2

View file

@ -45,6 +45,11 @@ class RDoc::Parser
end
##
# The name of the file being parsed
attr_reader :file_name
##
# Alias an extension to another extension. After this call, files ending
# "new_ext" will be parsed using the same parser as "old_ext"
@ -182,16 +187,18 @@ class RDoc::Parser
parser = use_markup content
unless parser then
parse_name = file_name
# If no extension, look for shebang
if file_name !~ /\.\w+$/ && content =~ %r{\A#!(.+)} then
shebang = $1
case shebang
when %r{env\s+ruby}, %r{/ruby}
file_name = "dummy.rb"
parse_name = 'dummy.rb'
end
end
parser = can_parse file_name
parser = can_parse parse_name
end
return unless parser

View file

@ -164,7 +164,7 @@ class TestRDocEncoding < RDoc::TestCase
RDoc::Encoding.set_encoding s
assert_equal "# more comments", s
assert_equal "#!/bin/ruby\n# more comments", s
end
def test_class_set_encoding_bad

View file

@ -77,6 +77,19 @@ class TestRDocParser < RDoc::TestCase
end
end
def test_class_for_executable
temp_dir do
content = "#!/usr/bin/env ruby -w\n"
open 'app', 'w' do |io| io.write content end
app = @store.add_file 'app'
parser = @RP.for app, 'app', content, @options, :stats
assert_kind_of RDoc::Parser::Ruby, parser
assert_equal 'app', parser.file_name
end
end
def test_can_parse_modeline
readme_ext = File.join Dir.tmpdir, "README.EXT.#{$$}"