Skip to content

Commit 743895e

Browse files
committed
Improve doc scraping
* Include security cops * Add a dumb heuristic for if a doc is worth including: the "undesirable" docs are basically always one small line of text, so a quick line-count check is largely sufficient.
1 parent 21115dd commit 743895e

File tree

98 files changed

+122
-140
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+122
-140
lines changed

Diff for: config/contents/lint/assignment_in_condition.md

-2
This file was deleted.

Diff for: config/contents/lint/debugger.md

-1
This file was deleted.

Diff for: config/contents/lint/deprecated_class_methods.md

-1
This file was deleted.

Diff for: config/contents/lint/empty_ensure.md

-1
This file was deleted.

Diff for: config/contents/lint/end_in_method.md

-1
This file was deleted.

Diff for: config/contents/lint/ensure_return.md

-1
This file was deleted.

Diff for: config/contents/lint/eval.md

-1
This file was deleted.

Diff for: config/contents/lint/handle_exceptions.md

-1
This file was deleted.

Diff for: config/contents/lint/loop.md

-1
This file was deleted.

Diff for: config/contents/lint/rescue_exception.md

-1
This file was deleted.

Diff for: config/contents/lint/syntax.md

-2
This file was deleted.

Diff for: config/contents/lint/underscore_prefixed_variable_name.md

-2
This file was deleted.

Diff for: config/contents/lint/void.md

-2
This file was deleted.

Diff for: config/contents/metrics/line_length.md

-2
This file was deleted.

Diff for: config/contents/performance/fixed_size.md

-1
This file was deleted.

Diff for: config/contents/rails/has_and_belongs_to_many.md

-1
This file was deleted.

Diff for: config/contents/rails/output.md

-1
This file was deleted.

Diff for: config/contents/rails/request_referer.md

-2
This file was deleted.

Diff for: config/contents/rails/validation.md

-1
This file was deleted.

Diff for: config/contents/security/json_load.md

+18

Diff for: config/contents/style/access_modifier_indentation.md

-2
This file was deleted.

Diff for: config/contents/style/align_array.md

-2
This file was deleted.

Diff for: config/contents/style/align_hash.md

-2
This file was deleted.

Diff for: config/contents/style/align_parameters.md

-2
This file was deleted.

Diff for: config/contents/style/and_or.md

-1
This file was deleted.

Diff for: config/contents/style/ascii_comments.md

-2
This file was deleted.

Diff for: config/contents/style/ascii_identifiers.md

-1
This file was deleted.

Diff for: config/contents/style/attr.md

-1
This file was deleted.

Diff for: config/contents/style/bare_percent_literals.md

-1
This file was deleted.

Diff for: config/contents/style/begin_block.md

-1
This file was deleted.

Diff for: config/contents/style/block_comments.md

-1
This file was deleted.

Diff for: config/contents/style/block_delimiters.md

-2
This file was deleted.

Diff for: config/contents/style/braces_around_hash_parameters.md

-2
This file was deleted.

Diff for: config/contents/style/case_equality.md

-1
This file was deleted.

Diff for: config/contents/style/character_literal.md

-1
This file was deleted.

Diff for: config/contents/style/class_and_module_camel_case.md

-2
This file was deleted.

Diff for: config/contents/style/class_check.md

-1
This file was deleted.

Diff for: config/contents/style/colon_method_call.md

-2
This file was deleted.

Diff for: config/contents/style/comment_annotation.md

-2
This file was deleted.

Diff for: config/contents/style/comment_indentation.md

-1
This file was deleted.

Diff for: config/contents/style/conditional_assignment.md

-2
This file was deleted.

Diff for: config/contents/style/dot_position.md

-1
This file was deleted.

Diff for: config/contents/style/empty_line_between_defs.md

-2
This file was deleted.

Diff for: config/contents/style/empty_lines.md

-1
This file was deleted.

Diff for: config/contents/style/empty_lines_around_access_modifier.md

-1
This file was deleted.

Diff for: config/contents/style/empty_literal.md

-2
This file was deleted.

Diff for: config/contents/style/end_block.md

-1
This file was deleted.

Diff for: config/contents/style/end_of_line.md

-1
This file was deleted.

Diff for: config/contents/style/flip_flop.md

-1
This file was deleted.

Diff for: config/contents/style/if_with_semicolon.md

-1
This file was deleted.

Diff for: config/contents/style/initial_indentation.md

-2
This file was deleted.

Diff for: config/contents/style/method_call_parentheses.md

-1
This file was deleted.

Diff for: config/contents/style/method_def_parentheses.md

-2
This file was deleted.

Diff for: config/contents/style/multiline_ternary_operator.md

-1
This file was deleted.

Diff for: config/contents/style/negated_if.md

-2
This file was deleted.

