rails-mermaid_erd_markdown 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67e66530c607079c622c67375de2af66f2e7622c10049a8972ee54daceced528
-  data.tar.gz: 79d8cde31fdd334cc53bb43e8bc86088d1525561cd8c05ad523dfd36b287a57c
+  metadata.gz: 1fc2645eeda1d07ce73a989297a6de24e9a28e8dd2a812bf94dca1eb7d9d0dd8
+  data.tar.gz: 20534d950c4ab8109286bd708e133516ce4a4e3ce0e7ba8991a664e23e2c0222
 SHA512:
-  metadata.gz: fb3657a451d92dc2520057b37c5fe75486ec1f6ecbfde168ae498e4b1213b40acca495cff3307aa704e99940b35069b1d9e61af8dd5d4b73dc92a489a4fb0c1d
-  data.tar.gz: 58fd1f844c7b8c16645bcdd48f7532d9175e1d53b0ad90ddef9a05021cdd2fa7e00968140d9bace215b4545f8917226b2f788adb15b6ece53c58857896cf1b10
+  metadata.gz: 4f99bb71981c90be8d6f0c6ad6725133b8e39b2e48664e4bd0dfae24314a24b9dee3045b939e33f5101ce4fd607fb5d5e3768ecd0e85a9e5f8b745bb87ccc248
+  data.tar.gz: 6980b1b01319af831bfc2798949fae4b85d6dc152e73dcd9469e704a6805711c1ae98cbcea066ea4fb062c153d8d57d2f5580aeea27b2039771656d488563a93

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
 ## [0.1.0] - 2024-05-27
-
 - Initial release
+- Create ERD mermaid markdown of all ActiveRecord models
+
+## [0.2.0] - 2024-05-28
+- Fix issues with package
+- Update gemspec
+
+## [0.3.0] - 2024-07-31
+- Fix minor issues
+- Add ability to optionally split into multiple ERDs 
+- Refactor classes to separate concerns
+
+## [0.3.1] - 2024-08-10
+- Update docs
+- Change rails-mermaid_erd version dependency to at least 0.4.2

data/Gemfile.lock

@@ -1,92 +1,88 @@
 PATH
   remote: .
   specs:
-    rails-mermaid_erd_markdown (0.3.0)
+    rails-mermaid_erd_markdown (0.3.1)
       rails (>= 5.2)
