Skip to content

Make methods private in AnnotateRoutes #598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Apr 28, 2019
Merged

Make methods private in AnnotateRoutes #598

Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
d47845d
Make AnnotateRoutes.rewrite_contents_with_header private
nard-tech Feb 2, 2019
d5942a9
Make AnnotateRoutes.header private
nard-tech Feb 2, 2019
c2ac243
Make AnnotateRoutes.strip_annotations private
nard-tech Feb 2, 2019
329c1e6
Make AnnotateRoutes.strip_on_removal private
nard-tech Feb 2, 2019
ad9752f
Make AnnotateRoutes.rewrite_contents private
nard-tech Feb 2, 2019
32fd1aa
Make AnnotateRoutes.routes_exists? private
nard-tech Feb 2, 2019
8d33af3
Make AnnotateRoutes.routes_file private
nard-tech Feb 2, 2019
818cef9
Make AnnotateRoutes.content private
nard-tech Feb 2, 2019
3bd8291
Make AnnotateRoutes.annotate_routes private
nard-tech Feb 2, 2019
69a00cc
Make AnnotateRoutes.app_routes_map private
nard-tech Feb 2, 2019
d62e1eb
Make AnnotateRoutes.extract_magic_comments_from_array private
nard-tech Feb 2, 2019
19cf2a8
Make AnnotateRoutes.magic_comment_matcher private
nard-tech Feb 2, 2019
7308eae
Make AnnotateRoutes.where_header_found private
nard-tech Feb 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
296 changes: 149 additions & 147 deletions lib/annotate/annotate_routes.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,53 @@ module AnnotateRoutes
HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']

class << self
def content(line, maxs, options = {})
return line.rstrip unless options[:format_markdown]
def do_annotations(options = {})
return unless routes_exists?
existing_text = File.read(routes_file)

line.each_with_index.map do |elem, index|
min_length = maxs.map { |arr| arr[index] }.max || 0
if rewrite_contents_with_header(existing_text, header(options), options)
puts "#{routes_file} annotated."
end
end

sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
end.join(' | ')
def remove_annotations(_options={})
return unless routes_exists?
existing_text = File.read(routes_file)
content, where_header_found = strip_annotations(existing_text)
new_content = strip_on_removal(content, where_header_found)
if rewrite_contents(existing_text, new_content)
puts "Removed annotations from #{routes_file}."
end
end

private

def routes_exists?
routes_exists = File.exists?(routes_file)
puts "Can't find routes.rb" unless routes_exists

routes_exists
end

def routes_file
@routes_rb ||= File.join('config', 'routes.rb')
end

def rewrite_contents_with_header(existing_text, header, options = {})
content, where_header_found = strip_annotations(existing_text)
new_content = annotate_routes(header, content, where_header_found, options)

# Make sure we end on a trailing newline.
new_content << '' unless new_content.last == ''
new_text = new_content.join("\n")

if existing_text == new_text
puts "#{routes_file} unchanged."
false
else
File.open(routes_file, 'wb') { |f| f.puts(new_text) }
true
end
end

def header(options = {})
Expand Down Expand Up @@ -70,180 +109,143 @@ def header(options = {})
out
end

def do_annotations(options = {})
return unless routes_exists?
existing_text = File.read(routes_file)

if rewrite_contents_with_header(existing_text, header(options), options)
puts "#{routes_file} annotated."
# TODO: write the method doc using ruby rdoc formats
# where_header_found => This will either be :before, :after, or
# a number. If the number is > 0, the
# annotation was found somewhere in the
# middle of the file. If the number is
# zero, no annotation was found.
def strip_annotations(content)
real_content = []
mode = :content
header_found_at = 0

content.split(/\n/, -1).each_with_index do |line, line_number|
if mode == :header && line !~ /\s*#/
mode = :content
real_content << line unless line.blank?
elsif mode == :content
if line =~ /^\s*#\s*== Route.*$/
header_found_at = line_number + 1 # index start's at 0
mode = :header
else
real_content << line
end
end
end

where_header_found(real_content, header_found_at)
end

def remove_annotations(_options={})
return unless routes_exists?
existing_text = File.read(routes_file)
content, where_header_found = strip_annotations(existing_text)
new_content = strip_on_removal(content, where_header_found)
if rewrite_contents(existing_text, new_content)
puts "Removed annotations from #{routes_file}."
def strip_on_removal(content, where_header_found)
if where_header_found == :before
content.shift while content.first == ''
elsif where_header_found == :after
content.pop while content.last == ''
end
end
end

def self.magic_comment_matcher
Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/)
end
# TODO: If the user buried it in the middle, we should probably see about
# TODO: preserving a single line of space between the content above and
# TODO: below...
content
end

# @param [Array<String>] content
# @return [Array<String>] all found magic comments
# @return [Array<String>] content without magic comments
def self.extract_magic_comments_from_array(content_array)
magic_comments = []
new_content = []
# @param [String, Array<String>]
def rewrite_contents(existing_text, new_content)
# Make sure we end on a trailing newline.
new_content << '' unless new_content.last == ''
new_text = new_content.join("\n")

content_array.map do |row|
if row =~ magic_comment_matcher
magic_comments << row.strip
if existing_text == new_text
puts "#{routes_file} unchanged."
false
else
new_content << row
File.open(routes_file, 'wb') { |f| f.puts(new_text) }
true
end
end

[magic_comments, new_content]
end

def self.app_routes_map(options)
routes_map = `rake routes`.chomp("\n").split(/\n/, -1)

