Merge branch 'release/v3.1.1'

.dockerignore

+Dockerfile
+coverage

.document

 spec/**/*.rb
 lib/**/*.rb
 -
-README.rdoc
-CHANGELOG.rdoc
-TODO.rdoc
+README.md
+CHANGELOG.md
+TODO.md

.github/release-drafter.yml

+template: |
+  ## What's Changed
+
+  $CHANGES

.github/workflows/ci.yml

+name: CI
+on:
+  pull_request:
+    branches:
+      - '*'
+
+  push:
+    branches:
+      - '*'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.4.x', '2.5.x', '2.6.x']
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - name: Install sqlite
+        run: |
+          sudo apt-get install libsqlite3-dev
+
+      - name: Update System
+        run: |
+          gem update --system --no-document
+
+      - name: Bundle install for Annotate models
+        run: |
+          bundle install --jobs=4 --retry=3
+
+      - name: Run Tests
+        run: bundle exec rspec
+
+      - name: Rubocop
+        run: bundle exec rubocop

.github/workflows/release.yml

+name: Release
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+
+      - name: Bundle
+        run: |
+          gem update --system
+          gem update bundler
+          bundle install --jobs 4 --retry 3
+
+      - name: Publish to GPR
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+          gem build *.gemspec
+          gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+        env:
+          GEM_HOST_API_KEY: ${{ secrets.GPR_AUTH_TOKEN }}
+          OWNER: ctran

.gitignore

-!/spec/integration/*/log/.gitkeep
-!/spec/integration/*/tmp/.gitkeep
 *.gem
 .DS_Store
 .bundle
@@ -16,8 +14,4 @@
 /doc/*
 /pkg/*
 /spec/debug.log
-/spec/integration/*/bin/
-/spec/integration/*/db/test.*
-/spec/integration/*/log/*
-/spec/integration/*/tmp/*
 .byebug_history

.rubocop.yml

@@ -6,3 +6,8 @@ AllCops:
     - 'vendor/**/*'
     - 'spec/fixtures/**/*'
     - 'tmp/**/*'
+    - 'spec/integration/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

.travis.yml

-sudo: false
 language: ruby
 rvm:
-- 2.2.10
-- 2.3.8
-- 2.4.6
-- 2.5.5
-- 2.6.0
-- 2.6.1
-- 2.6.2
-- 2.6.3
-- ruby-head
+  - 2.4.9
+  - 2.5.7
+  - 2.6.5
+  - ruby-head
+
+env:
+  - RAILS_ENV=development RACK_ENV=development
 
 matrix:
   allow_failures:
     - rvm: ruby-head
 
+addons:
+  apt_packages:
+    - libsqlite3-dev
+
 before_install:
-- gem update --system || (gem i "rubygems-update:~>2.7" --no-document && update_rubygems)
-- gem update bundler
+  - gem update --system --no-document --quiet
+
+install:
+  - bundle install --jobs=3 --retry=3
 
 script:
-- bundle exec rubocop && bundle exec rspec
+  - bundle exec rspec
+  - bundle exec rubocop
 
 jobs:
   include:

AUTHORS.rdoc → AUTHORS.md

-== 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

CHANGELOG.rdoc