-      rails-mermaid_erd (~> 0.4.2)
+      rails-mermaid_erd (>= 0.4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actioncable (7.2.0)
+      actionpack (= 7.2.0)
+      activesupport (= 7.2.0)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
       zeitwerk (~> 2.6)
-    actionmailbox (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activestorage (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      mail (>= 2.7.1)
-      net-imap
-      net-pop
-      net-smtp
-    actionmailer (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      actionview (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      mail (~> 2.5, >= 2.5.4)
-      net-imap
-      net-pop
-      net-smtp
+    actionmailbox (7.2.0)
+      actionpack (= 7.2.0)
+      activejob (= 7.2.0)
+      activerecord (= 7.2.0)
+      activestorage (= 7.2.0)
+      activesupport (= 7.2.0)
+      mail (>= 2.8.0)
+    actionmailer (7.2.0)
+      actionpack (= 7.2.0)
+      actionview (= 7.2.0)
+      activejob (= 7.2.0)
+      activesupport (= 7.2.0)
+      mail (>= 2.8.0)
       rails-dom-testing (~> 2.2)
-    actionpack (7.1.3.4)
-      actionview (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionpack (7.2.0)
+      actionview (= 7.2.0)
+      activesupport (= 7.2.0)
       nokogiri (>= 1.8.5)
       racc
-      rack (>= 2.2.4)
+      rack (>= 2.2.4, < 3.2)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actiontext (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activestorage (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+      useragent (~> 0.16)
+    actiontext (7.2.0)
+      actionpack (= 7.2.0)
+      activerecord (= 7.2.0)
+      activestorage (= 7.2.0)
+      activesupport (= 7.2.0)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionview (7.2.0)
+      activesupport (= 7.2.0)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activejob (7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activejob (7.2.0)
+      activesupport (= 7.2.0)
       globalid (>= 0.3.6)
-    activemodel (7.1.3.4)
-      activesupport (= 7.1.3.4)
-    activerecord (7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activemodel (7.2.0)
+      activesupport (= 7.2.0)
+    activerecord (7.2.0)
+      activemodel (= 7.2.0)
+      activesupport (= 7.2.0)
       timeout (>= 0.4.0)
-    activestorage (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    activestorage (7.2.0)
+      actionpack (= 7.2.0)
+      activejob (= 7.2.0)
+      activerecord (= 7.2.0)
+      activesupport (= 7.2.0)
       marcel (~> 1.0)
-    activesupport (7.1.3.4)
+    activesupport (7.2.0)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     ast (2.4.2)
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crass (1.0.6)
     date (3.3.4)
@@ -102,6 +98,7 @@ GEM
       reline (>= 0.4.2)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
+    logger (1.6.0)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -112,8 +109,7 @@ GEM
       net-smtp
     marcel (1.0.4)
     mini_mime (1.1.5)
-    minitest (5.23.1)
-    mutex_m (0.2.0)
+    minitest (5.24.1)
     net-imap (0.4.14)
       date
       net-protocol
@@ -126,17 +122,13 @@ GEM
     nio4r (2.7.3)
     nokogiri (1.16.7-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-darwin)
-      racc (~> 1.4)
-    nokogiri (1.16.7-x86_64-linux)
-      racc (~> 1.4)
     parallel (1.24.0)
     parser (3.3.1.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
-    racc (1.8.0)
+    racc (1.8.1)
     rack (3.1.7)
     rack-session (2.0.0)
       rack (>= 3.0.0)
@@ -145,20 +137,20 @@ GEM
     rackup (2.1.0)
       rack (>= 3)
       webrick (~> 1.8)
-    rails (7.1.3.4)
-      actioncable (= 7.1.3.4)
-      actionmailbox (= 7.1.3.4)
-      actionmailer (= 7.1.3.4)
-      actionpack (= 7.1.3.4)
-      actiontext (= 7.1.3.4)
-      actionview (= 7.1.3.4)
-      activejob (= 7.1.3.4)
-      activemodel (= 7.1.3.4)
-      activerecord (= 7.1.3.4)
-      activestorage (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    rails (7.2.0)
+      actioncable (= 7.2.0)
+      actionmailbox (= 7.2.0)
+      actionmailer (= 7.2.0)
+      actionpack (= 7.2.0)
+      actiontext (= 7.2.0)
+      actionview (= 7.2.0)
+      activejob (= 7.2.0)
+      activemodel (= 7.2.0)
+      activerecord (= 7.2.0)
+      activestorage (= 7.2.0)
+      activesupport (= 7.2.0)
       bundler (>= 1.15.0)
-      railties (= 7.1.3.4)
+      railties (= 7.2.0)
     rails-dom-testing (2.2.0)
       activesupport (>= 5.0.0)
       minitest
@@ -166,12 +158,12 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    rails-mermaid_erd (0.4.2)
+    rails-mermaid_erd (0.5.0)
       rails (>= 5.2)
-    railties (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      irb
+    railties (7.2.0)
+      actionpack (= 7.2.0)
+      activesupport (= 7.2.0)
+      irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
@@ -199,6 +191,7 @@ GEM
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
     ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
     sqlite3 (1.7.3-arm64-darwin)
     sqlite3 (1.7.3-x86_64-darwin)
     sqlite3 (1.7.3-x86_64-linux)
@@ -209,6 +202,7 @@ GEM
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
+    useragent (0.16.10)
     webrick (1.8.1)
     websocket-driver (0.7.6)
       websocket-extensions (>= 0.1.0)

data/README.md

@@ -1,36 +1,6 @@
 # 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 `output_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 up to date, the ERD will be updated. 
-
-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.
-
-If your entity diagram is too large to be displayed you can set a `split_output` configuration to `true` to generate multiple ERD files based on each model in your project. You can also set a `relationship_depth` configuration to include more than 1 level (the default) of associations in each document.
+A Ruby on Rails gem that extends rails-mermaid_erd to generate mermaid Entity-Relationship Diagrams (ERD) for ActiveRecord Models. When combined with Continuous Integration (CI) pipelines, it enables one to generate living, self-updating documentation of their data. 
 
 ## Example ERD
 
@@ -62,6 +32,103 @@ erDiagram
     Comment }o--|| Article : "BT:article"
 ```
 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-mermaid_erd_markdown'
+```
+
+Or install it yourself as:
+
+    $ gem install rails-mermaid_erd_markdown
+
+## Usage
+
+### Generating ERDs
+To generate the comprehensive mermaid ERD in markdown, run one of the following:
+   ```
+   rails generate_erd
+   ``` 
+   OR
+   ```
+   rake generate_erd
+   ``` 
+**If all of your models do not appear, be sure to eager load them first.** 
+
+### Configuration 
+You can configure the ERD generation by creating a `erd.yml` file in your root, and modifying the following fields. 
+
+``` 
+# erd.yml
+erd:
+    output_path: 'app/ERD.md' # Set output path of ERDs, default: 'app/ERD.md'
+    split_output: false, # Generates individual ERDs for each model with a specified depth, default: false
+    relationship_depth: 1 # Configured depth of individual ERD model generation, default: 1
+
+```
+
+If your entity diagram is too large to be displayed you can set a `split_output` configuration to `true` to generate multiple ERD files based on each model in your project. 
+
+You can also set a `relationship_depth` configuration to include more than 1 level (the default) of associations in each document.
+
+
+### Viewing Diagrams
+
+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 any markdown preview extension such as [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) view the ERD directly in your IDE.
+
+
+### Integration with CI Pipeline
+The most value of this gem comes with the integration of it's diagram generation into your CI. The amount of effort required to update documentation has always been the greatest deterrant to creating new documentation. By integrating this rake task into your CI, you can have the CI update the model for you anytime that it changes. 
+
+The following is a Github Actions job example for how one might do this for a Rails app that uses PostgreSQL: 
+
+```yml
+permissions:
+  contents: write
+  packages: read
+
+jobs:
+  update-erd:
+      runs-on: ubuntu-latest
+      services:
+          postgres:
+              image: postgres
+              env:
+                  POSTGRES_USER: postgres
+                  POSTGRES_PASSWORD: postgres
+              ports:
+              - 5432:5432
+              options:
+              - --health-cmd="pg_is_ready" --health-interval=10s --health-timeout=5s --health-retries=3
+      steps:
+      - name: Install packages
+        run:
+          sudo apt-get update && sudo apt-get install --no-install-recommends -y google-chrome-stable curl libvips postgresql-client libpq-dev
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with: 
+          ref: ${{ github.event.pull_request.head.ref }}
+      - name: Setup database
+        env:
+          RAILS_ENV: test
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432
+        run: bin/rails db:setup
+      - name: Setup database
+        env:
+          RAILS_ENV: test
+          DATABASE_URL: postgres://postgres:postgres@localhost:5432
+        run: bin/rails generate_erd
+      - name: Commit and Push Updated ERD
+        run: |
+          git config --global user.name 'Github Actions Bot'
+          git config --global user.email 'actions/@users.noreply.github.com'
+          git add app/models/ERD.md 
+          git commit -m "Update ERD" || echo "No changes to commit"
+```
+
 ## 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.

data/docs/examples/erd.yml

@@ -1,4 +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/models/ERD.md'
 erd:
-    output_path: 'app/ERD.md'
+    output_path: 'app/ERD.md' # Set output path of ERDs, default: 'app/ERD.md'
+    split_output: false, # Generates individual ERDs for each model with a specified depth, default: false
+    relationship_depth: 1 # Configured depth of individual ERD model generation, default: 1

data/lib/rails-mermaid_erd_markdown/version.rb

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

data/rails-mermaid_erd_markdown.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors = ["humzahkiani"]
   spec.email = ["89326566+humzahkiani@users.noreply.github.com"]
 
-  spec.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."
+  spec.summary = "Extends the rails-mermaid_erd gem to generate mermaid ERDs in markdown " \
+                 "for Ruby on Rails ActiveRecord Models"
   spec.homepage = "https://github.com/humzahkiani/rails-mermaid_erd_markdown"
   spec.license = "MIT"
   spec.required_ruby_version = ">= 2.6.0"
@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   # Runtime Dependencies
   spec.add_dependency "rails", ">= 5.2"
-  spec.add_dependency "rails-mermaid_erd", "~> 0.4.2"
+  spec.add_dependency "rails-mermaid_erd", ">= 0.4.2"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd_markdown
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - humzahkiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-31 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,14 +28,14 @@ dependencies:
   name: rails-mermaid_erd
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.2
 description:
@@ -106,6 +106,6 @@ 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.
+summary: Extends the rails-mermaid_erd gem to generate mermaid ERDs in markdown for
+  Ruby on Rails ActiveRecord Models
 test_files: []