Class: AnnotateRb::Options

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/annotate_rb/options.rb

Overview

Used to hold all of the options when annotating models and routes. Should be the source of truth for what are valid options.

Constant Summary collapse

POSITION_OPTIONS = 
{
  position: nil, # ModelAnnotator, RouteAnnotator
  position_in_additional_file_patterns: nil, # ModelAnnotator
  position_in_class: nil, # ModelAnnotator
  position_in_factory: nil, # ModelAnnotator
  position_in_fixture: nil, # ModelAnnotator
  position_in_routes: nil, # RouteAnnotator
  position_in_serializer: nil, # ModelAnnotator
  position_in_test: nil # ModelAnnotator
}.freeze
FLAG_OPTIONS = 
{
  classified_sort: true, # ModelAnnotator
  exclude_controllers: true, # ModelAnnotator
  exclude_factories: false, # ModelAnnotator
  exclude_fixtures: false, # ModelAnnotator
  exclude_helpers: true, # ModelAnnotator
  exclude_scaffolds: true, # ModelAnnotator
  exclude_serializers: false, # ModelAnnotator
  exclude_sti_subclasses: false, # ModelAnnotator
  exclude_tests: false, # ModelAnnotator
  force: false, # ModelAnnotator, but should be used by both
  format_bare: true, # Unused
  format_markdown: false, # ModelAnnotator, RouteAnnotator
  format_rdoc: false, # ModelAnnotator
  format_yard: false, # ModelAnnotator
  frozen: false, # ModelAnnotator, but should be used by both
  ignore_model_sub_dir: false, # ModelAnnotator
  ignore_unknown_models: false, # ModelAnnotator
  include_version: false, # ModelAnnotator
  show_complete_foreign_keys: false, # ModelAnnotator
  show_foreign_keys: true, # ModelAnnotator
  show_indexes: true, # ModelAnnotator
  simple_indexes: false, # ModelAnnotator
  sort: false, # ModelAnnotator
  timestamp: false, # RouteAnnotator
  trace: false, # ModelAnnotator, but is part of Core
  with_comment: true # ModelAnnotator
}.freeze
OTHER_OPTIONS = 
{
  active_admin: false, # ModelAnnotator
  command: nil, # Core
  debug: false, # Core

  # ModelAnnotator
  hide_default_column_types: "",

  # ModelAnnotator
  hide_limit_column_types: "",

  ignore_columns: nil, # ModelAnnotator
  ignore_routes: nil, # RouteAnnotator
  ignore_unknown_models: false, # ModelAnnotator
  models: true, # Core
  routes: false, # Core
  skip_on_db_migrate: false, # Core
  target_action: :do_annotations, # Core; Possible values: :do_annotations, :remove_annotations
  wrapper: nil, # ModelAnnotator, RouteAnnotator
  wrapper_close: nil, # ModelAnnotator, RouteAnnotator
  wrapper_open: nil # ModelAnnotator, RouteAnnotator
}.freeze
PATH_OPTIONS = 
{
  additional_file_patterns: [], # ModelAnnotator
  model_dir: ["app/models"], # ModelAnnotator
  require: [], # Core
  root_dir: [""] # Core; Old model Annotate code depends on it being empty when not provided another value
  # `root_dir` can also be a string but should get converted into an array with that string as the sole element when
  # that happens.
}.freeze
DEFAULT_OPTIONS = 
{}.merge(POSITION_OPTIONS, FLAG_OPTIONS, OTHER_OPTIONS, PATH_OPTIONS).freeze
FLAG_OPTION_KEYS = 
[
  :classified_sort,
  :exclude_controllers,
  :exclude_factories,
  :exclude_fixtures,
  :exclude_helpers,
  :exclude_scaffolds,
  :exclude_serializers,
  :exclude_sti_subclasses,
  :exclude_tests,
  :force,
  :format_markdown,
  :format_rdoc,
  :format_yard,
  :frozen,
  :ignore_model_sub_dir,
  :ignore_unknown_models,
  :include_version,
  :show_complete_foreign_keys,
  :show_foreign_keys,
  :show_indexes,
  :simple_indexes,
  :sort,
  :timestamp,
  :trace,
  :with_comment
].freeze
OTHER_OPTION_KEYS = 
[
  :active_admin,
  :command,
  :debug,
  :hide_default_column_types,
  :hide_limit_column_types,
  :ignore_columns,
  :ignore_routes,
  :ignore_unknown_models,
  :models,
  :routes,
  :skip_on_db_migrate,
  :target_action,
  :wrapper,
  :wrapper_close,
  :wrapper_open
].freeze
PATH_OPTION_KEYS = 
[
  :additional_file_patterns,
  :model_dir,
  :require,
  :root_dir
].freeze
ALL_OPTION_KEYS = 
[
  POSITION_OPTIONS.keys, FLAG_OPTION_KEYS, OTHER_OPTION_KEYS, PATH_OPTION_KEYS
].flatten.freeze
POSITION_DEFAULT = 
"before"

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}, state = {}) ⇒ Options

Returns a new instance of Options.



153
154
155
156
157
158
 
# File 'lib/annotate_rb/options.rb', line 153

def initialize(options = {}, state = {})
  @options = options

  # For now, state is a hash to store state that we need but is not a configuration option
  @state = state
end

Class Method Details

.from(options = {}, state = {}) ⇒ Object 



12
13
14
 
# File 'lib/annotate_rb/options.rb', line 12

def from(options = {}, state = {})
  new(options, state).load_defaults
end

Instance Method Details

#get_state(key) ⇒ Object 



202
203
204
 
# File 'lib/annotate_rb/options.rb', line 202

def get_state(key)
  @state[key]
end

#load_defaults ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/annotate_rb/options.rb', line 164

def load_defaults
  ALL_OPTION_KEYS.each do |key|
    @options[key] = DEFAULT_OPTIONS[key] unless @options.key?(key)
  end

  # Set all of the position options in the following order:
  # 1) Use the value if it's defined
  # 2) Use value from :position if it's defined
  # 3) Use default
  POSITION_OPTIONS.keys.each do |key|
    @options[key] = Helper.fallback(
      @options[key], @options[:position], POSITION_DEFAULT
    )
  end

  # Unpack path options if we're passed in a String
  PATH_OPTION_KEYS.each do |key|
    if @options[key].is_a?(String)
      @options[key] = @options[key].split(",").map(&:strip).reject(&:empty?)
    end
  end

  # Set wrapper to default to :wrapper
  @options[:wrapper_open] ||= @options[:wrapper]
  @options[:wrapper_close] ||= @options[:wrapper]

  self
end

#set_state(key, value, overwrite = false) ⇒ Object 



193
194
195
196
197
198
199
200
 
# File 'lib/annotate_rb/options.rb', line 193

def set_state(key, value, overwrite = false)
  if @state.key?(key) && !overwrite
    val = @state[key]
    raise ArgumentError, "Attempting to write '#{value}' to state with key '#{key}', but it already exists with '#{val}'."
  end

  @state[key] = value
end

#to_h ⇒ Object 



160
161
162
 
# File 'lib/annotate_rb/options.rb', line 160

def to_h
  @options.to_h
end