-== 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)
-* Check if model has skip tag in annotate_model_file (#167)
-* Fix issue where serializer-related flags weren't being honored (#246)
-* Prefer SQL column type over normalized AR type (#231)
-
-== 2.6.8
-* Nothing annotated unless options[:model_dir] is specified, #234
-
-== 2.6.7
-* Nothing annotated unless options[:model_dir] is specified, #234
-
-== 2.6.6
-* Makes it possible to wrap annotations, #225
-* Fix single model generation, #214
-* Fix default value for Rails 4.2, #212
-* Don't crash on inherited models in subdirectories, #232
-* Process model_dir in rake task, #197
-
-== 2.6.4
-* Skip "models/concerns", #194
-* Fix #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
-* Support rails 4.0 new default test directory, #182
-* Add an option to show timestamp in routes "-timestamp", #136
-* Skip plain ruby objects if they have the same class name as an ActiveRecord object, #121
-
-== 2.6.3
-* Fix bug of annotate position in routes (#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)
-
-== 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 \ns
-* 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]

Gemfile

@@ -2,7 +2,7 @@ source 'https://rubygems.org'
 
 ruby '>= 2.2.0'
 
-gem 'activerecord', '>= 4.2.5', require: false
+gem 'activerecord', '>= 4.2.5', '< 6', require: false
 gem 'rake', require: false
 
 group :development do
@@ -31,11 +31,12 @@ group :development, :test do
 
   platforms :mri, :mingw do
     gem 'pry', require: false
-    gem 'pry-coolline', require: false
+    gem 'pry-byebug', require: false
   end
 end
 
 group :test do
   gem 'files', require: false
+  gem 'git', require: false
   gem 'wrong', require: false
 end

RELEASE.md

+## Prerequisite 
+
+- Install "git-flow" (`brew install git-flow`)
+- Install "bump" gem (`gem install bump`)
+
+
+## Perform a release
+
+- `git flow release start <release>`
+- Update the `CHANGELOG.md` file
+- `bump current`
+- `bump patch`
+- `rm -rf dist`
+- `rake spec`
+- `rake gem`
+- `git flow release finish <release>`
+
+- `rake gem:publish`
+

RELEASE.rdoc

-== Prerequisite 
-
-- Install "git-flow" (brew install git-flow)
-- Install "bump" gem (gem install bump)
-
-== Perform a release
-
-- git flow release start <release>
-- Update the CHANGELOG.rdoc file
-- bump current
-- bump patch
-- rm -rf dist
-- rake spec
-- rake gem
-- git flow release finish <release>
-
-- rake gem:publish

Rakefile

@@ -60,7 +60,7 @@ namespace :gem do
       end
 
       gem.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
-      gem.extra_rdoc_files = ['README.rdoc', 'CHANGELOG.rdoc', 'TODO.rdoc']
+      gem.extra_rdoc_files = ['README.md', 'CHANGELOG.md', 'TODO.md']
 
       gem.files = `git ls-files -- .`.split("\n").reject do |fn|
         fn =~ /^Gemfile.*/ ||

TODO.rdoc

-== TODO
-
-- clean up history
-- change default position back to "top" for all annotations
-- change 'exclude' to 'only' (double negatives are not unconfusing)
-
-== TODO (proposed)
-
-- push two identical gems, named 'annotate' and 'annotate_models'
-- supply two binaries, named 'annotate' and 'annotate_models', since there's already a unix tool named 'annotate'
-- test EVERYTHING

annotate.gemspec

@@ -7,42 +7,23 @@ Gem::Specification.new do |s|
   s.name = 'annotate'
   s.version = Annotate.version
 
-  s.required_ruby_version = '>= 2.2.0'
+  s.required_ruby_version = '>= 2.4.0'
   s.required_rubygems_version = Gem::Requirement.new('>= 0') if s.respond_to? :required_rubygems_version=
   s.authors = ['Alex Chaffee', 'Cuong Tran', 'Marcos Piccinini', 'Turadg Aleahmad', 'Jon Frisby']
   s.description = 'Annotates Rails/ActiveRecord Models, routes, fixtures, and others based on the database schema.'
   s.email = ['alex@stinky.com', 'cuong.tran@gmail.com', 'x@nofxx.com', 'turadg@aleahmad.net', 'jon@cloudability.com']
   s.executables = ['annotate']
-  s.extra_rdoc_files = ['README.rdoc', 'CHANGELOG.rdoc', 'TODO.rdoc']
-  s.files = [
-    'AUTHORS.rdoc',
-    'CHANGELOG.rdoc',
-    'LICENSE.txt',
-    'README.rdoc',
-    'TODO.rdoc',
-    'annotate.gemspec',
-    'bin/annotate',
-    'lib/annotate.rb',
-    'lib/annotate/active_record_patch.rb',
-    'lib/annotate/annotate_models.rb',
-    'lib/annotate/annotate_routes.rb',
-    'lib/annotate/tasks.rb',
-    'lib/annotate/version.rb',
-    'lib/generators/annotate/USAGE',
-    'lib/generators/annotate/install_generator.rb',
-    'lib/generators/annotate/templates/auto_annotate_models.rake',
-    'lib/tasks/annotate_models.rake',
-    'lib/tasks/annotate_routes.rake',
-    'lib/tasks/annotate_models_migrate.rake'
-  ]
+  s.extra_rdoc_files = ['README.md', 'CHANGELOG.md']
+  s.files = `git ls-files -z LICENSE.txt *.md *.gemspec bin lib`.split("\x0")
   s.homepage = 'http://github.com/ctran/annotate_models'
   s.licenses = ['Ruby']
   s.require_paths = ['lib']
-  s.rubyforge_project = 'annotate'
   s.rubygems_version = '2.1.11'
   s.summary = 'Annotates Rails Models, routes, fixtures, and others based on the database schema.'
 
   s.specification_version = 4 if s.respond_to? :specification_version
-  s.add_runtime_dependency(%q<rake>, ['>= 10.4', '< 13.0'])
+  s.add_runtime_dependency(%q<rake>, '>= 10.4', '< 14.0')
   s.add_runtime_dependency(%q<activerecord>, ['>= 3.2', '< 7.0'])
+
+  s.metadata = { "github_repo" => "ssh://github.com/ctran/annotate_models" }
 end

bin/annotate

@@ -14,203 +14,19 @@ end
 here = File.expand_path(File.dirname __FILE__)
 $LOAD_PATH << "#{here}/../lib"
 
-require 'optparse'
 require 'annotate'
-Annotate.bootstrap_rake
-
-has_set_position = {}
-target_action = :do_annotations
-positions = %w(before top after bottom)
-
-OptionParser.new do |opts|
-  opts.banner = 'Usage: annotate [options] [model_file]*'
-
-  opts.on('-d', '--delete', 'Remove annotations from all model files or the routes.rb file') do
-    target_action = :remove_annotations
-  end
-
-  opts.on('-p', '--position [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)') do |p|
-    ENV['position'] = p
-    %w(position_in_class position_in_factory position_in_fixture position_in_test position_in_routes position_in_serializer).each do |key|
-      ENV[key] = p unless has_set_position[key]
-    end
-  end
-
-  opts.on('--pc', '--position-in-class [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the model file') do |p|
-    ENV['position_in_class'] = p
-    has_set_position['position_in_class'] = true
-  end
-
-  opts.on('--pf', '--position-in-factory [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any factory files') do |p|
-    ENV['position_in_factory'] = p
-    has_set_position['position_in_factory'] = true
-  end
-
-  opts.on('--px', '--position-in-fixture [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any fixture files') do |p|
-    ENV['position_in_fixture'] = p
-    has_set_position['position_in_fixture'] = true
-  end
-
-  opts.on('--pt', '--position-in-test [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of any test files') do |p|
-    ENV['position_in_test'] = p
-    has_set_position['position_in_test'] = true
-  end
-
-  opts.on('--pr', '--position-in-routes [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the routes.rb file') do |p|
-    ENV['position_in_routes'] = p
-    has_set_position['position_in_routes'] = true
-  end
-
-  opts.on('--ps', '--position-in-serializer [before|top|after|bottom]', positions,
-          'Place the annotations at the top (before) or the bottom (after) of the serializer files') do |p|
-    ENV['position_in_serializer'] = p
-    has_set_position['position_in_serializer'] = true
-  end
-
-  opts.on('--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') do |p|
-    ENV['wrapper'] = p
-  end
-
-  opts.on('--wo', '--wrapper-open STR', 'Annotation wrapper opening.') do |p|
-    ENV['wrapper_open'] = p
-  end
-
-  opts.on('--wc', '--wrapper-close STR', 'Annotation wrapper closing') do |p|
-    ENV['wrapper_close'] = p
-  end
-
-  opts.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") do
-    ENV['routes'] = 'true'
-  end
-
-  opts.on('-a', '--active-admin', 'Annotate active_admin models') do
-    ENV['active_admin'] = 'true'
-  end
-
-  opts.on('-v', '--version', 'Show the current version of this gem') do
-    puts "annotate v#{Annotate.version}"; exit
-  end
-
-  opts.on('-m', '--show-migration', 'Include the migration version number in the annotation') do
-    ENV['include_version'] = 'yes'
-  end
-
-  opts.on('-k', '--show-foreign-keys',
-          "List the table's foreign key constraints in the annotation") do
-    ENV['show_foreign_keys'] = 'yes'
-  end
+require 'annotate/parser'
 
-  opts.on('--ck',
-          '--complete-foreign-keys', 'Complete foreign key names in the annotation') do
-    ENV['show_foreign_keys'] = 'yes'
-    ENV['show_complete_foreign_keys'] = 'yes'
-  end
-
-  opts.on('-i', '--show-indexes',
-          "List the table's database indexes in the annotation") do
-    ENV['show_indexes'] = 'yes'
-  end
-
-  opts.on('-s', '--simple-indexes',
-          "Concat the column's related indexes in the annotation") do
-    ENV['simple_indexes'] = 'yes'
-  end
-
-  opts.on('--model-dir dir',
-          "Annotate model files stored in dir rather than app/models, separate multiple dirs with commas") do |dir|
-    ENV['model_dir'] = dir
-  end
-
-  opts.on('--root-dir dir',
-          "Annotate files stored within root dir projects, separate multiple dirs with commas") do |dir|
-    ENV['root_dir'] = dir
-  end
-
-  opts.on('--ignore-model-subdirects',
-          "Ignore subdirectories of the models directory") do |dir|
-    ENV['ignore_model_sub_dir'] = 'yes'
-  end
-
-  opts.on('--sort',
-          "Sort columns alphabetically, rather than in creation order") do |dir|
-    ENV['sort'] = 'yes'
-  end
-
-  opts.on('--classified-sort',
-          "Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns") do |dir|
-    ENV['classified_sort'] = 'yes'
-  end
-
-  opts.on('-R', '--require path',
-          "Additional file to require before loading models, may be used multiple times") do |path|
-    if !ENV['require'].blank?
-      ENV['require'] = ENV['require'] + ",#{path}"
-    else
-      ENV['require'] = path
-    end
-  end
-
-  opts.on('-e', '--exclude [tests,fixtures,factories,serializers]', Array, "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
-    exclusions ||= %w(tests fixtures factories)
-    exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = 'yes' }
-  end
-
-  opts.on('-f', '--format [bare|rdoc|markdown]', %w(bare rdoc markdown), 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
-    ENV["format_#{fmt}"] = 'yes'
-  end
-
-  opts.on('--force', 'Force new annotations even if there are no changes.') do |force|
-    ENV['force'] = 'yes'
-  end
-
-  opts.on('--frozen', 'Do not allow to change annotations. Exits non-zero if there are going to be changes to files.') do
-    ENV['frozen'] = 'yes'
-  end
-
-  opts.on('--timestamp', 'Include timestamp in (routes) annotation') do
-    ENV['timestamp'] = 'true'
-  end
-
-  opts.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |value|
-    ENV['trace'] = 'yes'
-  end
-
-  opts.on('-I', '--ignore-columns REGEX', "don't annotate columns that match a given REGEX (i.e., `annotate -I '^(id|updated_at|created_at)'`") do |regex|
-    ENV['ignore_columns'] = regex
-  end
-
-  opts.on('--ignore-routes REGEX', "don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`") do |regex|
-    ENV['ignore_routes'] = regex
-  end
-
-  opts.on('--hide-limit-column-types VALUES', "don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)") do |values|
-    ENV['hide_limit_column_types'] = "#{values}"
-  end
-
-  opts.on('--hide-default-column-types VALUES', "don't show default for given column types, separated by commas (i.e., `json,jsonb,hstore`)") do |values|
-    ENV['hide_default_column_types'] = "#{values}"
-  end
+Annotate.bootstrap_rake
 
-  opts.on('--ignore-unknown-models', "don't display warnings for bad model files") do |values|
-    ENV['ignore_unknown_models'] = 'true'
-  end
+options_result = Annotate::Parser.parse(ARGV)
 
-  opts.on('--with-comment', "include database comments in model annotations") do |values|
-    ENV['with_comment'] = 'true'
-  end
-end.parse!
+exit if options_result[:exit]
 
 options = Annotate.setup_options(
   is_rake: ENV['is_rake'] && !ENV['is_rake'].empty?
 )
-Annotate.eager_load(options) if Annotate.include_models?
+Annotate.eager_load(options) if Annotate::Helpers.include_models?
 
-AnnotateModels.send(target_action, options) if Annotate.include_models?
-AnnotateRoutes.send(target_action, options) if Annotate.include_routes?
+AnnotateModels.send(options_result[:target_action], options) if Annotate::Helpers.include_models?
+AnnotateRoutes.send(options_result[:target_action], options) if Annotate::Helpers.include_routes?

circle.yml

-machine:
-  ruby:
-    version: 2.2.6
-
-test:
-  override:
-    - bundle exec rubocop && bundle exec rspec

lib/annotate.rb

-# rubocop:disable  Metrics/ModuleLength
-
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'annotate/version'
 require 'annotate/annotate_models'
 require 'annotate/annotate_routes'
+require 'annotate/constants'
+require 'annotate/helpers'
 
 begin
   # ActiveSupport 3.x...
@@ -16,38 +16,6 @@ rescue StandardError
 end
 
 module Annotate
-  TRUE_RE = /^(true|t|yes|y|1)$/i
-
-  ##
-  # The set of available options to customize the behavior of Annotate.
-  #
-  POSITION_OPTIONS = [
-    :position_in_routes, :position_in_class, :position_in_test,
-    :position_in_fixture, :position_in_factory, :position,
-    :position_in_serializer
-  ].freeze
-  FLAG_OPTIONS = [
-    :show_indexes, :simple_indexes, :include_version, :exclude_tests,
-    :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
-    :format_bare, :format_rdoc, :format_markdown, :sort, :force, :frozen,
-    :trace, :timestamp, :exclude_serializers, :classified_sort,
-    :show_foreign_keys, :show_complete_foreign_keys,
-    :exclude_scaffolds, :exclude_controllers, :exclude_helpers,
-    :exclude_sti_subclasses, :ignore_unknown_models, :with_comment
-  ].freeze
-  OTHER_OPTIONS = [
-    :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close,
-    :wrapper, :routes, :hide_limit_column_types, :hide_default_column_types,
-    :ignore_routes, :active_admin
-  ].freeze
-  PATH_OPTIONS = [
-    :require, :model_dir, :root_dir
-  ].freeze
-
-  def self.all_options
-    [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS]
-  end
-
   ##
   # Set default values that can be overridden via environment variables.
   #
@@ -55,9 +23,9 @@ module Annotate
     return if @has_set_defaults
     @has_set_defaults = true
 
-    options = HashWithIndifferentAccess.new(options)
+    options = ActiveSupport::HashWithIndifferentAccess.new(options)
 
-    all_options.flatten.each do |key|
+    Constants::ALL_ANNOTATE_OPTIONS.flatten.each do |key|
       if options.key?(key)
         default_value = if options[key].is_a?(Array)
                           options[key].join(',')
@@ -75,68 +43,42 @@ module Annotate
   # TODO: what is the difference between this and set_defaults?
   #
   def self.setup_options(options = {})
-    POSITION_OPTIONS.each do |key|
-      options[key] = fallback(ENV[key.to_s], ENV['position'], 'before')
+    Constants::POSITION_OPTIONS.each do |key|
+      options[key] = Annotate::Helpers.fallback(ENV[key.to_s], ENV['position'], 'before')
     end
-    FLAG_OPTIONS.each do |key|
-      options[key] = true?(ENV[key.to_s])
+    Constants::FLAG_OPTIONS.each do |key|
+      options[key] = Annotate::Helpers.true?(ENV[key.to_s])
     end
-    OTHER_OPTIONS.each do |key|
+    Constants::OTHER_OPTIONS.each do |key|
       options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s] : nil
     end
-    PATH_OPTIONS.each do |key|
+    Constants::PATH_OPTIONS.each do |key|
       options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s].split(',') : []
     end
 
+    options[:additional_file_patterns] ||= []
+    options[:additional_file_patterns] = options[:additional_file_patterns].split(',') if options[:additional_file_patterns].is_a?(String)
     options[:model_dir] = ['app/models'] if options[:model_dir].empty?
 
     options[:wrapper_open] ||= options[:wrapper]
     options[:wrapper_close] ||= options[:wrapper]
 
     # These were added in 2.7.0 but so this is to revert to old behavior by default
-    options[:exclude_scaffolds] = Annotate.true?(ENV.fetch('exclude_scaffolds', 'true'))
-    options[:exclude_controllers] = Annotate.true?(ENV.fetch('exclude_controllers', 'true'))
-    options[:exclude_helpers] = Annotate.true?(ENV.fetch('exclude_helpers', 'true'))
+    options[:exclude_scaffolds] = Annotate::Helpers.true?(ENV.fetch('exclude_scaffolds', 'true'))
+    options[:exclude_controllers] = Annotate::Helpers.true?(ENV.fetch('exclude_controllers', 'true'))
+    options[:exclude_helpers] = Annotate::Helpers.true?(ENV.fetch('exclude_helpers', 'true'))
 
     options
   end
 
-  def self.reset_options
-    all_options.flatten.each { |key| ENV[key.to_s] = nil }
-  end
-
-  def self.skip_on_migration?
-    ENV['ANNOTATE_SKIP_ON_DB_MIGRATE'] =~ TRUE_RE || ENV['skip_on_db_migrate'] =~ TRUE_RE
-  end
-
-  def self.include_routes?
-    ENV['routes'] =~ TRUE_RE
-  end
-
-  def self.include_models?
-    ENV['routes'] !~ TRUE_RE
-  end
-
-  def self.loaded_tasks=(val)
-    @loaded_tasks = val
-  end
-
-  def self.loaded_tasks
-    @loaded_tasks
-  end
-
   def self.load_tasks
-    return if loaded_tasks
-    self.loaded_tasks = true
+    return if @tasks_loaded
 
     Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each do |rake|
       load rake
     end
-  end
 
-  def self.load_requires(options)
-    options[:require].count > 0 &&
-      options[:require].each { |path| require path }
+    @tasks_loaded = true
   end
 
   def self.eager_load(options)
@@ -192,13 +134,12 @@ module Annotate
     Rake::Task[:set_annotation_options].invoke
   end
 
-  def self.fallback(*args)
-    args.detect { |arg| !arg.blank? }
-  end
+  class << self
+    private
 
-  def self.true?(val)
-    return false if val.blank?
-    return false unless val =~ TRUE_RE
-    true
+    def load_requires(options)
+      options[:require].count > 0 &&
+        options[:require].each { |path| require path }
+    end
   end
 end

lib/annotate/annotate_routes.rb

@@ -10,7 +10,7 @@
 # Yes, it's simple but I'm thick and often need a reminder of what my routes
 # mean.
 #
-# Running this task will replace any exising route comment generated by the
+# Running this task will replace any existing route comment generated by the
 # task. Best to back up your routes file before running:
 #
 # Author:
@@ -19,65 +19,62 @@
 #
 # Released under the same license as Ruby. No Support. No Warranty.
 #
+
+require_relative './annotate_routes/helpers'
+
 module AnnotateRoutes
   PREFIX = '== Route Map'.freeze
   PREFIX_MD = '## Route Map'.freeze
-  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']
+  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action'].freeze
 
   class << self
     def do_annotations(options = {})
-      return unless routes_exists?
+      if routes_file_exist?
         existing_text = File.read(routes_file)
+        content, header_position = Helpers.strip_annotations(existing_text)
+        new_content = annotate_routes(header(options), content, header_position, options)
+        new_text = new_content.join("\n")
 
-      if rewrite_contents_with_header(existing_text, header(options), options)
-        puts "#{routes_file} annotated."
+        if rewrite_contents(existing_text, new_text)
+          puts "#{routes_file} was annotated."
+        else
+          puts "#{routes_file} was not changed."
+        end
+      else
+        puts "#{routes_file} could not be found."
       end
     end
 
     def remove_annotations(_options={})
-      return unless routes_exists?
+      if routes_file_exist?
         existing_text = File.read(routes_file)
-      content, where_header_found = strip_annotations(existing_text)
-      new_content = strip_on_removal(content, where_header_found)
-      if rewrite_contents(existing_text, new_content)
-        puts "Removed annotations from #{routes_file}."
+        content, header_position = Helpers.strip_annotations(existing_text)
+        new_content = strip_on_removal(content, header_position)
+        new_text = new_content.join("\n")
+        if rewrite_contents(existing_text, new_text)
+          puts "Annotations were removed from #{routes_file}."
+        else
+          puts "#{routes_file} was not changed (Annotation did not exist)."
+        end
+      else
+        puts "#{routes_file} could not be found."
       end
     end
 
     private
 
-    def routes_exists?
-      routes_exists = File.exists?(routes_file)
-      puts "Can't find routes.rb" unless routes_exists
-
-      routes_exists
+    def routes_file_exist?
+      File.exist?(routes_file)
     end
 
     def routes_file
       @routes_rb ||= File.join('config', 'routes.rb')
     end
 
-    def rewrite_contents_with_header(existing_text, header, options = {})
-      content, where_header_found = strip_annotations(existing_text)
-      new_content = annotate_routes(header, content, where_header_found, options)
-
-      # Make sure we end on a trailing newline.
-      new_content << '' unless new_content.last == ''
-      new_text = new_content.join("\n")
-
-      if existing_text == new_text
-        puts "#{routes_file} unchanged."
-        false
-      else
-        File.open(routes_file, 'wb') { |f| f.puts(new_text) }
-        true
-      end
-    end
-
     def header(options = {})
       routes_map = app_routes_map(options)
 
-      magic_comments_map, routes_map = extract_magic_comments_from_array(routes_map)
+      magic_comments_map, routes_map = Helpers.extract_magic_comments_from_array(routes_map)
 
       out = []
 
@@ -86,10 +83,10 @@ module AnnotateRoutes
       end
       out << '' if magic_comments_map.any?
 
-      out += ["# #{options[:wrapper_open]}"] if options[:wrapper_open]
+      out << comment(options[:wrapper_open]) if options[:wrapper_open]
 
-      out += ["# #{options[:format_markdown] ? PREFIX_MD : PREFIX}" + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')]
-      out += ['#']
+      out << comment(options[:format_markdown] ? PREFIX_MD : PREFIX) + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')
+      out << comment
       return out if routes_map.size.zero?
 
       maxs = [HEADER_ROW.map(&:size)] + routes_map[1..-1].map { |line| line.split.map(&:size) }
@@ -97,67 +94,44 @@ module AnnotateRoutes
       if options[:format_markdown]
         max = maxs.map(&:max).compact.max
 
-        out += ["# #{content(HEADER_ROW, maxs, options)}"]
-        out += ["# #{content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options)}"]
+        out << comment(content(HEADER_ROW, maxs, options))
+        out << comment(content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options))
       else
-        out += ["# #{content(routes_map[0], maxs, options)}"]
+        out << comment(content(routes_map[0], maxs, options))
       end
 
-      out += routes_map[1..-1].map { |line| "# #{content(options[:format_markdown] ? line.split(' ') : line, maxs, options)}" }
-      out += ["# #{options[:wrapper_close]}"] if options[:wrapper_close]
+      out += routes_map[1..-1].map { |line| comment(content(options[:format_markdown] ? line.split(' ') : line, maxs, options)) }
+      out << comment(options[:wrapper_close]) if options[:wrapper_close]
 
       out
     end
 
-    # TODO: write the method doc using ruby rdoc formats
-    # where_header_found => This will either be :before, :after, or
-    # a number.  If the number is > 0, the
-    # annotation was found somewhere in the
-    # middle of the file.  If the number is
-    # zero, no annotation was found.
-    def strip_annotations(content)
-      real_content = []
-      mode = :content
-      header_found_at = 0
-
-      content.split(/\n/, -1).each_with_index do |line, line_number|
-        if mode == :header && line !~ /\s*#/
-          mode = :content
-          real_content << line unless line.blank?
-        elsif mode == :content
-          if line =~ /^\s*#\s*== Route.*$/
-            header_found_at = line_number + 1 # index start's at 0
-            mode = :header
+    def comment(row = '')
+      if row == ''
+        '#'
       else
-            real_content << line
-          end
+        "# #{row}"
       end
     end
 
-      where_header_found(real_content, header_found_at)
-    end
-
-    def strip_on_removal(content, where_header_found)
-      if where_header_found == :before
+    def strip_on_removal(content, header_position)
+      if header_position == :before
         content.shift while content.first == ''
-      elsif where_header_found == :after
+      elsif header_position == :after
         content.pop while content.last == ''
       end
 
+      # Make sure we end on a trailing newline.
+      content << '' unless content.last == ''
+
       # TODO: If the user buried it in the middle, we should probably see about
       # TODO: preserving a single line of space between the content above and
       # TODO: below...
       content
     end
 
-    # @param [String, Array<String>]
-    def rewrite_contents(existing_text, new_content)
-      # Make sure we end on a trailing newline.
-      new_content << '' unless new_content.last == ''
-      new_text = new_content.join("\n")
-
+    def rewrite_contents(existing_text, new_text)
       if existing_text == new_text
-        puts "#{routes_file} unchanged."
         false
       else
         File.open(routes_file, 'wb') { |f| f.puts(new_text) }
@@ -165,8 +139,8 @@ module AnnotateRoutes
       end
     end
 
-    def annotate_routes(header, content, where_header_found, options = {})
-      magic_comments_map, content = extract_magic_comments_from_array(content)
+    def annotate_routes(header, content, header_position, options = {})
+      magic_comments_map, content = Helpers.extract_magic_comments_from_array(content)
       if %w(before top).include?(options[:position_in_routes])
         header = header << '' if content.first != ''
         magic_comments_map << '' if magic_comments_map.any?
@@ -178,11 +152,14 @@ module AnnotateRoutes
 
         # We're moving something from the top of the file to the bottom, so ditch
         # the spacer we put in the first time around.
-        content.shift if where_header_found == :before && content.first == ''
+        content.shift if header_position == :before && content.first == ''
 
         new_content = magic_comments_map + content + header
       end
 
+      # Make sure we end on a trailing newline.
+      new_content << '' unless new_content.last == ''
+
       new_content
     end
 
@@ -203,24 +180,6 @@ module AnnotateRoutes
       routes_map
     end
 
-    # @param [Array<String>] content
-    # @return [Array<String>] all found magic comments
-    # @return [Array<String>] content without magic comments
-    def extract_magic_comments_from_array(content_array)
-      magic_comments = []
-      new_content = []
-
-      content_array.map do |row|
-        if row =~ magic_comment_matcher
-          magic_comments << row.strip
-        else
-          new_content << row
-        end
-      end
-
-      [magic_comments, new_content]
-    end
-
     def content(line, maxs, options = {})
       return line.rstrip unless options[:format_markdown]
 
@@ -230,22 +189,5 @@ module AnnotateRoutes
         sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
       end.join(' | ')
     end
-
-    def where_header_found(real_content, header_found_at)
-      # By default assume the annotation was found in the middle of the file
-
-      # ... unless we have evidence it was at the beginning ...
-      return real_content, :before if header_found_at == 1
-
-      # ... or that it was at the end.
-      return real_content, :after if header_found_at >= real_content.count
-
-      # and the default
-      return real_content, header_found_at
-    end
-
-    def magic_comment_matcher
-      Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/)
-    end
   end
 end

