annotate 3.0.2 → 3.2.0

data/lib/annotate/parser.rb

@@ -9,14 +9,19 @@ module Annotate
 
     attr_reader :args, :options, :env
 
+    DEFAULT_OPTIONS = {
+      target_action: :do_annotations,
+      exit: false
+    }.freeze
+
     ANNOTATION_POSITIONS = %w[before top after bottom].freeze
     FILE_TYPE_POSITIONS = %w[position_in_class position_in_factory position_in_fixture position_in_test position_in_routes position_in_serializer].freeze
     EXCLUSION_LIST = %w[tests fixtures factories serializers].freeze
-    FORMAT_TYPES = %w[bare rdoc markdown].freeze
+    FORMAT_TYPES = %w[bare rdoc yard markdown].freeze
 
     def initialize(args, env)
       @args = args
-      @options = default_options
+      @options = DEFAULT_OPTIONS.dup
       @env = env
     end
 
@@ -31,128 +36,164 @@ module Annotate
 
     private
 
-    def commit
-      env.each_pair do |key, value|
-        ENV[key] = value
-      end
-    end
-
     def parser
       OptionParser.new do |option_parser|
         add_options_to_parser(option_parser)
       end
     end
 
+    def commit
+      env.each_pair do |key, value|
+        ENV[key] = value
+      end
+    end
+
     def add_options_to_parser(option_parser) # rubocop:disable Metrics/MethodLength
       has_set_position = {}
-      positions = ANNOTATION_POSITIONS
 
       option_parser.banner = 'Usage: annotate [options] [model_file]*'
 
-      option_parser.on('--additional-file-patterns path1,path2,path3', Array, "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)") do |additional_file_patterns|
+      option_parser.on('--additional-file-patterns path1,path2,path3',
+                       Array,
+                       "Additional file paths or globs to annotate, separated by commas (e.g. `/foo/bar/%model_name%/*.rb,/baz/%model_name%.rb`)") do |additional_file_patterns|
         ENV['additional_file_patterns'] = additional_file_patterns
       end
 
-      option_parser.on('-d', '--delete', 'Remove annotations from all model files or the routes.rb file') do
+      option_parser.on('-d',
+                       '--delete',
+                       'Remove annotations from all model files or the routes.rb file') do
         @options[:target_action] = :remove_annotations
       end
 
-      option_parser.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
+      option_parser.on('-p',
+                       '--position [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of the model/test/fixture/factory/route/serializer file(s)') do |position|
+        env['position'] = position
 
         FILE_TYPE_POSITIONS.each do |key|
-          env[key] = p unless has_set_position[key]
+          env[key] = position unless has_set_position[key]
         end
       end
 
-      option_parser.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
+      option_parser.on('--pc',
+                       '--position-in-class [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of the model file') do |position_in_class|
+        env['position_in_class'] = position_in_class
         has_set_position['position_in_class'] = true
       end
 
-      option_parser.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
+      option_parser.on('--pf',
+                       '--position-in-factory [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of any factory files') do |position_in_factory|
+        env['position_in_factory'] = position_in_factory
         has_set_position['position_in_factory'] = true
       end
 
-      option_parser.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
+      option_parser.on('--px',
+                       '--position-in-fixture [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of any fixture files') do |position_in_fixture|
+        env['position_in_fixture'] = position_in_fixture
         has_set_position['position_in_fixture'] = true
       end
 
-      option_parser.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
+      option_parser.on('--pt',
+                       '--position-in-test [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of any test files') do |position_in_test|
+        env['position_in_test'] = position_in_test
         has_set_position['position_in_test'] = true
       end
 
-      option_parser.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
+      option_parser.on('--pr',
+                       '--position-in-routes [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of the routes.rb file') do |position_in_routes|
+        env['position_in_routes'] = position_in_routes
         has_set_position['position_in_routes'] = true
       end
 
-      option_parser.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
+      option_parser.on('--ps',
+                       '--position-in-serializer [before|top|after|bottom]',
+                       ANNOTATION_POSITIONS,
+                       'Place the annotations at the top (before) or the bottom (after) of the serializer files') do |position_in_serializer|
+        env['position_in_serializer'] = position_in_serializer
         has_set_position['position_in_serializer'] = true
       end
 
-      option_parser.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
+      option_parser.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 |wrapper|
+        env['wrapper'] = wrapper
       end
 
