docbrown/app/labor/markdown_fixer.rb
Fabbri Paolo 89e893f157 Fix rubocop detected offenses (#4552)
* Run Inspecting 1050 files
....................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................................C.....................................................................................................................................................................................................................................................................................................

Offenses:

spec/models/article_spec.rb:195:7: C: RSpec/NestedGroups: Maximum example group nesting exceeded [4/3]. (http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NestedGroups)
      context "when description is empty" do
      ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

1050 files inspected, 1 offense detected to fix autofixable errors

* Refactor  to correct test

it was braking the rule RSpec/NestedGroups: Maximum example group nesting exceeded [4/3]. (http://www.rubydoc.info/gems/rubocop-rspec/RuboCop/Cop/RSpec/NestedGroups)

* Run `rubocop --auto-gen-config` to regenrate `.rubocop_todo.yml`
2019-10-24 11:53:03 -04:00

78 lines
2.6 KiB
Ruby

class MarkdownFixer
FRONT_MATTER_DETECTOR = /-{3}.*?-{3}/m.freeze
class << self
def fix_all(markdown)
methods = %i[
add_quotes_to_title add_quotes_to_description
modify_hr_tags convert_new_lines split_tags underscores_in_usernames
]
methods.reduce(markdown) { |result, method| send(method, result) }
end
def fix_for_preview(markdown)
methods = %i[add_quotes_to_title add_quotes_to_description modify_hr_tags underscores_in_usernames]
methods.reduce(markdown) { |result, method| send(method, result) }
end
def fix_for_comment(markdown)
methods = %I[modify_hr_tags underscores_in_usernames]
methods.reduce(markdown) { |result, method| send(method, result) }
end
def add_quotes_to_title(markdown)
add_quotes_to_section(markdown, section: "title")
end
def add_quotes_to_description(markdown)
add_quotes_to_section(markdown, section: "description")
end
# This turns --- into ------- after the first two,
# because --- messes with front matter
def modify_hr_tags(markdown)
markdown.gsub(/-{3}.*?-{3}/m) do |front_matter|
front_matter.gsub(/^---/).with_index { |match, i| i > 1 ? "#{match}-----" : match }
end
end
def convert_new_lines(markdown)
markdown.gsub("\r\n", "\n")
end
def split_tags(markdown)
markdown.gsub(/\ntags:.*\n/) do |tags|
tags.split(" #").join(",").delete("#").gsub(":,", ": ")
end
end
def underscores_in_usernames(markdown)
markdown.gsub(/(@)(_\w+)(_)/, '\1\\\\\2\\\\\3')
end
private
def add_quotes_to_section(markdown, section:)
# Only add quotes to front matter, or text between triple dashes
markdown.sub(FRONT_MATTER_DETECTOR) do |front_matter|
front_matter.gsub(/#{section}: ?(?<content>.*?)(\r\n|\n)/m) do |target|
# `content` is the captured group (.*?)
captured_text = Regexp.last_match("content")
# The query below checks if the whole text is wrapped in
# either single or double quotes.
match = captured_text.scan(/(^".*"$|^'.*'$)/)
if match.empty?
# Double quotes that aren't already escaped will get esacped.
# Then the whole text get warped in double quotes.
parsed_text = captured_text.gsub(/(?<![\\])["]/, "\\\"")
"#{section}: \"#{parsed_text}\"\n"
else
# if the text comes pre-warped in either single or double quotes,
# no more processing is done
target
end
end
end
end
end
end