Merge branch 'release/v2.7.2'

.gitignore

+!/spec/integration/*/log/.gitkeep
+!/spec/integration/*/tmp/.gitkeep
+*.gem
 .DS_Store
+.bundle
+.gems
+.rbenv-version
+.ruby-*
+/.idea/
+/.rbx
+/.rvmrc
 /.yardoc/*
-/doc/*
+/Gemfile.lock
 /coverage/*
-/spec/debug.log
-/pkg/*
 /dist
-/Gemfile.lock
-*.gem
-/.idea/
-/.rvmrc
-.bundle
-/.rbx
+/doc/*
+/pkg/*
+/spec/debug.log
 /spec/integration/*/bin/
+/spec/integration/*/db/test.*
 /spec/integration/*/log/*
-!/spec/integration/*/log/.gitkeep
 /spec/integration/*/tmp/*
-!/spec/integration/*/tmp/.gitkeep
-/spec/integration/*/db/test.*
-.rbenv-version
\ No newline at end of file
+.byebug_history

.overcommit.yml

+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+PreCommit:
+ RuboCop:
+   enabled: true
+   on_warn: fail # Treat all warnings as failures
+
+PrePush:
+  RSpec:
+     enabled: true
+     on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

.rbenv-gemsets

+.gems

.rubocop.yml

+inherit_from: ./.rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+    - 'spec/fixtures/**/*'
+    - 'tmp/**/*'

.travis.yml

@@ -4,7 +4,16 @@ rvm:
   - 1.9.3
   - 2.0
   - 2.1
-  - 2.2
-  - 2.3.0-preview1
+  - 2.2.5
+  - 2.3.0
+  - 2.4.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: 1.9.3
 before_install:
-  - rvm @global do gem install bundler
+  - gem update --system
+  - gem update bundler
+script:
+  - bundle exec rubocop && bundle exec rspec

AUTHORS.rdoc

@@ -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.

CHANGELOG.rdoc

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

Gemfile

 source 'https://rubygems.org'
 
-gem 'rake', '>= 10.4.2', :require => false
-gem 'activerecord', '>= 4.2.5', :require => false
+gem 'activerecord', '>= 4.2.5', require: false
+gem 'rake', require: false
 
 group :development do
-  gem 'mg', :require => false
   gem 'bump'
-  platforms :mri do
-    gem 'yard', :require => false
+  gem 'mg', require: false
+  platforms :mri, :mingw do
+    gem 'yard', require: false
   end
 end
 
 group :development, :test do
-  gem 'rspec', :require => false
-  gem 'guard-rspec', :require => false
-  gem 'terminal-notifier-guard', :require => false
+  gem 'byebug'
+  gem 'guard-rspec', require: false
+  gem 'rspec', require: false
 
-  platforms :mri do
-    gem 'pry', :require => false
-    gem 'pry-coolline', :require => false
+  gem 'rubocop', '~> 0.46.0', require: false unless RUBY_VERSION =~ /^1.8/
+  gem 'simplecov', require: false
+  gem 'terminal-notifier-guard', require: false
+
+  gem 'codeclimate-test-reporter'
+  gem 'coveralls'
+
+  gem 'overcommit'
+  gem 'ruby_dep', '1.3.1'
+
+  platforms :mri, :mingw do
+    gem 'pry', require: false
+    gem 'pry-coolline', require: false
   end
 end
 
 group :test do
-  gem 'wrong', :require => false
-  gem 'files', :require => false
+  gem 'files', require: false
+  gem 'wrong', require: false
 end

Guardfile

-
-
 # Note: The cmd option is now required due to the increasing number of ways
 #       rspec may be run, below are examples of the most common uses.
 #  * bundler: 'bundle exec rspec'
@@ -11,16 +9,16 @@
 guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/.+_spec\.rb$})
   watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')  { "spec" }
+  watch('spec/spec_helper.rb')  { 'spec' }
 
   # Rails example
   watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
   watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
   watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