Diff for: config/contents/style/negated_while.md

-1
This file was deleted.

Diff for: config/contents/style/nested_ternary_operator.md

-1
This file was deleted.

Diff for: config/contents/style/not.md

-1
This file was deleted.

Diff for: config/contents/style/numeric_literals.md

-2
This file was deleted.

Diff for: config/contents/style/one_line_conditional.md

-2
This file was deleted.

Diff for: config/contents/style/parentheses_around_condition.md

-2
This file was deleted.

Diff for: config/contents/style/percent_literal_delimiters.md

-1
This file was deleted.

Diff for: config/contents/style/percent_q_literals.md

-1
This file was deleted.

Diff for: config/contents/style/perl_backrefs.md

-2
This file was deleted.

Diff for: config/contents/style/proc.md

-2
This file was deleted.

Diff for: config/contents/style/rescue_modifier.md

-1
This file was deleted.

Diff for: config/contents/style/semicolon.md

-2
This file was deleted.

Diff for: config/contents/style/send.md

-1
This file was deleted.

Diff for: config/contents/style/signal_exception.md

-1
This file was deleted.

Diff for: config/contents/style/single_line_methods.md

-2
This file was deleted.

Diff for: config/contents/style/space_after_comma.md

-1
This file was deleted.

Diff for: config/contents/style/space_after_semicolon.md

-1
This file was deleted.

Diff for: config/contents/style/space_around_equals_in_parameter_default.md

-2
This file was deleted.

Diff for: config/contents/style/space_around_operators.md

-2
This file was deleted.

Diff for: config/contents/style/space_before_block_braces.md

-2
This file was deleted.

Diff for: config/contents/style/space_before_comma.md

-1
This file was deleted.

Diff for: config/contents/style/space_before_comment.md

-2
This file was deleted.

Diff for: config/contents/style/space_before_semicolon.md

-1
This file was deleted.

Diff for: config/contents/style/space_inside_brackets.md

-1
This file was deleted.

Diff for: config/contents/style/space_inside_hash_literal_braces.md

-2
This file was deleted.

Diff for: config/contents/style/space_inside_parens.md

-1
This file was deleted.

Diff for: config/contents/style/special_global_vars.md

-1
This file was deleted.

Diff for: config/contents/style/string_literals.md

-1
This file was deleted.

Diff for: config/contents/style/string_literals_in_interpolation.md

-1
This file was deleted.

Diff for: config/contents/style/string_methods.md

-2
This file was deleted.

Diff for: config/contents/style/tab.md

-1
This file was deleted.

Diff for: config/contents/style/trailing_blank_lines.md

-2
This file was deleted.

Diff for: config/contents/style/trailing_whitespace.md

-1
This file was deleted.

Diff for: config/contents/style/trivial_accessors.md

-2
This file was deleted.

Diff for: config/contents/style/unless_else.md

-1
This file was deleted.

Diff for: config/contents/style/unneeded_capital_w.md

-1
This file was deleted.

Diff for: config/contents/style/unneeded_percent_q.md

-1
This file was deleted.

Diff for: config/contents/style/variable_interpolation.md

-1
This file was deleted.

Diff for: config/contents/style/variable_name.md

-2
This file was deleted.

Diff for: config/contents/style/when_then.md

-1
This file was deleted.

Diff for: config/contents/style/while_until_do.md

-1
This file was deleted.

Diff for: lib/tasks/docs.rake

+10-6
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
require "rubocop"
2+
require "fileutils"
23

34
namespace :docs do
45
desc "Scrapes documentation from the rubocop gem"
56
task :scrape do
6-
COP_FOLDERS = %w[lint metrics performance rails style]
7+
MIN_LINES = 3
8+
COP_FOLDERS = %w[lint metrics performance rails security style].freeze
79

810
%x{git clone https://github.com/bbatsov/rubocop.git rubocop-git}
911
%x{cd rubocop-git && git checkout tags/v#{RuboCop::Version.version}}
@@ -34,12 +36,14 @@ namespace :docs do
3436
folder_path = "./config/contents/#{namespace}"
3537
write_path = "#{folder_path}/#{file_name}.md"
3638

37-
puts "Writing documentation to #{write_path}"
39+
if documentation.split("\n").count >= MIN_LINES
40+
puts "Writing documentation to #{write_path}"
3841

39-
40-
FileUtils.mkdir_p(folder_path)
41-
File.open(write_path, 'w') do |file|
42-
file.write(documentation)
42+
FileUtils.mkdir_p(folder_path)
43+
File.write(write_path, documentation)
44+
else
45+
puts "Documentation for #{file_name} looks poor: deleting it."
46+
FileUtils.rm(write_path) if File.exist?(write_path)
4347
end
4448
end
4549

0 commit comments

Comments
 (0)