Skip to content

Make --additional_file_patterns consistent by using dashes #654

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.

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 4 commits into from
Sep 28, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 7 additions & 7 deletions README.rdoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,7 +163,7 @@ you can do so with a simple environment variable, instead of editing the
== Options

Usage: annotate [options] [model_file]*
--additional_file_patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
--additional-file-patterns Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)
-d, --delete Remove annotations from all model files or the routes.rb file
-p [before|top|after|bottom], Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)
--position
Expand Down Expand Up @@ -216,18 +216,18 @@ you can do so with a simple environment variable, instead of editing the
--ignore-unknown-models don't display warnings for bad model files
--with-comment include database comments in model annotations

=== Option: +additional_file_patterns+
=== Option: +additional-file-patterns+

CLI: +--additional_file_patterns+<br>
Ruby: +:additional_file_patterns+
CLI: +--additional-file-patterns+<br>
Ruby: +:additional-file-patterns+

Provide additional paths for the gem to annotate. These paths can include globs.
It is recommended to use absolute paths. Here are some examples:


- <code>/app/lib/decorates/%MODEL_NAME%/&ast;.rb</code>
- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME%/&ast;&ast;/&ast;.rb</code>
- <code>/app/lib/forms/%TABLE_NAME%/&ast;.rb</code>
- <code>/app/lib/decorates/%MODEL_NAME%/*.rb</code>
- <code>/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb</code>
- <code>/app/lib/forms/%TABLE_NAME%/*.rb</code>

The appropriate model will be inferred using the <code>%*%</code> syntax, annotating any matching files.
It works with existing filename resolutions (options for which can be found in the +resolve_filename+ method of
Expand Down
6 changes: 1 addition & 5 deletions lib/annotate/parser.rb
Original file line number Diff line number Diff line change
Expand Up @@ -49,18 +49,14 @@ def add_options_to_parser(option_parser) # rubocop:disable Metrics/MethodLength

option_parser.banner = 'Usage: annotate [options] [model_file]*'

option_parser.on('--additional_file_patterns path1,path2,path3', Array, "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)") do |additional_file_patterns|
option_parser.on('--additional-file-patterns path1,path2,path3', Array, "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)") do |additional_file_patterns|
ENV['additional_file_patterns'] = additional_file_patterns
end

option_parser.on('-d', '--delete', 'Remove annotations from all model files or the routes.rb file') do
@options[:target_action] = :remove_annotations
end

option_parser.on('--additional_file_patterns path1,path2,path3', Array, "Additional file paths or globs to annotate") do |additional_file_patterns|
ENV['additional_file_patterns'] = additional_file_patterns
end

option_parser.on('-p', '--position [before|top|after|bottom]', positions,
'Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)') do |p|
env['position'] = p
Expand Down
6 changes: 1 addition & 5 deletions spec/lib/annotate/parser_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,9 @@ module Annotate # rubocop:disable Metrics/ModuleLength
end
end

%w[--additional_file_patterns].each do |option|
%w[--additional-file-patterns].each do |option|
describe option do
it 'sets array of paths to :additional_file_patterns' do
# options = "-a ${('foo/bar' 'baz')}"
# Parser.parse(options)
# expect(ENV['additional_file_patterns']).to eq(['foo/bar', 'baz'])

paths = 'foo/bar,baz'
allow(ENV).to receive(:[]=)
Parser.parse([option, paths])
Expand Down