rdoc 6.4.1.1 → 6.5.0

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (60) hide show
  1. checksums.yaml +4 -4
  2. data/CONTRIBUTING.rdoc +1 -2
  3. data/LEGAL.rdoc +1 -1
  4. data/exe/rdoc +0 -1
  5. data/lib/rdoc/any_method.rb +2 -2
  6. data/lib/rdoc/code_objects.rb +1 -2
  7. data/lib/rdoc/context/section.rb +2 -0
  8. data/lib/rdoc/context.rb +1 -3
  9. data/lib/rdoc/cross_reference.rb +17 -1
  10. data/lib/rdoc/generator/markup.rb +1 -1
  11. data/lib/rdoc/generator/template/darkfish/_head.rhtml +10 -10
  12. data/lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml +27 -3
  13. data/lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml +22 -2
  14. data/lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml +25 -4
  15. data/lib/rdoc/generator/template/darkfish/class.rhtml +22 -20
  16. data/lib/rdoc/generator/template/darkfish/css/rdoc.css +24 -1
  17. data/lib/rdoc/generator/template/darkfish/index.rhtml +1 -1
  18. data/lib/rdoc/generator/template/darkfish/js/darkfish.js +1 -1
  19. data/lib/rdoc/generator/template/darkfish/js/search.js +1 -1
  20. data/lib/rdoc/generator/template/darkfish/table_of_contents.rhtml +2 -2
  21. data/lib/rdoc/generator.rb +5 -5
  22. data/lib/rdoc/i18n.rb +1 -1
  23. data/lib/rdoc/known_classes.rb +5 -4
  24. data/lib/rdoc/markdown/literals.rb +43 -66
  25. data/lib/rdoc/markdown.kpeg +25 -18
  26. data/lib/rdoc/markdown.rb +252 -194
  27. data/lib/rdoc/markup/attribute_manager.rb +29 -35
  28. data/lib/rdoc/markup/parser.rb +12 -6
  29. data/lib/rdoc/markup/to_html.rb +18 -14
  30. data/lib/rdoc/markup/to_label.rb +1 -1
  31. data/lib/rdoc/markup/to_rdoc.rb +3 -20
  32. data/lib/rdoc/markup.rb +35 -667
  33. data/lib/rdoc/method_attr.rb +1 -1
  34. data/lib/rdoc/normal_class.rb +1 -1
  35. data/lib/rdoc/normal_module.rb +1 -1
  36. data/lib/rdoc/options.rb +33 -18
  37. data/lib/rdoc/parser/c.rb +89 -101
  38. data/lib/rdoc/parser/ruby.rb +25 -10
  39. data/lib/rdoc/parser.rb +19 -2
  40. data/lib/rdoc/rd/block_parser.rb +14 -12
  41. data/lib/rdoc/rd/block_parser.ry +12 -8
  42. data/lib/rdoc/rd/inline_parser.rb +2 -4
  43. data/lib/rdoc/rd.rb +3 -4
  44. data/lib/rdoc/rdoc.rb +17 -3
  45. data/lib/rdoc/ri/driver.rb +11 -78
  46. data/lib/rdoc/ri.rb +4 -5
  47. data/lib/rdoc/rubygems_hook.rb +1 -1
  48. data/lib/rdoc/servlet.rb +1 -1
  49. data/lib/rdoc/single_class.rb +5 -0
  50. data/lib/rdoc/stats.rb +3 -4
  51. data/lib/rdoc/store.rb +19 -26
  52. data/lib/rdoc/task.rb +3 -3
  53. data/lib/rdoc/version.rb +3 -1
  54. data/lib/rdoc.rb +46 -46
  55. metadata +7 -9
  56. data/Gemfile +0 -12
  57. data/Rakefile +0 -107
  58. data/bin/console +0 -7
  59. data/bin/setup +0 -6
  60. data/rdoc.gemspec +0 -249
