rails-mermaid_erd_markdown 0.2.0 → 0.3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. checksums.yaml +4 -4
  2. data/.github/CODEOWNERS.md +1 -0
  3. data/.github/workflows/CI.yml +42 -0
  4. data/.github/workflows/codeql.yml +93 -0
  5. data/.rubocop.yml +30 -6
  6. data/.ruby-version +1 -0
  7. data/CHANGELOG.md +14 -1
  8. data/Gemfile +6 -9
  9. data/Gemfile.lock +88 -86
  10. data/README.md +111 -17
  11. data/Rakefile +1 -1
  12. data/bin/console +1 -1
  13. data/bin/rubocop +29 -0
  14. data/docs/examples/erd.yml +3 -3
  15. data/lib/rails-mermaid_erd_markdown/configuration.rb +11 -3
  16. data/lib/rails-mermaid_erd_markdown/generator.rb +169 -0
  17. data/lib/rails-mermaid_erd_markdown/markdown_document.rb +104 -0
  18. data/lib/rails-mermaid_erd_markdown/source_data.rb +63 -0
  19. data/lib/rails-mermaid_erd_markdown/version.rb +1 -1
  20. data/lib/rails-mermaid_erd_markdown.rb +3 -93
  21. data/rails-mermaid_erd_markdown.gemspec +6 -4
  22. data/test/example_output/mock_ERD.md +48 -0
  23. data/test/example_output/mock_ERD_index.md +10 -0
  24. data/test/example_output/mock_ERD_model.md +46 -0
  25. data/test/mock_data/models.rb +105 -0
  26. data/test/test_helper.rb +4 -2
  27. data/test/test_rails/rails-mermaid_erd_markdown/test_generator.rb +54 -0
  28. data/test/test_rails/rails-mermaid_erd_markdown/test_markdown_document.rb +76 -0
  29. data/test/test_rails/rails-mermaid_erd_markdown/test_source_data.rb +70 -0
  30. data/test/test_rails/test_rails-mermaid_erd_markdown.rb +0 -40
  31. metadata +23 -67
  32. data/test/dummy-rails/.dockerignore +0 -37
  33. data/test/dummy-rails/.ruby-version +0 -1
  34. data/test/dummy-rails/Rakefile +0 -6
  35. data/test/dummy-rails/app/assets/config/manifest.js +0 -4
  36. data/test/dummy-rails/app/assets/images/.keep +0 -0
  37. data/test/dummy-rails/app/assets/stylesheets/application.css +0 -15
  38. data/test/dummy-rails/app/channels/application_cable/channel.rb +0 -4
  39. data/test/dummy-rails/app/channels/application_cable/connection.rb +0 -4
  40. data/test/dummy-rails/app/controllers/application_controller.rb +0 -2
  41. data/test/dummy-rails/app/controllers/concerns/.keep +0 -0
  42. data/test/dummy-rails/app/helpers/application_helper.rb +0 -2
  43. data/test/dummy-rails/app/javascript/application.js +0 -3
  44. data/test/dummy-rails/app/javascript/controllers/application.js +0 -9
  45. data/test/dummy-rails/app/javascript/controllers/hello_controller.js +0 -7
  46. data/test/dummy-rails/app/javascript/controllers/index.js +0 -11
  47. data/test/dummy-rails/app/jobs/application_job.rb +0 -7
  48. data/test/dummy-rails/app/mailers/application_mailer.rb +0 -4
  49. data/test/dummy-rails/app/models/application_record.rb +0 -3
  50. data/test/dummy-rails/app/models/concerns/.keep +0 -0
  51. data/test/dummy-rails/app/views/layouts/application.html.erb +0 -16
  52. data/test/dummy-rails/app/views/layouts/mailer.html.erb +0 -13
  53. data/test/dummy-rails/app/views/layouts/mailer.text.erb +0 -1
  54. data/test/dummy-rails/bin/bundle +0 -114
  55. data/test/dummy-rails/bin/docker-entrypoint +0 -8
  56. data/test/dummy-rails/bin/importmap +0 -4
  57. data/test/dummy-rails/bin/rails +0 -4
  58. data/test/dummy-rails/bin/rake +0 -4
  59. data/test/dummy-rails/bin/setup +0 -33
  60. data/test/dummy-rails/config/application.rb +0 -27
  61. data/test/dummy-rails/config/boot.rb +0 -3
  62. data/test/dummy-rails/config/cable.yml +0 -10
  63. data/test/dummy-rails/config/credentials.yml.enc +0 -1
  64. data/test/dummy-rails/config/database.yml +0 -25
  65. data/test/dummy-rails/config/environment.rb +0 -5
  66. data/test/dummy-rails/config/environments/development.rb +0 -76
  67. data/test/dummy-rails/config/environments/production.rb +0 -97
  68. data/test/dummy-rails/config/environments/test.rb +0 -64
  69. data/test/dummy-rails/config/importmap.rb +0 -7
  70. data/test/dummy-rails/config/initializers/content_security_policy.rb +0 -25
  71. data/test/dummy-rails/config/initializers/filter_parameter_logging.rb +0 -8
  72. data/test/dummy-rails/config/initializers/inflections.rb +0 -16
  73. data/test/dummy-rails/config/initializers/permissions_policy.rb +0 -13
  74. data/test/dummy-rails/config/locales/en.yml +0 -31
  75. data/test/dummy-rails/config/puma.rb +0 -35
  76. data/test/dummy-rails/config/routes.rb +0 -10
  77. data/test/dummy-rails/config/storage.yml +0 -34
  78. data/test/dummy-rails/config.ru +0 -6
  79. data/test/dummy-rails/db/seeds.rb +0 -9
  80. data/test/dummy-rails/test/application_system_test_case.rb +0 -5
  81. data/test/dummy-rails/test/channels/application_cable/connection_test.rb +0 -13
  82. data/test/dummy-rails/test/controllers/.keep +0 -0
  83. data/test/dummy-rails/test/fixtures/files/.keep +0 -0
  84. data/test/dummy-rails/test/helpers/.keep +0 -0
  85. data/test/dummy-rails/test/integration/.keep +0 -0
  86. data/test/dummy-rails/test/mailers/.keep +0 -0
  87. data/test/dummy-rails/test/models/.keep +0 -0
  88. data/test/dummy-rails/test/system/.keep +0 -0
  89. data/test/dummy-rails/test/test_helper.rb +0 -15
  90. data/test/dummy-rails/vendor/.keep +0 -0
  91. data/test/dummy-rails/vendor/javascript/.keep +0 -0
  92. data/test/util/mock_ERD.md +0 -27
