Add option for additional file patterns #633
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
drwl
reviewed
Jul 7, 2019
| case pattern_type | ||
| when 'test' then test_files(root_directory) | ||
| when 'fixture' then fixture_files(root_directory) | ||
| when 'scaffold' then scaffold_files(root_directory) | ||
| when 'factory' then factory_files(root_directory) | ||
| when 'serializer' then serialize_files(root_directory) | ||
| when 'additional_file_patterns' | ||
| [options[:additional_file_patterns] || []].flatten |
There was a problem hiding this comment.
Can you elaborate what's going on here?
There was a problem hiding this comment.
This will return the config setting additional_file_patterns, which is a list of files and/or globs. This allows the gem to infer models based on file structure or naming and annotate additional files.
There was a problem hiding this comment.
I should've been more specific - I'm curious about:
[options[:additional_file_patterns] || []].flattenIs there any special reason behind it? Couldn't it also be:
options[:additional_file_patterns] || []
|
Ah, yes. It's to handle when the input setting is an array of arrays. We
could validate the input to make sure it's a 1D array of strings if there's
a good place for that.
On Wed, Jul 10, 2019 at 01:49 Andrew W. Lee ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In lib/annotate/annotate_models.rb
<#633 (comment)>:
> case pattern_type
when 'test' then test_files(root_directory)
when 'fixture' then fixture_files(root_directory)
when 'scaffold' then scaffold_files(root_directory)
when 'factory' then factory_files(root_directory)
when 'serializer' then serialize_files(root_directory)
+ when 'additional_file_patterns'
+ [options[:additional_file_patterns] || []].flatten
I should've been more specific - I'm curious about:
[options[:additional_file_patterns] || []].flatten
Is there any special reason behind it? Couldn't it also be:
options[:additional_file_patterns] || []
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#633?email_source=notifications&email_token=AAFAT3X77HSHE3LA3Z6MJNDP6VZ6PA5CNFSM4H4A5FS2YY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOB56XMRA#discussion_r301894826>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAFAT3Q5CS6ENIQNIE4J5ELP6VZ6PANCNFSM4H4A5FSQ>
.
--
…--
Ryan Jackson
ryanwjackson@gmail.com
|
|
Oh no problem, I didn't consider that possibility. So right now it looks like this can be used by invoking Annotate in code. Do you think this should and could be invoked using command line arguments? This would be covered in |
|
Also nice to see a fellow xooyalan! 👋 |
ryanwjackson
force-pushed
the
additional_file_patterns
branch
from
8bb7a92
to
58d61b1
Compare
|
Looks good thanks for adding tests and adding it to the CLI. |
drwl
pushed a commit
that referenced
this pull request
Aug 6, 2019
Adds option for additional file patterns (implemented in #633) in the CLI.
drwl
pushed a commit
that referenced
this pull request
Aug 8, 2019
peterfication
pushed a commit
to store2be/annotate_models
that referenced
this pull request
Jan 20, 2020
This PR adds an option named `additional_file_patterns`. You can specify custom path patterns (including globs) that the gem will use to annotate.
For example, I used it like this on a project:
```ruby
Annotate.set_defaults(
'additional_file_patterns' => [
File.join(Rails.application.root, 'app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb'),
File.join(Rails.application.root, 'spec/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb')
],
...
)
```
This makes it possible to have files nested under a directory which corresponds to the model.
I believe this fixes ctran#594.
peterfication
pushed a commit
to store2be/annotate_models
that referenced
this pull request
Jan 20, 2020
Adds option for additional file patterns (implemented in ctran#633) in the CLI.
peterfication
pushed a commit
to store2be/annotate_models
that referenced
this pull request
Jan 20, 2020
vfonic
pushed a commit
to vfonic/annotate_models
that referenced
this pull request
May 8, 2020
This PR adds an option named `additional_file_patterns`. You can specify custom path patterns (including globs) that the gem will use to annotate.
For example, I used it like this on a project:
```ruby
Annotate.set_defaults(
'additional_file_patterns' => [
File.join(Rails.application.root, 'app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb'),
File.join(Rails.application.root, 'spec/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb')
],
...
)
```
This makes it possible to have files nested under a directory which corresponds to the model.
I believe this fixes ctran#594.
vfonic
pushed a commit
to vfonic/annotate_models
that referenced
this pull request
May 8, 2020
Adds option for additional file patterns (implemented in ctran#633) in the CLI.
vfonic
pushed a commit
to vfonic/annotate_models
that referenced
this pull request
May 8, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR adds an option named
additional_file_patterns. You can specify custom path patterns (including globs) that the gem will use to annotate.For example, I used it like this on a project:
This makes it possible to have files nested under a directory which corresponds to the model.
I believe this fixes #594.