Module: Annotator::InitialDescription

Defined in:
lib/annotator/initial_description.rb,
lib/annotator/initial_description/base.rb,
lib/annotator/initial_description/rails.rb,
lib/annotator/initial_description/devise.rb,
lib/annotator/initial_description/paperclip.rb,
lib/annotator/initial_description/belongs_to.rb

Defined Under Namespace

Classes: Base, BelongsTo, Devise, Paperclip, Rails

Constant Summary collapse

DEFAULT_DESCRIPTION = 
"TODO: document me"
NO_DESCRIPTION_COLUMNS = 
%w{email name title body}

Class Method Summary collapse

Class Method Details

.for(model, column) ⇒ Object

Get initial description for given model & column



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/annotator/initial_description.rb', line 11

def self.for(model, column)
  # Check if any module provides such description
  Base.providers.each do |klass|
    provider = klass.new model, column
    return provider.text if provider.check
  end
  # Some columns are just too obvious
  return "" if NO_DESCRIPTION_COLUMNS.include? column
  # Let user do the work
  return DEFAULT_DESCRIPTION
end