annotate 2.7.0 → 2.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d69e9ad0ab7a59e673f3cb7287d6cccb78b8ba20
-  data.tar.gz: a3b5adea28b4f3ebedc4f7af1df32907167d2bb9
+  metadata.gz: 2e6c2484a81d38c69c86e48305ae0a1b8724e5b1
+  data.tar.gz: 7463f0ee24a0023b105dc5e48fc9eec49559de0e
 SHA512:
-  metadata.gz: e6b5b503403df98d298e29c1ea4413999496d4c67326704c4c59a079bcd58fa3c6160e0e8812793a5e2796ddd8dcb216482793e5ff11e789463432c93d76cadd
-  data.tar.gz: 15d8f31b8c2bebd74cb0447b5f8283bf0397ae73b8e5a5fd6dc1306b19511cbbd03523338327da32fe2acc599c292fe2f0d434b5969b6eca2468d3bd2c4b9139
+  metadata.gz: d4dd08320d2fa1b85c21afdeb1fd5daa4ec6cd39877d70a0681b04ce7453f6fd204da258b0a9d20fe22d4eb4649d44c086383a20db3fe4c6b183ac35a8e1171c
+  data.tar.gz: 25101a0b978d74579bd47e2dba28a3b89fc738fe19966c50a78aaa43543748c5cd523ff7c7be3b708caa80925092a553a28f4dc6b55b6e91547d9ec5fdbb810f

data/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.

data/CHANGELOG.rdoc

@@ -1,3 +1,6 @@
+== 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
 

data/README.rdoc

@@ -1,7 +1,10 @@
 == Annotate (aka AnnotateModels)
 
 {<img src="https://badge.fury.io/rb/annotate.svg" alt="Gem Version" />}[http://badge.fury.io/rb/annotate]
+{<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.png" />}[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="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 +47,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
@@ -71,7 +74,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 +103,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 +139,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 +149,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,6 +178,7 @@ 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

data/annotate.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |s|
     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<rake>, [">= 10.4", "< 12.0"])
       s.add_runtime_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
     else
-      s.add_dependency(%q<rake>, ["~> 10.4"])
+      s.add_dependency(%q<rake>, [">= 10.4", "< 12.0"])
       s.add_dependency(%q<activerecord>, [">= 3.2", "< 6.0"])
     end
   else

data/bin/annotate

@@ -1,14 +1,14 @@
 #!/usr/bin/env ruby
 
-unless File.exists?('./Rakefile') || File.exists?('./Gemfile')
-  abort "Please run annotate from the root of the project."
+unless File.exist?('./Rakefile') || File.exist?('./Gemfile')
+  abort 'Please run annotate from the root of the project.'
 end
 
 require 'rubygems'
 begin
   require 'bundler'
   Bundler.setup
-rescue Exception => e
+rescue Exception
 end
 
 here = File.expand_path(File.dirname __FILE__)
@@ -20,58 +20,55 @@ 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
+  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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)") do |p|
+  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
-    [
-      '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])
+    %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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of the model file") do |p|
+  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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of any factory files") do |p|
+  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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of any fixture files") do |p|
+  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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of any test files") do |p|
+  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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of the routes.rb file") do |p|
+  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]', ['before', 'top', 'after', 'bottom'],
-          "Place the annotations at the top (before) or the bottom (after) of the serializer files") do |p|
+  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
@@ -89,34 +86,36 @@ OptionParser.new do |opts|
     ENV['wrapper_close'] = p
   end
 
-  opts.on('-r', '--routes',
-          "Annotate routes.rb with the output of 'rake routes'") do
+  opts.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") do
     ENV['routes'] = 'true'
   end
 
+  opts.on('-aa', '--active-admin', 'Annotate active_admin models') do |p|
+    ENV['active_admin'] = p
+  end
+
   opts.on('-v', '--version',
-          "Show the current version of this gem") do
+          '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"
+  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"
+    ENV['show_foreign_keys'] = 'yes'
   end
 
   opts.on('-i', '--show-indexes',
           "List the table's database indexes in the annotation") do