lib/annotate/annotate_routes/helpers.rb

+module AnnotateRoutes
+  module Helpers
+    MAGIC_COMMENT_MATCHER = Regexp.new(/(^#\s*encoding:.*)|(^# coding:.*)|(^# -\*- coding:.*)|(^# -\*- encoding\s?:.*)|(^#\s*frozen_string_literal:.+)|(^# -\*- frozen_string_literal\s*:.+-\*-)/).freeze
+
+    class << self
+      # TODO: write the method doc using ruby rdoc formats
+      # This method returns an array of 'real_content' and 'header_position'.
+      # 'header_position' will either be :before, :after, or
+      # a number.  If the number is > 0, the
+      # annotation was found somewhere in the
+      # middle of the file.  If the number is
+      # zero, no annotation was found.
+      def strip_annotations(content)
+        real_content = []
+        mode = :content
+        header_position = 0
+
+        content.split(/\n/, -1).each_with_index do |line, line_number|
+          if mode == :header && line !~ /\s*#/
+            mode = :content
+            real_content << line unless line.blank?
+          elsif mode == :content
+            if line =~ /^\s*#\s*== Route.*$/
+              header_position = line_number + 1 # index start's at 0
+              mode = :header
+            else
+              real_content << line
+            end
+          end
+        end
+
+        real_content_and_header_position(real_content, header_position)
+      end
+
+      # @param [Array<String>] content
+      # @return [Array<String>] all found magic comments
+      # @return [Array<String>] content without magic comments
+      def extract_magic_comments_from_array(content_array)
+        magic_comments = []
+        new_content = []
+
+        content_array.each do |row|
+          if row =~ MAGIC_COMMENT_MATCHER
+            magic_comments << row.strip
+          else
+            new_content << row
+          end
+        end
+
+        [magic_comments, new_content]
+      end
+
+      private
+
+      def real_content_and_header_position(real_content, header_position)
+        # By default assume the annotation was found in the middle of the file
+
+        # ... unless we have evidence it was at the beginning ...
+        return real_content, :before if header_position == 1
+
+        # ... or that it was at the end.
+        return real_content, :after if header_position >= real_content.count
+
+        # and the default
+        return real_content, header_position
+      end
+    end
+  end
+end

lib/annotate/constants.rb

+module Annotate
+  module Constants
+    TRUE_RE = /^(true|t|yes|y|1)$/i.freeze
+
+    ##
+    # The set of available options to customize the behavior of Annotate.
+    #
+    POSITION_OPTIONS = [
+      :position_in_routes, :position_in_class, :position_in_test,
+      :position_in_fixture, :position_in_factory, :position,
+      :position_in_serializer
+    ].freeze
+
+    FLAG_OPTIONS = [
+      :show_indexes, :simple_indexes, :include_version, :exclude_tests,
+      :exclude_fixtures, :exclude_factories, :ignore_model_sub_dir,
+      :format_bare, :format_rdoc, :format_yard, :format_markdown, :sort, :force, :frozen,
+      :trace, :timestamp, :exclude_serializers, :classified_sort,
+      :show_foreign_keys, :show_complete_foreign_keys,
+      :exclude_scaffolds, :exclude_controllers, :exclude_helpers,
+      :exclude_sti_subclasses, :ignore_unknown_models, :with_comment
+    ].freeze
+
+    OTHER_OPTIONS = [
+      :additional_file_patterns, :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close,
+      :wrapper, :routes, :models, :hide_limit_column_types, :hide_default_column_types,
+      :ignore_routes, :active_admin
+    ].freeze
+
+    PATH_OPTIONS = [
+      :require, :model_dir, :root_dir
+    ].freeze
+
+    ALL_ANNOTATE_OPTIONS = [
+      POSITION_OPTIONS, FLAG_OPTIONS, OTHER_OPTIONS, PATH_OPTIONS
+    ].freeze
+  end
+end

lib/annotate/helpers.rb

+module Annotate
+  # Class for holding helper methods. Done to make lib/annotate.rb less bloated.
+  class Helpers
+    class << self
+      def skip_on_migration?
+        ENV['ANNOTATE_SKIP_ON_DB_MIGRATE'] =~ Constants::TRUE_RE || ENV['skip_on_db_migrate'] =~ Constants::TRUE_RE
+      end
+
+      def include_routes?
+        ENV['routes'] =~ Constants::TRUE_RE
+      end
+
+      def include_models?
+        ENV['models'] =~ Constants::TRUE_RE
+      end
+
+      def true?(val)
+        val.present? && Constants::TRUE_RE.match?(val)
+      end
+
+      def fallback(*args)
+        args.detect(&:present?)
+      end
+
+      def reset_options(options)
+        options.flatten.each { |key| ENV[key.to_s] = nil }
+      end
+    end
+  end
+end

lib/annotate/version.rb

 module Annotate
   def self.version
-    '2.7.5'
+    '3.1.1'
   end
 end

lib/generators/annotate/templates/auto_annotate_models.rake

@@ -7,7 +7,10 @@ if Rails.env.development?
     # You can override any of these by setting an environment variable of the
     # same name.
     Annotate.set_defaults(
+      'active_admin'                => 'false',
+      'additional_file_patterns'    => [],
       'routes'                      => 'false',
+      'models'                      => 'true',
       'position_in_routes'          => 'before',
       'position_in_class'           => 'before',
       'position_in_test'            => 'before',
@@ -39,6 +42,7 @@ if Rails.env.development?
       'skip_on_db_migrate'          => 'false',
       'format_bare'                 => 'true',
       'format_rdoc'                 => 'false',
+      'format_yard'                 => 'false',
       'format_markdown'             => 'false',
       'sort'                        => 'false',
       'force'                       => 'false',

lib/tasks/annotate_models.rake

@@ -11,45 +11,47 @@ task annotate_models: :environment do
   require "#{annotate_lib}/annotate/active_record_patch"
 
   options = {is_rake: true}
-  ENV['position'] = options[:position] = Annotate.fallback(ENV['position'], 'before')
-  options[:position_in_class] = Annotate.fallback(ENV['position_in_class'], ENV['position'])
-  options[:position_in_fixture] = Annotate.fallback(ENV['position_in_fixture'], ENV['position'])
-  options[:position_in_factory] = Annotate.fallback(ENV['position_in_factory'], ENV['position'])
-  options[:position_in_test] = Annotate.fallback(ENV['position_in_test'], ENV['position'])
-  options[:position_in_serializer] = Annotate.fallback(ENV['position_in_serializer'], ENV['position'])
-  options[:show_foreign_keys] = Annotate.true?(ENV['show_foreign_keys'])
-  options[:show_complete_foreign_keys] = Annotate.true?(ENV['show_complete_foreign_keys'])
-  options[:show_indexes] = Annotate.true?(ENV['show_indexes'])
-  options[:simple_indexes] = Annotate.true?(ENV['simple_indexes'])
+  ENV['position'] = options[:position] = Annotate::Helpers.fallback(ENV['position'], 'before')
+  options[:additional_file_patterns] = ENV['additional_file_patterns'] ? ENV['additional_file_patterns'].split(',') : []
+  options[:position_in_class] = Annotate::Helpers.fallback(ENV['position_in_class'], ENV['position'])
+  options[:position_in_fixture] = Annotate::Helpers.fallback(ENV['position_in_fixture'], ENV['position'])
+  options[:position_in_factory] = Annotate::Helpers.fallback(ENV['position_in_factory'], ENV['position'])
+  options[:position_in_test] = Annotate::Helpers.fallback(ENV['position_in_test'], ENV['position'])
+  options[:position_in_serializer] = Annotate::Helpers.fallback(ENV['position_in_serializer'], ENV['position'])
+  options[:show_foreign_keys] = Annotate::Helpers.true?(ENV['show_foreign_keys'])
+  options[:show_complete_foreign_keys] = Annotate::Helpers.true?(ENV['show_complete_foreign_keys'])
+  options[:show_indexes] = Annotate::Helpers.true?(ENV['show_indexes'])
+  options[:simple_indexes] = Annotate::Helpers.true?(ENV['simple_indexes'])
   options[:model_dir] = ENV['model_dir'] ? ENV['model_dir'].split(',') : ['app/models']
   options[:root_dir] = ENV['root_dir']
-  options[:include_version] = Annotate.true?(ENV['include_version'])
+  options[:include_version] = Annotate::Helpers.true?(ENV['include_version'])
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
-  options[:exclude_tests] = Annotate.true?(ENV['exclude_tests'])
-  options[:exclude_factories] = Annotate.true?(ENV['exclude_factories'])
-  options[:exclude_fixtures] = Annotate.true?(ENV['exclude_fixtures'])
-  options[:exclude_serializers] = Annotate.true?(ENV['exclude_serializers'])
-  options[:exclude_scaffolds] = Annotate.true?(ENV['exclude_scaffolds'])
-  options[:exclude_controllers] = Annotate.true?(ENV.fetch('exclude_controllers', 'true'))
-  options[:exclude_helpers] = Annotate.true?(ENV.fetch('exclude_helpers', 'true'))
-  options[:exclude_sti_subclasses] = Annotate.true?(ENV['exclude_sti_subclasses'])
-  options[:ignore_model_sub_dir] = Annotate.true?(ENV['ignore_model_sub_dir'])
-  options[:format_bare] = Annotate.true?(ENV['format_bare'])
-  options[:format_rdoc] = Annotate.true?(ENV['format_rdoc'])
-  options[:format_markdown] = Annotate.true?(ENV['format_markdown'])
-  options[:sort] = Annotate.true?(ENV['sort'])
-  options[:force] = Annotate.true?(ENV['force'])
-  options[:frozen] = Annotate.true?(ENV['frozen'])
-  options[:classified_sort] = Annotate.true?(ENV['classified_sort'])
-  options[:trace] = Annotate.true?(ENV['trace'])
-  options[:wrapper_open] = Annotate.fallback(ENV['wrapper_open'], ENV['wrapper'])
-  options[:wrapper_close] = Annotate.fallback(ENV['wrapper_close'], ENV['wrapper'])
+  options[:exclude_tests] = Annotate::Helpers.true?(ENV['exclude_tests'])
+  options[:exclude_factories] = Annotate::Helpers.true?(ENV['exclude_factories'])
+  options[:exclude_fixtures] = Annotate::Helpers.true?(ENV['exclude_fixtures'])
+  options[:exclude_serializers] = Annotate::Helpers.true?(ENV['exclude_serializers'])
+  options[:exclude_scaffolds] = Annotate::Helpers.true?(ENV['exclude_scaffolds'])
+  options[:exclude_controllers] = Annotate::Helpers.true?(ENV.fetch('exclude_controllers', 'true'))
+  options[:exclude_helpers] = Annotate::Helpers.true?(ENV.fetch('exclude_helpers', 'true'))
+  options[:exclude_sti_subclasses] = Annotate::Helpers.true?(ENV['exclude_sti_subclasses'])
+  options[:ignore_model_sub_dir] = Annotate::Helpers.true?(ENV['ignore_model_sub_dir'])
+  options[:format_bare] = Annotate::Helpers.true?(ENV['format_bare'])
+  options[:format_rdoc] = Annotate::Helpers.true?(ENV['format_rdoc'])
+  options[:format_yard] = Annotate::Helpers.true?(ENV['format_yard'])
+  options[:format_markdown] = Annotate::Helpers.true?(ENV['format_markdown'])
+  options[:sort] = Annotate::Helpers.true?(ENV['sort'])
+  options[:force] = Annotate::Helpers.true?(ENV['force'])
+  options[:frozen] = Annotate::Helpers.true?(ENV['frozen'])
+  options[:classified_sort] = Annotate::Helpers.true?(ENV['classified_sort'])
+  options[:trace] = Annotate::Helpers.true?(ENV['trace'])
+  options[:wrapper_open] = Annotate::Helpers.fallback(ENV['wrapper_open'], ENV['wrapper'])
+  options[:wrapper_close] = Annotate::Helpers.fallback(ENV['wrapper_close'], ENV['wrapper'])
   options[:ignore_columns] = ENV.fetch('ignore_columns', nil)
   options[:ignore_routes] = ENV.fetch('ignore_routes', nil)
-  options[:hide_limit_column_types] = Annotate.fallback(ENV['hide_limit_column_types'], '')
-  options[:hide_default_column_types] = Annotate.fallback(ENV['hide_default_column_types'], '')
-  options[:with_comment] = Annotate.true?(ENV['with_comment'])
-  options[:ignore_unknown_models] = Annotate.true?(ENV.fetch('ignore_unknown_models', 'false'))
+  options[:hide_limit_column_types] = Annotate::Helpers.fallback(ENV['hide_limit_column_types'], '')
+  options[:hide_default_column_types] = Annotate::Helpers.fallback(ENV['hide_default_column_types'], '')
+  options[:with_comment] = Annotate::Helpers.true?(ENV['with_comment'])
+  options[:ignore_unknown_models] = Annotate::Helpers.true?(ENV.fetch('ignore_unknown_models', 'false'))
 
   AnnotateModels.do_annotations(options)
 end
@@ -63,6 +65,6 @@ task remove_annotation: :environment do
   options[:model_dir] = ENV['model_dir']
   options[:root_dir] = ENV['root_dir']
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
-  options[:trace] = Annotate.true?(ENV['trace'])
+  options[:trace] = Annotate::Helpers.true?(ENV['trace'])
   AnnotateModels.remove_annotations(options)
 end

lib/tasks/annotate_models_migrate.rake

@@ -23,11 +23,11 @@ module Annotate
     @@working = false
 
     def self.update_annotations
-      unless @@working || Annotate.skip_on_migration?
+      unless @@working || Annotate::Helpers.skip_on_migration?
         @@working = true
 
-        self.update_models if Annotate.include_models?
-        self.update_routes if Annotate.include_routes?
+        self.update_models if Annotate::Helpers.include_models?
+        self.update_routes if Annotate::Helpers.include_routes?
       end
     end
 

lib/tasks/annotate_routes.rake

@@ -4,12 +4,12 @@ task :annotate_routes => :environment do
   require "#{annotate_lib}/annotate/annotate_routes"
 
   options={}
-  ENV['position'] = options[:position] = Annotate.fallback(ENV['position'], 'before')
-  options[:position_in_routes] = Annotate.fallback(ENV['position_in_routes'], ENV['position'])
-  options[:ignore_routes] = Annotate.fallback(ENV['ignore_routes'],  nil)
+  ENV['position'] = options[:position] = Annotate::Helpers.fallback(ENV['position'], 'before')
+  options[:position_in_routes] = Annotate::Helpers.fallback(ENV['position_in_routes'], ENV['position'])
+  options[:ignore_routes] = Annotate::Helpers.fallback(ENV['ignore_routes'],  nil)
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
-  options[:wrapper_open] = Annotate.fallback(ENV['wrapper_open'], ENV['wrapper'])
-  options[:wrapper_close] = Annotate.fallback(ENV['wrapper_close'], ENV['wrapper'])
+  options[:wrapper_open] = Annotate::Helpers.fallback(ENV['wrapper_open'], ENV['wrapper'])
+  options[:wrapper_close] = Annotate::Helpers.fallback(ENV['wrapper_close'], ENV['wrapper'])
   AnnotateRoutes.do_annotations(options)
 end
 

spec/fixtures/database.yml

-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 1
-  timeout: 5000
-
-test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 1
-  timeout: 5000

spec/fixtures/rails32_boot.rb

-require 'rubygems'
-
-# Set up gems listed in the Gemfile.
-ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
-
-require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])

spec/fixtures/rails32_unified_initializer.rb

-# secret_token.rb
-TestApp::Application.config.secret_token = '4768b21141022d583b141fde0db7e0b31759321b7fce459963914fdd82db248ea0318d9568030dcde70d404d4e86003ce5f51a7a83c8130842e5a97062b68c3c'
-
-# session_store.rb
-TestApp::Application.config.session_store :cookie_store, key: '_session'
-
-# wrap_parameters.rb
-ActiveSupport.on_load(:active_record) { self.include_root_in_json = false }

spec/fixtures/rails_328_gemfile

-# This file is a hybrid file meant for live debugging without going through an
-# actual RSpec run, and for being used in an RSpec run.  To change it, change
-# template.Gemfile and run 'rake templates:rebuild' which will do so for all
-# templates in all build scenarios.
-#
-# ALSO, be sure NOT to commit any changes that happen in app/* or config/*
-# when debugging this way as that will defeat the point of the automated tests!
-#
-# In fact, before running RSpec again after manual testing, you should run
-# 'rake integration:clober' to reset modified files to their pristine state,
-# and remove cruft that may interfere with the build.
-source 'https://rubygems.org'
-
-gem 'rails', '3.2.8'
-
-gem 'sqlite3'
-
-group :development do
-  if(ENV['AUTOMATED_TEST'] && ENV['AUTOMATED_TEST'] != '')
-    gem 'annotate', :path => ENV['AUTOMATED_TEST']
-  else
-    gem 'annotate', :path => '../../..'
-  end
-end

spec/fixtures/rails_328_gemfile.lock

-PATH
-  remote: ../../..
-  specs:
-    annotate (2.5.0)
-      activerecord
-      rake
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (3.2.8)
-      actionpack (= 3.2.8)
-      mail (~> 2.4.4)
-    actionpack (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.4)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.2)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.3)
-    activemodel (3.2.8)
-      activesupport (= 3.2.8)
-      builder (~> 3.0.0)
-    activerecord (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.8)
-      activemodel (= 3.2.8)
-      activesupport (= 3.2.8)
-    activesupport (3.2.8)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.4)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.8)
-      actionmailer (= 3.2.8)
-      actionpack (= 3.2.8)
-      activerecord (= 3.2.8)
-      activeresource (= 3.2.8)
-      activesupport (= 3.2.8)
-      bundler (~> 1.0)
-      railties (= 3.2.8)
-    railties (3.2.8)
-      actionpack (= 3.2.8)
-      activesupport (= 3.2.8)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (>= 0.14.6, < 2.0)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.16.0)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  annotate!
-  rails (= 3.2.8)
-  sqlite3

