Skip to content

Commit ac2a151

Browse files
st0012st0012
authored
Improve how gemspec's files are defined (#1212)
Currently, the gemspec's files are defined by hand, which is error-prone. For example: #1211 This commit uses `Dir.glob` where possible to reduce the risk of that happening again. - Additional files added with this approach: ``` # This should have been added by only captured by this commit lib/rdoc/parser/prism_ruby.rb # These are folders and can be included/ignored either way lib/rdoc/generator/template/darkfish lib/rdoc/generator/template/darkfish/css lib/rdoc/generator/template/darkfish/fonts lib/rdoc/generator/template/darkfish/images lib/rdoc/generator/template/darkfish/js lib/rdoc/generator/template/json_index lib/rdoc/generator/template/json_index/js ``` - Files that are ignored after this change: ``` # They make no difference on documentation generation # Probably can be removed lib/rdoc/generator/template/darkfish/.document lib/rdoc/generator/template/json_index/.document ```
1 parent 6909516 commit ac2a151

File tree

1 file changed

+5
-176
lines changed

1 file changed

+5
-176
lines changed

‎rdoc.gemspec

+5-176
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
3737
s.require_paths = ["lib"]
3838
# for ruby core repository. It was generated by
3939
# `git ls-files -z`.split("\x0").each {|f| puts " #{f.dump}," unless f.start_with?(*%W[test/ spec/ features/ .]) }
40-
s.files = [
40+
non_lib_files = [
4141
"CONTRIBUTING.rdoc",
4242
"CVE-2013-0256.rdoc",
4343
"ExampleMarkdown.md",
@@ -50,183 +50,12 @@ RDoc includes the +rdoc+ and +ri+ tools for generating and displaying documentat
5050
"TODO.rdoc",
5151
"exe/rdoc",
5252
"exe/ri",
53-
"lib/rdoc.rb",
54-
"lib/rdoc/code_object/alias.rb",
55-
"lib/rdoc/code_object/anon_class.rb",
56-
"lib/rdoc/code_object/any_method.rb",
57-
"lib/rdoc/code_object/attr.rb",
58-
"lib/rdoc/code_object/class_module.rb",
59-
"lib/rdoc/code_object.rb",
60-
"lib/rdoc/code_objects.rb",
61-
"lib/rdoc/comment.rb",
62-
"lib/rdoc/code_object/constant.rb",
63-
"lib/rdoc/code_object/context.rb",
64-
"lib/rdoc/code_object/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/code_object/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/_sidebar_toggle.rhtml",
96-
"lib/rdoc/generator/template/darkfish/class.rhtml",
97-
"lib/rdoc/generator/template/darkfish/css/fonts.css",
98-
"lib/rdoc/generator/template/darkfish/css/rdoc.css",
99-
"lib/rdoc/generator/template/darkfish/fonts/Lato-Light.ttf",
100-
"lib/rdoc/generator/template/darkfish/fonts/Lato-LightItalic.ttf",
101-
"lib/rdoc/generator/template/darkfish/fonts/Lato-Regular.ttf",
102-
"lib/rdoc/generator/template/darkfish/fonts/Lato-RegularItalic.ttf",
103-
"lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Bold.ttf",
104-
"lib/rdoc/generator/template/darkfish/fonts/SourceCodePro-Regular.ttf",
105-
"lib/rdoc/generator/template/darkfish/images/add.png",
106-
"lib/rdoc/generator/template/darkfish/images/arrow_up.png",
107-
"lib/rdoc/generator/template/darkfish/images/brick.png",
108-
"lib/rdoc/generator/template/darkfish/images/brick_link.png",
109-
"lib/rdoc/generator/template/darkfish/images/bug.png",
110-
"lib/rdoc/generator/template/darkfish/images/bullet_black.png",
111-
"lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png",
112-
"lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png",
113-
"lib/rdoc/generator/template/darkfish/images/date.png",
114-
"lib/rdoc/generator/template/darkfish/images/delete.png",
115-
"lib/rdoc/generator/template/darkfish/images/find.png",
116-
"lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif",
117-
"lib/rdoc/generator/template/darkfish/images/macFFBgHack.png",
118-
"lib/rdoc/generator/template/darkfish/images/package.png",
119-
"lib/rdoc/generator/template/darkfish/images/page_green.png",
120-
"lib/rdoc/generator/template/darkfish/images/page_white_text.png",
121-
"lib/rdoc/generator/template/darkfish/images/page_white_width.png",
122-
"lib/rdoc/generator/template/darkfish/images/plugin.png",
123-
"lib/rdoc/generator/template/darkfish/images/ruby.png",
124-
"lib/rdoc/generator/template/darkfish/images/tag_blue.png",
125-
"lib/rdoc/generator/template/darkfish/images/tag_green.png",
126-
"lib/rdoc/generator/template/darkfish/images/transparent.png",
127-
"lib/rdoc/generator/template/darkfish/images/wrench.png",
128-
"lib/rdoc/generator/template/darkfish/images/wrench_orange.png",
129-
"lib/rdoc/generator/template/darkfish/images/zoom.png",
130-
"lib/rdoc/generator/template/darkfish/index.rhtml",
131-
"lib/rdoc/generator/template/darkfish/js/darkfish.js",
132-
"lib/rdoc/generator/template/darkfish/js/search.js",
133-
"lib/rdoc/generator/template/darkfish/page.rhtml",
134-
"lib/rdoc/generator/template/darkfish/servlet_not_found.rhtml",
135-
"lib/rdoc/generator/template/darkfish/servlet_root.rhtml",
136-
"lib/rdoc/generator/template/darkfish/table_of_contents.rhtml",
137-
"lib/rdoc/generator/template/json_index/.document",
138-
"lib/rdoc/generator/template/json_index/js/navigation.js",
139-
"lib/rdoc/generator/template/json_index/js/searcher.js",
140-
"lib/rdoc/code_object/ghost_method.rb",
141-
"lib/rdoc/i18n.rb",
142-
"lib/rdoc/i18n/locale.rb",
143-
"lib/rdoc/i18n/text.rb",
144-
"lib/rdoc/code_object/include.rb",
145-
"lib/rdoc/known_classes.rb",
146-
"lib/rdoc/markdown.kpeg",
147-
"lib/rdoc/markdown/entities.rb",
148-
"lib/rdoc/markdown/literals.kpeg",
149-
"lib/rdoc/markup.rb",
150-
"lib/rdoc/markup/attr_changer.rb",
151-
"lib/rdoc/markup/attr_span.rb",
152-
"lib/rdoc/markup/attribute_manager.rb",
153-
"lib/rdoc/markup/attributes.rb",
154-
"lib/rdoc/markup/blank_line.rb",
155-
"lib/rdoc/markup/block_quote.rb",
156-
"lib/rdoc/markup/document.rb",
157-
"lib/rdoc/markup/formatter.rb",
158-
"lib/rdoc/markup/hard_break.rb",
159-
"lib/rdoc/markup/heading.rb",
160-
"lib/rdoc/markup/include.rb",
161-
"lib/rdoc/markup/indented_paragraph.rb",
162-
"lib/rdoc/markup/list.rb",
163-
"lib/rdoc/markup/list_item.rb",
164-
"lib/rdoc/markup/paragraph.rb",
165-
"lib/rdoc/markup/parser.rb",
166-
"lib/rdoc/markup/pre_process.rb",
167-
"lib/rdoc/markup/raw.rb",
168-
"lib/rdoc/markup/regexp_handling.rb",
169-
"lib/rdoc/markup/rule.rb",
170-
"lib/rdoc/markup/table.rb",
171-
"lib/rdoc/markup/to_ansi.rb",
172-
"lib/rdoc/markup/to_bs.rb",
173-
"lib/rdoc/markup/to_html.rb",
174-
"lib/rdoc/markup/to_html_crossref.rb",
175-
"lib/rdoc/markup/to_html_snippet.rb",
176-
"lib/rdoc/markup/to_joined_paragraph.rb",
177-
"lib/rdoc/markup/to_label.rb",
178-
"lib/rdoc/markup/to_markdown.rb",
179-
"lib/rdoc/markup/to_rdoc.rb",
180-
"lib/rdoc/markup/to_table_of_contents.rb",
181-
"lib/rdoc/markup/to_test.rb",
182-
"lib/rdoc/markup/to_tt_only.rb",
183-
"lib/rdoc/markup/verbatim.rb",
184-
"lib/rdoc/code_object/meta_method.rb",
185-
"lib/rdoc/code_object/method_attr.rb",
186-
"lib/rdoc/code_object/mixin.rb",
187-
"lib/rdoc/code_object/normal_class.rb",
188-
"lib/rdoc/code_object/normal_module.rb",
189-
"lib/rdoc/options.rb",
190-
"lib/rdoc/parser.rb",
191-
"lib/rdoc/parser/c.rb",
192-
"lib/rdoc/parser/changelog.rb",
193-
"lib/rdoc/parser/markdown.rb",
194-
"lib/rdoc/parser/rd.rb",
195-
"lib/rdoc/parser/ripper_state_lex.rb",
196-
"lib/rdoc/parser/ruby.rb",
197-
"lib/rdoc/parser/ruby_tools.rb",
198-
"lib/rdoc/parser/simple.rb",
199-
"lib/rdoc/parser/text.rb",
200-
"lib/rdoc/rd.rb",
201-
"lib/rdoc/rd/block_parser.ry",
202-
"lib/rdoc/rd/inline.rb",
203-
"lib/rdoc/rd/inline_parser.ry",
204-
"lib/rdoc/rdoc.rb",
205-
"lib/rdoc/code_object/require.rb",
206-
"lib/rdoc/ri.rb",
207-
"lib/rdoc/ri/driver.rb",
208-
"lib/rdoc/ri/formatter.rb",
209-
"lib/rdoc/ri/paths.rb",
210-
"lib/rdoc/ri/store.rb",
211-
"lib/rdoc/ri/task.rb",
212-
"lib/rdoc/rubygems_hook.rb",
213-
"lib/rdoc/servlet.rb",
214-
"lib/rdoc/code_object/single_class.rb",
215-
"lib/rdoc/stats.rb",
216-
"lib/rdoc/stats/normal.rb",
217-
"lib/rdoc/stats/quiet.rb",
218-
"lib/rdoc/stats/verbose.rb",
219-
"lib/rdoc/store.rb",
220-
"lib/rdoc/task.rb",
221-
"lib/rdoc/text.rb",
222-
"lib/rdoc/token_stream.rb",
223-
"lib/rdoc/tom_doc.rb",
224-
"lib/rdoc/code_object/top_level.rb",
225-
"lib/rdoc/version.rb",
22653
"man/ri.1",
22754
]
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"
55+
template_files = Dir.glob("lib/rdoc/generator/template/**/*")
56+
lib_files = Dir.glob("lib/**/*.{rb,kpeg,ry}")
57+
58+
s.files = (non_lib_files + template_files + lib_files).uniq
23059

23160
s.rdoc_options = ["--main", "README.rdoc"]
23261
s.extra_rdoc_files += s.files.grep(%r[\A[^\/]+\.(?:rdoc|md)\z])

0 commit comments

Comments
 (0)