annotate 2.7.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d69e9ad0ab7a59e673f3cb7287d6cccb78b8ba20
-  data.tar.gz: a3b5adea28b4f3ebedc4f7af1df32907167d2bb9
+SHA256:
+  metadata.gz: 14932a4a189792b68c9d85c63313d0d60322ca22fed18a7a4a00edd47348743a
+  data.tar.gz: 351b61b7b3eac94f1ce6d8a86e1630bbbf6c0920cacfe46319163a86bc189887
 SHA512:
-  metadata.gz: e6b5b503403df98d298e29c1ea4413999496d4c67326704c4c59a079bcd58fa3c6160e0e8812793a5e2796ddd8dcb216482793e5ff11e789463432c93d76cadd
-  data.tar.gz: 15d8f31b8c2bebd74cb0447b5f8283bf0397ae73b8e5a5fd6dc1306b19511cbbd03523338327da32fe2acc599c292fe2f0d434b5969b6eca2468d3bd2c4b9139
+  metadata.gz: a717f48aff793ea4566fca6919eb4fe85b1545fe93b0bece91c5a9507cbb87fe14aa35ac520e618e98f8db92fe11010a8fe8653802b25b83b24590467e5d64f1
+  data.tar.gz: d13aab072e5e3901788f4aff809e08f3d28ac24cf0eed4187b0e5c0f98008f3c95a7553b58c4f50705f2f42729e96a05a57631356715953bb7d29531e4365fbd

data/{AUTHORS.rdoc → AUTHORS.md}

@@ -1,4 +1,4 @@
-== Authors
+## Authors
 
 - Original code by: Dave Thomas -- Pragmatic Programmers, LLC <http://agilewebdevelopment.com/plugins/annotate_models>
 - Overhauled by: Alex Chaffee <http://alexch.github.com> alex@stinky.com
@@ -6,7 +6,7 @@
 - Maintained by: Alex Chaffee and Cuong Tran
 - Homepage: http://github.com/ctran/annotate_models
 
-With help from:
+### With help from:
 
 - Jack Danger - http://github.com/JackDanger
 - Michael Bumann - http://github.com/bumi
@@ -29,5 +29,6 @@ With help from:
 - Paul Alexander
 - Dmitry Lihachev
 - qichunren
+- Guillermo Guerrero - http://github.com/ryanfox1985
 
 and many others that I may have forgotten to add.

data/CHANGELOG.md