data/Rakefile DELETED
@@ -1,107 +0,0 @@
1
- $:.unshift File.expand_path 'lib'
2
- require 'rdoc/task'
3
- require 'bundler/gem_tasks'
4
- require 'rake/testtask'
5
-
6
- task :docs => :generate
7
- task :test => [:normal_test, :rubygems_test]
8
-
9
- PARSER_FILES = %w[
10
- lib/rdoc/rd/block_parser.ry
11
- lib/rdoc/rd/inline_parser.ry
12
- lib/rdoc/markdown.kpeg
13
- lib/rdoc/markdown/literals.kpeg
14
- ]
15
-
16
- $rdoc_rakefile = true
17
-
18
- task :default => :test
19
-
20
- RDoc::Task.new do |doc|
21
- doc.main = 'README.rdoc'
22
- doc.title = "rdoc #{RDoc::VERSION} Documentation"
23
- doc.rdoc_dir = 'html'
24
- doc.rdoc_files = FileList.new %w[lib/**/*.rb *.rdoc] - PARSER_FILES
25
- end
26
-
27
- task ghpages: :rdoc do
28
- `git checkout gh-pages`
29
- require "fileutils"
30
- FileUtils.rm_rf "/tmp/html"
31
- FileUtils.mv "html", "/tmp"
32
- FileUtils.rm_rf "*"
33
- FileUtils.cp_r Dir.glob("/tmp/html/*"), "."
34
- end
35
-
36
- Rake::TestTask.new(:normal_test) do |t|
37
- t.libs << "test/rdoc"
38
- t.verbose = true
39
- t.deps = :generate
40
- t.test_files = FileList["test/**/test_*.rb"].exclude("test/rdoc/test_rdoc_rubygems_hook.rb")
41
- end
42
-
43
- Rake::TestTask.new(:rubygems_test) do |t|
44
- t.libs << "test/rdoc"
45
- t.verbose = true
46
- t.deps = :generate
47
- t.pattern = "test/rdoc/test_rdoc_rubygems_hook.rb"
48
- end
49
-
50
- path = "pkg/#{Bundler::GemHelper.gemspec.full_name}"
51
-
52
- package_parser_files = PARSER_FILES.map do |parser_file|
53
- name = File.basename(parser_file, File.extname(parser_file))
54
- _path = File.dirname(parser_file)
55
- package_parser_file = "#{path}/#{name}.rb"
56
- parsed_file = "#{_path}/#{name}.rb"
57
-
58
- file package_parser_file => parsed_file # ensure copy runs before racc
59
-
60
- package_parser_file
61
- end
62
-
63
- parsed_files = PARSER_FILES.map do |parser_file|
64
- ext = File.extname(parser_file)
65
- parsed_file = "#{parser_file.chomp(ext)}.rb"
66
-
67
- file parsed_file => parser_file do |t|
68
- puts "Generating #{parsed_file}..."
69
- case ext
70
- when '.ry' # need racc
71
- racc = Gem.bin_path 'racc', 'racc'
72
- rb_file = parser_file.gsub(/\.ry\z/, ".rb")
73
- ruby "#{racc} -l -o #{rb_file} #{parser_file}"
74
- open(rb_file, 'r+') do |f|
75
- newtext = "# frozen_string_literal: true\n#{f.read}"
76
- f.rewind
77
- f.write newtext
78
- end
79
- when '.kpeg' # need kpeg
80
- kpeg = Gem.bin_path 'kpeg', 'kpeg'
81
- rb_file = parser_file.gsub(/\.kpeg\z/, ".rb")
82
- ruby "#{kpeg} -fsv -o #{rb_file} #{parser_file}"
83
- end
84
- end
85
-
86
- parsed_file
87
- end
88
-
89
- task "#{path}.gem" => package_parser_files
90
- desc "Generate all files used racc and kpeg"
91
- task :generate => parsed_files
92
-
93
- task :clean do
94
- parsed_files.each do |path|
95
- File.delete(path) if File.exist?(path)
96
- end
97
- end
98
-
99
- begin
100
- require 'rubocop/rake_task'
101
- rescue LoadError
102
- else
103
- RuboCop::RakeTask.new(:rubocop) do |t|
104
- t.options = [*parsed_files]
105
- end
106
- task :build => [:generate]#, "rubocop:auto_correct"]
107
- end
data/bin/console DELETED
@@ -1,7 +0,0 @@
1
- #!/usr/bin/env ruby
2
-
3
- require "bundler/setup"
4
- require "rdoc"
5
-
6
- require "irb"
7
- IRB.start
data/bin/setup DELETED
@@ -1,6 +0,0 @@
1
- #!/usr/bin/env bash
2
- set -euo pipefail
3
- IFS=$'\n\t'
4
- set -vx
5
-
6
- bundle install
data/rdoc.gemspec DELETED
@@ -1,249 +0,0 @@
1
- begin
2
- require_relative "lib/rdoc/version"
3
- rescue LoadError
4
- # for Ruby repository
5
- require_relative "version"
6
- end
7
-
8
- Gem::Specification.new do |s|
9
- s.name = "rdoc"
10
- s.version = RDoc::VERSION
11
-
12
- s.authors = [
13
- "Eric Hodel",
14
- "Dave Thomas",
15
- "Phil Hagelberg",
16
- "Tony Strauss",
17
- "Zachary Scott",
18
- "Hiroshi SHIBATA",
19
- "ITOYANAGI Sakura"
20
- ]
21
- s.email = ["drbrain@segment7.net", "", "", "", "mail@zzak.io", "hsbt@ruby-lang.org", "aycabta@gmail.com"]
22
-
23
- s.summary = "RDoc produces HTML and command-line documentation for Ruby projects"
24
- s.description = <<-DESCRIPTION
25
- RDoc produces HTML and command-line documentation for Ruby projects.
26
- RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentation from the command-line.
27
- DESCRIPTION
28
- s.homepage = "https://ruby.github.io/rdoc"
29
- s.licenses = ["Ruby"]
30
-
31
- s.bindir = "exe"
32
- s.executables = ["rdoc", "ri"]
33
- s.require_paths = ["lib"]
34
- # for ruby core repository. It was generated by
35
- # `git ls-files -z`.split("\x0").each {|f| puts " #{f.dump}," unless f.start_with?(*%W[test/ spec/ features/ .]) }
36
- s.files = [
37
- "CONTRIBUTING.rdoc",
38
- "CVE-2013-0256.rdoc",
39
- "ExampleMarkdown.md",
40
- "ExampleRDoc.rdoc",
41
- "Gemfile",
42
- "History.rdoc",
43
- "LEGAL.rdoc",
44
- "LICENSE.rdoc",
45
- "README.rdoc",
46
- "RI.rdoc",
47
- "Rakefile",
48
- "TODO.rdoc",
49
- "bin/console",
50
- "bin/setup",
51
- "exe/rdoc",
52
- "exe/ri",
53
- "lib/rdoc.rb",
54
- "lib/rdoc/alias.rb",
55
- "lib/rdoc/anon_class.rb",
56
- "lib/rdoc/any_method.rb",
57
- "lib/rdoc/attr.rb",
58
- "lib/rdoc/class_module.rb",
59
- "lib/rdoc/code_object.rb",
60
- "lib/rdoc/code_objects.rb",
61
- "lib/rdoc/comment.rb",
62
- "lib/rdoc/constant.rb",
63
- "lib/rdoc/context.rb",
64
- "lib/rdoc/context/section.rb",
65
- "lib/rdoc/cross_reference.rb",
66
- "lib/rdoc/encoding.rb",
67
- "lib/rdoc/erb_partial.rb",
68
- "lib/rdoc/erbio.rb",
69
- "lib/rdoc/extend.rb",
70
- "lib/rdoc/generator.rb",
71
- "lib/rdoc/generator/darkfish.rb",
72
- "lib/rdoc/generator/json_index.rb",
73
- "lib/rdoc/generator/markup.rb",
74
- "lib/rdoc/generator/pot.rb",
75
- "lib/rdoc/generator/pot/message_extractor.rb",
76
- "lib/rdoc/generator/pot/po.rb",
77
- "lib/rdoc/generator/pot/po_entry.rb",
78
- "lib/rdoc/generator/ri.rb",
79
- "lib/rdoc/generator/template/darkfish/.document",
80
- "lib/rdoc/generator/template/darkfish/_footer.rhtml",
81
- "lib/rdoc/generator/template/darkfish/_head.rhtml",
82
- "lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml",
83
- "lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml",
84
- "lib/rdoc/generator/template/darkfish/_sidebar_extends.rhtml",
85
- "lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml",
86
- "lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml",
87
- "lib/rdoc/generator/template/darkfish/_sidebar_installed.rhtml",
88
- "lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml",
89
- "lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml",
90
- "lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml",
91
- "lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml",
92
- "lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml",
93
- "lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml",
94
- "lib/rdoc/generator/template/darkfish/_sidebar_table_of_contents.rhtml",
95
- "lib/rdoc/generator/template/darkfish/class.rhtml",
96
- "lib/rdoc/generator/template/darkfish/css/fonts.css",
97
- "lib/rdoc/generator/template/darkfish/css/rdoc.css",
98
- "lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf",
99
- "lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf",
100
- "lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf",
101
- "lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf",
102
- "lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf",
103
- "lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf",
104
- "lib/rdoc/generator/template/darkfish/images/add.png",
105
- "lib/rdoc/generator/template/darkfish/images/arrow_up.png",
106
- "lib/rdoc/generator/template/darkfish/images/brick.png",
107
- "lib/rdoc/generator/template/darkfish/images/brick_link.png",
108
- "lib/rdoc/generator/template/darkfish/images/bug.png",
109
- "lib/rdoc/generator/template/darkfish/images/bullet_black.png",
110
- "lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png",
111
- "lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png",
112
- "lib/rdoc/generator/template/darkfish/images/date.png",
113
- "lib/rdoc/generator/template/darkfish/images/delete.png",
114
- "lib/rdoc/generator/template/darkfish/images/find.png",
115
- "lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif",
116
- "lib/rdoc/generator/template/darkfish/images/macFFBgHack.png",
117
- "lib/rdoc/generator/template/darkfish/images/package.png",
118
- "lib/rdoc/generator/template/darkfish/images/page_green.png",
119
- "lib/rdoc/generator/template/darkfish/images/page_white_text.png",
120
- "lib/rdoc/generator/template/darkfish/images/page_white_width.png",
121
- "lib/rdoc/generator/template/darkfish/images/plugin.png",
122
- "lib/rdoc/generator/template/darkfish/images/ruby.png",
123
- "lib/rdoc/generator/template/darkfish/images/tag_blue.png",
124
- "lib/rdoc/generator/template/darkfish/images/tag_green.png",
125
- "lib/rdoc/generator/template/darkfish/images/transparent.png",
126
- "lib/rdoc/generator/template/darkfish/images/wrench.png",
127
- "lib/rdoc/generator/template/darkfish/images/wrench_orange.png",
128
- "lib/rdoc/generator/template/darkfish/images/zoom.png",
129
- "lib/rdoc/generator/template/darkfish/index.rhtml",
130
- "lib/rdoc/generator/template/darkfish/js/darkfish.js",
131
- "lib/rdoc/generator/template/darkfish/js/search.js",
132
- "lib/rdoc/generator/template/darkfish/page.rhtml",
133
- "lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml",
134
- "lib/rdoc/generator/template/darkfish/servlet_root.rhtml",
135
- "lib/rdoc/generator/template/darkfish/table_of_contents.rhtml",
136
- "lib/rdoc/generator/template/json_index/.document",
137
- "lib/rdoc/generator/template/json_index/js/navigation.js",
138
- "lib/rdoc/generator/template/json_index/js/searcher.js",
139
- "lib/rdoc/ghost_method.rb",
140
- "lib/rdoc/i18n.rb",
141
- "lib/rdoc/i18n/locale.rb",
142
- "lib/rdoc/i18n/text.rb",
143
- "lib/rdoc/include.rb",
144
- "lib/rdoc/known_classes.rb",
145
- "lib/rdoc/markdown.kpeg",
146
- "lib/rdoc/markdown/entities.rb",
147
- "lib/rdoc/markdown/literals.kpeg",
148
- "lib/rdoc/markup.rb",
149
- "lib/rdoc/markup/attr_changer.rb",
150
- "lib/rdoc/markup/attr_span.rb",
151
- "lib/rdoc/markup/attribute_manager.rb",
152
- "lib/rdoc/markup/attributes.rb",
153
- "lib/rdoc/markup/blank_line.rb",
154
- "lib/rdoc/markup/block_quote.rb",
155
- "lib/rdoc/markup/document.rb",
156
- "lib/rdoc/markup/formatter.rb",
157
- "lib/rdoc/markup/hard_break.rb",
158
- "lib/rdoc/markup/heading.rb",
159
- "lib/rdoc/markup/include.rb",
160
- "lib/rdoc/markup/indented_paragraph.rb",
161
- "lib/rdoc/markup/list.rb",
162
- "lib/rdoc/markup/list_item.rb",
163
- "lib/rdoc/markup/paragraph.rb",
164
- "lib/rdoc/markup/parser.rb",
165
- "lib/rdoc/markup/pre_process.rb",
166
- "lib/rdoc/markup/raw.rb",
167
- "lib/rdoc/markup/regexp_handling.rb",
168
- "lib/rdoc/markup/rule.rb",
169
- "lib/rdoc/markup/table.rb",
170
- "lib/rdoc/markup/to_ansi.rb",
171
- "lib/rdoc/markup/to_bs.rb",
172
- "lib/rdoc/markup/to_html.rb",
173
- "lib/rdoc/markup/to_html_crossref.rb",
174
- "lib/rdoc/markup/to_html_snippet.rb",
175
- "lib/rdoc/markup/to_joined_paragraph.rb",
176
- "lib/rdoc/markup/to_label.rb",
177
- "lib/rdoc/markup/to_markdown.rb",
178
- "lib/rdoc/markup/to_rdoc.rb",
179
- "lib/rdoc/markup/to_table_of_contents.rb",
180
- "lib/rdoc/markup/to_test.rb",
181
- "lib/rdoc/markup/to_tt_only.rb",
182
- "lib/rdoc/markup/verbatim.rb",
183
- "lib/rdoc/meta_method.rb",
184
- "lib/rdoc/method_attr.rb",
185
- "lib/rdoc/mixin.rb",
186
- "lib/rdoc/normal_class.rb",
187
- "lib/rdoc/normal_module.rb",
188
- "lib/rdoc/options.rb",
189
- "lib/rdoc/parser.rb",
190
- "lib/rdoc/parser/c.rb",
191
- "lib/rdoc/parser/changelog.rb",
192
- "lib/rdoc/parser/markdown.rb",
193
- "lib/rdoc/parser/rd.rb",
194
- "lib/rdoc/parser/ripper_state_lex.rb",
195
- "lib/rdoc/parser/ruby.rb",
196
- "lib/rdoc/parser/ruby_tools.rb",
197
- "lib/rdoc/parser/simple.rb",
198
- "lib/rdoc/parser/text.rb",
199
- "lib/rdoc/rd.rb",
200
- "lib/rdoc/rd/block_parser.ry",
201
- "lib/rdoc/rd/inline.rb",
202
- "lib/rdoc/rd/inline_parser.ry",
203
- "lib/rdoc/rdoc.rb",
204
- "lib/rdoc/require.rb",
205
- "lib/rdoc/ri.rb",
206
- "lib/rdoc/ri/driver.rb",
207
- "lib/rdoc/ri/formatter.rb",
208
- "lib/rdoc/ri/paths.rb",
209
- "lib/rdoc/ri/store.rb",
210
- "lib/rdoc/ri/task.rb",
211
- "lib/rdoc/rubygems_hook.rb",
212
- "lib/rdoc/servlet.rb",
213
- "lib/rdoc/single_class.rb",
214
- "lib/rdoc/stats.rb",
215
- "lib/rdoc/stats/normal.rb",
216
- "lib/rdoc/stats/quiet.rb",
217
- "lib/rdoc/stats/verbose.rb",
218
- "lib/rdoc/store.rb",
219
- "lib/rdoc/task.rb",
220
- "lib/rdoc/text.rb",
221
- "lib/rdoc/token_stream.rb",
222
- "lib/rdoc/tom_doc.rb",
223
- "lib/rdoc/top_level.rb",
224
- "lib/rdoc/version.rb",
225
- "man/ri.1",
226
- "rdoc.gemspec",
227
- ]
228
- # files from .gitignore
229
- s.files << "lib/rdoc/rd/block_parser.rb" << "lib/rdoc/rd/inline_parser.rb" << "lib/rdoc/markdown.rb" << "lib/rdoc/markdown/literals.rb"
230
-
231
- s.rdoc_options = ["--main", "README.rdoc"]
232
- s.extra_rdoc_files += %w[
233
- CVE-2013-0256.rdoc
234
- CONTRIBUTING.rdoc
235
- ExampleMarkdown.md
236
- ExampleRDoc.rdoc
237
- History.rdoc
238
- LEGAL.rdoc
239
- LICENSE.rdoc
240
- README.rdoc
241
- RI.rdoc
242
- TODO.rdoc
243
- ]
244
-
245
- s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
246
- s.required_rubygems_version = Gem::Requirement.new(">= 2.2")
247
-
248
- s.add_dependency 'psych', '>= 4.0.0'
249
- end