# Summary

*   Removed unnecessary variables
*   Renamed variables that have same name as reserved word (`p`)
*   Other tiny fixes

I fixed message to make them more natural English.

The scope of this pull request is to allow annotate_models to generate models documentation using YARD. This is the first step, I'll add more features later.

I moved `puts` from `AnnotateRoutes.rewrite_contents` to `.do_annotations` and `.remove_annotations`.

I removed `AnnotateRoutes.rewrite_contents_with_header` because the logic of `AnnotateRoutes.rewrite_contents_with_header` is as same as `.rewrite_contents`.

* Add columns managed by Globalize gem

Globalize hooks into the model and removes the translated columns
from the `klass.columns`. This commit checks if globalize is
hooked into the model and adds the necessary columns to the
annotation array.

* Disable Rubocop Metrics/BlockLength for spec files

RSpec spec files can contain long blocks easily because
of the outher describe methods. So this rule makes not too much
sense for these files.

I refactored `AnnotateRoutes.annotate_routes` and `.rewrite_contents_with_header` in order to add an empty string to `new_content` array in `.annotate_routes`.

I will refactor `.rewrite_contents_with_header` more, and remove `. rewrite_contents_with_header` in the next PR.

# Summary

*   I replaced `#blank?` of ActiveSupport to `#present?`
*   I moved `AnnotateModels::Parser#commit` after `#parser ` because `#commit` is used after `#parser` in `#parse`.

I removed invalid document of AnnotateRoutes.rewrite_contents.

I will add valid documents in YARD format in another PR.

I refactored two methods in AnnotateModels::Helpers for readability.

I refactored `AnnotateRoutes.routes_exists?` and methods using this.
The points are as follows.

*   Removing `puts` in `AnnotateRoutes.routes_exists?`
*   Using `File.exist?` instead of `File.exists?` because `File.exists?` is deprecated
*   Renaming `AnnotateRoutes.routes_exists?` to `AnnotateRoutes.routes_file_exists?` in order to make the name of method more explanatory

* Refactor AnnotateRoutes.rewrite_contents and .remove_annotations

* Refactor AnnotateRoutes.remove_annotations and .strip_on_removal

I refactored `AnnotateRoutes.header` for performance, and add `AnnotateRoutes.comment` to make code DRY.

As the change log shows, I froze the constant `HEADER_ROW` in accordance with the normal Ruby style regulation.

I added `AnnotateModels::MAGIC_COMMENT_MATCHER` and `AnnotateRoutes::MAGIC_COMMENT_MATCHER` instad of `AnnotateModels.magic_comment_matcher` and `AnnotateRoutes.magic_comment_matcher`.

I think that they should be constants because the result of Regexp is always fixed.

Before I commited, the method `AnnotateRoutes.where_header_found` returned an array of `real_content` and `header_found_at`.

I fixed the name of method and variable because they did not match.

I renamed the method `real_content_and_header_position` and unified related variable names to `header_position`.

This change converts .all_options into a constant and moves it into Annotate::Constants. It also changes usages of .all_options.

Same problem returned by @janosrusiczki in #430

Spatial columns with activerecord-postgis-adapter (5.2.2) are not displayed nice

```
# name           :string(3)
# active         :boolean          default(FALSE), not null
# geom           :geometry({:srid= geometry, 4326
```

That's come from activerecord-postgis-adapter, with redefined columns as such :

``` 
#<ActiveRecord::ConnectionAdapters::PostGIS::SpatialColumn 
  @sql_type="geometry(Geometry,4326)",
  @geo_type="Geometry",
  @geometric_type=RGeo::Feature::Geometry,
  @srid=4326,
  @limit={:srid=>4326, :type=>"geometry"}
  [...]
>
```

This fix displays them like this :

```
# name           :string(3)
# active         :boolean          default(FALSE), not null
# geometry       :geometry         geometry, 4326
```

Another possibility would have been to display them as below, but it involves a lot of extra-spaces for other columns.

```
# name           :string(3)
# active         :boolean                   default(FALSE), not null
# geometry       :geometry(Geometry, 4326)
```

Rails 6 has dropped name from ActiveRecord::ConnectionAdapters::ForeignKeyDefinition
for Sqlite3 adapter:

https://github.com/rails/rails/blob/f2df77709f7e536aaf4d6f984ff21a49d44d34c1/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb\#L305-L311

This has caused issues with getting foreign key info and blowing up
when trying to annotate models with foreign keys. This commit
adds one additional check for name presence and uses column
attribute from options instead.

Closes #620.

Changed references to `--additional_file_patterns` to be `--additional-file-patterns` to make it consistent with other flags.

Adds tests for `.include_routes?`, `.include_models?`, `.skip_on_migration?`. Also moves the `TRUE_RE` under the `Annotate::Constants` namespace.

Prior to this change, `Annotate.include_models?` returned the inverse of `Annotate.include_routes?`. This made it so annotating models and routes was not possible to do together.

This PR adds an explicit `--models` flag and also adds it the option to `lib/generators/annotate/templates/auto_annotate_models.rake` with the default being set to `false`. 

Fixes #563 and undoes the bug introduced in #485.

Add better documentation for new option for additional file patterns. Implemented in #633 and #636.

Adds option for additional file patterns (implemented in #633) in the CLI.

Refactored Parser to isolate changes being made to ENV. This way we have an intermediate step where we know the environment variables being set.

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 #594.