# In old versions of Rake, the first line of output was the cwd. Not so
# much in newer ones. We ditch that line if it exists, and if not, we
# keep the line around.
routes_map.shift if routes_map.first =~ /^\(in \//

# Skip routes which match given regex
# Note: it matches the complete line (route_name, path, controller/action)
if options[:ignore_routes]
routes_map.reject! { |line| line =~ /#{options[:ignore_routes]}/ }
end

routes_map
end

def self.routes_file
@routes_rb ||= File.join('config', 'routes.rb')
end
def annotate_routes(header, content, where_header_found, options = {})
magic_comments_map, content = extract_magic_comments_from_array(content)
if %w(before top).include?(options[:position_in_routes])
header = header << '' if content.first != ''
magic_comments_map << '' if magic_comments_map.any?
new_content = magic_comments_map + header + content
else
# Ensure we have adequate trailing newlines at the end of the file to
# ensure a blank line separating the content from the annotation.
content << '' unless content.last == ''

def self.routes_exists?
routes_exists = File.exists?(routes_file)
puts "Can't find routes.rb" unless routes_exists
# We're moving something from the top of the file to the bottom, so ditch
# the spacer we put in the first time around.
content.shift if where_header_found == :before && content.first == ''

routes_exists
end
new_content = magic_comments_map + content + header
end

# @param [String, Array<String>]
def self.rewrite_contents(existing_text, new_content)
# Make sure we end on a trailing newline.
new_content << '' unless new_content.last == ''
new_text = new_content.join("\n")

if existing_text == new_text
puts "#{routes_file} unchanged."
false
else
File.open(routes_file, 'wb') { |f| f.puts(new_text) }
true
new_content
end
end

def self.rewrite_contents_with_header(existing_text, header, options = {})
content, where_header_found = strip_annotations(existing_text)
new_content = annotate_routes(header, content, where_header_found, options)
def app_routes_map(options)
routes_map = `rake routes`.chomp("\n").split(/\n/, -1)

# Make sure we end on a trailing newline.
new_content << '' unless new_content.last == ''
new_text = new_content.join("\n")
# In old versions of Rake, the first line of output was the cwd. Not so
# much in newer ones. We ditch that line if it exists, and if not, we
# keep the line around.
routes_map.shift if routes_map.first =~ /^\(in \//

if existing_text == new_text
puts "#{routes_file} unchanged."
false
else
File.open(routes_file, 'wb') { |f| f.puts(new_text) }
true
end
end
# Skip routes which match given regex
# Note: it matches the complete line (route_name, path, controller/action)
if options[:ignore_routes]
routes_map.reject! { |line| line =~ /#{options[:ignore_routes]}/ }
end

def self.annotate_routes(header, content, where_header_found, options = {})
magic_comments_map, content = extract_magic_comments_from_array(content)
if %w(before top).include?(options[:position_in_routes])
header = header << '' if content.first != ''
magic_comments_map << '' if magic_comments_map.any?
new_content = magic_comments_map + header + content
else
# Ensure we have adequate trailing newlines at the end of the file to
# ensure a blank line separating the content from the annotation.
content << '' unless content.last == ''

# We're moving something from the top of the file to the bottom, so ditch
# the spacer we put in the first time around.
content.shift if where_header_found == :before && content.first == ''

new_content = magic_comments_map + content + header
routes_map
end

new_content
end
# @param [Array<String>] content
# @return [Array<String>] all found magic comments
# @return [Array<String>] content without magic comments
def extract_magic_comments_from_array(content_array)
magic_comments = []
new_content = []

# TODO: write the method doc using ruby rdoc formats
# where_header_found => This will either be :before, :after, or
# a number. If the number is > 0, the
# annotation was found somewhere in the
# middle of the file. If the number is
# zero, no annotation was found.
def self.strip_annotations(content)
real_content = []
mode = :content
header_found_at = 0

content.split(/\n/, -1).each_with_index do |line, line_number|
if mode == :header && line !~ /\s*#/
mode = :content
real_content << line unless line.blank?
elsif mode == :content
if line =~ /^\s*#\s*== Route.*$/
header_found_at = line_number + 1 # index start's at 0
mode = :header
content_array.map do |row|
if row =~ magic_comment_matcher
magic_comments << row.strip
else
real_content << line
new_content << row
end
end

[magic_comments, new_content]
end

where_header_found(real_content, header_found_at)
end
def content(line, maxs, options = {})
return line.rstrip unless options[:format_markdown]

line.each_with_index.map do |elem, index|
min_length = maxs.map { |arr| arr[index] }.max || 0

def self.where_header_found(real_content, header_found_at)
# By default assume the annotation was found in the middle of the file
sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
end.join(' | ')
end

# ... unless we have evidence it was at the beginning ...
return real_content, :before if header_found_at == 1
def where_header_found(real_content, header_found_at)
# By default assume the annotation was found in the middle of the file

# ... or that it was at the end.
return real_content, :after if header_found_at >= real_content.count
# ... unless we have evidence it was at the beginning ...
return real_content, :before if header_found_at == 1

# and the default
return real_content, header_found_at
end
# ... or that it was at the end.
return real_content, :after if header_found_at >= real_content.count

def self.strip_on_removal(content, where_header_found)
if where_header_found == :before
content.shift while content.first == ''
elsif where_header_found == :after
content.pop while content.last == ''
# and the default
return real_content, header_found_at
end

# TODO: If the user buried it in the middle, we should probably see about
# TODO: preserving a single line of space between the content above and
# TODO: below...
content
def magic_comment_matcher
Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/)
end
end
end