@@ -0,0 +1,326 @@
+## 3.1.1
+Changes
+- Bump required ruby version to >= 2.4 [#772](https://github.com/ctran/annotate_models/pull/772)
+- [Revert #677] Fix column default annotations [#768](https://github.com/ctran/annotate_models/pull/768)
+
+Project Improvements
+- Refactor by adding AnnotateRoutes::Helpers [#770](https://github.com/ctran/annotate_models/pull/770) 
+- Bump puma from 4.3.1 to 4.3.3 in /spec/integration/rails_6.0.2.1 [#771](https://github.com/ctran/annotate_models/pull/771)
+- Bump puma from 3.12.2 to 4.3.3 in /spec/integration/rails_5.2.4.1 [#769](https://github.com/ctran/annotate_models/pull/769)
+- Bump nokogiri from 1.10.7 to 1.10.8 in /spec/integration/rails_5.2.4.1 [#766](https://github.com/ctran/annotate_models/pull/766)
+- Bump nokogiri from 1.10.7 to 1.10.8 in /spec/integration/rails_6.0.2.1 [#765](https://github.com/ctran/annotate_models/pull/765)
+- Refactor test cases of AnnotateRoutes [#760](https://github.com/ctran/annotate_models/pull/760)
+- Rename FactoryGirl -> FactoryBot comment [#759](https://github.com/ctran/annotate_models/pull/759)
+
+## 3.1.0
+Changes
+- Fix new lines after comments for rubocop compatibility [#757](https://github.com/ctran/annotate_models/pull/757)
+- Fix messages from AnnotateRoutes [#737](https://github.com/ctran/annotate_models/pull/737)
+- Support YARD notation [#724](https://github.com/ctran/annotate_models/pull/724)
+- Refactor AnnotateRoutes.routes_file_exist? [#716](https://github.com/ctran/annotate_models/pull/716)
+- Refactor namespace Annotate [#719](https://github.com/ctran/annotate_models/pull/719)
+- Add columns managed by Globalize gem [#602](https://github.com/ctran/annotate_models/pull/602)
+
+Bug Fixes
+- Fix additional_file_patterns parsing [#756](https://github.com/ctran/annotate_models/pull/756)
+- Fix typo in README [#752](https://github.com/ctran/annotate_models/pull/752)
+- Fix bin/annotate NoMethodError [#745](https://github.com/ctran/annotate_models/pull/745)
+- Fix README for YARD format [#740](https://github.com/ctran/annotate_models/pull/740)
+- Fix constant names that were not renamed in #721 [#739](https://github.com/ctran/annotate_models/pull/739)
+- Replace soft-deprecated constant `HashWithIndifferentAccess` to `ActiveSupport::HashWithIndifferentAccess` [#699](https://github.com/ctran/annotate_models/pull/699)
+- [Fix #570](https://github.com/ctran/annotate_models/issues/570) Change of foreign key should be considered as a column change
+- [Fix #430](https://github.com/ctran/annotate_models/issues/430) Handle columns from activerecord-postgis-adapter [#694](https://github.com/ctran/annotate_models/pull/694)
+- Add ActiveAdmin option to template [#693](https://github.com/ctran/annotate_models/pull/693)
+- Fix foreign key issue with Rails 6 and Sqlite3 [#695](https://github.com/ctran/annotate_models/pull/695)
+- Fix Serializers Test Directory [#625](https://github.com/ctran/annotate_models/pull/625)
+- [Fix #624](https://github.com/ctran/annotate_models/issues/624) Correct default values for columns when ActiveRecord::Enum is used [#677](https://github.com/ctran/annotate_models/pull/677)
+- [Fix #675](https://github.com/ctran/annotate_models/issues/675) Correct indentation for double-byte characters [#676](https://github.com/ctran/annotate_models/pull/676)
+- FIX: Ensure only one line is around the annotation [#669](https://github.com/ctran/annotate_models/pull/669)
+- Fix shifted when format_markdown option enabled and used non-ascii [#650](https://github.com/ctran/annotate_models/pull/650)
+
+Project improvements
+- Refactor RSpec for AnnotateModels - structuralize test cases [#755](https://github.com/ctran/annotate_models/pull/755)
+- Refactor test cases of AnnotateRoutes as for Rake versions [#754](https://github.com/ctran/annotate_models/pull/754)
+- Add integration tests to project [#747](https://github.com/ctran/annotate_models/pull/747)
+- Refactor test cases for AnnotateRoutes.remove_annotations [#748](https://github.com/ctran/annotate_models/pull/748)
+- Refactor RSpec for AnnotateModels - with Globalize gem [#749](https://github.com/ctran/annotate_models/pull/749)
+- Fixed CHANGELOG.md to add link to each PR [#751](https://github.com/ctran/annotate_models/pull/751)
+- Delete integration test fixtures [#746](https://github.com/ctran/annotate_models/pull/746)
+- Remove remaining integration test files [#744](https://github.com/ctran/annotate_models/pull/744)
+- Remove unworking integration tests [#725](https://github.com/ctran/annotate_models/pull/725)
+- Refactor Annotate::Parser [#742](https://github.com/ctran/annotate_models/pull/742)
+- Refactor RSpec for AnnotateModels (4) - AnnotateModels.get_schema_info (without custom options) [#735](https://github.com/ctran/annotate_models/pull/735)
+- Refactor RSpec for AnnotateRoutes (1) [#736](https://github.com/ctran/annotate_models/pull/736)
+- Refactor AnnotateRoutes.rewrite_contents [#734](https://github.com/ctran/annotate_models/pull/734)
+- AnnotateModels.get_schema_info (with custom options) [#732](https://github.com/ctran/annotate_models/pull/732)
+- Fix typo in RSpec of AnnotateModels [#731](https://github.com/ctran/annotate_models/pull/731)
+- Remove AnnotateRoutes.rewrite_contents_with_header [#730](https://github.com/ctran/annotate_models/pull/730)
+- Refactor AnnotateRoutes.annotate_routes and .rewrite_contents_with_header [#729](https://github.com/ctran/annotate_models/pull/729)
+- Refactor AnnotateModels::Parser [#728](https://github.com/ctran/annotate_models/pull/728)
+- Remove invalid document of AnnotateRoutes.rewrite_contents [#727](https://github.com/ctran/annotate_models/pull/727)
+- Refactor RSpec for AnnotateModels (1) [#726](https://github.com/ctran/annotate_models/pull/726)
+- Refactor AnnotateModels::Helpers [#723](https://github.com/ctran/annotate_models/pull/723)
+- Refactor AnnotateRoutes.remove_annotations [#715](https://github.com/ctran/annotate_models/pull/715)
+- Fix AnnotateRoutes.extract_magic_comments_from_array [#712](https://github.com/ctran/annotate_models/pull/712)
+- Rename FactoryGirl to FactoryBot [#721](https://github.com/ctran/annotate_models/pull/721)
+- Refactor AnnotateRoutes.header [#714](https://github.com/ctran/annotate_models/pull/714)
+- Freeze constant AnnotateRoutes::HEADER_ROW [#713](https://github.com/ctran/annotate_models/pull/713)
+- Add constants MAGIC_COMMENT_MATCHER [#711](https://github.com/ctran/annotate_models/pull/711)
+- Rename method and variable of AnnotateRoutes for readability [#709](https://github.com/ctran/annotate_models/pull/709)
+- Refactor lib/annotate.rb [#707](https://github.com/ctran/annotate_models/pull/707)
+- Delete TODO.md [#700](https://github.com/ctran/annotate_models/pull/700)
+- Tidy README [#701](https://github.com/ctran/annotate_models/pull/701)
+- Convert documentation files to Markdown [#697](https://github.com/ctran/annotate_models/pull/697)
+- Upgrade and fix CI [#698](https://github.com/ctran/annotate_models/pull/698)
+- Add upgrade instructions to README [#687](https://github.com/ctran/annotate_models/pull/687)
+- Fix Github release action [#682](https://github.com/ctran/annotate_models/pull/682)
+
+## 3.0.3
+- Use a less error-prone way of specifying gem files [#662](https://github.com/ctran/annotate_models/pull/662)
+- Update rake requirement from `>= 10.4, < 13.0` to `>= 10.4, < 14.0` [#659](https://github.com/ctran/annotate_models/pull/659)
+- Bump nokogiri from 1.6.6.2 to 1.10.4 in /spec/integration/rails_4.2.0 [#655](https://github.com/ctran/annotate_models/pull/655)
+- Default annotate models to true in config generated by `rails g annotate:install` [#671](https://github.com/ctran/annotate_models/pull/671)
+- Bump loofah from 2.3.0 to 2.3.1 in /spec/integration/rails_4.2.0 [#681](https://github.com/ctran/annotate_models/pull/681)
+
+## 3.0.2
+- Fixes `LoadError` due to gemspec not referencing `parser.rb`, issue [#657](https://github.com/ctran/annotate_models/issues/657) [#660](https://github.com/ctran/annotate_models/pull/660)
+- Changes `--additional_file_patterns` to use dashes `--additional-file-patterns` for consistency [#649](https://github.com/ctran/annotate_models/pull/649)
+- Refactor: moving constants into `constants.rb` [#653](https://github.com/ctran/annotate_models/pull/653)
+
+## 3.0.1
+- Skipped as an official release, used the 3.0.1 patch for setting up Github Actions [#619](https://github.com/ctran/annotate_models/pull/619)
+
+## 3.0.0
+- **Breaking:** when option `models` is not set - models will not be annotated by default.
+
+  Add `'models'=>'true'` to your config manually or use `--models` option if using CLI.
+
+- Added `--models` CLI option fixing issue [#563](https://github.com/ctran/annotate_models/issues/563) [#647](https://github.com/ctran/annotate_models/pull/647)
+- Added `--additional_file_patterns` option for additional file patterns [#633](https://github.com/ctran/annotate_models/pull/633) [#636](https://github.com/ctran/annotate_models/pull/636) [#637](https://github.com/ctran/annotate_models/pull/637)
+- Refactored CLI parser [#646](https://github.com/ctran/annotate_models/pull/646)
+- Fixed `BigDecimal.new` deprecation warning [#634](https://github.com/ctran/annotate_models/pull/634)
+- Fixed annotations for columns with long data types [#622](https://github.com/ctran/annotate_models/pull/622)
+- Made methods private in AnnotateRoutes [#598](https://github.com/ctran/annotate_models/pull/598)
+
+See https://github.com/ctran/annotate_models/releases/tag/v3.0.0
+
+## 2.7.5
+See https://github.com/ctran/annotate_models/releases/tag/v2.7.5
+
+## 2.7.3
+See https://github.com/ctran/annotate_models/releases/tag/v2.7.3
+
+## 2.7.2
+See https://github.com/ctran/annotate_models/releases/tag/v2.7.2
+
+## 2.7.1
+See https://github.com/ctran/annotate_models/releases/tag/v2.7.1
+
+## 2.7.0
+See https://github.com/ctran/annotate_models/releases/tag/v2.7.0
+
+## 2.6.9
+- Support foreigh key [#241](https://github.com/ctran/annotate_models/pull/241)
+- Check if model has skip tag in annotate_model_file [#167](https://github.com/ctran/annotate_models/pull/167)
+- Fix issue where serializer-related flags weren't being honored [#246](https://github.com/ctran/annotate_models/issues/246)
+- Prefer SQL column type over normalized AR type [#231](https://github.com/ctran/annotate_models/issues/231)
+
+## 2.6.8
+- Nothing annotated unless `options[:model_dir]` is specified, [#234](https://github.com/ctran/annotate_models/pull/234)
+
+## 2.6.7
+- Nothing annotated unless `options[:model_dir]` is specified, [#234](https://github.com/ctran/annotate_models/pull/234)
+
+## 2.6.6
+- Makes it possible to wrap annotations, [#225](https://github.com/ctran/annotate_models/pull/225)
+- Fix single model generation, [#214](https://github.com/ctran/annotate_models/pull/214)
+- Fix default value for Rails 4.2, [#212](https://github.com/ctran/annotate_models/issues/212)
+- Don't crash on inherited models in subdirectories, [#232](https://github.com/ctran/annotate_models/issues/232)
+- Process model_dir in rake task, [#197](https://github.com/ctran/annotate_models/pull/197)
+
+## 2.6.4
+- Skip "models/concerns", [#194](https://github.com/ctran/annotate_models/pull/194)
+- Fix [#173](https://github.com/ctran/annotate_models/issues/173) where annotate says "Nothing to annotate" in rails 4.2
+- Display an error message if not run from the root of the project, [#186](https://github.com/ctran/annotate_models/pull/186)
+- Support rails 4.0 new default test directory, [#182](https://github.com/ctran/annotate_models/issues/182)
+- Add an option to show timestamp in routes "-timestamp", [#136](https://github.com/ctran/annotate_models/issues/136)
+- Skip plain ruby objects if they have the same class name as an ActiveRecord object, [#121](https://github.com/ctran/annotate_models/issues/121)
+
+## 2.6.3
+- Fix bug of annotate position in routes [#158](https://github.com/ctran/annotate_models/issues/158)
+
+## 2.6.2
+- Retain the current annotate block unless --force is specified
+- Always load models, since they may not be autoloaded by Rails
+- The pg array type is now detected (see [#158](https://github.com/ctran/annotate_models/pull/158))
+
+## 2.6.0.beta2
+- support for composite_primary_keys (garysweaver)
+- bug fix for annotate_one_file (vlado)
+
+
+## 2.6.0.beta1
+
+- It's now possible to use Annotate in standalone ActiveRecord (non-Rails) projects again.
+- Adding note that Markdown is actually MultiMarkdown, and recommending the use
+  of the `kramdown` engine for parsing it.
+- Improved Markdown formatting considerably.
+- Bugfix: Needed to use inline-code tag for column and table names,
+    otherwise underscores would cause havok with the formatting.
+- Bugfix: Markdown syntax was incorrect
+    (can't have trailing spaces before the closing marker for an emphasis tag).
+- Bugfix: Remove-annotations wasn't properly finding test/spec files,
+    and wasn't even looking for FactoryGirl factories under the new naming convention.
+- Bugfix: Load the Rakefile from the current directory, not the first
+    Rakefile in our load path.
+- Added support for new FactoryGirl naming convention.
+- Fix behavior of route annotations in newer versions of Rake that don't
+    spit out the CWD as their first line of output.
+- Overhauled integration testing system to be much easier to work with,
+    better compartmentalized, and so forth -- at the cost that you must be
+    using RVM to utilize it.  (It'll spit out appropriate pending messages if
+    you don't.) Also includes a mode for "tinkering" by hand with a scenario,
+    and won't let you run it through rspect if the repo is in a dirty state. 
+    Added appropriate rake tasks to help with all of this.
+- Routes can now be appended, pre-pended, or removed -- and do sane things in all cases.
+- Expose all `position_*` variables as CLI params.
+- Make `ENV ['position']` work as a default for all the `ENV ['position_*']` variables.
+- Make rake tasks more resilient to unusual circumstances / code loading behavior.
+- Resolve annotate vs. annotate_models ambiguity once and for all by
+  settling on `annotate_models` *and* `annotate_routes`.  This avoids a name
+  collision with RMagick while not needlessly overloading the term.
+- Fixed that schema kept prepending additional newlines
+- Updates to make annotate smarter about when to touch a model
+- Recognize column+type, and don't change a file unless the column+type
+  combination of the new schema are different than that of the old (i.e.,
+  don't regenerate if columns happen to be in a different order. That's just
+  how life is sometimes)
+- Change annotate to use options hash instead of ENV.
+
+
+## 2.5.0
+
+- Works better with Rails 3
+- Bugfix: schema kept prepending additional newlines
+- Updates to make annotate smarter about when to touch a model
+- Recognize column+type, and don't change a file unless the column+type
+  combination of the new schema are different than that of the old (i.e.,
+  don't regenerate if columns happen to be in a different order. That's just
+  how life is sometimes.)
+- Grab old specification even if it has `\r\n` as line endings rather than pure `\n`s
+- Various warning and specification fixes
+- Fix "no such file to load -- annotate/annotate_models (MissingSourceFile)"
+  error (require statements in tasks now use full path to lib files)
+- warn about macros, to mitigate when we're included during a production
+  run, not just a rakefile run -- possibly at the expense of too much noise
+- Adding rake as a runtime dependency
+- If the schema is already in the model file, it will be replaced into the same location.
+  If it didn't previously exist, it'll be placed according to the "position", as before.
+- Allow task loading from Rakefile for gems (plugin installation already auto-detects).
+- Add skip_on_db_migrate option as well for people that don't want it
+- Fix options parsing to convert strings to proper booleans
+- Add support for Fabrication fabricators
+- Leave magic encoding comment intact
+- Fix issue #14 - RuntimeError: Already memoized
+- Count a model as 'annotated' if any of its tests/fixtures are annotated
+- Support FactoryGirl
+- Support :change migrations (Rails 3.1)
+- Allow models with non-standard capitalization
+- Widen type column so we can handle longtexts with chopping things off.
+- Skip trying to get list of models from commandline when running via Rake
+  (was preventing the use of multiple rake tasks in one command if one of them was `db:migrate`).
+- Add ability to skip annotations for a model by adding
+  `# -*- SkipSchemaAnnotations` anywhere in the file.
+- Don't show column limits for integer and boolean types.
+- Add sorting for columns and indexes.
+  (Helpful for out-of-order migration execution.  Use `--sort` if you want this.)
+- Annotate unit tests in subfolders.
+- Add generator to install rakefile that automatically annotates on `db:migrate`.
+- Correct Gemfile to clarify which environments need which gems.
+- Add an .rvmrc to facilitate clean development.
+- Refactor out ActiveRecord monkey-patch to permit extending without side-effects.
+- Use ObjectSpace to locate models to facilitate handling of models with
+  non-standard capitalization.
+  Note that this still requires that the inflector be configured to understand
+  the special case.
+- Shore up test cases a bit.
+- Merge against many of the older branches on Github whose functionality is
+  already reflected to reduce confusion about what is and is not implemented here.
+- Accept String or Symbol for :position (et al) options.
+- Add RDoc output formatting as an option.
+- Add Markdown output formatting as an option.
+- Add option to force annotation regeneration.
+- Add new configuration option for controlling where info is placed in
+  fixtures/factories.
+- Fix for models without tables.
+- Fix gemspec generation now that Jeweler looks at Gemfile.
+- Fix warning: `NOTE: Gem::Specification#default_executable= is deprecated
+  with no replacement. It will be removed on or after 2011-10-01.`
+- Fix handling of files with no trailing newline when putting annotations at
+  the end of the file.
+- Now works on tables with no primary key.
+- `--format=markdown` option
+- `--trace` option to help debug "Unable to annotate" errors
+- "Table name" annotation (if table name is different from model name)
+- "Human name" annotation (enabling translation to non-English locales)
+- Fix JRuby ObjectSpace compatibility bug (https://github.com/ctran/annotate_models/pull/85)
+- Fix FactoryGirl compatibility bug (https://github.com/ctran/annotate_models/pull/82)
+
+
+## 2.4.2 2009-11-21
+- Annotates `(spec|test)/factories/<model>_factory.rb` files
+
+## 2.4.1 2009-11-20
+
+- Annotates thoughtbot's factory_girl factories (`test/factories/<model>_factory.rb`)
+- Move default annotation position back to top
+
+
+## 2.4.0 2009-12-13
+- Incorporated lots of patches from the Github community,
+  including support for Blueprints fixtures
+- Several bug fixes
+
+## 2.1 2009-10-18
+
+- New options
+    - `-R` to require additional files before loading the models
+    - `-i` to show database indexes in annotations
+    - `-e` to exclude annotating tests or fixtures
+    - `-m` to include the migration version number in the annotation
+    - `--model-dir` to annotate model files stored a different place than `app/models`
+
+- Ignore unknown macros ('acts_as_whatever')
+
+
+## 2.0 2009-02-03
+
+- Add annotate_models plugin fork additions
+    - Annotates Rspec and Test Unit models
+    - Annotates Object Daddy exemplars
+    - Annotates geometrical columns
+
+- Add AnnotateRoutes rake task
+- Up gem structure to newgem defaults
+
+
+## 1.0.4 2008-09-04
+
+- Only update modified models since last run, thanks to sant0sk1
+
+## 1.0.3 2008-05-02
+
+- Add misc changes from Dustin Sallings and Henrik N
+    - Remove trailing whitespace
+    - More intuitive info messages
+    - Update README file with update-to-date example
+
+## 1.0.2 2008-03-22
+
+- Add contributions from Michael Bumann (http://github.com/bumi)
+    - added an option "position" to choose to put the annotation,
+    - spec/fixtures now also get annotated
+    - added a task to remove the annotations
+    - these options can be specified from command line as `-d` and `-p [before|after]`
+
+

data/README.md

@@ -0,0 +1,331 @@
+## Annotate (aka AnnotateModels)
+
+[![Gem Version](https://badge.fury.io/rb/annotate.svg)](http://badge.fury.io/rb/annotate)
+[![Downloads count](https://img.shields.io/gem/dt/annotate.svg?style=flat)](https://rubygems.org/gems/annotate)
+[![Build status](https://travis-ci.org/ctran/annotate_models.svg?branch=develop)](https://travis-ci.org/ctran/annotate_models)
+[![CI Status](https://github.com/ctran/annotate_models/workflows/CI/badge.svg)](https://github.com/ctran/annotate_models/actions?workflow=CI)
+[![Coveralls](https://coveralls.io/repos/ctran/annotate_models/badge.svg?branch=develop)](https://coveralls.io/r/ctran/annotate_models?branch=develop)
+[![Maintenability](https://codeclimate.com/github/ctran/annotate_models/badges/gpa.svg)](https://codeclimate.com/github/ctran/annotate_models)
+[![Inline docs](http://inch-ci.org/github/ctran/annotate_models.svg?branch=develop)](http://inch-ci.org/github/ctran/annotate_models)
+
+Add a comment summarizing the current schema to the top or bottom of each of your...
+
+- ActiveRecord models
+- Fixture files
+- Tests and Specs
+- Object Daddy exemplars
+- Machinist blueprints
+- Fabrication fabricators
+- Thoughtbot's factory_bot factories, i.e. the `(spec|test)/factories/<model>_factory.rb` files
+- `routes.rb` file (for Rails projects)
+
+
+The schema comment looks like this:
+
+```ruby
+# == Schema Info
+#
+# Table name: line_items
+#
+#  id                  :integer(11)    not null, primary key
+#  quantity            :integer(11)    not null
+#  product_id          :integer(11)    not null
+#  unit_price          :float
+#  order_id            :integer(11)
+#
+
+class LineItem < ActiveRecord::Base
+  belongs_to :product
+  . . .
+```
+
+It also annotates geometrical columns, `geom` type and `srid`,
+when using `SpatialAdapter`, `PostgisAdapter` or `PostGISAdapter`:
+
+```ruby
+# == Schema Info
+#
+# Table name: trips
+#
+#  local           :geometry        point, 4326
+#  path            :geometry        line_string, 4326
+```
+
+Also, if you pass the `-r` option, it'll annotate `routes.rb` with the output of `rake routes`.
+
+
+## Upgrading to 3.X and annotate models not working?
+
+In versions 2.7.X the annotate gem defaulted to annotating models if no arguments were passed in.
+The annotate gem by default would not allow for routes and models to be annotated together.
+A [change was added in #647](https://github.com/ctran/annotate_models/pull/647).
+You [can read more here](https://github.com/ctran/annotate_models/issues/663).
+
+There are a few ways of fixing this:
+
+- If using CLI explicitly pass in models flag using `--models`
+
+OR
+
+a) Running `rails g annotate:install` will overwrite your defaults with the annotating `models` option set to `'true'`.
+
+b) In `lib/tasks/auto_annotate_models.rake` add the `models` key-value option:
+
+```ruby
+    Annotate.set_defaults(
+      ...
+      'models'                      => 'true',
+      ...
+```
+
+## Install
+
+Into Gemfile from rubygems.org:
+
+```ruby
+group :development do
+  gem 'annotate'
+end
+```
+
+Into Gemfile from Github:
+
+```ruby
+group :development do
+  gem 'annotate', git: 'https://github.com/ctran/annotate_models.git'
+end
+```
+
+Into environment gems from rubygems.org:
+
+    gem install annotate
+
+Into environment gems from Github checkout:
+
+    git clone https://github.com/ctran/annotate_models.git annotate_models
+    cd annotate_models
+    rake build
+    gem install pkg/annotate-*.gem
+
+## Usage
+
+(If you used the Gemfile install, prefix the below commands with `bundle exec`.)
+
+### Usage in Rails
+
+To annotate all your models, tests, fixtures, and factories:
+
+    cd /path/to/app
+    annotate
+
+To annotate just your models, tests, and factories:
+
+    annotate --models --exclude fixtures
+
+To annotate just your models:
+
+    annotate --models
+
+To annotate routes.rb:
+
+    annotate --routes
+
+To remove model/test/fixture/factory/serializer annotations:
+
+    annotate --delete
+
+To remove routes.rb annotations:
+
+    annotate --routes --delete
+
+To automatically annotate every time you run `db:migrate`,
+either run `rails g annotate:install`
+or add `Annotate.load_tasks` to your `Rakefile`.
+
+See the [configuration in Rails](#configuration-in-rails) section for more info.
+
+### Usage Outside of Rails
+
+Everything above applies, except that `--routes` is not meaningful,
+and you will probably need to explicitly set one or more `--require` option(s), and/or one or more `--model-dir` options
+to inform `annotate` about the structure of your project and help it bootstrap and load the relevant code.
+
+## Configuration
+
+If you want to always skip annotations on a particular model, add this string
+anywhere in the file:
+
+    # -*- SkipSchemaAnnotations
+
+### Configuration in Rails
+
+To generate a configuration file (in the form of a `.rake` file), to set
+default options:
+
+    rails g annotate:install
+
+Edit this file to control things like output format, where annotations are
+added (top or bottom of file), and in which artifacts.
+
+The generated rakefile `lib/tasks/auto_annotate_models.rake` also contains
+`Annotate.load_tasks`. This adds a few rake tasks which duplicate command-line
+functionality:
+
+    rake annotate_models                          # Add schema information (as comments) to model and fixture files
+    rake annotate_routes                          # Adds the route map to routes.rb
+    rake remove_annotation                        # Remove schema information from model and fixture files
+
+By default, once you've generated a configuration file, annotate will be
+executed whenever you run `rake db:migrate` (but only in development mode).
+If you want to disable this behavior permanently,
+edit the `.rake` file and change:
+
+```ruby
+    'skip_on_db_migrate'   => 'false',
+```
+
+To:
+
+```ruby
+    'skip_on_db_migrate'   => 'true',
+```
+
+If you want to run `rake db:migrate` as a one-off without running annotate,
+you can do so with a simple environment variable, instead of editing the
+`.rake` file:
+
+    ANNOTATE_SKIP_ON_DB_MIGRATE=1 rake db:migrate
+
+## 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`)
+        -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
+            --pc, --position-in-class [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of the model file
+            --pf, --position-in-factory [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of any factory files
+            --px, --position-in-fixture [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of any fixture files
+            --pt, --position-in-test [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of any test files
+            --pr, --position-in-routes [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of the routes.rb file
+            --ps, --position-in-serializer [before|top|after|bottom]
+                                         Place the annotations at the top (before) or the bottom (after) of the serializer files
+            --w, --wrapper STR           Wrap annotation with the text passed as parameter.
+                                         If --w option is used, the same text will be used as opening and closing
+            --wo, --wrapper-open STR     Annotation wrapper opening.
+            --wc, --wrapper-close STR    Annotation wrapper closing
+        -r, --routes                     Annotate routes.rb with the output of 'rake routes'
+            --models                     Annotate ActiveRecord models
+        -a, --active-admin               Annotate active_admin models
+        -v, --version                    Show the current version of this gem
+        -m, --show-migration             Include the migration version number in the annotation
+        -k, --show-foreign-keys          List the table's foreign key constraints in the annotation
+            --ck, --complete-foreign-keys
+                                         Complete foreign key names in the annotation
+        -i, --show-indexes               List the table's database indexes in the annotation
+        -s, --simple-indexes             Concat the column's related indexes in the annotation
+            --model-dir dir              Annotate model files stored in dir rather than app/models, separate multiple dirs with commas
+            --root-dir dir               Annotate files stored within root dir projects, separate multiple dirs with commas
+            --ignore-model-subdirects    Ignore subdirectories of the models directory
+            --sort                       Sort columns alphabetically, rather than in creation order
+            --classified-sort            Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns
+        -R, --require path               Additional file to require before loading models, may be used multiple times
+        -e [tests,fixtures,factories,serializers],
+            --exclude                    Do not annotate fixtures, test files, factories, and/or serializers
+        -f [bare|rdoc|yard|markdown],    Render Schema Infomation as plain/RDoc/YARD/Markdown
+            --format
+            --force                      Force new annotations even if there are no changes.
+            --frozen                     Do not allow to change annotations. Exits non-zero if there are going to be changes to files.
+            --timestamp                  Include timestamp in (routes) annotation
+            --trace                      If unable to annotate a file, print the full stack trace, not just the exception message.
+        -I, --ignore-columns REGEX       don't annotate columns that match a given REGEX (e.g. `annotate -I '^(id|updated_at|created_at)'`)
+            --ignore-routes REGEX        don't annotate routes that match a given REGEX (e.g. `annotate -I '(mobile|resque|pghero)'`)_
+            --hide-limit-column-types VALUES
+                                         don't show limit for given column types, separated by commas (e.g. `integer,boolean,text`)
+            --hide-default-column-types VALUES
+                                         don't show default for given column types, separated by commas (e.g. `json,jsonb,hstore`)
+            --ignore-unknown-models      don't display warnings for bad model files
+            --with-comment               include database comments in model annotations
+
+### Option: `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:
+
+*   `/app/lib/decorates/%MODEL_NAME%/*.rb`
+*   `/app/lib/forms/%PLURALIZED_MODEL_NAME%/**/*.rb`
+*   `/app/lib/forms/%TABLE_NAME%/*.rb`
+
+
+The appropriate model will be inferred using the `%*%` syntax, annotating any
+matching files. It works with existing filename resolutions (options for which
+can be found in the `resolve_filename` method of `annotate_models.rb`).
+
+When using in a Rails config, you can use the following:
+
+`File.join(Rails.application.root,
+'app/lib/forms/%PLURALIZED_MODEL_NAME%/***/**.rb')`
+
+## Sorting
+
+By default, columns will be sorted in database order (i.e. the order in which
+migrations were run).
+
+If you prefer to sort alphabetically so that the results of annotation are
+consistent regardless of what order migrations are executed in, use `--sort`.
+
+## Markdown
+
+The format produced is actually MultiMarkdown, making use of the syntax
+extension for tables.  It's recommended you use `kramdown` as your parser if
+you want to use this format.  If you're using `yard` to generate
+documentation, specify a format of markdown with `kramdown` as the provider by
+adding this to your `.yardopts` file:
+
+    --markup markdown
+    --markup-provider kramdown
+
+Be sure to add this to your `Gemfile` as well:
+
+    gem 'kramdown', groups => [:development], require => false
+
+## WARNING
+
+**Don't add text after an automatically-created comment block.** This tool
+will blow away the initial/final comment block in your models if it looks like
+it was previously added by this gem.
+
+Be sure to check the changes that this tool makes! If you are using Git, you
+may simply check your project's status after running `annotate`:
+
+    $ git status
+
+If you are not using a VCS (like Git, Subversion or similar), please tread
+extra carefully, and consider using one.
+
+## Links
+
+*   Factory Bot: http://github.com/thoughtbot/factory_bot
+*   Object Daddy: http://github.com/flogic/object_daddy
+*   Machinist: http://github.com/notahat/machinist
+*   Fabrication: http://github.com/paulelliott/fabrication
+*   SpatialAdapter: http://github.com/pdeffendol/spatial_adapter
+*   PostgisAdapter: http://github.com/nofxx/postgis_adapter
+*   PostGISAdapter: https://github.com/dazuma/activerecord-postgis-adapter
+
+
+## License
+
+Released under the same license as Ruby. No Support. No Warranty.
+
+## Authors
+
+[See AUTHORS.md](AUTHORS.md).