Class: AnnotateRb::ModelAnnotator::ForeignKeyAnnotation::AnnotationBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/annotate_rb/model_annotator/foreign_key_annotation/annotation_builder.rb

Instance Method Summary collapse

Constructor Details

#initialize(model, options) ⇒ AnnotationBuilder

Returns a new instance of AnnotationBuilder.



7
8
9
10
 
# File 'lib/annotate_rb/model_annotator/foreign_key_annotation/annotation_builder.rb', line 7

def initialize(model, options)
  @model = model
  @options = options
end

Instance Method Details

#build ⇒ Object 



12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/annotate_rb/model_annotator/foreign_key_annotation/annotation_builder.rb', line 12

def build
  fk_info = if @options[:format_markdown]
    "#\n# ### Foreign Keys\n#\n"
  else
    "#\n# Foreign Keys\n#\n"
  end

  return "" unless @model.connection.respond_to?(:supports_foreign_keys?) &&
    @model.connection.supports_foreign_keys? && @model.connection.respond_to?(:foreign_keys)

  foreign_keys = @model.connection.foreign_keys(@model.table_name)
  return "" if foreign_keys.empty?

  format_name = lambda do |fk|
    return fk.options[:column] if fk.name.blank?

    @options[:show_complete_foreign_keys] ? fk.name : fk.name.gsub(/(?<=^fk_rails_)[0-9a-f]{10}$/, "...")
  end

  max_size = foreign_keys.map(&format_name).map(&:size).max + 1
  foreign_keys.sort_by { |fk| [format_name.call(fk), fk.column] }.each do |fk|
    ref_info = "#{fk.column} => #{fk.to_table}.#{fk.primary_key}"
    constraints_info = ""
    constraints_info += "ON DELETE => #{fk.on_delete} " if fk.on_delete
    constraints_info += "ON UPDATE => #{fk.on_update} " if fk.on_update
    constraints_info = constraints_info.strip

    fk_info += if @options[:format_markdown]
      format("# * `%s`%s:\n#     * **`%s`**\n",
        format_name.call(fk),
        constraints_info.blank? ? "" : " (_#{constraints_info}_)",
        ref_info)
    else
      format("#  %-#{max_size}.#{max_size}s %s %s",
        format_name.call(fk),
        "(#{ref_info})",
        constraints_info).rstrip + "\n"
    end
  end

  fk_info
end