spec/fixtures/rails_32_development.rb

-TestApp::Application.configure do
-  config.action_dispatch.best_standards_support = :builtin
-  config.active_record.auto_explain_threshold_in_seconds = 0.5
-  config.active_record.mass_assignment_sanitizer = :strict
-  config.active_support.deprecation = :log
-  config.cache_classes = false
-  config.consider_all_requests_local = true
-  config.whiny_nils = true
-end

spec/fixtures/rails_32_environment.rb

-# Load the rails application
-require File.expand_path('../application', __FILE__)
-
-# Initialize the rails application
-TestApp::Application.initialize!

spec/fixtures/rails_32_rails

-#!/usr/bin/env ruby
-# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
-
-APP_PATH = File.expand_path('../../config/application',  __FILE__)
-require File.expand_path('../../config/boot',  __FILE__)
-require 'rails/commands'

spec/fixtures/rails_32_rakefile

-#!/usr/bin/env rake
-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require File.expand_path('../config/application', __FILE__)
-
-TestApp::Application.load_tasks

spec/fixtures/rails_32_test.rb

-TestApp::Application.configure do
-  config.action_dispatch.show_exceptions = false
-  config.active_record.mass_assignment_sanitizer = :strict
-  config.active_support.deprecation = :stderr
-  config.cache_classes = true
-  config.consider_all_requests_local = true
-  config.serve_static_assets = true
-  config.static_cache_control = "public, max-age=3600"
-  config.whiny_nils = true
-end

