module Annotate

Constants

FLAG_OPTIONS
OTHER_OPTIONS
PATH_OPTIONS
POSITION_OPTIONS

The set of available options to customize the behavior of Annotate.

TRUE_RE

Public Class Methods

all_options() click to toggle source
# File lib/annotate.rb, line 47
def self.all_options
  [POSITION_OPTIONS, FLAG_OPTIONS, PATH_OPTIONS, OTHER_OPTIONS]
end
bootstrap_rake() click to toggle source
# File lib/annotate.rb, line 167
def self.bootstrap_rake
  begin
    require 'rake/dsl_definition'
  rescue StandardError => e
    # We might just be on an old version of Rake...
    $stderr.puts e.message
    exit e.status_code
  end
  require 'rake'

  load './Rakefile' if File.exist?('./Rakefile')
  begin
    Rake::Task[:environment].invoke
  rescue
    nil
  end
  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

  load_tasks
  Rake::Task[:set_annotation_options].invoke
end
eager_load(options) click to toggle source
# File lib/annotate.rb, line 142
def self.eager_load(options)
  load_requires(options)
  require 'annotate/active_record_patch'

  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|
          require_dependency file.sub(matcher, '\1')
        end
      end
    else
      klass = Rails::Application.send(:subclasses).first
      klass.eager_load!
    end
  else
    options[:model_dir].each do |dir|
      FileList["#{dir}/**/*.rb"].each do |fname|
        require File.expand_path(fname)
      end
    end
  end
end
fallback(*args) click to toggle source
# File lib/annotate.rb, line 195
def self.fallback(*args)
  args.detect { |arg| !arg.blank? }
end
include_models?() click to toggle source
# File lib/annotate.rb, line 116
def self.include_models?
  ENV['routes'] !~ TRUE_RE
end
include_routes?() click to toggle source
# File lib/annotate.rb, line 112
def self.include_routes?
  ENV['routes'] =~ TRUE_RE
end
load_requires(options) click to toggle source
# File lib/annotate.rb, line 137
def self.load_requires(options)
  options[:require].count > 0 &&
    options[:require].each { |path| require path }
end
load_tasks() click to toggle source
# File lib/annotate.rb, line 128
def self.load_tasks
  return if loaded_tasks
  self.loaded_tasks = true

  Dir[File.join(File.dirname(__FILE__), 'tasks', '**/*.rake')].each do |rake|
    load rake
  end
end
loaded_tasks() click to toggle source
# File lib/annotate.rb, line 124
def self.loaded_tasks
  @loaded_tasks
end
loaded_tasks=(val) click to toggle source
# File lib/annotate.rb, line 120
def self.loaded_tasks=(val)
  @loaded_tasks = val
end
reset_options() click to toggle source
# File lib/annotate.rb, line 104
def self.reset_options
  all_options.flatten.each { |key| ENV[key.to_s] = nil }
end
set_defaults(options = {}) click to toggle source

Set default values that can be overridden via environment variables.

# File lib/annotate.rb, line 54
def self.set_defaults(options = {})
  return if @has_set_defaults
  @has_set_defaults = true

  options = HashWithIndifferentAccess.new(options)

  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
    end

    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
setup_options(options = {}) click to toggle source

TODO: what is the difference between this and ::set_defaults?

# File lib/annotate.rb, line 77
def self.setup_options(options = {})
  POSITION_OPTIONS.each do |key|
    options[key] = fallback(ENV[key.to_s], ENV['position'], 'before')
  end
  FLAG_OPTIONS.each do |key|
    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
  end
  PATH_OPTIONS.each do |key|
    options[key] = !ENV[key.to_s].blank? ? ENV[key.to_s].split(',') : []
  end

  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
end
skip_on_migration?() click to toggle source
# File lib/annotate.rb, line 108
def self.skip_on_migration?
  ENV['ANNOTATE_SKIP_ON_DB_MIGRATE'] =~ TRUE_RE || ENV['skip_on_db_migrate'] =~ TRUE_RE
end
true?(val) click to toggle source
# File lib/annotate.rb, line 199
def self.true?(val)
  return false if val.blank?
  return false unless val =~ TRUE_RE
  true
end
version() click to toggle source
# File lib/annotate/version.rb, line 2
def self.version
  '2.7.3'
end