rails-mermaid_erd_markdown 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ca036f9a93d9694b096ad1bce2d2f2ed21a46fa9b2e042a2a6324522301743be
+  data.tar.gz: e518276d23ef0e0b8efa1d68a2d36c2528b5c3f5297414e6bef8b9429c742640
+SHA512:
+  metadata.gz: 8c0791403b7e7c91c35b3c5fb8b17f94fded6b414bf2c98d2f8fed34dd5e75e9b16615b6997bcec2b15c4f962902c5949de26cf69c346fffcee239374d3c9346
+  data.tar.gz: 685f21a2e320ceb5283c92f2f841c777032a97d8f621be3edbd08585b0fdc3b5966d5f05f84a563d4bd58ec3e3b19f81052d216d562843eac4dc9ec5902f2b9c

data/README.md

@@ -0,0 +1,54 @@
+# rails-mermaid_erd_markdown
+
+This is a rails gem that extends the rails-mermaid_erd gem to generate a mermaid ERD for Rails Models in markdown directly in source code. This avoids the need to download the ERD through a html page, which can be difficult for scenarios where one would like to programmatically generate an ERD.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-mermaid_erd_markdown'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rails-mermaid_erd_markdown
+
+## Usage
+
+To generate a mermaid ERD in markdown, run `rails generate_erd` or `rake generate_erd` from the terminal
+
+The default path for the generated ERD is `app/models/ERD.md`. You can modify this by creating an `erd.yml` file in the root directory
+and modifying the `result_path` as seen in the example at `docs/examples/erd.yml`. Make sure to include the markdown file name you 
+wish to generate in the path. 
+
+If an ERD already exists at the path specified, it will be parsed to determine if it is up to date. If it is, nothing happens. If it 
+is not, the ERD is ed. 
+
+One can create self-updating, living documentation by integrating this rake task into their CI. This ensures that the ERD is always up 
+to date and accurately describes the latest state of the models and their relationships.
+
+You can view the ERD by navigating to the file in Github, which supports rendering mermaid diagrams from code. If you are a Visual 
+Studio Code user, you can use the [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) extension to view the ERD directly in your IDE. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rails-mermaid_erd_markdown. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/rails-mermaid_erd_markdown/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the rails-mermaid_erd_markdown project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rails-mermaid_erd_markdown/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/docs/examples/erd.yml

@@ -0,0 +1,4 @@
+# This is the path and filename of the generated ERD. You can modify it to change where the ERD is stored/updated.
+# Default output path: 'app/ERD.md'
+erd:
+    output_path: 'app/ERD.md'

data/lib/rails-mermaid_erd_markdown/configuration.rb

@@ -0,0 +1,20 @@
+require "yaml"
+require "logger"
+
+class MermaidErdMarkdown::Configuration
+  attr_accessor :output_path
+
+  def initialize
+    config = {
+      output_path: "app/models/ERD.md"
+    }
+    erd_config_path = "erd.yml"
+
+    begin
+      erd_yml = YAML.safe_load File.open(erd_config_path)
+      @output_path = erd_yml["erd"]["output_path"]
+    rescue StandardError
+      @output_path = config[:output_path]
+    end
+  end
+end

data/lib/rails-mermaid_erd_markdown/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MermaidErdMarkdown
+  VERSION = "0.1.0"
+end

data/lib/rails-mermaid_erd_markdown.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "rails-mermaid_erd_markdown/configuration"
+require "digest/md5"
+require "rake"
+require "rake/dsl_definition"
+require "pathname"
+require "logger"
+
+module MermaidErdMarkdown
+  extend Rake::DSL
+
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new($stdout).tap do |log|
+        log.progname = name
+      end
+    end
+
+    def configuration
+      @configuration ||= MermaidErdMarkdown::Configuration.new
+    end
+
+    def perform
+      new_erd = generate_mermaid_erd
+      existing_erd_path = Pathname.new(configuration.output_path)
+
+      unless existing_erd_path.exist?
+        logger.info("ERD does not currently exist at result path. Creating...")
+        begin
+          create_erd_file(new_erd)
+          logger.info("ERD successfully created at #{configuration.output_path}")
+        rescue StandardError
+          logger.info("Could not create ERD. Output path is invalid.")
+        end
+
+        return
+      end
+
+      existing_erd = File.read(existing_erd_path)
+      update_erd_file(existing_erd, new_erd)
+    end
+
+    def update_erd_file(current_erd, new_erd)
+      # check if two diagrams are the same by comparing their MD5 hashes
+      if Digest::MD5.hexdigest(current_erd) == Digest::MD5.hexdigest(new_erd)
+        logger.info("ERD already exists and is up to date. Skipping...")
+        return
+      end
+
+      logger.info("ERD already exists but is out of date. Overwriting...")
+      File.write(configuration.output_path, new_erd)
+      logger.info("ERD successfully updated")
+
+      nil
+    end
+
+    def create_erd_file(erd)
+      File.write(configuration.output_path, erd)
+
+      nil
+    end
+
+    def generate_mermaid_erd
+      data = RailsMermaidErd::Builder.model_data
+
+      is_show_key = true
+      is_show_relation_comment = true
+
+      lines = ["```mermaid"]
+      lines << "erDiagram"
+      lines << "    %% --------------------------------------------------------"
+      lines << "    %% Entity-Relationship Diagram"
+      lines << "    %% --------------------------------------------------------"
+      lines << ""
+
+      data[:Models].each do |model|
+        lines << "    %% table name: #{model[:TableName]}"
+        lines << "    #{model[:ModelName].tr(":", "-")}{"
+
+        model[:Columns].each do |column|
+          key = is_show_key ? column[:key] : ""
+          lines << "        #{column[:type]} #{column[:name]} #{key} "
+        end
+
+        lines << "    }"
+        lines << ""
+      end
+
+      data[:Relations].each do |relation|
+        left_model_name = relation[:LeftModelName].tr(":", "-")
+        right_model_name = relation[:RightModelName].tr(":", "-")
+        comment = is_show_relation_comment ? ": \"#{relation[:Comment]}\"" : ": \"\""
+
+        lines << "    #{left_model_name} #{relation[:LeftValue]}#{relation[:Line]}#{relation[:RightValue]} #{right_model_name} #{comment}"
+      end
+
+      lines << "```"
+      lines.join("\n")
+    end
+  end
+
+  desc "Generate/update mermaid ERD diagram for database Models."
+  task generate_erd: :environment do
+    perform
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: rails-mermaid_erd_markdown
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- humzahkiani
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+description:
+email:
+- 89326566+humzahkiani@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- docs/examples/erd.yml
+- lib/rails-mermaid_erd_markdown.rb
+- lib/rails-mermaid_erd_markdown/configuration.rb
+- lib/rails-mermaid_erd_markdown/version.rb
+homepage: https://github.com/humzahkiani/rails-mermaid_erd_markdown
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/humzahkiani/rails-mermaid_erd_markdown
+  source_code_uri: https://github.com/humzahkiani/rails-mermaid_erd_markdown
+  changelog_uri: https://github.com/humzahkiani/rails-mermaid_erd_markdown/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.3
+signing_key:
+specification_version: 4
+summary: This is a rails gem that extends the rails-mermaid_erd gem to generate a
+  mermaid ERD for Rails Models in markdown directly in source code.
+test_files: []