Skip to content

A
annotate
Commit 111640d0 by Andrew W. Lee
Options

Merge branch 'develop'

parents 0ef095dc 5ac56e47
Showing with 200 additions and 185 deletions
.rubocop.yml
inherit_from: ./.rubocop_todo.yml
inherit_from:
- .rubocop_todo.yml
AllCops:
Exclude:
......
.rubocop_todo.yml
# This configuration was generated by
# `rubocop --auto-gen-config`
# on 2019-03-07 18:25:02 -0800 using RuboCop version 0.65.0.
# on 2019-06-16 12:01:03 -0700 using RuboCop version 0.68.1.
# The point is for the user to remove these configuration records
# one by one as the offenses are removed from the code base.
# Note that changes in the inspected code, or installation of new
......@@ -51,7 +51,7 @@ Layout/AlignArray:
Exclude:
- 'spec/annotate/annotate_models_spec.rb'
# Offense count: 103
# Offense count: 104
# Cop supports --auto-correct.
# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
# SupportedHashRocketStyles: key, separator, table
......@@ -149,7 +149,7 @@ Layout/EmptyLinesAroundExceptionHandlingKeywords:
# Offense count: 24
# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
# Configuration parameters: AllowForAlignment, AllowBeforeTrailingComments, ForceEqualSignAlignment.
Layout/ExtraSpacing:
Exclude:
- 'Guardfile'
......@@ -170,7 +170,7 @@ Layout/ExtraSpacing:
# Cop supports --auto-correct.
# Configuration parameters: IndentationWidth.
# SupportedStyles: special_inside_parentheses, consistent, align_braces
Layout/IndentHash:
Layout/IndentFirstHashElement:
EnforcedStyle: consistent
# Offense count: 54
......@@ -247,7 +247,7 @@ Layout/SpaceAroundKeyword:
- 'spec/integration/rails_4.2.0/Gemfile'
- 'spec/integration/standalone/Gemfile'
# Offense count: 4
# Offense count: 5
# Cop supports --auto-correct.
# Configuration parameters: AllowForAlignment.
Layout/SpaceAroundOperators:
......@@ -419,15 +419,15 @@ Lint/UnusedBlockArgument:
Exclude:
- 'bin/annotate'
# Offense count: 18
# Offense count: 19
Metrics/AbcSize:
Max: 139
Max: 138
# Offense count: 29
# Offense count: 27
# Configuration parameters: CountComments, ExcludedMethods.
# ExcludedMethods: refine
Metrics/BlockLength:
Max: 1140
Max: 244
# Offense count: 1
# Configuration parameters: CountBlocks.
......@@ -475,14 +475,6 @@ Naming/UncommunicativeMethodParamName:
Exclude:
- 'Rakefile'
# Offense count: 4
# Cop supports --auto-correct.
Performance/RegexpMatch:
Exclude:
- 'lib/annotate/annotate_models.rb'
- 'lib/annotate/annotate_routes.rb'
- 'spec/integration/rails_2.3_with_bundler/config/boot.rb'
# Offense count: 1
# Configuration parameters: EnforcedStyle.
# SupportedStyles: inline, group
......@@ -688,7 +680,7 @@ Style/NestedParenthesizedCalls:
Style/NumericLiterals:
MinDigits: 15
# Offense count: 2
# Offense count: 3
# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, EnforcedStyle, IgnoredMethods.
# SupportedStyles: predicate, comparison
......@@ -809,7 +801,7 @@ Style/StderrPuts:
- 'lib/annotate/annotate_models.rb'
- 'spec/integration/rails_2.3_with_bundler/config/boot.rb'
# Offense count: 240
# Offense count: 243
# Cop supports --auto-correct.
# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
# SupportedStyles: single_quotes, double_quotes
......@@ -867,8 +859,9 @@ Style/UnneededPercentQ:
- 'annotate.gemspec'
- 'spec/integration/rails_2.3_with_bundler/config/boot.rb'
# Offense count: 424
# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
# Offense count: 431
# Cop supports --auto-correct.
# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
# URISchemes: http, https
Metrics/LineLength:
Max: 276
.travis.yml
sudo: false
language: ruby
rvm:
- 2.2.7
- 2.3.4
- 2.4.1
- 2.2.10
- 2.3.8
- 2.4.6
- 2.5.5
- 2.6.0
- 2.6.1
- 2.6.2
- 2.6.3
- ruby-head
matrix:
allow_failures:
- rvm: ruby-head
before_install:
- gem update --system
- gem update --system || (gem i "rubygems-update:~>2.7" --no-document && update_rubygems)
- gem update bundler
script:
- bundle exec rubocop && bundle exec rspec
deploy:
provider: rubygems
api_key:
secure: Y7DUitak26kcRAAkgph/7m6Y1wHeObD0BelSSJbmCfjkRd/qaVy7fz9VvHL9zxlRJtLGVHInyCnwcfzinibY6OFd3MoMYHKv8GFa2LxLJNEVSY46KQYFxfH5JTg1ejh6ldoJRRBoeOx9dcWS80pRNjYMKPGnpSz7yDBl1azibFs=
gem: annotate
on:
tags: true
repo: ctran/annotate_models
jobs:
include:
- stage: gem release
if: tag =~ ^v
rvm: 2.6.0
script: echo "Deploying to rubygems.org ..."
deploy:
provider: rubygems
api_key: $RUBYGEMS_API_KEY
gem: annotate
on:
tags: true
repo: ctran/annotate_models
Gemfile
......@@ -19,7 +19,7 @@ group :development, :test do
gem 'guard-rspec', require: false
gem 'rspec', require: false
gem 'rubocop', '~> 0.67.2', require: false unless RUBY_VERSION =~ /^1.8/
gem 'rubocop', '~> 0.68.1', require: false unless RUBY_VERSION =~ /^1.8/
gem 'simplecov', require: false
gem 'terminal-notifier-guard', require: false
......@@ -27,7 +27,7 @@ group :development, :test do
gem 'coveralls'
gem 'overcommit'
gem 'ruby_dep', '1.3.1'
gem 'ruby_dep', '1.5.0'
platforms :mri, :mingw do
gem 'pry', require: false
......
lib/annotate/annotate_models.rb
......@@ -910,7 +910,11 @@ module AnnotateModels
def mb_chars_ljust(string, length)
string = string.to_s
padding = length - width(string)
string + (' ' * padding)
if padding > 0
string + (' ' * padding)
else
string[0..length-1]
end
end
end
......
lib/annotate/annotate_routes.rb
......@@ -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 = {})
......@@ -70,180 +109,143 @@ module AnnotateRoutes
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
spec/annotate/annotate_models_spec.rb
......@@ -943,7 +943,8 @@ EOS
[:active, :boolean, { limit: 1, comment: 'ＡＣＴＩＶＥ' }],
[:name, :string, { limit: 50, comment: 'ＮＡＭＥ' }],
[:notes, :text, { limit: 55, comment: 'ＮＯＴＥＳ' }],
[:no_comment, :text, { limit: 20, comment: nil }]
[:no_comment, :text, { limit: 20, comment: nil }],
[:location, :geometry_collection, { limit: nil, comment: nil }]
]
when_called_with with_comment: 'yes',
......@@ -958,6 +959,7 @@ EOS
# name(ＮＡＭＥ) :string(50) not null
# notes(ＮＯＴＥＳ) :text(55) not null
# no_comment :text(20) not null
# location :geometry_collect not null
#
EOS
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment