Module: MermaidRailsErd

Defined in:
lib/mermaid_rails_erd.rb,
lib/mermaid_rails_erd/railtie.rb,
lib/mermaid_rails_erd/version.rb,
lib/mermaid_rails_erd/generator.rb,
lib/mermaid_rails_erd/column_info.rb,
lib/mermaid_rails_erd/parsed_data.rb,
lib/mermaid_rails_erd/model_loader.rb,
lib/mermaid_rails_erd/relationship.rb,
lib/mermaid_rails_erd/mermaid_emitter.rb,
lib/mermaid_rails_erd/association_resolver.rb,
lib/mermaid_rails_erd/model_data_collector.rb,
lib/mermaid_rails_erd/relationship_registry.rb,
lib/mermaid_rails_erd/relationship_symbol_mapper.rb,
lib/mermaid_rails_erd/polymorphic_targets_resolver.rb,
lib/mermaid_rails_erd/relationship_builders/base_relationship_builder.rb,
lib/mermaid_rails_erd/relationship_builders/habtm_relationship_builder.rb,
lib/mermaid_rails_erd/relationship_builders/has_one_relationship_builder.rb,
lib/mermaid_rails_erd/relationship_builders/has_many_relationship_builder.rb,
lib/mermaid_rails_erd/relationship_builders/belongs_to_relationship_builder.rb

Defined Under Namespace

Modules: RelationshipBuilders Classes: AssociationResolver, ColumnInfo, Error, Generator, MermaidEmitter, ModelDataCollector, ModelLoader, ParsedData, PolymorphicTargetsResolver, Railtie, Relationship, RelationshipRegistry, RelationshipSymbolMapper

Constant Summary collapse

VERSION = 
"1.0.1"

Class Method Summary collapse

Class Method Details

.build ⇒ Generator

Build and return a Generator instance with all data collected

Returns:

  • (Generator) —

    Generator instance with collected data



26
27
28
 
# File 'lib/mermaid_rails_erd.rb', line 26

def self.build
  Generator.new.build
end

.generate(output: $stdout) ⇒ Object

Generate Mermaid ERD and write to output stream

Parameters:

  • output (IO) (defaults to: $stdout) —

    Output stream to write the ERD to



32
33
34
 
# File 'lib/mermaid_rails_erd.rb', line 32

def self.generate(output: $stdout)
  build.emit(output: output)
end