-  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
-  watch('config/routes.rb')                           { "spec/routing" }
-  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
-  watch('spec/rails_helper.rb')                       { "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { 'spec' }
+  watch('config/routes.rb')                           { 'spec/routing' }
+  watch('app/controllers/application_controller.rb')  { 'spec/controllers' }
+  watch('spec/rails_helper.rb')                       { 'spec' }
 
   # Capybara features specs
   watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
@@ -29,4 +27,3 @@ guard :rspec, cmd: 'bundle exec rspec' do
   watch(%r{^spec/acceptance/(.+)\.feature$})
   watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
 end
-

README.rdoc

 == Annotate (aka AnnotateModels)
 
 {<img src="https://badge.fury.io/rb/annotate.svg" alt="Gem Version" />}[http://badge.fury.io/rb/annotate]
-{<img src="https://travis-ci.org/ctran/annotate_models.png" />}[https://travis-ci.org/ctran/annotate_models]
+{<img src="https://img.shields.io/gem/dt/annotate.svg?style=flat" />}[https://rubygems.org/gems/annotate]
+{<img src="https://travis-ci.org/ctran/annotate_models.svg?branch=develop" />}[https://travis-ci.org/ctran/annotate_models]
+{<img src="https://coveralls.io/repos/ctran/annotate_models/badge.svg?branch=develop" />}[https://coveralls.io/r/ctran/annotate_models?branch=develop]
+{<img src="https://codeclimate.com/github/ctran/annotate_models/badges/gpa.svg" />}[https://codeclimate.com/github/ctran/annotate_models]
+{<img src="http://inch-ci.org/github/ctran/annotate_models.svg?branch=develop" alt="Inline docs" />}[http://inch-ci.org/github/ctran/annotate_models]
 {<img src="https://gemnasium.com/ctran/annotate_models.png" />}[https://gemnasium.com/ctran/annotate_models]
 
 Add a comment summarizing the current schema to the top or bottom of each of
@@ -44,7 +48,7 @@ It also annotates geometrical columns, geom type and srid, when using
    #  path            :geometry        line_string, 4326
 
 Also, if you pass the -r option, it'll annotate routes.rb with the output of
-+rake routes+.
+<code>rake routes</code>.
 
 
 == Install
@@ -55,7 +59,7 @@ Into Gemfile from rubygems.org:
 
 Into Gemfile from Github:
 
-    gem 'annotate', github: 'ctran/annotate_models'
+    gem 'annotate', git: 'https://github.com/ctran/annotate_models.git'
 
 Into environment gems from rubygems.org:
 
@@ -63,7 +67,7 @@ Into environment gems from rubygems.org:
 
 Into environment gems from Github checkout:
 
-    git clone git://github.com/ctran/annotate_models.git annotate_models
+    git clone https://github.com/ctran/annotate_models.git annotate_models
     cd annotate_models
     rake build
     gem install pkg/annotate-*.gem
@@ -71,7 +75,7 @@ Into environment gems from Github checkout:
 
 == Usage
 
-(If you used the Gemfile install, prefix the below commands with +bundle exec+.)
+(If you used the Gemfile install, prefix the below commands with <code>bundle exec</code>.)
 
 === Usage in Rails
 
@@ -100,7 +104,7 @@ 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.
+To automatically annotate every time you run <code>db:migrate</code>, either run <code>rails g annotate:install</code> or add +Annotate.load_tasks+ to your `Rakefile`. See the {configuration in Rails}[link:README.rdoc#configuration-in-rails] section for more info.
 
 === Usage Outside of Rails
 
@@ -136,7 +140,7 @@ functionality:
     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).
+executed whenever you run <code>rake db:migrate</code> (but only in development mode).
 If you want to disable this behavior permanently, edit the +.rake+ file and
 change:
 
@@ -146,7 +150,7 @@ To:
 
     'skip_on_db_migrate'   => 'true',
 
-If you want to run +rake db:migrate+ as a one-off without running annotate,
+If you want to run <code>rake db:migrate</code> as a one-off without running annotate,
 you can do so with a simple environment variable, instead of editing the
 +.rake+ file:
 
@@ -175,12 +179,13 @@ you can do so with a simple environment variable, instead of editing the
             --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'
+        -aa, --active-admin              Annotate all activeadmin models
         -v, --version                    Show the current version of this gem
         -m, --show-migration             Include the migration version number in the annotation
         -i, --show-indexes               List the table's database indexes in the annotation
         -k, --show-foreign-keys          List the table's foreign key constraints 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 comas
+            --model-dir dir              Annotate model files stored in dir rather than app/models, separate multiple dirs with commas
             --ignore-model-subdirects    Ignore subdirectories of the models directory
             --sort                       Sort columns alphabetically, rather than in creation order
         -R, --require path               Additional file to require before loading models, may be used multiple times

annotate.gemspec

@@ -4,36 +4,45 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'annotate/version'
 
 Gem::Specification.new do |s|
-  s.name = "annotate"
+  s.name = 'annotate'
   s.version = Annotate.version
 
   s.required_ruby_version = '>= 1.9.3'
-  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/migrate.rake"]
-  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.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.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.'
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<rake>, ["~> 10.4"])
-      s.add_runtime_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
-    else
-      s.add_dependency(%q<rake>, ["~> 10.4"])
-      s.add_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
-    end
-  else
-    s.add_dependency(%q<rake>, [">= 0.8.7"])
-    s.add_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
-  end
+  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<activerecord>, ['>= 3.2', '< 6.0'])
 end

circle.yml

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

lib/annotate.rb

-$:.unshift(File.dirname(__FILE__))
+# rubocop:disable  Metrics/ModuleLength
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'annotate/version'
 require 'annotate/annotate_models'
 require 'annotate/annotate_routes'
@@ -7,60 +9,70 @@ begin
   # ActiveSupport 3.x...
   require 'active_support/hash_with_indifferent_access'
   require 'active_support/core_ext/object/blank'
-rescue Exception
+rescue StandardError
   # ActiveSupport 2.x...
   require 'active_support/core_ext/hash/indifferent_access'
   require 'active_support/core_ext/blank'
 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_OPTIONS = [
     :position_in_routes, :position_in_class, :position_in_test,
     :position_in_fixture, :position_in_factory, :position,
     :position_in_serializer
-  ]
-  FLAG_OPTIONS=[
+  ].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, :trace,
     :timestamp, :exclude_serializers, :classified_sort, :show_foreign_keys,
-    :exclude_scaffolds, :exclude_controllers, :exclude_helpers, :ignore_unknown_models,
-  ]
-  OTHER_OPTIONS=[
-    :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close, :wrapper, :routes,
-    :hide_limit_column_types,
-  ]
-  PATH_OPTIONS=[
+    :exclude_scaffolds, :exclude_controllers, :exclude_helpers,
+    :exclude_sti_subclasses, :ignore_unknown_models
+  ].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.
   #
   def self.set_defaults(options = {})
-    return if(@has_set_defaults)
+    return if @has_set_defaults
     @has_set_defaults = true
 
     options = HashWithIndifferentAccess.new(options)
 
-    [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS].flatten.each do |key|
-      if options.has_key?(key)
+    all_options.flatten.each do |key|
+      if options.key?(key)
         default_value = if options[key].is_a?(Array)
-          options[key].join(",")
-        else
-          options[key]
-        end
+                          options[key].join(',')
+                        else
+                          options[key]
+                        end
       end
 
-      default_value = ENV[key.to_s] if !ENV[key.to_s].blank?
+      default_value = ENV[key.to_s] unless ENV[key.to_s].blank?
       ENV[key.to_s] = default_value.nil? ? nil : default_value.to_s
     end
   end
 
-  TRUE_RE = /^(true|t|yes|y|1)$/i
+  ##
+  # 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')
@@ -69,30 +81,27 @@ module Annotate
       options[key] = true?(ENV[key.to_s])
     end
     OTHER_OPTIONS.each do |key|
-      options[key] = (!ENV[key.to_s].blank?) ? ENV[key.to_s] : nil
+      options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s] : nil
     end
     PATH_OPTIONS.each do |key|
-      options[key] = (!ENV[key.to_s].blank?) ? ENV[key.to_s].split(',') : []
+      options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s].split(',') : []
     end
 
-    if(options[:model_dir].empty?)
-      options[:model_dir] = ['app/models']
-    end
-
-    if(options[:root_dir].empty?)
-      options[:root_dir] = ['']
-    end
+    options[:model_dir] = ['app/models'] if options[:model_dir].empty?
 
     options[:wrapper_open] ||= options[:wrapper]
     options[:wrapper_close] ||= options[:wrapper]
 
-    return options
+    # 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
   end
 
   def self.reset_options
-    [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS].flatten.each do |key|
-      ENV[key.to_s] = nil
-    end
+    all_options.flatten.each { |key| ENV[key.to_s] = nil }
   end
 
   def self.skip_on_migration?
@@ -107,26 +116,34 @@ module Annotate
     true
   end
 
-  def self.loaded_tasks=(val); @loaded_tasks = val; end
-  def self.loaded_tasks; return @loaded_tasks; end
+  def self.loaded_tasks=(val)
+    @loaded_tasks = val
+  end
+
+  def self.loaded_tasks
+    @loaded_tasks
+  end
 
   def self.load_tasks
-    return if(self.loaded_tasks)
+    return if loaded_tasks
     self.loaded_tasks = true
 
-    Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each { |rake| load rake }
+    Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each do |rake|
+      load rake
+    end
   end
 
   def self.load_requires(options)
-    options[:require].each { |path| require path } if options[:require].count > 0
+    options[:require].count > 0 &&
+      options[:require].each { |path| require path }
   end
 
   def self.eager_load(options)
-    self.load_requires(options)
-    require "annotate/active_record_patch"
+    load_requires(options)
+    require 'annotate/active_record_patch'
 
-    if(defined?(Rails))
-      if(Rails.version.split('.').first.to_i < 3)
+    if defined?(Rails::Application)
+      if Rails.version.split('.').first.to_i < 3
         Rails.configuration.eager_load_paths.each do |load_path|
           matcher = /\A#{Regexp.escape(load_path)}(.*)\.rb\Z/
           Dir.glob("#{load_path}/**/*.rb").sort.each do |file|
@@ -149,33 +166,38 @@ module Annotate
   def self.bootstrap_rake
     begin
       require 'rake/dsl_definition'
-    rescue Exception
+    rescue StandardError => e
       # We might just be on an old version of Rake...
+      puts e.message
+      exit e.status_code
     end
     require 'rake'
 
-    if File.exists?('./Rakefile')
-      load './Rakefile'
+    load './Rakefile' if File.exist?('./Rakefile')
+    begin
+      Rake::Task[:environment].invoke
+    rescue
+      nil
     end
-    Rake::Task[:environment].invoke rescue nil
-    if(!defined?(Rails))
+    unless defined?(Rails)
       # Not in a Rails project, so time to load up the parts of
       # ActiveSupport we need.
       require 'active_support'
       require 'active_support/core_ext/class/subclasses'
       require 'active_support/core_ext/string/inflections'
     end
-    self.load_tasks
+
+    load_tasks
     Rake::Task[:set_annotation_options].invoke
   end
 
   def self.fallback(*args)
-    return args.detect { |arg| !arg.blank? }
+    args.detect { |arg| !arg.blank? }
   end
 
   def self.true?(val)
-    return false if(val.blank?)
-    return false unless(val =~ TRUE_RE)
-    return true
+    return false if val.blank?
+    return false unless val =~ TRUE_RE
+    true
   end
 end

lib/annotate/active_record_patch.rb

@@ -2,7 +2,7 @@
 
 module ::ActiveRecord
   class Base
-    def self.method_missing(name, *args)
+    def self.method_missing(_name, *_args)
       # ignore this, so unknown/unloaded macros won't cause parsing to fail
     end
   end

lib/annotate/annotate_routes.rb

@@ -18,139 +18,181 @@
 # Released under the same license as Ruby. No Support. No Warranty.
 #
 module AnnotateRoutes
-  PREFIX = "# == Route Map"
+  PREFIX = '== Route Map'.freeze
+  PREFIX_MD = '## Route Map'.freeze
+  HEADER_ROW = ['Prefix', 'Verb', 'URI Pattern', 'Controller#Action']
 
-  def self.do_annotations(options={})
-    return unless(routes_exists?)
+  class << self
+    def content(line, maxs, options = {})
+      return line.rstrip unless options[:format_markdown]
 
-    position_after = ! %w(before top).include?(options[:position_in_routes])
+      line.each_with_index.map do |elem, index|
+        min_length = maxs.map { |arr| arr[index] }.max || 0
 
-    routes_map = `rake routes`.split(/\n/, -1)
+        sprintf("%-#{min_length}.#{min_length}s", elem.tr('|', '-'))
+      end.join(' | ')
+    end
 
-    # In old versions of Rake, the first line of output was the cwd.  Not so
-    # much in newer ones.  We ditch that line if it exists, and if not, we
-    # keep the line around.
-    routes_map.shift if(routes_map.first =~ /^\(in \//)
-
-    header = [
-      "#{PREFIX}" + (options[:timestamp] ? " (Updated #{Time.now.strftime("%Y-%m-%d %H:%M")})" : ""),
-      "#"
-    ] + routes_map.map { |line| "# #{line}".rstrip }
-
-    existing_text = File.read(routes_file)
-    (content, where_header_found) = strip_annotations(existing_text)
-    changed = where_header_found != 0 # 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.
-
-    if(position_after)
-      # Ensure we have adequate trailing newlines at the end of the file to
-      # ensure a blank line separating the content from the annotation.
-      content << '' if(content.last != '')
+    def header(options = {})
+      routes_map = app_routes_map(options)
 
-      # We're moving something from the top of the file to the bottom, so ditch
-      # the spacer we put in the first time around.
-      if(changed && where_header_found == :before)
-        content.shift if(content.first == '')
+      out = ["# #{options[:format_markdown] ? PREFIX_MD : PREFIX}" + (options[:timestamp] ? " (Updated #{Time.now.strftime('%Y-%m-%d %H:%M')})" : '')]
+      out += ['#']
+      return out if routes_map.size.zero?
+
+      maxs = [HEADER_ROW.map(&:size)] + routes_map[1..-1].map { |line| line.split.map(&:size) }
+
+      if options[:format_markdown]
+        max = maxs.map(&:max).compact.max
+
+        out += ["# #{content(HEADER_ROW, maxs, options)}"]
+        out += ["# #{content(['-' * max, '-' * max, '-' * max, '-' * max], maxs, options)}"]
+      else
+        out += ["# #{content(routes_map[0], maxs, options)}"]
       end
-    else
-      header = header << '' if(content.first != '' || changed)
+
+      out + routes_map[1..-1].map { |line| "# #{content(options[:format_markdown] ? line.split(' ') : line, maxs, options)}" }
     end
 
-    content = position_after ? (content + header) : header + content
+    def do_annotations(options = {})
+      return unless routes_exists?
+      existing_text = File.read(routes_file)
 
-    if write_contents(existing_text, content)
-      puts "#{routes_file} annotated."
-    else
-      puts "#{routes_file} unchanged."
+      if write_contents(existing_text, header(options), options)
+        puts "#{routes_file} annotated."
+      end
     end
-  end
 
-  def self.remove_annotations(options={})
-    return unless(routes_exists?)
-    existing_text = File.read(routes_file)
-    (content, where_header_found) = strip_annotations(existing_text)
+    def remove_annotations(options={})
+      return unless routes_exists?
+      existing_text = File.read(routes_file)
+      content, where_header_found = strip_annotations(existing_text)
 
-    content = strip_on_removal(content, where_header_found)
+      content = strip_on_removal(content, where_header_found)
 
-    if write_contents(existing_text, content)
-      puts "Removed annotations from #{routes_file}."
-    else
-      puts "#{routes_file} unchanged."
+      if write_contents(existing_text, content, options)
+        puts "Removed annotations from #{routes_file}."
+      end
     end
   end
 
-protected
+  private
+
+  def self.app_routes_map(options)
+    routes_map = `rake routes`.split(/\n/, -1)
+
+    # In old versions of Rake, the first line of output was the cwd.  Not so
+    # much in newer ones.  We ditch that line if it exists, and if not, we
+    # keep the line around.
+    routes_map.shift if routes_map.first =~ /^\(in \//
+
+    # Skip routes which match given regex
+    # Note: it matches the complete line (route_name, path, controller/action)
+    if options[:ignore_routes]
+      routes_map.reject! { |line| line =~ /#{options[:ignore_routes]}/ }
+    end
+
+    routes_map
+  end
 
   def self.routes_file
-    @routes_rb ||= File.join("config", "routes.rb")
+    @routes_rb ||= File.join('config', 'routes.rb')
   end
 
   def self.routes_exists?
     routes_exists = File.exists?(routes_file)
-    puts "Can`t find routes.rb" if(!routes_exists)
-    return routes_exists
+    puts "Can't find routes.rb" unless routes_exists
+
+    routes_exists
   end
 
-  def self.write_contents(existing_text, new_content)
+  def self.write_contents(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_content << '' unless new_content.last == ''
     new_text = new_content.join("\n")
 
-    return false if 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) }
+      true
+    end
+  end
+
+  def self.annotate_routes(header, content, where_header_found, options = {})
+    if %w(before top).include?(options[:position_in_routes])
+      header = header << '' if content.first != ''
+      new_content = header + content
+    else
+      # Ensure we have adequate trailing newlines at the end of the file to
+      # ensure a blank line separating the content from the annotation.
+      content << '' unless content.last == ''
+
+      # 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 == ''
+
+      new_content = content + header
+    end
 
-    File.open(routes_file, "wb") { |f| f.puts(new_text) }
-    return true
+    new_content
   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 self.strip_annotations(content)
     real_content = []
     mode = :content
-    line_number = 0
     header_found_at = 0
-    content.split(/\n/, -1).each do |line|
-      line_number += 1
-      begin
-        if(mode == :header)
-          if(line !~ /\s*#/)
-            mode = :content
-            raise unless (line == '')
-          end
-        elsif(mode == :content)
-          if(line =~ /^\s*#\s*== Route.*$/)
-            header_found_at = line_number
-            mode = :header
-          else
-            real_content << line
-          end
+
+    content.split(/\n/, -1).each_with_index do |line, line_number|
+      if mode == :header && line !~ /\s*#/
+        mode = :content
+        next unless line == ''
+      elsif mode == :content
+        if line =~ /^\s*#\s*== Route.*$/
+          header_found_at = line_number + 1 # index start's at 0
+          mode = :header
+        else
+          real_content << line
         end
-      rescue
-        retry
       end
     end
-    content_lines = real_content.count
 
-    # By default assume the annotation was found in the middle of the file...
-    where_header_found = header_found_at
+    where_header_found(real_content, header_found_at)
+  end
+
+  def self.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 ...
-    where_header_found = :before if(header_found_at == 1)
+    return real_content, :before if header_found_at == 1
+
     # ... or that it was at the end.
-    where_header_found = :after if(header_found_at >= content_lines)
+    return real_content, :after if header_found_at >= real_content.count
 
-    return real_content, where_header_found
+    # and the default
+    return real_content, header_found_at
   end
 
   def self.strip_on_removal(content, where_header_found)
-    if(where_header_found == :before)
-      content.shift while(content.first == '')
-    elsif(where_header_found == :after)
-      content.pop while(content.last == '')
+    if where_header_found == :before
+      content.shift while content.first == ''
+    elsif where_header_found == :after
+      content.pop while content.last == ''
     end
+
     # 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...
-    return content
+    content
   end
 end

lib/annotate/version.rb

 module Annotate
   def self.version
-    '2.7.0'
+    '2.7.2'
   end
 end

lib/generators/annotate/install_generator.rb

 module Annotate
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc "Copy annotate_models rakefiles for automatic annotation"
+      desc 'Copy annotate_models rakefiles for automatic annotation'
       source_root File.expand_path('../templates', __FILE__)
 
       # copy rake tasks
       def copy_tasks
-        template "auto_annotate_models.rake", "lib/tasks/auto_annotate_models.rake"
+        template 'auto_annotate_models.rake', 'lib/tasks/auto_annotate_models.rake'
       end
-
     end
   end
 end

lib/generators/annotate/templates/auto_annotate_models.rake

@@ -2,44 +2,50 @@
 # NOTE: are sensitive to local FS writes, and besides -- it's just not proper
 # NOTE: to have a dev-mode tool do its thing in production.
 if Rails.env.development?
+  require 'annotate'
   task :set_annotation_options do
     # You can override any of these by setting an environment variable of the
     # same name.
     Annotate.set_defaults(
-      'routes'                  => 'false',
-      'position_in_routes'      => 'before',
-      'position_in_class'       => 'before',
-      'position_in_test'        => 'before',
-      'position_in_fixture'     => 'before',
-      'position_in_factory'     => 'before',
-      'position_in_serializer'  => 'before',
-      'show_foreign_keys'       => 'true',
-      'show_indexes'            => 'true',
-      'simple_indexes'          => 'false',
-      'model_dir'               => 'app/models',
-      'root_dir'                => '',
-      'include_version'         => 'false',
-      'require'                 => '',
-      'exclude_tests'           => 'false',
-      'exclude_fixtures'        => 'false',
-      'exclude_factories'       => 'false',
-      'exclude_serializers'     => 'false',
-      'exclude_scaffolds'       => 'false',
-      'exclude_controllers'     => 'false',
-      'exclude_helpers'         => 'false',
-      'ignore_model_sub_dir'    => 'false',
-      'ignore_columns'          => nil,
-      'ignore_unknown_models'   => 'false',
-      'hide_limit_column_types' => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(',') %>',
-      'skip_on_db_migrate'      => 'false',
-      'format_bare'             => 'true',
-      'format_rdoc'             => 'false',
-      'format_markdown'         => 'false',
-      'sort'                    => 'false',
-      'force'                   => 'false',
-      'trace'                   => 'false',
-      'wrapper_open'            => nil,
-      'wrapper_close'           => nil,
+      'routes'                    => 'false',
+      'position_in_routes'        => 'before',
+      'position_in_class'         => 'before',
+      'position_in_test'          => 'before',
+      'position_in_fixture'       => 'before',
+      'position_in_factory'       => 'before',
+      'position_in_serializer'    => 'before',
+      'show_foreign_keys'         => 'true',
+      'show_complete_foreign_keys' => 'false',
+      'show_indexes'              => 'true',
+      'simple_indexes'            => 'false',
+      'model_dir'                 => 'app/models',
+      'root_dir'                  => '',
+      'include_version'           => 'false',
+      'require'                   => '',
+      'exclude_tests'             => 'false',
+      'exclude_fixtures'          => 'false',
+      'exclude_factories'         => 'false',
+      'exclude_serializers'       => 'false',
+      'exclude_scaffolds'         => 'true',
+      'exclude_controllers'       => 'true',
+      'exclude_helpers'           => 'true',
+      'exclude_sti_subclasses'    => 'false',
+      'ignore_model_sub_dir'      => 'false',
+      'ignore_columns'            => nil,
+      'ignore_routes'             => nil,
+      'ignore_unknown_models'     => 'false',
+      'hide_limit_column_types'   => '<%= AnnotateModels::NO_LIMIT_COL_TYPES.join(",") %>',
+      'hide_default_column_types' => '<%= AnnotateModels::NO_DEFAULT_COL_TYPES.join(",") %>',
+      'skip_on_db_migrate'        => 'false',
+      'format_bare'               => 'true',
+      'format_rdoc'               => 'false',
+      'format_markdown'           => 'false',
+      'sort'                      => 'false',
+      'force'                     => 'false',
+      'trace'                     => 'false',
+      'wrapper_open'              => nil,
+      'wrapper_close'             => nil,
+      'with_comment'              => true
     )
   end
 

lib/tasks/annotate_models.rake

 annotate_lib = File.expand_path(File.dirname(File.dirname(__FILE__)))
 
-if !ENV['is_cli']
+unless ENV['is_cli']
   task :set_annotation_options
-  task :annotate_models => :set_annotation_options
+  task annotate_models: :set_annotation_options
 end
 
-desc "Add schema information (as comments) to model and fixture files"
-task :annotate_models => :environment do
+desc 'Add schema information (as comments) to model and fixture files'
+task annotate_models: :environment do
   require "#{annotate_lib}/annotate/annotate_models"
   require "#{annotate_lib}/annotate/active_record_patch"
 
-  options={ :is_rake => true }
+  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'])
@@ -18,10 +18,11 @@ task :annotate_models => :environment do
   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'])
   options[:model_dir] = ENV['model_dir'] ? ENV['model_dir'].split(',') : ['app/models']
-  options[:root_dir] = ENV['root_dir'] ? ENV['root_dir'].split(',') : ['']
+  options[:root_dir] = ENV['root_dir']
   options[:include_version] = Annotate.true?(ENV['include_version'])
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
   options[:exclude_tests] = Annotate.true?(ENV['exclude_tests'])
@@ -29,8 +30,9 @@ task :annotate_models => :environment do
   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['exclude_controllers'])
-  options[:exclude_helpers] = Annotate.true?(ENV['exclude_helpers'])
+  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'])
@@ -42,16 +44,19 @@ task :annotate_models => :environment do
   options[:wrapper_open] = Annotate.fallback(ENV['wrapper_open'], ENV['wrapper'])
   options[:wrapper_close] = Annotate.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'], '')
 
   AnnotateModels.do_annotations(options)
 end
 
-desc "Remove schema information from model and fixture files"
-task :remove_annotation => :environment do
+desc 'Remove schema information from model and fixture files'
+task remove_annotation: :environment do
   require "#{annotate_lib}/annotate/annotate_models"
   require "#{annotate_lib}/annotate/active_record_patch"
 
-  options={ :is_rake => true }
+  options = {is_rake: true}
   options[:model_dir] = ENV['model_dir']
   options[:root_dir] = ENV['root_dir']
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []

lib/tasks/annotate_routes.rake

@@ -6,6 +6,7 @@ task :annotate_routes => :environment do
   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)
   options[:require] = ENV['require'] ? ENV['require'].split(',') : []
   AnnotateRoutes.do_annotations(options)
 end

potato.md

+Colons can be used to align columns.
+
+| Tables        | Are           | Cool  |
+| ------------- |:-------------:| -----:|
+| col 3 is      | right-aligned | $1600 |
+| col 2 is      | centered      |   $12 |
+| zebra stripes | are neat      |    $1 |
+
+There must be at least 3 dashes separating each header cell.
+The outer pipes (|) are optional, and you don't need to make the
+raw Markdown line up prettily. You can also use inline Markdown.
+
+Markdown | Less | Pretty
+--- | --- | ---
+*Still* | `renders` | **nicely**
+1 | 2 | 3
+
+
+ ## Route Map
+
+  Prefix    | Verb       | URI Pattern     | Controller#Action    
+  --------- | ---------- | --------------- | --------------------
+  myaction1 | GET        | /url1(.:format) | mycontroller1#action
+  myaction2 | POST       | /url2(.:format) | mycontroller2#action
+  myaction3 | DELETE-GET | /url3(.:format) | mycontroller3#action \n")
+
+
+
+ Table name: `users`
+
+ ### Columns
+
+ Name                    | Type               | Attributes
+ ----------------------- | ------------------ | ---------------------------
+ **`id`**                | `integer`          | `not null, primary key`
+ **`foreign_thing_id`**  | `integer`          | `not null`
+
+ ### Foreign Keys
+
+ * `fk_rails_...` (_ON DELETE => on_delete_value ON UPDATE => on_update_value_):
+     * **`foreign_thing_id => foreign_things.id`**

spec/annotate_spec.rb

 require File.dirname(__FILE__) + '/spec_helper.rb'
 
 describe Annotate do
-
-  it "should have a version" do
+  it 'should have a version' do
     expect(Annotate.version).to be_instance_of(String)
   end
-
 end

spec/fixtures/rails_32_schema.rb

@@ -12,11 +12,9 @@
 # It's strongly recommended to check this file into your version control system.
 
 ActiveRecord::Schema.define(:version => 20120816164927) do
-
   create_table "tasks", :force => true do |t|
     t.string   "content"
     t.datetime "created_at", :null => false
     t.datetime "updated_at", :null => false
   end
-
 end

spec/integration/common_validation.rb

@@ -2,10 +2,7 @@ module Annotate
   module Validations
     module Common
       def self.test_commands
-        return %q{
-          bin/annotate &&
-          bin/annotate --routes
-        }
+        'bin/annotate && bin/annotate --routes'
       end
 
       def self.verify_output(output)
@@ -13,54 +10,52 @@ module Annotate
         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])
+      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
+      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
+      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
+      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
+        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
+        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
+      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
 
-    protected
-
-      def self.apply_annotation(test_rig, fname, annotation, place_before=true)
+      def self.apply_annotation(test_rig, fname, annotation, place_before = true)
         corpus = File.read(File.join(test_rig, fname))
-        if(place_before)
-          corpus = annotation + "\n" + corpus
+        if place_before
+          annotation + "\n" + corpus
         else
-          corpus = corpus + "\n" + annotation
+          corpus + "\n" + annotation
         end
       end
     end
@@ -71,27 +66,28 @@ module Annotate
   module Validations
     class Base
       def self.test_commands
-        return Annotate::Validations::Common.test_commands
+        Annotate::Validations::Common.test_commands
       end
 
       def self.verify_output(output)
-        return Annotate::Validations::Common.verify_output(output)
+        Annotate::Validations::Common.verify_output(output)
       end
 
       def self.verify_files(test_rig)
-        return Annotate::Validations::Common.verify_files({
-          :model => true,
-          :test => true,
-          :fixture => true,
-          :factory => false,
-          :routes => true
-        }, test_rig, self.schema_annotation, self.route_annotation, true)
+        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'
-        binding.pry
       end
     end
   end

spec/integration/integration_spec.rb

 # Smoke test to assure basic functionality works on a variety of Rails versions.
-$:.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'spec_helper'
 require 'files'
 require 'wrong'
@@ -7,7 +7,7 @@ require 'rake'
 include Files
 include Wrong::D
 
-BASEDIR=File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+BASEDIR = File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
 RVM_BIN = `which rvm`.chomp
 USING_RVM = (RVM_BIN != '')
 
@@ -16,25 +16,24 @@ ENV['rvm_pretty_print_flag'] = '0'
 ENV['BUNDLE_GEMFILE'] = './Gemfile'
 
 describe "annotate inside Rails, using #{CURRENT_RUBY}" do
-  
-  here = File.expand_path('..', __FILE__)
   chosen_scenario = nil
-  if(!ENV['SCENARIO'].blank?)
+  unless ENV['SCENARIO'].blank?
     chosen_scenario = File.expand_path(ENV['SCENARIO'])
-    raise "Can't find specified scenario '#{chosen_scenario}'!" unless(File.directory?(chosen_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)
+    next if chosen_scenario && chosen_scenario != test_rig
     it "works under #{test_name}" do
-      if(!USING_RVM)
-        skip "Must have RVM installed."
+      unless USING_RVM
+        skip 'Must have RVM installed.'
         next
       end
 
       # Don't proceed if the working copy is dirty!
-      expect(Annotate::Integration.is_clean?(test_rig)).to eq(true)
+      expect(Annotate::Integration.clean?(test_rig)).to eq(true)
 
-      skip "temporarily ignored until Travis can run them"
+      skip 'temporarily ignored until Travis can run them'
 
       Bundler.with_clean_env do
         dir base_dir do
@@ -53,10 +52,10 @@ describe "annotate inside Rails, using #{CURRENT_RUBY}" do
 
           # 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
+          ENV['rvm_ruby_string'] = CURRENT_RUBY
 
-          require "#{base_dir}" # Will get "#{base_dir}.rb"...
-          klass = "Annotate::Validations::#{base_dir.gsub('.', '_').classify}".constantize
+          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

spec/integration/rails_2.3_with_bundler.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Rails23WithBundler < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,7 +18,7 @@ RUBY
       end
 
       def self.route_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Route Map (Updated YYYY-MM-DD HH:MM)
 #
 #     tasks GET    /tasks(.:format)          {:controller=>"tasks", :action=>"index"}

spec/integration/rails_3.2.2.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Rails322 < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,7 +18,7 @@ RUBY
       end
 
       def self.route_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Route Map (Updated YYYY-MM-DD HH:MM)
 #
 #     tasks GET    /tasks(.:format)          tasks#index

spec/integration/rails_3.2.8.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Rails328 < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,7 +18,7 @@ RUBY
       end
 
       def self.route_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Route Map (Updated YYYY-MM-DD HH:MM)
 #
 #     tasks GET    /tasks(.:format)          tasks#index

spec/integration/rails_3.2_autoloading_factory_girl.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Rails32AutoloadingFactoryGirl < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,7 +18,7 @@ RUBY
       end
 
       def self.route_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Route Map (Updated YYYY-MM-DD HH:MM)
 #
 #     tasks GET    /tasks(.:format)          tasks#index
@@ -33,13 +33,15 @@ RUBY
       end
 
       def self.verify_files(test_rig)
-        return Annotate::Validations::Common.verify_files({
-          :model => true,
-          :test => true,
-          :fixture => false,
-          :factory => true,
-          :routes => true
-        }, test_rig, self.schema_annotation, self.route_annotation, true)
+        Annotate::Validations::Common.verify_files(
+          {
+            model: true,
+            test: true,
+            fixture: false,
+            factory: true,
+            routes: true
+          }, test_rig, schema_annotation, route_annotation, true
+        )
       end
     end
   end

spec/integration/rails_3.2_custom_inflections.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Rails32CustomInflection < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,7 +18,7 @@ RUBY
       end
 
       def self.route_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Route Map (Updated YYYY-MM-DD HH:MM)
 #
 #     tasks GET    /tasks(.:format)          tasks#index

spec/integration/rails_3.2_with_asset_pipeline.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Rails32WithAssetPipeline < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,7 +18,7 @@ RUBY
       end
 
       def self.route_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Route Map (Updated YYYY-MM-DD HH:MM)
 #
 #     tasks GET    /tasks(.:format)          tasks#index

spec/integration/standalone.rb

@@ -4,7 +4,7 @@ module Annotate
   module Validations
     class Standalone < Base
       def self.schema_annotation
-        return <<-RUBY
+        <<-RUBY
 # == Schema Information
 #
 # Table name: tasks
@@ -18,9 +18,7 @@ RUBY
       end
 
       def self.test_commands
-        return %q{
-          bin/annotate --require ./config/init.rb
-        }
+        'bin/annotate --require ./config/init.rb'
       end
 
       def self.verify_output(output)
@@ -28,13 +26,15 @@ RUBY
       end
 
       def self.verify_files(test_rig)
-        return Annotate::Validations::Common.verify_files({
-          :model => true,
-          :test => false,
-          :fixture => false,
-          :factory => false,
-          :routes => false
-        }, test_rig, self.schema_annotation, nil, true)
+        Annotate::Validations::Common.verify_files(
+          {
+            model: true,
+            test: false,
+            fixture: false,
+            factory: false,
+            routes: false
+          }, test_rig, schema_annotation, nil, true
+        )
       end
     end
   end

spec/spec_helper.rb

+require 'coveralls'
+require 'codeclimate-test-reporter'
+require 'simplecov'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+  [
+    Coveralls::SimpleCov::Formatter,
+    SimpleCov::Formatter::HTMLFormatter,
+    CodeClimate::TestReporter::Formatter
+  ]
+)
+
+SimpleCov.start
+
 require 'rubygems'
 require 'bundler'
 Bundler.setup
 
+require 'rake'
 require 'rspec'
 require 'wrong/adapters/rspec'
 
-$:.unshift(File.join(File.dirname(__FILE__), '../lib'))
-$:.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '../lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 
 require 'active_support'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/class/subclasses'
 require 'active_support/core_ext/string/inflections'
 require 'annotate'
+require 'byebug'
 
 module Annotate
   module Integration
-    ABSOLUTE_GEM_ROOT=File.expand_path('../../', __FILE__)
+    ABSOLUTE_GEM_ROOT = File.expand_path('../../', __FILE__)
 
-    CRUFT_PATTERNS=[
-      "%SCENARIO%/bin/*", "%SCENARIO%/log/*", "%SCENARIO%/tmp/*",
-      "%SCENARIO%/.bundle"
-    ]
-    SCENARIO_HOME=File.join(File.dirname(__FILE__), 'integration')
-    SCENARIOS=Dir.glob("#{SCENARIO_HOME}/*").
-      select { |candidate| File.directory?(candidate) }.
-      map do |test_rig|
-        base_dir = File.basename(test_rig)
-        [test_rig, base_dir, base_dir.titlecase]
-      end
+    CRUFT_PATTERNS = %w(
+      %SCENARIO%/bin/*
+      %SCENARIO%/log/*
+      %SCENARIO%/tmp/*
+      %SCENARIO%/.bundle
+    ).freeze
+
+    SCENARIO_HOME = File.join(File.dirname(__FILE__), 'integration')
+    SCENARIOS = Dir.glob("#{SCENARIO_HOME}/*").select do |candidate|
+      File.directory?(candidate)
+    end.map do |test_rig|
+      base_dir = File.basename(test_rig)
+      [test_rig, base_dir, base_dir.titlecase]
+    end
 
     def self.nuke_cruft(test_rig)
       FileList[
-        Annotate::Integration::CRUFT_PATTERNS.
-          map { |pattern| pattern.sub('%SCENARIO%', test_rig) }
+        Annotate::Integration::CRUFT_PATTERNS.map do |pattern|
+          pattern.sub('%SCENARIO%', test_rig)
+        end
       ].each do |fname|
         FileUtils.rm_rf(fname)
       end
     end
 
     def self.nuke_all_cruft
-      SCENARIOS.each do |test_rig, base_dir, test_name|
+      SCENARIOS.each do |test_rig, _base_dir, _test_name|
         nuke_cruft(test_rig)
       end
     end
 
     def self.empty_gemset(test_rig)
       Dir.chdir(test_rig) do
-        system(%q{
+        system('
           (
             export SKIP_BUNDLER=1
             source .rvmrc &&
             rvm --force gemset empty
           ) 2>&1
-        })
+        ')
       end
     end
 
@@ -65,8 +85,8 @@ module Annotate
       system("git clean -dfx #{SCENARIO_HOME}/*/")
     end
 
-    def self.is_clean?(test_rig)
-      return `git status --porcelain #{test_rig}/ | wc -l`.strip.to_i == 0
+    def self.clean?(test_rig)
+      `git status --porcelain #{test_rig}/ | wc -l`.strip.to_i.zero?
     end
   end
 end