Module: BlastRadius::ActiveRecordExtension::ClassMethods

Defined in:
lib/blast_radius/active_record_extension.rb

Instance Method Summary collapse

Instance Method Details

#blast_radius(options = {}) ⇒ String

Analyze the blast radius for this model class

Parameters:

  • options (Hash) (defaults to: {})

    options

    • :format [Symbol] output format (:text, :mermaid, :json, :dot, :html)
    • :max_depth [Integer] maximum depth
    • :include_nullify [Boolean] include nullify associations
    • :include_restrict [Boolean] include restrict associations

Returns:

  • (String)

    formatted dependency tree



14
15
16
17
18
19
20
# File 'lib/blast_radius/active_record_extension.rb', line 14

def blast_radius(options = {})
  format = options.delete(:format) || BlastRadius.configuration.default_format
  tree = BlastRadius.analyze(self, options)

  formatter = formatter_for(format)
  formatter.format(tree)
end