spec/fixtures/rails_32_test_helper.rb

-ENV["RAILS_ENV"] = "test"
-require File.expand_path('../../config/environment', __FILE__)
-require 'rails/test_help'
-
-class ActiveSupport::TestCase
-end

spec/fixtures/rails_32old_application.rb

-require File.expand_path('../boot', __FILE__)
-
-require "active_record/railtie"
-require "rails/test_unit/railtie"
-
-if defined?(Bundler)
-  # If you precompile assets before deploying to production, use this line
-  Bundler.require(*Rails.groups(:assets => %w(development test)))
-end
-
-module TestApp
-  class Application < Rails::Application
-    config.assets.enabled = false
-  end
-end

spec/fixtures/rvmrc.sh

-# This file is a hybrid file meant for live debugging without going through an
-# actual RSpec run, and for being used in an RSpec run.  To change it, change
-# template..rvmrc and run 'rake templates:rebuild' which will do so for all
-# templates in all build scenarios.
-#
-# ALSO, be sure NOT to commit any changes that happen in app/* or config/*
-# when debugging this way as that will defeat the point of the automated tests!
-#
-# In fact, before running RSpec again after manual testing, you should run
-# 'rake integration:clober' to reset modified files to their pristine state,
-# and remove cruft that may interfere with the build.
-if [ "$(type rvm | head -1)" != "rvm is a function" ]; then
-  # First, make sure we're not in 'sh' mode (I.E. strict-superset-of-Bourne
-  # mode), as RVM doesn't like this...
-  shopt -u -o posix
-  # Now, load RVM...
-  source $HOME/.rvm/scripts/rvm
-fi
-
-# Now, switch to our preferred Ruby and gemset...
-GEMSET=annotate_test_$(basename $(pwd) | perl -pse 's/\.//g')
-rvm use --create ${rvm_ruby_string}@${GEMSET}
-
-# Early-out when we just want to wipe the gemsets clean...
-if [ "$SKIP_BUNDLER" != "1" ]; then
-  # ... and make sure everything's up-to-date, that it'll use the right Gemfile,
-  # etc.
-  if [ $(which bundle) == "" ]; then
-    gem install bundler
-  fi
-  export BUNDLE_GEMFILE=./Gemfile
-  # The apparently superfluous --gemfile param is to work around some stupidness
-  # in Bundler.  Specifically it gets very confused about BUNDLE_GEMFILE not
-  # pointing at an absolute path.
-  #
-  # The special-case handling of bin being empty is to support debug workflows
-  # where the gemset will in fact already be set up, but the binstubs get nuked.
-  mkdir -p bin
-  if [ $(($(ls bin | wc -l) + 0)) -eq 0 ]; then
-    bundle install --binstubs=bin --gemfile ./Gemfile
-  else
-    bundle check || bundle install --binstubs=bin --gemfile ./Gemfile
-  fi
-fi