-      option_parser.on('--wo', '--wrapper-open STR', 'Annotation wrapper opening.') do |p|
-        env['wrapper_open'] = p
+      option_parser.on('--wo',
+                       '--wrapper-open STR',
+                       'Annotation wrapper opening.') do |wrapper_open|
+        env['wrapper_open'] = wrapper_open
       end
 
-      option_parser.on('--wc', '--wrapper-close STR', 'Annotation wrapper closing') do |p|
-        env['wrapper_close'] = p
+      option_parser.on('--wc',
+                       '--wrapper-close STR',
+                       'Annotation wrapper closing') do |wrapper_close|
+        env['wrapper_close'] = wrapper_close
       end
 
-      option_parser.on('-r', '--routes', "Annotate routes.rb with the output of 'rake routes'") do
+      option_parser.on('-r',
+                       '--routes',
+                       "Annotate routes.rb with the output of 'rake routes'") do
         env['routes'] = 'true'
       end
 
-      option_parser.on('--models', "Annotate ActiveRecord models") do
+      option_parser.on('--models',
+                       "Annotate ActiveRecord models") do
         env['models'] = 'true'
       end
 
-      option_parser.on('-a', '--active-admin', 'Annotate active_admin models') do
+      option_parser.on('-a',
+                       '--active-admin',
+                       'Annotate active_admin models') do
         env['active_admin'] = 'true'
       end
 
-      option_parser.on('-v', '--version', 'Show the current version of this gem') do
+      option_parser.on('-v',
+                       '--version',
+                       'Show the current version of this gem') do
         puts "annotate v#{Annotate.version}"
         @options[:exit] = true
       end
 
-      option_parser.on('-m', '--show-migration', 'Include the migration version number in the annotation') do
+      option_parser.on('-m',
+                       '--show-migration',
+                       'Include the migration version number in the annotation') do
         env['include_version'] = 'yes'
       end
 
-      option_parser.on('-k', '--show-foreign-keys',
+      option_parser.on('-k',
+                       '--show-foreign-keys',
                        "List the table's foreign key constraints in the annotation") do
         env['show_foreign_keys'] = 'yes'
       end
 
       option_parser.on('--ck',
-                       '--complete-foreign-keys', 'Complete foreign key names in the annotation') do
+                       '--complete-foreign-keys',
+                       'Complete foreign key names in the annotation') do
         env['show_foreign_keys'] = 'yes'
         env['show_complete_foreign_keys'] = 'yes'
       end
 
-      option_parser.on('-i', '--show-indexes',
+      option_parser.on('-i',
+                       '--show-indexes',
                        "List the table's database indexes in the annotation") do
         env['show_indexes'] = 'yes'
       end
 
-      option_parser.on('-s', '--simple-indexes',
+      option_parser.on('-s',
+                       '--simple-indexes',
                        "Concat the column's related indexes in the annotation") do
         env['simple_indexes'] = 'yes'
       end
@@ -168,84 +209,95 @@ module Annotate
       end
 
       option_parser.on('--ignore-model-subdirects',
-                       "Ignore subdirectories of the models directory") do |_dir|
+                       "Ignore subdirectories of the models directory") do
         env['ignore_model_sub_dir'] = 'yes'
       end
 
       option_parser.on('--sort',
-                       "Sort columns alphabetically, rather than in creation order") do |_dir|
+                       "Sort columns alphabetically, rather than in creation order") do
         env['sort'] = 'yes'
       end
 
       option_parser.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|
+                       "Sort columns alphabetically, but first goes id, then the rest columns, then the timestamp columns and then the association columns") do
         env['classified_sort'] = 'yes'
       end
 