-    ENV['show_indexes'] = "yes"
+    ENV['show_indexes'] = 'yes'
   end
 
   opts.on('-s', '--simple-indexes',
           "Concat the column's related indexes in the annotation") do
-    ENV['simple_indexes'] = "yes"
+    ENV['simple_indexes'] = 'yes'
   end
 
   opts.on('--model-dir dir',
@@ -131,17 +130,17 @@ OptionParser.new do |opts|
 
   opts.on('--ignore-model-subdirects',
           "Ignore subdirectories of the models directory") do |dir|
-    ENV['ignore_model_sub_dir'] = "yes"
+    ENV['ignore_model_sub_dir'] = 'yes'
   end
 
   opts.on('--sort',
           "Sort columns alphabetically, rather than in creation order") do |dir|
-    ENV['sort'] = "yes"
+    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"
+    ENV['classified_sort'] = 'yes'
   end
 
   opts.on('-R', '--require path',
@@ -155,10 +154,10 @@ OptionParser.new do |opts|
 
   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" }
+    exclusions.each { |exclusion| ENV["exclude_#{exclusion}"] = 'yes' }
   end
 
-  opts.on('-f', '--format [bare|rdoc|markdown]', ['bare', 'rdoc', 'markdown'], 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
+  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
 
@@ -174,21 +173,25 @@ OptionParser.new do |opts|
     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|
+  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('--hide-limit-column-types VALUES', "don't show limit for given column types, separated by comas (i.e., `integer,boolean,text`)" ) do |values|
+  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 comas (i.e., `integer,boolean,text`)") do |values|
     ENV['hide_limit_column_types'] = "#{values}"
   end
 
-  opts.on('--ignore-unknown-models', "don't display warnings for bad model files" ) do |values|
-    ENV['ignore_unknown_models'] = "true"
+  opts.on('--ignore-unknown-models', "don't display warnings for bad model files") do |values|
+    ENV['ignore_unknown_models'] = 'true'
   end
 
 end.parse!
 
-options = Annotate.setup_options({ :is_rake => ENV['is_rake'] && !ENV['is_rake'].empty? })
+options = Annotate.setup_options({is_rake: ENV['is_rake'] && !ENV['is_rake'].empty?})
 Annotate.eager_load(options)
 
 AnnotateModels.send(target_action, options) if Annotate.include_models?

data/lib/annotate.rb

@@ -1,4 +1,4 @@
-$:.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'annotate/version'
 require 'annotate/annotate_models'
 require 'annotate/annotate_routes'
@@ -14,53 +14,57 @@ rescue Exception
 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=[
+    :exclude_scaffolds, :exclude_controllers, :exclude_helpers, :ignore_unknown_models
+  ].freeze
+  OTHER_OPTIONS = [
     :ignore_columns, :skip_on_db_migrate, :wrapper_open, :wrapper_close, :wrapper, :routes,
-    :hide_limit_column_types,
-  ]
-  PATH_OPTIONS=[
+    :hide_limit_column_types, :ignore_routes, :active_admin
+  ].freeze
+  PATH_OPTIONS = [
     :require, :model_dir, :root_dir
-  ]
+  ].freeze
 
   ##
   # 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)
+      if options.key?(key)
         default_value = if options[key].is_a?(Array)
-          options[key].join(",")
-        else
-          options[key]
+                          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,24 +73,24 @@ 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(',') : []
-    end
-
-    if(options[:model_dir].empty?)
-      options[:model_dir] = ['app/models']
+      options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s].split(',') : []
     end
 
-    if(options[:root_dir].empty?)
-      options[:root_dir] = ['']
-    end
+    options[:model_dir] = ['app/models'] if options[:model_dir].empty?
+    options[:root_dir] = [''] if options[:root_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
@@ -107,11 +111,16 @@ 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 }
@@ -122,11 +131,11 @@ module Annotate
   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)
+      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 +158,38 @@ module Annotate
   def self.bootstrap_rake
     begin
       require 'rake/dsl_definition'
-    rescue Exception
+    rescue Exception => 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