spec/integration/common_validation.rb

-module Annotate
-  module Validations
-    module Common
-      def self.test_commands
-        'bin/annotate && bin/annotate --routes'
-      end
-
-      def self.verify_output(output)
-        output.should =~ /Annotated \(1\): Task/
-        output.should =~ /Route file annotated./
-      end
-
-      def self.verify_files(which_files, test_rig, schema_annotation, routes_annotation, place_before = true)
-        check_task_model(test_rig, schema_annotation, place_before) if which_files[:model]
-        check_task_unittest(test_rig, schema_annotation, place_before) if which_files[:test]
-        check_task_fixture(test_rig, schema_annotation, place_before) if which_files[:fixture]
-        check_task_factory(test_rig, schema_annotation, place_before) if which_files[:factory]
-        check_routes(test_rig, routes_annotation, place_before) if which_files[:routes]
-      end
-
-      def self.check_task_model(test_rig, annotation, place_before = true)
-        model = apply_annotation(test_rig, 'app/models/task.rb', annotation, place_before)
-        File.read('app/models/task.rb').should == model
-      end
-
-      def self.check_routes(test_rig, annotation, place_before = true)
-        routes = apply_annotation(test_rig, 'config/routes.rb', annotation, place_before)
-        File.read('config/routes.rb')
-            .sub(/\d{4}-\d{2}-\d{2} \d{2}:\d{2}/, 'YYYY-MM-DD HH:MM')
-            .should == routes
-      end
-
-      def self.check_task_unittest(test_rig, annotation, place_before = true)
-        unittest = apply_annotation(test_rig, 'test/unit/task_test.rb', annotation, place_before)
-        File.read('test/unit/task_test.rb').should == unittest
-      end
-
-      def self.check_task_modeltest(test_rig, annotation, place_before=true)
-        unittest = apply_annotation(test_rig, 'test/models/task_test.rb', annotation, place_before)
-        File.read('test/models/task_test.rb').should == unittest
-      end
-
-      def self.check_task_factory(test_rig, annotation, place_before=true)
-        fixture = apply_annotation(test_rig, 'test/factories/tasks.rb', annotation, place_before)
-        File.read('test/factories/tasks.rb').should == fixture
-      end
-
-      def self.check_task_fixture(test_rig, annotation, place_before = true)
-        fixture = apply_annotation(test_rig, 'test/fixtures/tasks.yml', annotation, place_before)
-        File.read('test/fixtures/tasks.yml').should == fixture
-      end
-
-      def self.apply_annotation(test_rig, fname, annotation, place_before = true)
-        corpus = File.read(File.join(test_rig, fname))
-        if place_before
-          annotation + "\n" + corpus
-        else
-          corpus + "\n" + annotation
-        end
-      end
-    end
-  end
-end
-
-module Annotate
-  module Validations
-    class Base
-      def self.test_commands
-        Annotate::Validations::Common.test_commands
-      end
-
-      def self.verify_output(output)
-        Annotate::Validations::Common.verify_output(output)
-      end
-
-      def self.verify_files(test_rig)
-        Annotate::Validations::Common.verify_files(
-          {
-            model: true,
-            test: true,
-            fixture: true,
-            factory: false,
-            routes: true
-          }, test_rig, schema_annotation, route_annotation, true
-        )
-      end
-
-      def self.foo
-        require 'pry'
-        require 'pry-coolline'
-      end
-    end
-  end
-end

spec/integration/integration_helper.rb

+class IntegrationHelper
+  MIN_RUBY_VERSIONS = {
+    'rails_5.2.4.1' => '>= 2.2.2',
+    'rails_6.0.2.1' => '>= 2.5.0'
+  }.freeze
+
+  def self.able_to_run?(file_path, ruby_version)
+    file_name = File.basename(file_path)
+    rails_app = File.basename(file_name, '_spec.rb')
+    ruby_dependency = MIN_RUBY_VERSIONS[rails_app]
+
+    required_version = Gem::Dependency.new('', ruby_dependency)
+    able_to_run = required_version.match?('', ruby_version)
+
+    unless able_to_run
+      output = "\n" \
+            "Skipping running the integration test for #{file_name}.\n" \
+            "The current version of Ruby is #{ruby_version}, " \
+            "but the integration test requires Ruby #{ruby_dependency}."
+      puts output
+    end
+
+    able_to_run
+  end
+end

spec/integration/integration_spec.rb

-# Smoke test to assure basic functionality works on a variety of Rails versions.
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'spec_helper'
-require 'files'
-require 'wrong'
-require 'rake'
-include Files
-include Wrong::D
-
-BASEDIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
-RVM_BIN = `which rvm`.chomp
-USING_RVM = (RVM_BIN != '')
-
-CURRENT_RUBY = `rvm-prompt i v p 2>/dev/null`.chomp
-ENV['rvm_pretty_print_flag'] = '0'
-ENV['BUNDLE_GEMFILE'] = './Gemfile'
-
-describe "annotate inside Rails, using #{CURRENT_RUBY}" do
-  chosen_scenario = nil
-  unless ENV['SCENARIO'].blank?
-    chosen_scenario = File.expand_path(ENV['SCENARIO'])
-    raise "Can't find specified scenario '#{chosen_scenario}'!" unless File.directory?(chosen_scenario)
-  end
-
-  Annotate::Integration::SCENARIOS.each do |test_rig, base_dir, test_name|
-    next if chosen_scenario && chosen_scenario != test_rig
-    it "works under #{test_name}" do
-      unless USING_RVM
-        skip 'Must have RVM installed.'
-        next
-      end
-
-      # Don't proceed if the working copy is dirty!
-      expect(Annotate::Integration.clean?(test_rig)).to eq(true)
-
-      skip 'temporarily ignored until Travis can run them'
-
-      Bundler.with_clean_env do
-        dir base_dir do
-          temp_dir = Dir.pwd
-          expect(File.basename(temp_dir)).to eq(base_dir)
-
-          # Delete cruft from hands-on debugging...
-          Annotate::Integration.nuke_cruft(test_rig)
-
-          # Copy everything to our test directory...
-          exclusions = ["#{test_rig}/.", "#{test_rig}/.."]
-
-          files = (FileList["#{test_rig}/*", "#{test_rig}/.*"] - exclusions).to_a
-          # We want to NOT preserve symlinks during this copy...
-          system("rsync -aL #{files.shelljoin} #{temp_dir.shellescape}")
-
-          # By default, rvm_ruby_string isn't inherited over properly, so let's
-          # make sure it's there so our .rvmrc will work.
-          ENV['rvm_ruby_string'] = CURRENT_RUBY
-
-          require base_dir.to_s # Will get "#{base_dir}.rb"...
-          klass = "Annotate::Validations::#{base_dir.tr('.', '_').classify}".constantize
-
-          Dir.chdir(temp_dir) do
-            # bash is required by rvm
-            # the shopt command forces us out of "strict sh" mode
-            commands = <<-BASH
-export AUTOMATED_TEST="#{BASEDIR}";
-shopt -u -o posix;
-source .rvmrc &&
-(bundle check || bundle install) &&
-#{klass.test_commands}
-            BASH
-            output = `/usr/bin/env bash -c '#{commands}' 2>&1`.chomp
-            klass.verify_output(output)
-            klass.verify_files(test_rig)
-          end
-        end
-      end
-    end
-  end
-end

spec/integration/rails_2.3_with_bundler.rb

