Skip to content

Latest commit

 

History

History
505 lines (346 loc) · 34.9 KB

CHANGELOG.md

File metadata and controls

505 lines (346 loc) · 34.9 KB

Changelog

v4.20.0 (2025-10-20)

Full Changelog

Merged pull requests:

v4.19.0 (2025-08-28)

Full Changelog

Implemented enhancements:

  • ignore ActiveRecord::AssociatedObject #172

Closed issues:

  • STI classes blank #252
  • Model annotation issue #249

Merged pull requests:

  • Bump version to v4.19.0 #259 (drwl)
  • Fix STI models not being annotated #256 (drwl)
  • refactor: relocate migration_version_for_model method to ModelWrapper #255 (OdenTakashi)
  • Fix: Skip abstract models during annotation #253 (taise)
  • Fix Ruby 3.3.8 compatibility and improve Zeitwerk support for non-Rails projects #250 (bradley2W1DL)
  • Return a model files array even if it’s empty #248 (Flink)
  • Generate changelog for v4.18.0 #247 (drwl)

v4.18.0 (2025-08-04)

Full Changelog

Implemented enhancements:

  • Feature request: support for multi database #188

Closed issues:

  • Does not run on rollback with multiple databases #244
  • classified_sort and polymorphic associations #236
  • --show-migration also annotates the primary DB's schema version for models referencing the secondary DB #233
  • Annotations are not added on top of model files when columns'comment: contains Japanese characters in migrations #200
  • Feature: further customization to achieve more compact annotations #150
  • Version 5 change list #127
  • Reformat Column Comments #117

Merged pull requests:

  • Bump version to v4.18.0 #246 (drwl)
  • Run on rollback in app with multiple databases #245 (z1lk)
  • Speed up AnnotationDecider #243 (DRBragg)
  • Add AnnotateRb::Runner.running? method #242 (thewatts)
  • fix: --show-migration to use per-model database connections #241 (OdenTakashi)
  • Fix: Support Japanese characters in column names #239 (tonystrawberry)
  • Fix classified_sort to group polymorphic association columns together #238 (garriguv)
  • Generate changelog for v4.17.0 #235 (drwl)

v4.17.0 (2025-07-14)

Full Changelog

Implemented enhancements:

  • Place column comments at the end of the line (feature suggestion) #164

Fixed bugs:

  • Model annotation chokes on an empty file #182

Closed issues:

  • uninitialized constant Zeitwerk::VERSION #216
  • Incorrect annotation of fixture files when different models share the same table name in different databases #206
  • Should active record and active support be in the gemspec? #197

Merged pull requests:

v4.16.0 (2025-06-18)

Full Changelog

Implemented enhancements:

  • Feature Request: Add Option to Place Annotations Above Nested Classes or Modules. #186

Closed issues:

  • Misleading pattern examples in documentation for additional_file_patterns #221
  • Permission denied for table pg_index #209
  • Performance regression relative to pre-fork? #205
  • Add back ruby configuration option? #203
  • Enable frozen mode when CI environment variable is set #171

Merged pull requests:

  • Bump version to v4.16.0 #228 (drwl)
  • chore: add --with-column-comments readme documentation #227 (jonmcelroy-appfolio)
  • Drop Ruby 2.7 support and improve CI #226 (drwl)
  • Pass .annotaterb.yml through ERB #225 (fxn)
  • feat: Add --nested-position option for placing annotations above nested classes. #223 (yamat47)
  • Fix for: Misleading pattern examples in documentation for additional_file_patterns #222 (skliarov)
  • Move activerecord dependency into gemspec #220 (drwl)
  • Generate changelog for v4.15.0 #219 (drwl)
  • chore: add rake task to automatically deploy to rubygems #183 (OdenTakashi)

v4.15.0 (2025-05-30)

Full Changelog

Closed issues:

  • Feature request: packs-rails support #99
  • Annotate models using Zeitwerk namespaces #82

Merged pull requests:

v4.14.1 (2025-03-31)

Full Changelog

Closed issues:

  • Sort by database order #194
  • “wrong number of arguments (given 0, expected 1..2)” when using enum in a Rails 8 model #184

v4.14.0 (2025-02-17)

Full Changelog

Closed issues:

  • How do I annotate models but NOT routes? #178
  • Model Annotation Not Updated When Modifying Table Columns Using change_table. #169
  • annotate_rb:install failing on Rails 8 #168
  • Annotations with enums changing between db:create db:migrate and then db:migrate #167
  • JSON parse error #155
  • Feature: Add Support for dynamic fixtures with ERB #149

