rails-plant_uml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5a7c3a523233698db255ec7c48fac143292c8d797c164006c99671843438c764
+  data.tar.gz: 8870df85ab949000effb9049e0e4e8aa96ed973b92554d39b4a45acdd60701d5
+SHA512:
+  metadata.gz: 66b9129bf10a625cc87058f0f7de5cff2da5c2d4be58b294ab064f4be5c94c9bfa5d55f818e9dc654b27f2a5ae05da4f55640bbe4f21fdfe212da6bcdb42c6da
+  data.tar.gz: a53486bfb65dd6a44fd62bd1ea13b9c5d9ebe99898a4e08790ff5c18fadbba6154e2943f3e06cdce794552030431b26f89c7b11bac4ba2109841882d29d23a6b

data/lib/rails/plant_uml/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rails"
+
+module Rails
+  module PlantUml
+    class Railtie < Rails::Railtie
+      rake_tasks do
+        # add tasks from rails/plant_uml/tasks
+        load File.expand_path("../tasks/rails_erd.rake", __FILE__)
+      end
+    end
+  end
+end

data/lib/rails/plant_uml/tasks/rails_erd.rake

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+namespace :erd do
+  desc "Generate a PlantUML diagram of your models"
+  task plant_uml: :environment do
+    require "rails/plant_uml"
+
+    options = {
+      filename: "erd.puml",
+      title: "Entity Relationship Diagram",
+      app_name: Rails.application.class.module_parent_name
+    }
+
+    diagram = RailsErd::PlantUml.new(RailsERD::Domain.generate, options)
+    diagram.save
+  end
+end

data/lib/rails/plant_uml/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Rails
+  module PlantUml
+    VERSION = "0.1.0"
+  end
+end

data/lib/rails/plant_uml.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require "rails_erd"
+require "rails_erd/diagram"
+require "rails_erd/diagram/graphviz"
+require "active_support/core_ext/string"
+require "rails/plant_uml/railtie"
+
+module RailsErd
+  # PlantUML implementation of the Diagram class, which will output a .puml file
+  # that can be processed by the PlantUML renderer.
+  class PlantUml < RailsERD::Diagram
+    setup do
+      @markup = []
+      @relationships = []
+    end
+
+    # Initialize the diagram
+    def initialize(domain, options = {})
+      @domain = domain
+      @title = options[:title] || "Entity Relationship Diagram"
+      @app_name = options[:app_name] || "SOFware"
+      @filename = options[:filename] || "erd.puml"
+      @filename += ".puml" unless @filename.end_with?(".puml")
+      @only = options[:only]
+      @timestamp = Time.current.iso8601
+      @markup = []
+    end
+
+    # Main method to generate the PlantUML diagram
+    def save
+      # Generate the PlantUML content
+      generate_diagram
+
+      # Write to file
+      File.write(@filename, @markup.join("\n"))
+
+      # Return the filename so it can be used in the CLI output
+      @filename
+    end
+
+    private
+
+    # Assemble the full PlantUML diagram
+    def generate_diagram
+      # Start the PlantUML diagram with a name based on the title
+      diagram_name = @title ? @title.gsub(/\s+/, "_") : "ERD"
+      @markup << "@startuml #{diagram_name}"
+
+      # Add title if provided
+      @markup << "title #{@title}".indent(2) if @title
+
+      # Add creation timestamp as a note
+      @markup << "note \"Generated by #{@app_name} on #{@timestamp}\" as GenerationNote".indent(2)
+
+      if @only
+        @domain.entities.select { |e| @only.include?(e.name) }
+      else
+        @domain.entities
+      end.each do |entity|
+        add_entity(entity)
+      end
+
+      if @only
+        @domain.relationships.select { |r| @only.include?(r.source.name) && @only.include?(r.destination.name) }
+      else
+        @domain.relationships
+      end.each do |relationship|
+        add_relationship(relationship)
+      end
+
+      # End the PlantUML diagram
+      @markup << "@enduml"
+    end
+
+    # Convert an entity (model) to PlantUML class notation
+    def add_entity(entity)
+      # Start class definition
+      @markup << "class #{entity.name} {".indent(2)
+
+      # Get foreign key attributes directly
+      foreign_key_attributes = entity.attributes.select { |attr| attr.foreign_key? }
+
+      # Only show foreign keys section if there are foreign keys
+      if foreign_key_attributes.any?
+        @markup << "  .. Foreign Keys ..".indent(2)
+        foreign_key_attributes.each do |attribute|
+          @markup << "  + #{attribute.name} : #{attribute.type}".indent(2)
+        end
+      end
+
+      # End class definition
+      @markup << "}".indent(2)
+      @markup << ""  # Empty line for readability
+    end
+
+    # Convert a relationship to PlantUML relationship notation
+    def add_relationship(relationship)
+      source = relationship.source.name
+      destination = relationship.destination.name
+
+      # Get the Rails models to check their associations
+      source_model = begin
+        source.constantize
+      rescue
+        nil
+      end
+      destination_model = begin
+        destination.constantize
+      rescue
+        nil
+      end
+
+      # Default to the relationship cardinality from RailsERD
+      cardinality = relationship.cardinality
+
+      # Try to determine the relationship type from Rails models
+      if source_model && destination_model && source_model.is_a?(Class) && destination_model.is_a?(Class)
+        source_association = source_model.reflect_on_association(destination.underscore.to_sym)&.macro
+        destination_association = destination_model.reflect_on_association(source.underscore.to_sym)&.macro
+
+        cardinality = if ([source_association, destination_association].compact & [:belongs_to, :has_many]).present?
+          :many
+        elsif [source_association, destination_association].include? :has_one
+          :one
+        elsif source_model.reflect_on_association(destination.pluralize.underscore.to_sym)&.macro == :has_and_belongs_to_many ||
+            destination_model.reflect_on_association(source.pluralize.underscore.to_sym)&.macro == :has_and_belongs_to_many
+          :many_to_many
+        end
+      end
+
+      # Determine relationship type and convert to PlantUML arrow notation
+      @markup << case cardinality
+      when :one
+        # One-to-one relationship
+        "#{source} \"1\" -- \"1\" #{destination}".indent(2)
+      when :many
+        # One-to-many relationship
+        if relationship.source_optional?
+          "#{source} \"0..1\" -- \"*\" #{destination}".indent(2)
+        else
+          "#{source} \"1\" -- \"*\" #{destination}".indent(2)
+        end
+      when :many_to_many
+        # Many-to-many relationship
+        "#{source} \"*\" -- \"*\" #{destination}".indent(2)
+      else
+        # Default relationship
+        "#{source} -- #{destination}".indent(2)
+      end
+    end
+  end
+end

data/lib/rails-plant_uml.rb

@@ -0,0 +1 @@
+require_relative "rails/plant_uml"

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rails-plant_uml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jim Gay
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: rails-erd
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.0
+description: Adds a PlantUML output format to RailsERD.
+email:
+- jim@saturnflyer.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/rails-plant_uml.rb
+- lib/rails/plant_uml.rb
+- lib/rails/plant_uml/railtie.rb
+- lib/rails/plant_uml/tasks/rails_erd.rake
+- lib/rails/plant_uml/version.rb
+homepage: https://github.com/SOFware/rails-plant_uml
+licenses: []
+metadata:
+  homepage_uri: https://github.com/SOFware/rails-plant_uml
+  source_code_uri: https://github.com/SOFware/rails-plant_uml
+  changelog_uri: https://github.com/SOFware/rails-plant_uml/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Tie into RailsERD to generate PlantUML diagrams.
+test_files: []