-require 'common_validation'
-
-module Annotate
-  module Validations
-    class Rails23WithBundler < Base
-      def self.schema_annotation
-        <<-RUBY
-# == Schema Information
-#
-# Table name: tasks
-#
-#  id         :integer          not null, primary key
-#  content    :string(255)
-#  created_at :datetime
-#  updated_at :datetime
-#
-RUBY
-      end
-
-      def self.route_annotation
-        <<-RUBY
-# == Route Map (Updated YYYY-MM-DD HH:MM)
-#
-#     tasks GET    /tasks(.:format)          {:controller=>"tasks", :action=>"index"}
-#           POST   /tasks(.:format)          {:controller=>"tasks", :action=>"create"}
-#  new_task GET    /tasks/new(.:format)      {:controller=>"tasks", :action=>"new"}
-# edit_task GET    /tasks/:id/edit(.:format) {:controller=>"tasks", :action=>"edit"}
-#      task GET    /tasks/:id(.:format)      {:controller=>"tasks", :action=>"show"}
-#           PUT    /tasks/:id(.:format)      {:controller=>"tasks", :action=>"update"}
-#           DELETE /tasks/:id(.:format)      {:controller=>"tasks", :action=>"destroy"}
-#
-RUBY
-      end
-    end
-  end
-end

spec/integration/rails_2.3_with_bundler/.gitignore