Merged pull requests:

  • Bump version to v4.14.0 #190 (drwl)
  • Add expected file to automatically require #185 (drwl)
  • Fix translation foreign key exclusion bug #181 (galori)
  • Lock concurrent-ruby gem to fix CI #180 (tagliala)
  • Chore: alert when multiple conmmands were selected #179 (OdenTakashi)
  • Updated COLUMN_PATTERN to handle optional metadata (e.g., constraints or descriptions) enclosed in parentheses. #170 (hatsu38)
  • Opt-in for MFA requirement #166 (tagliala)
  • Fix typos #165 (tagliala)
  • Add support for virtual columns #163 (robbevp)
  • Generate changelog for v4.13.0 #160 (drwl)

v4.13.0 (2024-10-21)

Full Changelog

Closed issues:

  • Bug: Bigint are reported as integer #157
  • Bug (apparently): :ignore_columns does not work (with any syntax I've tried) #154

Merged pull requests:

  • Bump version to v4.13.0 #159 (drwl)
  • Support parsing of dynamic fixture erb yml files #158 (drwl)
  • Fix updating of indexes containing escaped characters #156 (antonivanopoulos)
  • Add model with association and foreign key to dummyapp #153 (drwl)
  • Generate changelog for v4.12.0 #152 (drwl)

v4.12.0 (2024-09-15)

Full Changelog

Merged pull requests:

v4.11.0 (2024-08-16)

Full Changelog

Closed issues:

  • Include the length of comments in max_schema_info_width only when the with_column_comments option is true. #144
  • Rakefile seems to be loaded twice #130

Merged pull requests:

  • Bump version to v4.11.0 #146 (drwl)
  • Include the length of comments in max_schema_info_width only when the with_comment and with_column_comments option is true. #145 (shibaaaa)
  • Add Ruby 3.3 to CI #143 (drwl)
  • Generate changelog for v4.10.2 #142 (drwl)

v4.10.2 (2024-07-23)

Full Changelog

Closed issues:

  • Composite primary keys are unsupported #138

Merged pull requests:

  • Bump version to v4.10.2 #141 (drwl)
  • Fix double-loading of Rakefile #140 (dmke)
  • Change structure of model annotation builder #136 (drwl)
  • Refactor model annotation components #134 (drwl)
  • Generate changelog for v4.10.1 #133 (drwl)

v4.10.1 (2024-07-07)

Full Changelog

Merged pull requests:

v4.10.0 (2024-06-28)

Full Changelog

Closed issues:

  • Feature Request: add support for arrays when using StoreModel #125
  • Error on composite foreign key constraints #121

Merged pull requests:

  • Bump version to v4.10.0 #128 (drwl)
  • Support composite foreign keys #126 (drwl)
  • Add files to improve other's ability to help the project #123 (drwl)
  • Add database and adapter to issue template #122 (drwl)
  • Generate changelog for v4.9.0 #120 (drwl)

v4.9.0 (2024-05-29)

Full Changelog

Closed issues:

  • Duplicate content in fixtures when annotating models #108
  • Cannot exclude annotations from serializer specs #103

Merged pull requests:

v4.8.0 (2024-05-14)

Full Changelog

Closed issues:

  • Nested module models and unexpected annotations #106

Merged pull requests:

  • Bump version to v4.8.0 #115 (drwl)
  • Generate changelog for v4.7.1 #114 (drwl)
  • Support annotating model fixture files #110 (drwl)
  • Make exclude_tests option able to override other exclude options #107 (drwl)

v4.7.1 (2024-05-09)

Full Changelog

Closed issues:

  • Check constraint support #104

Merged pull requests:

v4.7.0 (2024-03-27)

Full Changelog

Closed issues:

  • Feature request: better custom type representation #97

Merged pull requests:

  • Bump version to v4.7.0 #100 (drwl)
  • Add configurable classes list with to_s representation #98 (viralpraxis)
  • Generate changelog for v4.6.0 #96 (drwl)

v4.6.0 (2024-02-27)

Full Changelog

Closed issues:

  • Add support for data_migrate gem #89

Merged pull requests:

  • Bump version to v4.6.0 #95 (drwl)
  • Add support for parsing RSpec files #94 (drwl)
  • Add support for model name without namespace in resolver #93 (drwl)
  • Fixes for RelatedFilesListBuilder #92 (drwl)
  • Refactor AnnotatedFile classes #91 (drwl)
  • Add support for data_migrate gem #90 (cmer)
  • Support non-model files in CustomParser #88 (drwl)
  • Fix flakey integration test #87 (drwl)
  • Improve integration tests #86 (drwl)
  • Add Zeitwerk support #85 (drwl)
  • Improve annotate after adding new migration integration test #84 (drwl)
  • Add integration test using force #81 (drwl)
  • Generate changelog for v4.5.0 #80 (drwl)
  • Fix annotations swallowing comments #72 (drwl)

v4.5.0 (2024-02-08)

Full Changelog

Closed issues:

  • Add an automated way to migrate from the old annotate gem #73
  • Default array value is double-quoted/escaped #57

Merged pull requests:

  • Bump version to v4.5.0 #79 (drwl)
  • Update README on the new Rails generator commands #78 (drwl)
  • Bump github/codeql-action from 2 to 3 #77 (dependabot[bot])
  • Add command to generate a configuration file #76 (drwl)
  • Bump actions/checkout from 3 to 4 #75 (dependabot[bot])
  • CI: Configure dependabot to update GH Actions #74 (olleolleolle)
  • Refactor FileBuilder and MagicCommentParser #71 (drwl)
  • Test running annotations after a migration #70 (drwl)
  • Add integration test for rake task installer #69 (drwl)
  • Add integration test for annotating routes #68 (drwl)
  • Remove optional args #67 (drwl)
  • Remove optional arg from AnnotationPatternGenerator #66 (drwl)
  • Remove ARGV use during runtime #65 (drwl)
  • Add integration test for annotating a singular file #64 (drwl)
  • Generate changelog for v4.4.1 #63 (drwl)
  • Add support for factory_bot's default suffixed pattern #59 (drwl)

v4.4.1 (2023-09-11)

Full Changelog

Merged pull requests:

  • Bump version to v4.4.1 #62 (drwl)
  • Fix annotation for columns with Date and DateTime default values #61 (drwl)
  • Add integration tests #60 (drwl)
  • Fix the default array value from being escaped #58 (drwl)
  • Update dummyapp Rails version #56 (drwl)
  • Bump puma from 5.6.5 to 6.3.1 in /dummyapp #55 (dependabot[bot])
  • Generate changelog for v4.4.0 #53 (drwl)
  • Add CLI specs using aruba gem #43 (drwl)

v4.4.0 (2023-06-24)

Full Changelog

Merged pull requests:

  • Bump version to v4.4.0 #52 (drwl)
  • Flatten tests in annotation_builder_spec.rb #51 (drwl)
  • Add support for table comments #50 (drwl)
  • Improve some model annotator tests #49 (drwl)
  • Make tests that use mock_column more accurate #48 (drwl)
  • Generate changelog for v4.3.1 #47 (drwl)

v4.3.1 (2023-06-15)

Full Changelog

Closed issues:

  • Column defaults change in migration #45

Merged pull requests:

  • Bump version to v4.3.1 #46 (drwl)
  • Prettify column defaults #44 (drwl)
  • Generate changelog for v4.3.0 #42 (drwl)

v4.3.0 (2023-06-10)

Full Changelog

Merged pull requests:

  • Bump version to v4.3.0 #41 (drwl)
  • Add ANNOTATERB_SKIP_ON_DB_TASKS ENV var to skip auto annotations #40 (drwl)

v4.2.0 (2023-06-02)

Full Changelog

Merged pull requests:

  • Specify standard gem version #39 (drwl)
  • Generate changelog for 4.2 again #38 (drwl)
  • Bump version to v4.2.0 #37 (drwl)
  • Generate changelog for 4.2 #36 (drwl)
  • Improve tests for ColumnAnnotation::* #35 (drwl)
  • Change instances of Options.from => Options.new in tests #34 (drwl)
  • Add Standard linter to project #33 (drwl)
  • Support Sorbet typed magic comment #32 (drwl)
  • Add position_in_additional_file_patterns to Options and Parser #31 (drwl)
  • Remove Files gem as a dependency #30 (drwl)
  • Refactor ModelAnnotator again #28 (drwl)
  • Add initial change log #27 (drwl)

v4.1.1 (2023-05-20)

Full Changelog

Merged pull requests:

  • Bump version to v4.1.1 #26 (drwl)
  • Tidy the github repo #25 (drwl)
  • Add guide for migrating from Annotate gem #24 (drwl)
  • Update column pattern regex to incorporate special column comments #23 (drwl)

v4.1.0 (2023-05-17)

Full Changelog

Merged pull requests:

  • Bump version to 4.1.0 #22 (drwl)
  • Refactor ModelAnnotator; Fix instances of incorrect exclude_* keys #21 (drwl)
  • Fix the default behavior for model annotator #20 (drwl)
  • Refactor model annotator #19 (drwl)
  • Removed unused helper methods and Env class #18 (drwl)
  • Update dummy app dependencies #17 (drwl)

v4.0.0 (2023-05-03)

Full Changelog

Merged pull requests:

  • Last project polish for 4.0.0 release #14 (drwl)
  • Add configuration instructions to README #13 (drwl)
  • Prepare gem for beta release #12 (drwl)
  • Make annotaterb usable #11 (drwl)
  • Move old annotate code into AnnotateRb namespace #10 (drwl)
  • Fix CodeQL action #9 (drwl)
  • Regularly run CI #8 (drwl)
  • Get CI consistently green #7 (drwl)
  • More work #6 (drwl)
  • Make CI green #5 (drwl)
  • Make it work for Rails 7 #4 (drwl)
  • Tidy up project #3 (drwl)
  • Set spec run order to random #2 (drwl)
  • Tidy rspec configuration #1 (drwl)

* This Changelog was automatically generated by github_changelog_generator