-      option_parser.on('-R', '--require path',
+      option_parser.on('-R',
+                       '--require path',
                        "Additional file to require before loading models, may be used multiple times") do |path|
-        env['require'] = if !env['require'].blank?
-                           env['require'] + ",#{path}"
+        env['require'] = if env['require'].present?
+                           "#{env['require']},#{path}"
                          else
                            path
                          end
       end
 
-      option_parser.on('-e', '--exclude [tests,fixtures,factories,serializers]', Array, "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
+      option_parser.on('-e',
+                       '--exclude [tests,fixtures,factories,serializers]',
+                       Array,
+                       "Do not annotate fixtures, test files, factories, and/or serializers") do |exclusions|
         exclusions ||= EXCLUSION_LIST
         exclusions.each { |exclusion| env["exclude_#{exclusion}"] = 'yes' }
       end
 
-      option_parser.on('-f', '--format [bare|rdoc|markdown]', FORMAT_TYPES, 'Render Schema Infomation as plain/RDoc/Markdown') do |fmt|
-        env["format_#{fmt}"] = 'yes'
+      option_parser.on('-f',
+                       '--format [bare|rdoc|yard|markdown]',
+                       FORMAT_TYPES,
+                       'Render Schema Infomation as plain/RDoc/Yard/Markdown') do |format_type|
+        env["format_#{format_type}"] = 'yes'
       end
 
-      option_parser.on('--force', 'Force new annotations even if there are no changes.') do |_force|
+      option_parser.on('--force',
+                       'Force new annotations even if there are no changes.') do
         env['force'] = 'yes'
       end
 
-      option_parser.on('--frozen', 'Do not allow to change annotations. Exits non-zero if there are going to be changes to files.') do
+      option_parser.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
 
-      option_parser.on('--timestamp', 'Include timestamp in (routes) annotation') do
+      option_parser.on('--timestamp',
+                       'Include timestamp in (routes) annotation') do
         env['timestamp'] = 'true'
       end
 
-      option_parser.on('--trace', 'If unable to annotate a file, print the full stack trace, not just the exception message.') do |_value|
+      option_parser.on('--trace',
+                       'If unable to annotate a file, print the full stack trace, not just the exception message.') do
         env['trace'] = 'yes'
       end
 
-      option_parser.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|
+      option_parser.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
 
-      option_parser.on('--ignore-routes REGEX', "don't annotate routes that match a given REGEX (i.e., `annotate -I '(mobile|resque|pghero)'`") do |regex|
+      option_parser.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
 
-      option_parser.on('--hide-limit-column-types VALUES', "don't show limit for given column types, separated by commas (i.e., `integer,boolean,text`)") do |values|
+      option_parser.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.to_s
       end
 
-      option_parser.on('--hide-default-column-types VALUES', "don't show default for given column types, separated by commas (i.e., `json,jsonb,hstore`)") do |values|
+      option_parser.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.to_s
       end
 
-      option_parser.on('--ignore-unknown-models', "don't display warnings for bad model files") do |_values|
+      option_parser.on('--ignore-unknown-models',
+                       "don't display warnings for bad model files") do
         env['ignore_unknown_models'] = 'true'
       end
 
-      option_parser.on('--with-comment', "include database comments in model annotations") do |_values|
+      option_parser.on('--with-comment',
+                       "include database comments in model annotations") do
         env['with_comment'] = 'true'
       end
     end
-
-    def default_options
-      {
-        target_action: :do_annotations,
-        exit: false
-      }
-    end
   end
 end

data/lib/annotate/version.rb

@@ -1,5 +1,5 @@
 module Annotate
   def self.version
-    '3.0.2'
+    '3.2.0'
   end
 end

data/lib/annotate.rb

@@ -1,10 +1,9 @@
-# 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...
@@ -17,36 +16,6 @@ rescue StandardError
 end
 
 module Annotate
-  ##
-  # 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 = [
-    :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
-
-  def self.all_options
-    [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS]
-  end
-
   ##
   # Set default values that can be overridden via environment variables.
   #
@@ -54,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(',')
@@ -74,69 +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'] =~ Constants::TRUE_RE || ENV['skip_on_db_migrate'] =~ Constants::TRUE_RE
-  end
-
-  def self.include_routes?
-    ENV['routes'] =~ Constants::TRUE_RE
-  end
-
-  def self.include_models?
-    ENV['models'] =~ Constants::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 =~ Constants::TRUE_RE
-    true
+    def load_requires(options)
+      options[:require].count > 0 &&
+        options[:require].each { |path| require path }
+    end
   end
 end

data/lib/generators/annotate/templates/auto_annotate_models.rake

@@ -7,9 +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'                      => 'false',
+      'models'                      => 'true',
       'position_in_routes'          => 'before',
       'position_in_class'           => 'before',
       'position_in_test'            => 'before',
@@ -41,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',

data/lib/tasks/annotate_models.rake

@@ -11,46 +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')
+  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.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'])
+  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
@@ -64,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