-tmp/*
-!tmp/.gitkeep
-
-log/*
-!log/.gitkeep

spec/integration/rails_2.3_with_bundler/.rvmrc

-../../fixtures/rvmrc.sh
\ No newline at end of file

spec/integration/rails_2.3_with_bundler/Gemfile

-# This file is a hybrid file meant for live debugging without going through an
-# actual RSpec run, and for being used in an RSpec run.  To change it, change
-# template.Gemfile and run 'rake templates:rebuild' which will do so for all
-# templates in all build scenarios.
-#
-# ALSO, be sure NOT to commit any changes that happen in app/* or config/*
-# when debugging this way as that will defeat the point of the automated tests!
-#
-# In fact, before running RSpec again after manual testing, you should run
-# 'rake integration:clober' to reset modified files to their pristine state,
-# and remove cruft that may interfere with the build.
-source 'https://rubygems.org'
-
-gem 'bundler'
-gem 'rake', '~>0.8.7', :require => false
-gem 'rails', '~>2.3.14'
-gem 'sqlite3'
-
-group :development do
-  if(ENV['AUTOMATED_TEST'] && ENV['AUTOMATED_TEST'] != '')
-    gem 'annotate', :path => ENV['AUTOMATED_TEST']
-  else
-    gem 'annotate', :path => '../../..'
-  end
-end

spec/integration/rails_2.3_with_bundler/Gemfile.lock

-PATH
-  remote: ../../..
-  specs:
-    annotate (2.5.0)
-      activerecord
-      rake
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (2.3.14)
-      actionpack (= 2.3.14)
-    actionpack (2.3.14)
-      activesupport (= 2.3.14)
-      rack (~> 1.1.0)
-    activerecord (2.3.14)
-      activesupport (= 2.3.14)
-    activeresource (2.3.14)
-      activesupport (= 2.3.14)
-    activesupport (2.3.14)
-    rack (1.1.3)
-    rails (2.3.14)
-      actionmailer (= 2.3.14)
-      actionpack (= 2.3.14)
-      activerecord (= 2.3.14)
-      activeresource (= 2.3.14)
-      activesupport (= 2.3.14)
-      rake (>= 0.8.3)
-    rake (0.8.7)
-    sqlite3 (1.3.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  annotate!
-  bundler
-  rails (~> 2.3.14)
-  rake (~> 0.8.7)
-  sqlite3

spec/integration/rails_2.3_with_bundler/Rakefile

-# Add your own tasks in files placed in lib/tasks ending in .rake,
-# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
-
-require(File.join(File.dirname(__FILE__), 'config', 'boot'))
-
-require 'rake'
-require 'rake/testtask'
-require 'rake/rdoctask'
-
-require 'tasks/rails'

spec/integration/rails_2.3_with_bundler/config/boot.rb

-# Don't change this file!
-# Configure your app in config/environment.rb and config/environments/*.rb
-
-RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
-
-module Rails
-  class << self
-    def boot!
-      unless booted?
-        preinitialize
-        pick_boot.run
-      end
-    end
-
-    def booted?
-      defined? Rails::Initializer
-    end
-
-    def pick_boot
-      (vendor_rails? ? VendorBoot : GemBoot).new
-    end
-
-    def vendor_rails?
-      File.exist?("#{RAILS_ROOT}/vendor/rails")
-    end
-
-    def preinitialize
-      load(preinitializer_path) if File.exist?(preinitializer_path)
-    end
-
-    def preinitializer_path
-      "#{RAILS_ROOT}/config/preinitializer.rb"
-    end
-  end
-
-  class Boot
-    def run
-      load_initializer
-      Rails::Initializer.run(:set_load_path)
-    end
-  end
-
-  class VendorBoot < Boot
-    def load_initializer
-      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
-      Rails::Initializer.run(:install_gem_spec_stubs)
-      Rails::GemDependency.add_frozen_gem_path
-    end
-  end
-
-  class GemBoot < Boot
-    def load_initializer
-      self.class.load_rubygems
-      load_rails_gem
-      require 'initializer'
-    end
-
-    def load_rails_gem
-      if version = self.class.gem_version
-        gem 'rails', version
-      else
-        gem 'rails'
-      end
-    rescue Gem::LoadError => e
-      if e.message =~ /Could not find RubyGem rails/
-        $stderr.puts "Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed."
-        exit 1
-      else
-        raise
-      end
-    end
-
-    class << self
-      def rubygems_version
-        Gem::RubyGemsVersion rescue nil
-      end
-
-      def gem_version
-        if defined? RAILS_GEM_VERSION
-          RAILS_GEM_VERSION
-        elsif ENV.include?('RAILS_GEM_VERSION')
-          ENV['RAILS_GEM_VERSION']
-        else
-          parse_gem_version(read_environment_rb)
-        end
-      end
-
-      def load_rubygems
-        min_version = '1.3.2'
-        require 'rubygems'
-        unless rubygems_version >= min_version
-          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
-          exit 1
-        end
-
-      rescue LoadError
-        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
-        exit 1
-      end
-
-      def parse_gem_version(text)
-        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
-      end
-
-      private
-        def read_environment_rb
-          File.read("#{RAILS_ROOT}/config/environment.rb")
-        end
-    end
-  end
-end
-
-# All that for this:
-class Rails::Boot
-  def run
-    load_initializer
-
-    Rails::Initializer.class_eval do
-      def load_gems
-        @bundler_loaded ||= Bundler.require :default, Rails.env
-      end
-    end
-
-    Rails::Initializer.run(:set_load_path)
-  end
-end
-
-Rails.boot!

spec/integration/rails_2.3_with_bundler/config/database.yml

-# SQLite version 3.x
-#   gem install sqlite3-ruby (not necessary on OS X Leopard)
-development:
-  adapter: sqlite3
-  database: db/development.sqlite3
-  pool: 1
-  timeout: 5000
-
-test:
-  adapter: sqlite3
-  database: db/test.sqlite3
-  pool: 1
-  timeout: 5000

spec/integration/rails_2.3_with_bundler/config/environment.rb

-# Be sure to restart your server when you modify this file
-
-# Specifies gem version of Rails to use when vendor/rails is not present
-RAILS_GEM_VERSION = '2.3.14' unless defined? RAILS_GEM_VERSION
-
-# Bootstrap the Rails environment, frameworks, and default configuration
-require File.join(File.dirname(__FILE__), 'boot')
-
-Rails::Initializer.run do |config|
-  config.frameworks -= [ :active_resource, :action_mailer ]
-end

spec/integration/rails_2.3_with_bundler/config/environments/development.rb

-config.cache_classes = false
-config.whiny_nils = true
-config.action_controller.consider_all_requests_local = true
-config.action_controller.perform_caching             = false
-config.action_view.debug_rjs                         = true
-config.action_mailer.raise_delivery_errors = false

spec/integration/rails_2.3_with_bundler/config/environments/test.rb

-config.cache_classes = true
-config.whiny_nils = true
-config.action_controller.consider_all_requests_local = true
-config.action_controller.perform_caching             = false
-config.action_controller.allow_forgery_protection    = false
-config.action_view.cache_template_loading            = true
-config.action_mailer.delivery_method = :test

spec/integration/rails_2.3_with_bundler/config/initializers/unified_initializer.rb

-# new_rails_defaults.rb
-if defined?(ActiveRecord)
-  ActiveRecord::Base.include_root_in_json = true
-  ActiveRecord::Base.store_full_sti_class = true
-end
-ActionController::Routing.generate_best_match = false
-ActiveSupport.use_standard_json_time_format = true
-ActiveSupport.escape_html_entities_in_json = false
-
-# session_store.rb
-ActionController::Base.session = {
-  :key         => '_session',
-  :secret      => 'a61ce930be7219beee70d3e3411e0794d90ab22d12e87a1f7f50c98ad7b08771ed92e72e1a7299c8ec4795d45d566a39e0a0a1f7e7095e2eeb31320a0c5d7ee5'
-}
-
-# cookie_verification_secret.rb
-ActionController::Base.cookie_verifier_secret = '1b2363a161fbf01041bd9d0b0d9a332e5c7445503c9e89585c8a248698d28054e3918fa77a0206e662629ee9a00d2831949e74801f27ee85ba2116b62b675935';
-
-# Hacks for Ruby 1.9.3...
-MissingSourceFile::REGEXPS << [/^cannot load such file -- (.+)$/i, 1]

spec/integration/rails_2.3_with_bundler/config/routes.rb

-ActionController::Routing::Routes.draw do |map|
-  map.resources :tasks
-end

spec/integration/rails_2.3_with_bundler/db/migrate/20120816085200_create_tasks.rb

-class CreateTasks < ActiveRecord::Migration
-  def self.up
-    create_table :tasks do |t|
-      t.string :content
-
-      t.timestamps
-    end
-  end
-
-  def self.down
-    drop_table :tasks
-  end
-end

spec/integration/rails_2.3_with_bundler/db/schema.rb

-# This file is auto-generated from the current state of the database. Instead of editing this file, 
-# please use the migrations feature of Active Record to incrementally modify your database, and
-# then regenerate this schema definition.
-#
-# Note that this schema.rb definition is the authoritative source for your database schema. If you need
-# to create the application database on another system, you should be using db:schema:load, not running
-# all the migrations from scratch. The latter is a flawed and unsustainable approach (the more migrations
-# you'll amass, the slower it'll run and the greater likelihood for issues).
-#
-# It's strongly recommended to check this file into your version control system.
-
-ActiveRecord::Schema.define(:version => 20120816085200) do
-
-  create_table "tasks", :force => true do |t|
-    t.string   "content"
-    t.datetime "created_at"
-    t.datetime "updated_at"
-  end
-
-end

spec/integration/rails_2.3_with_bundler/script/console

-#!/usr/bin/env ruby
-require File.expand_path('../../config/boot',  __FILE__)
-require 'commands/console'

spec/integration/rails_2.3_with_bundler/test/test_helper.rb

-ENV["RAILS_ENV"] = "test"
-require File.expand_path(File.dirname(__FILE__) + "/../config/environment")
-
-require 'test_help'
-
-class ActiveSupport::TestCase
-end

spec/integration/rails_2.3_with_bundler/test/unit/task_test.rb

-require 'test_helper'
-
-class TaskTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end

spec/integration/rails_3.2.2.rb

-require 'common_validation'
-
-module Annotate
-  module Validations
-    class Rails322 < Base
-      def self.schema_annotation
-        <<-RUBY
-# == Schema Information
-#
-# Table name: tasks
-#
-#  id         :integer          not null, primary key
-#  content    :string(255)
-#  created_at :datetime         not null
-#  updated_at :datetime         not null
-#
-RUBY
-      end
-
-      def self.route_annotation
-        <<-RUBY
-# == Route Map (Updated YYYY-MM-DD HH:MM)
-#
-#     tasks GET    /tasks(.:format)          tasks#index
-#           POST   /tasks(.:format)          tasks#create
-#  new_task GET    /tasks/new(.:format)      tasks#new
-# edit_task GET    /tasks/:id/edit(.:format) tasks#edit
-#      task GET    /tasks/:id(.:format)      tasks#show
-#           PUT    /tasks/:id(.:format)      tasks#update
-#           DELETE /tasks/:id(.:format)      tasks#destroy
-#
-RUBY
-      end
-    end
-  end
-end

spec/integration/rails_3.2.2/.rvmrc

-../../fixtures/rvmrc.sh
\ No newline at end of file

spec/integration/rails_3.2.2/Gemfile

-# This file is a hybrid file meant for live debugging without going through an
-# actual RSpec run, and for being used in an RSpec run.  To change it, change
-# template.Gemfile and run 'rake templates:rebuild' which will do so for all
-# templates in all build scenarios.
-#
-# ALSO, be sure NOT to commit any changes that happen in app/* or config/*
-# when debugging this way as that will defeat the point of the automated tests!
-#
-# In fact, before running RSpec again after manual testing, you should run
-# 'rake integration:clober' to reset modified files to their pristine state,
-# and remove cruft that may interfere with the build.
-source 'https://rubygems.org'
-
-gem 'rails', '3.2.2'
-
-gem 'sqlite3'
-
-group :development do
-  if(ENV['AUTOMATED_TEST'] && ENV['AUTOMATED_TEST'] != '')
-    gem 'annotate', :path => ENV['AUTOMATED_TEST']
-  else
-    gem 'annotate', :path => '../../..'
-  end
-end

spec/integration/rails_3.2.2/Gemfile.lock

-PATH
-  remote: ../../..
-  specs:
-    annotate (2.5.0)
-      activerecord
-      rake
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    actionmailer (3.2.2)
-      actionpack (= 3.2.2)
-      mail (~> 2.4.0)
-    actionpack (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
-      builder (~> 3.0.0)
-      erubis (~> 2.7.0)
-      journey (~> 1.0.1)
-      rack (~> 1.4.0)
-      rack-cache (~> 1.1)
-      rack-test (~> 0.6.1)
-      sprockets (~> 2.1.2)
-    activemodel (3.2.2)
-      activesupport (= 3.2.2)
-      builder (~> 3.0.0)
-    activerecord (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
-      arel (~> 3.0.2)
-      tzinfo (~> 0.3.29)
-    activeresource (3.2.2)
-      activemodel (= 3.2.2)
-      activesupport (= 3.2.2)
-    activesupport (3.2.2)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    arel (3.0.2)
-    builder (3.0.0)
-    erubis (2.7.0)
-    hike (1.2.1)
-    i18n (0.6.0)
-    journey (1.0.4)
-    json (1.7.4)
-    mail (2.4.4)
-      i18n (>= 0.4.0)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.19)
-    multi_json (1.3.6)
-    polyglot (0.3.3)
-    rack (1.4.1)
-    rack-cache (1.2)
-      rack (>= 0.4)
-    rack-ssl (1.3.2)
-      rack
-    rack-test (0.6.1)
-      rack (>= 1.0)
-    rails (3.2.2)
-      actionmailer (= 3.2.2)
-      actionpack (= 3.2.2)
-      activerecord (= 3.2.2)
-      activeresource (= 3.2.2)
-      activesupport (= 3.2.2)
-      bundler (~> 1.0)
-      railties (= 3.2.2)
-    railties (3.2.2)
-      actionpack (= 3.2.2)
-      activesupport (= 3.2.2)
-      rack-ssl (~> 1.3.2)
-      rake (>= 0.8.7)
-      rdoc (~> 3.4)
-      thor (~> 0.14.6)
-    rake (0.9.2.2)
-    rdoc (3.12)
-      json (~> 1.4)
-    sprockets (2.1.3)
-      hike (~> 1.2)
-      rack (~> 1.0)
-      tilt (~> 1.1, != 1.3.0)
-    sqlite3 (1.3.6)
-    thor (0.14.6)
-    tilt (1.3.3)
-    treetop (1.4.10)
-      polyglot
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.33)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  annotate!
-  rails (= 3.2.2)
-  sqlite3

spec/integration/rails_3.2.2/Rakefile

-../../fixtures/rails_32_rakefile
\ No newline at end of file

spec/integration/rails_3.2.2/config/application.rb

-../../../fixtures/rails_32old_application.rb
\ No newline at end of file

spec/integration/rails_3.2.2/config/boot.rb

-../../../fixtures/rails32_boot.rb
\ No newline at end of file

spec/integration/rails_3.2.2/config/database.yml

-../../../fixtures/database.yml
\ No newline at end of file

spec/integration/rails_3.2.2/config/environment.rb

-../../../fixtures/rails_32_environment.rb
\ No newline at end of file

spec/integration/rails_3.2.2/config/environments/development.rb

-../../../../fixtures/rails_32_development.rb
\ No newline at end of file

spec/integration/rails_3.2.2/config/environments/test.rb

-../../../../fixtures/rails_32_test.rb
\ No newline at end of file

spec/integration/rails_3.2.2/config/initializers/unified_initializer.rb

-../../../../fixtures/rails32_unified_initializer.rb
\ No newline at end of file

spec/integration/rails_3.2.2/db/migrate/20120816164927_create_tasks.rb

-../../../../fixtures/20120816164927_create_tasks.rb
\ No newline at end of file

spec/integration/rails_3.2.2/db/schema.rb

-../../../fixtures/rails_32_schema.rb
\ No newline at end of file

spec/integration/rails_3.2.2/script/rails

-../../../fixtures/rails_32_rails
\ No newline at end of file

spec/integration/rails_3.2.2/test/test_helper.rb

-../../../fixtures/rails_32_test_helper.rb
\ No newline at end of file

spec/integration/rails_3.2.2/test/unit/task_test.rb

-require 'test_helper'
-
-class TaskTest < ActiveSupport::TestCase
-  # Replace this with your real tests.
-  test "the truth" do
-    assert true
-  end
-end

spec/integration/rails_3.2.8.rb

-require 'common_validation'
-
-module Annotate
-  module Validations
-    class Rails328 < Base
-      def self.schema_annotation
-        <<-RUBY
-# == Schema Information
-#
-# Table name: tasks
-#
-#  id         :integer          not null, primary key
-#  content    :string(255)
-#  created_at :datetime         not null
-#  updated_at :datetime         not null
-#
-RUBY
-      end
-
-      def self.route_annotation
-        <<-RUBY
-# == Route Map (Updated YYYY-MM-DD HH:MM)
-#
-#     tasks GET    /tasks(.:format)          tasks#index
-#           POST   /tasks(.:format)          tasks#create
-#  new_task GET    /tasks/new(.:format)      tasks#new
-# edit_task GET    /tasks/:id/edit(.:format) tasks#edit
-#      task GET    /tasks/:id(.:format)      tasks#show
-#           PUT    /tasks/:id(.:format)      tasks#update
-#           DELETE /tasks/:id(.:format)      tasks#destroy
-#
-RUBY
-      end
-    end
-  end
-end

spec/integration/rails_3.2.8/.rvmrc

-../../fixtures/rvmrc.sh
\ No newline at end of file

spec/integration/rails_3.2.8/Gemfile

-../../fixtures/rails_328_gemfile
\ No newline at end of file

spec/integration/rails_3.2.8/Gemfile.lock

-../../fixtures/rails_328_gemfile.lock
\ No newline at end of file

spec/integration/rails_3.2.8/Rakefile

-../../fixtures/rails_32_rakefile
\ No newline at end of file

spec/integration/rails_3.2.8/app/models/task.rb

-class Task < ActiveRecord::Base
-  attr_accessible :content
-end

spec/integration/rails_3.2.8/config/application.rb

-require File.expand_path('../boot', __FILE__)
-
-require "active_record/railtie"
-require "rails/test_unit/railtie"
-
-if defined?(Bundler)
-  # If you precompile assets before deploying to production, use this line
-  Bundler.require(*Rails.groups(:assets => %w(development test)))
-end
-
-module TestApp
-  class Application < Rails::Application
-    config.active_record.whitelist_attributes = true
-    config.active_support.escape_html_entities_in_json = true
-    config.assets.enabled = false
-  end
-end

spec/integration/rails_3.2.8/config/boot.rb

-../../../fixtures/rails32_boot.rb
\ No newline at end of file

spec/integration/rails_3.2.8/config/database.yml

-../../../fixtures/database.yml
\ No newline at end of file

spec/integration/rails_3.2.8/config/environment.rb

-../../../fixtures/rails_32_environment.rb
\ No newline at end of file

spec/integration/rails_3.2.8/config/environments/development.rb

-../../../../fixtures/rails_32_development.rb
\ No newline at end of file

spec/integration/rails_3.2.8/config/environments/test.rb

-../../../../fixtures/rails_32_test.rb
\ No newline at end of file