Skip to content

A
annotate
Switch branch/tag
  1. 24 Jun, 2022 1 commit
  3. 11 Feb, 2022 1 commit
  5. 10 Feb, 2022 3 commits
  7. 08 Feb, 2022 1 commit
  9. 03 Feb, 2022 2 commits
  11. 01 Feb, 2022 1 commit
  13. 31 Jan, 2022 1 commit
  15. 14 Jun, 2021 4 commits
  17. 12 Jun, 2021 1 commit
  19. 10 May, 2021 1 commit
  21. 26 Apr, 2021 6 commits
  23. 24 Mar, 2021 3 commits
  25. 03 Jan, 2021 3 commits
  27. 01 Jul, 2020 1 commit
  29. 18 May, 2020 2 commits
  31. 17 May, 2020 1 commit
  33. 09 May, 2020 1 commit
  35. 08 May, 2020 1 commit
    • Adding option to skip loading models from subdirectories (#767) · 508d06a8
      ethanbresler authored 
      Currently, the models annotator automatically attempts to find a class with a matching name at the bottom of project's directory tree before going up into specific engine's models.  This causes issues with models that share names with classes in other engines or lower classes in the project's directory.   This PR adds the option to skip attempts to load classes from lower directories and just uses the model's file path directly. 

#674
  37. 07 May, 2020 1 commit
  39. 06 Apr, 2020 2 commits
  41. 05 Apr, 2020 3 commits
    • Add methods to AnnotateRoutes::HeaderGenerator and refactor methods (#792) · ce7f22df
      Shu Fujita authored 
      cf. #790 

In order to refactor `AnnoateRoutes`, I added methods to `AnnotateRoutes::HeaderGenerator` and refactor methods.

I will add `AnnotateRoutes::AnnotationProcessor` and `AnnotateRoutes::RemovalProcessor` in next PR.
    • Fix output for multiline column comments (#779) · 214da4f6
      Troy Rosenberg authored 
      Closes #778 

If a column comment includes the newline character, the newline character
would be "printed" into the annotation block resulting in a line break
and an uncommented line.

For example, for the following table:

```
create_table "users", force: :cascade do |t|
  t.string "name", comment: "This is a comment.\nWith two lines!"
  t.datetime "created_at", precision: 6, null: false
  t.datetime "updated_at", precision: 6, null: false
end
```

annotating the model with the `--with-comment` flag will result in:

```
\# == Schema Information
\#
\# Table name: users
\#
\#  id                                       :bigint           not null, primary key
\#  name(This is a comment.
With two lines!) :string
\#  created_at                               :datetime         not null
\#  updated_at                               :datetime         not null
\#
```

This uncommented line would result in invalid Ruby and cause the file to
no longer be valid.

This fix replaces the newline character with an escaped version, so the
output will look more like:

```
\# == Schema Information
\#
\# Table name: users
\#
\#  id                                       :bigint           not null, primary key
\#  name(This is a comment.\nWith two lines!):string
\#  created_at                               :datetime         not null
\#  updated_at                               :datetime         not null
\#
```
    • Reactors AnnotateModels.get_schema_info (#791) · da1e6052
      Troy Rosenberg authored 
      This is a bit of a cheat of a refactoring that simply extracts the logic for collecting a column's attributes out of `get_schema_info` and into its own method (`get_attributes`).

I found that in PRs like #779 that the Rubocop ABC limit was being exceeded:

```
lib/annotate/annotate_models.rb:235:5: C: Metrics/AbcSize: Assignment Branch Condition size for get_schema_info is too high. [145/145]
    def get_schema_info(klass, header, options = {}) ...
    ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
```

Hopefully, this should break this up and reduce the complexity of the method.

There are opportunities to go further, but I thought this could be a good place to start. 

I would be open and interested in discussing further refactoring opportunities if it would make sense (maybe creating some new classes to encapsulate some of this logic).