@@ -1,64 +0,0 @@
1
- require "active_support/core_ext/integer/time"
2
-
3
- # The test environment is used exclusively to run your application's
4
- # test suite. You never need to work with it otherwise. Remember that
5
- # your test database is "scratch space" for the test suite and is wiped
6
- # and recreated between test runs. Don't rely on the data there!
7
-
8
- Rails.application.configure do
9
- # Settings specified here will take precedence over those in config/application.rb.
10
-
11
- # While tests run files are not watched, reloading is not necessary.
12
- config.enable_reloading = false
13
-
14
- # Eager loading loads your entire application. When running a single test locally,
15
- # this is usually not necessary, and can slow down your test suite. However, it's
16
- # recommended that you enable it in continuous integration systems to ensure eager
17
- # loading is working properly before deploying your code.
18
- config.eager_load = ENV["CI"].present?
19
-
20
- # Configure public file server for tests with Cache-Control for performance.
21
- config.public_file_server.enabled = true
22
- config.public_file_server.headers = {
23
- "Cache-Control" => "public, max-age=#{1.hour.to_i}"
24
- }
25
-
26
- # Show full error reports and disable caching.
27
- config.consider_all_requests_local = true
28
- config.action_controller.perform_caching = false
29
- config.cache_store = :null_store
30
-
31
- # Render exception templates for rescuable exceptions and raise for other exceptions.
32
- config.action_dispatch.show_exceptions = :rescuable
33
-
34
- # Disable request forgery protection in test environment.
35
- config.action_controller.allow_forgery_protection = false
36
-
37
- # Store uploaded files on the local file system in a temporary directory.
38
- config.active_storage.service = :test
39
-
40
- config.action_mailer.perform_caching = false
41
-
42
- # Tell Action Mailer not to deliver emails to the real world.
43
- # The :test delivery method accumulates sent emails in the
44
- # ActionMailer::Base.deliveries array.
45
- config.action_mailer.delivery_method = :test
46
-
47
- # Print deprecation notices to the stderr.
48
- config.active_support.deprecation = :stderr
49
-
50
- # Raise exceptions for disallowed deprecations.
51
- config.active_support.disallowed_deprecation = :raise
52
-
53
- # Tell Active Support which deprecation messages to disallow.
54
- config.active_support.disallowed_deprecation_warnings = []
55
-
56
- # Raises error for missing translations.
57
- # config.i18n.raise_on_missing_translations = true
58
-
59
- # Annotate rendered view with file names.
60
- # config.action_view.annotate_rendered_view_with_filenames = true
61
-
62
- # Raise error when a before_action's only/except options reference missing actions
63
- config.action_controller.raise_on_missing_callback_actions = true
64
- end
@@ -1,7 +0,0 @@
1
- # Pin npm packages by running ./bin/importmap
2
-
3
- pin "application"
4
- pin "@hotwired/turbo-rails", to: "turbo.min.js"
5
- pin "@hotwired/stimulus", to: "stimulus.min.js"
6
- pin "@hotwired/stimulus-loading", to: "stimulus-loading.js"
7
- pin_all_from "app/javascript/controllers", under: "controllers"
@@ -1,25 +0,0 @@
1
- # Be sure to restart your server when you modify this file.
2
-
3
- # Define an application-wide content security policy.
4
- # See the Securing Rails Applications Guide for more information:
5
- # https://guides.rubyonrails.org/security.html#content-security-policy-header
6
-
7
- # Rails.application.configure do
8
- # config.content_security_policy do |policy|
9
- # policy.default_src :self, :https
10
- # policy.font_src :self, :https, :data
11
- # policy.img_src :self, :https, :data
12
- # policy.object_src :none
13
- # policy.script_src :self, :https
14
- # policy.style_src :self, :https
15
- # # Specify URI for violation reports
16
- # # policy.report_uri "/csp-violation-report-endpoint"
17
- # end
18
- #
19
- # # Generate session nonces for permitted importmap, inline scripts, and inline styles.
20
- # config.content_security_policy_nonce_generator = ->(request) { request.session.id.to_s }
21
- # config.content_security_policy_nonce_directives = %w(script-src style-src)
22
- #
23
- # # Report violations without enforcing the policy.
24
- # # config.content_security_policy_report_only = true
25
- # end
@@ -1,8 +0,0 @@
1
- # Be sure to restart your server when you modify this file.
2
-
3
- # Configure parameters to be partially matched (e.g. passw matches password) and filtered from the log file.
4
- # Use this to limit dissemination of sensitive information.
5
- # See the ActiveSupport::ParameterFilter documentation for supported notations and behaviors.
6
- Rails.application.config.filter_parameters += [
7
- :passw, :secret, :token, :_key, :crypt, :salt, :certificate, :otp, :ssn
8
- ]
@@ -1,16 +0,0 @@
1
- # Be sure to restart your server when you modify this file.
2
-
3
- # Add new inflection rules using the following format. Inflections
4
- # are locale specific, and you may define rules for as many different
5
- # locales as you wish. All of these examples are active by default:
6
- # ActiveSupport::Inflector.inflections(:en) do |inflect|
7
- # inflect.plural /^(ox)$/i, "\\1en"
8
- # inflect.singular /^(ox)en/i, "\\1"
9
- # inflect.irregular "person", "people"
10
- # inflect.uncountable %w( fish sheep )
11
- # end
12
-
13
- # These inflection rules are supported but not enabled by default:
14
- # ActiveSupport::Inflector.inflections(:en) do |inflect|
15
- # inflect.acronym "RESTful"
16
- # end
@@ -1,13 +0,0 @@
1
- # Be sure to restart your server when you modify this file.
2
-
3
- # Define an application-wide HTTP permissions policy. For further
4
- # information see: https://developers.google.com/web/updates/2018/06/feature-policy
5
-
6
- # Rails.application.config.permissions_policy do |policy|
7
- # policy.camera :none
8
- # policy.gyroscope :none
9
- # policy.microphone :none
10
- # policy.usb :none
11
- # policy.fullscreen :self
12
- # policy.payment :self, "https://secure.example.com"
13
- # end
@@ -1,31 +0,0 @@
1
- # Files in the config/locales directory are used for internationalization and
2
- # are automatically loaded by Rails. If you want to use locales other than
3
- # English, add the necessary files in this directory.
4
- #
5
- # To use the locales, use `I18n.t`:
6
- #
7
- # I18n.t "hello"
8
- #
9
- # In views, this is aliased to just `t`:
10
- #
11
- # <%= t("hello") %>
12
- #
13
- # To use a different locale, set it with `I18n.locale`:
14
- #
15
- # I18n.locale = :es
16
- #
17
- # This would use the information in config/locales/es.yml.
18
- #
19
- # To learn more about the API, please read the Rails Internationalization guide
20
- # at https://guides.rubyonrails.org/i18n.html.
21
- #
22
- # Be aware that YAML interprets the following case-insensitive strings as
23
- # booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings
24
- # must be quoted to be interpreted as strings. For example:
25
- #
26
- # en:
27
- # "yes": yup
28
- # enabled: "ON"
29
-
30
- en:
31
- hello: "Hello world"
@@ -1,35 +0,0 @@
1
- # This configuration file will be evaluated by Puma. The top-level methods that
2
- # are invoked here are part of Puma's configuration DSL. For more information
3
- # about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
4
-
5
- # Puma can serve each request in a thread from an internal thread pool.
6
- # The `threads` method setting takes two numbers: a minimum and maximum.
7
- # Any libraries that use thread pools should be configured to match
8
- # the maximum value specified for Puma. Default is set to 5 threads for minimum
9
- # and maximum; this matches the default thread size of Active Record.
10
- max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
11
- min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
12
- threads min_threads_count, max_threads_count
13
-
14
- # Specifies that the worker count should equal the number of processors in production.
15
- if ENV["RAILS_ENV"] == "production"
16
- require "concurrent-ruby"
17
- worker_count = Integer(ENV.fetch("WEB_CONCURRENCY") { Concurrent.physical_processor_count })
18
- workers worker_count if worker_count > 1
19
- end
20
-
21
- # Specifies the `worker_timeout` threshold that Puma will use to wait before
22
- # terminating a worker in development environments.
23
- worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
24
-
25
- # Specifies the `port` that Puma will listen on to receive requests; default is 3000.
26
- port ENV.fetch("PORT") { 3000 }
27
-
28
- # Specifies the `environment` that Puma will run in.
29
- environment ENV.fetch("RAILS_ENV") { "development" }
30
-
31
- # Specifies the `pidfile` that Puma will use.
32
- pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
33
-
34
- # Allow puma to be restarted by `bin/rails restart` command.
35
- plugin :tmp_restart
@@ -1,10 +0,0 @@
1
- Rails.application.routes.draw do
2
- # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
3
-
4
- # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
5
- # Can be used by load balancers and uptime monitors to verify that the app is live.
6
- get "up" => "rails/health#show", as: :rails_health_check
7
-
8
- # Defines the root path route ("/")
9
- # root "posts#index"
10
- end
@@ -1,34 +0,0 @@
1
- test:
2
- service: Disk
3
- root: <%= Rails.root.join("tmp/storage") %>
4
-
5
- local:
6
- service: Disk
7
- root: <%= Rails.root.join("storage") %>
8
-
9
- # Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
10
- # amazon:
11
- # service: S3
12
- # access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
13
- # secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
14
- # region: us-east-1
15
- # bucket: your_own_bucket-<%= Rails.env %>
16
-
17
- # Remember not to checkin your GCS keyfile to a repository
18
- # google:
19
- # service: GCS
20
- # project: your_project
21
- # credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
22
- # bucket: your_own_bucket-<%= Rails.env %>
23
-
24
- # Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
25
- # microsoft:
26
- # service: AzureStorage
27
- # storage_account_name: your_account_name
28
- # storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
29
- # container: your_container_name-<%= Rails.env %>
30
-
31
- # mirror:
32
- # service: Mirror
33
- # primary: local
34
- # mirrors: [ amazon, google, microsoft ]
@@ -1,6 +0,0 @@
1
- # This file is used by Rack-based servers to start the application.
2
-
3
- require_relative "config/environment"
4
-
5
- run Rails.application
6
- Rails.application.load_server
@@ -1,9 +0,0 @@
1
- # This file should ensure the existence of records required to run the application in every environment (production,
2
- # development, test). The code here should be idempotent so that it can be executed at any point in every environment.
3
- # The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
4
- #
5
- # Example:
6
- #
7
- # ["Action", "Comedy", "Drama", "Horror"].each do |genre_name|
8
- # MovieGenre.find_or_create_by!(name: genre_name)
9
- # end
@@ -1,5 +0,0 @@
1
- require "test_helper"
2
-
3
- class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
4
- driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
5
- end
@@ -1,13 +0,0 @@
1
- require "test_helper"
2
-
3
- module ApplicationCable
4
- class ConnectionTest < ActionCable::Connection::TestCase
5
- # test "connects with cookies" do
6
- # cookies.signed[:user_id] = 42
7
- #
8
- # connect
9
- #
10
- # assert_equal connection.user_id, "42"
11
- # end
12
- end
13
- end
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
File without changes
@@ -1,15 +0,0 @@
1
- ENV["RAILS_ENV"] ||= "test"
2
- require_relative "../config/environment"
3
- require "rails/test_help"
4
-
5
- module ActiveSupport
6
- class TestCase
7
- # Run tests in parallel with specified workers
8
- parallelize(workers: :number_of_processors)
9
-
10
- # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
11
- fixtures :all
12
-
13
- # Add more helper methods to be used by all tests here...
14
- end
15
- end
File without changes
File without changes
@@ -1,27 +0,0 @@
1
- ```mermaid
2
- erDiagram
3
- %% --------------------------------------------------------
4
- %% Entity-Relationship Diagram
5
- %% --------------------------------------------------------
6
-
7
- %% table name: articles
8
- Article{
9
- integer id PK
10
- string title
11
- text content
12
- datetime created_at
13
- datetime updated_at
14
- }
15
-
16
- %% table name: comments
17
- Comment{
18
- integer id PK
19
- string commenter
20
- text body
21
- integer article_id FK
22
- datetime created_at
23
- datetime updated_at
24
- }
25
-
26
- Comment }o--|| Article : "BT:article"
27
- ```