rails-mermaid_erd_markdown 0.1.0 → 0.2.0

data/test/dummy-rails/config/locales/en.yml

@@ -0,0 +1,31 @@
+# Files in the config/locales directory are used for internationalization and
+# are automatically loaded by Rails. If you want to use locales other than
+# English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t "hello"
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t("hello") %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more about the API, please read the Rails Internationalization guide
+# at https://guides.rubyonrails.org/i18n.html.
+#
+# Be aware that YAML interprets the following case-insensitive strings as
+# booleans: `true`, `false`, `on`, `off`, `yes`, `no`. Therefore, these strings
+# must be quoted to be interpreted as strings. For example:
+#
+#     en:
+#       "yes": yup
+#       enabled: "ON"
+
+en:
+  hello: "Hello world"

data/test/dummy-rails/config/puma.rb

@@ -0,0 +1,35 @@
+# This configuration file will be evaluated by Puma. The top-level methods that
+# are invoked here are part of Puma's configuration DSL. For more information
+# about methods provided by the DSL, see https://puma.io/puma/Puma/DSL.html.
+
+# Puma can serve each request in a thread from an internal thread pool.
+# The `threads` method setting takes two numbers: a minimum and maximum.
+# Any libraries that use thread pools should be configured to match
+# the maximum value specified for Puma. Default is set to 5 threads for minimum
+# and maximum; this matches the default thread size of Active Record.
+max_threads_count = ENV.fetch("RAILS_MAX_THREADS") { 5 }
+min_threads_count = ENV.fetch("RAILS_MIN_THREADS") { max_threads_count }
+threads min_threads_count, max_threads_count
+
+# Specifies that the worker count should equal the number of processors in production.
+if ENV["RAILS_ENV"] == "production"
+  require "concurrent-ruby"
+  worker_count = Integer(ENV.fetch("WEB_CONCURRENCY") { Concurrent.physical_processor_count })
+  workers worker_count if worker_count > 1
+end
+
+# Specifies the `worker_timeout` threshold that Puma will use to wait before
+# terminating a worker in development environments.
+worker_timeout 3600 if ENV.fetch("RAILS_ENV", "development") == "development"
+
+# Specifies the `port` that Puma will listen on to receive requests; default is 3000.
+port ENV.fetch("PORT") { 3000 }
+
+# Specifies the `environment` that Puma will run in.
+environment ENV.fetch("RAILS_ENV") { "development" }
+
+# Specifies the `pidfile` that Puma will use.
+pidfile ENV.fetch("PIDFILE") { "tmp/pids/server.pid" }
+
+# Allow puma to be restarted by `bin/rails restart` command.
+plugin :tmp_restart

data/test/dummy-rails/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  # Define your application routes per the DSL in https://guides.rubyonrails.org/routing.html
+
+  # Reveal health status on /up that returns 200 if the app boots with no exceptions, otherwise 500.
+  # Can be used by load balancers and uptime monitors to verify that the app is live.
+  get "up" => "rails/health#show", as: :rails_health_check
+
+  # Defines the root path route ("/")
+  # root "posts#index"
+end

data/test/dummy-rails/config/storage.yml

@@ -0,0 +1,34 @@
+test:
+  service: Disk
+  root: <%= Rails.root.join("tmp/storage") %>
+
+local:
+  service: Disk
+  root: <%= Rails.root.join("storage") %>
+
+# Use bin/rails credentials:edit to set the AWS secrets (as aws:access_key_id|secret_access_key)
+# amazon:
+#   service: S3
+#   access_key_id: <%= Rails.application.credentials.dig(:aws, :access_key_id) %>
+#   secret_access_key: <%= Rails.application.credentials.dig(:aws, :secret_access_key) %>
+#   region: us-east-1
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Remember not to checkin your GCS keyfile to a repository
+# google:
+#   service: GCS
+#   project: your_project
+#   credentials: <%= Rails.root.join("path/to/gcs.keyfile") %>
+#   bucket: your_own_bucket-<%= Rails.env %>
+
+# Use bin/rails credentials:edit to set the Azure Storage secret (as azure_storage:storage_access_key)
+# microsoft:
+#   service: AzureStorage
+#   storage_account_name: your_account_name
+#   storage_access_key: <%= Rails.application.credentials.dig(:azure_storage, :storage_access_key) %>
+#   container: your_container_name-<%= Rails.env %>
+
+# mirror:
+#   service: Mirror
+#   primary: local
+#   mirrors: [ amazon, google, microsoft ]

data/test/dummy-rails/config.ru

@@ -0,0 +1,6 @@
+# This file is used by Rack-based servers to start the application.
+
+require_relative "config/environment"
+
+run Rails.application
+Rails.application.load_server

data/test/dummy-rails/db/seeds.rb

@@ -0,0 +1,9 @@
+# This file should ensure the existence of records required to run the application in every environment (production,
+# development, test). The code here should be idempotent so that it can be executed at any point in every environment.
+# The data can then be loaded with the bin/rails db:seed command (or created alongside the database with db:setup).
+#
+# Example:
+#
+#   ["Action", "Comedy", "Drama", "Horror"].each do |genre_name|
+#     MovieGenre.find_or_create_by!(name: genre_name)
+#   end

data/test/dummy-rails/test/application_system_test_case.rb

@@ -0,0 +1,5 @@
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end

data/test/dummy-rails/test/channels/application_cable/connection_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+
+module ApplicationCable
+  class ConnectionTest < ActionCable::Connection::TestCase
+    # test "connects with cookies" do
+    #   cookies.signed[:user_id] = 42
+    #
+    #   connect
+    #
+    #   assert_equal connection.user_id, "42"
+    # end
+  end
+end

data/test/dummy-rails/test/test_helper.rb

@@ -0,0 +1,15 @@
+ENV["RAILS_ENV"] ||= "test"
+require_relative "../config/environment"
+require "rails/test_help"
+
+module ActiveSupport
+  class TestCase
+    # Run tests in parallel with specified workers
+    parallelize(workers: :number_of_processors)
+
+    # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+    fixtures :all
+
+    # Add more helper methods to be used by all tests here...
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "rails-mermaid_erd_markdown"
+require "rails-mermaid_erd_markdown/configuration"
+
+require "minitest/autorun"
+require File.expand_path("./dummy-rails/config/environment", __dir__)

data/test/test_rails/test_rails-mermaid_erd_markdown.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "test_helper"
+require "rails-mermaid_erd"
+
+class MermaidErdMarkdownTest < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil MermaidErdMarkdown::VERSION
+  end
+
+  def setup
+    markdown_file_path = File.expand_path("../../test/util/mock_ERD.md", __dir__)
+    mock_erd = File.read(markdown_file_path)
+    @mock_erd = mock_erd
+  end
+
+  def test_generate_mermaid_erd
+    stubbed_model_data = {
+      Models: [
+        { TableName: "articles", ModelName: "Article", IsModelExist: true,
+          Columns: [
+            { name: "id", type: :integer, key: "PK", comment: nil },
+            { name: "title", type: :string, key: "", comment: nil },
+            { name: "content", type: :text, key: "", comment: nil },
+            { name: "created_at", type: :datetime, key: "", comment: nil },
+            { name: "updated_at", type: :datetime, key: "", comment: nil }
+          ] },
+        { TableName: "comments", ModelName: "Comment", IsModelExist: true,
+          Columns: [
+            { name: "id", type: :integer, key: "PK", comment: nil },
+            { name: "commenter", type: :string, key: "", comment: nil },
+            { name: "body", type: :text, key: "", comment: nil },
+            { name: "article_id", type: :integer, key: "FK", comment: nil },
+            { name: "created_at", type: :datetime, key: "", comment: nil },
+            { name: "updated_at", type: :datetime, key: "", comment: nil }
+          ] }
+      ], Relations: [
+        { LeftModelName: "Comment", LeftValue: "}o", Line: "--", RightModelName: "Article",
+          RightValue: "||", Comment: "BT:article" }
+      ]
+    }
+    result = nil
+
+    RailsMermaidErd::Builder.stub :model_data, stubbed_model_data do
+      result = MermaidErdMarkdown.generate_mermaid_erd
+    end
+    assert_equal @mock_erd, result
+  end
+end

data/test/util/mock_ERD.md

@@ -0,0 +1,27 @@
+```mermaid
+erDiagram
+    %% --------------------------------------------------------
+    %% Entity-Relationship Diagram
+    %% --------------------------------------------------------
+
+    %% table name: articles
+    Article{
+        integer id PK 
+        string title  
+        text content  
+        datetime created_at  
+        datetime updated_at  
+    }
+
+    %% table name: comments
+    Comment{
+        integer id PK 
+        string commenter  
+        text body  
+        integer article_id FK 
+        datetime created_at  
+        datetime updated_at  
+    }
+
+    Comment }o--|| Article : "BT:article"
+```

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails-mermaid_erd_markdown
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - humzahkiani
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-28 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.2'
+- !ruby/object:Gem::Dependency
+  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:
 email:
 - 89326566+humzahkiani@users.noreply.github.com
@@ -31,12 +45,86 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - docs/examples/erd.yml
 - lib/rails-mermaid_erd_markdown.rb
 - lib/rails-mermaid_erd_markdown/configuration.rb
 - lib/rails-mermaid_erd_markdown/version.rb
+- rails-mermaid_erd_markdown.gemspec
+- sig/rails/mermaid_erd_markdown.rbs
+- test/dummy-rails/.dockerignore
+- test/dummy-rails/.ruby-version
+- test/dummy-rails/Rakefile
+- test/dummy-rails/app/assets/config/manifest.js
+- test/dummy-rails/app/assets/images/.keep
+- test/dummy-rails/app/assets/stylesheets/application.css
+- test/dummy-rails/app/channels/application_cable/channel.rb
+- test/dummy-rails/app/channels/application_cable/connection.rb
+- test/dummy-rails/app/controllers/application_controller.rb
+- test/dummy-rails/app/controllers/concerns/.keep
+- test/dummy-rails/app/helpers/application_helper.rb
+- test/dummy-rails/app/javascript/application.js
+- test/dummy-rails/app/javascript/controllers/application.js
+- test/dummy-rails/app/javascript/controllers/hello_controller.js
+- test/dummy-rails/app/javascript/controllers/index.js
+- test/dummy-rails/app/jobs/application_job.rb
+- test/dummy-rails/app/mailers/application_mailer.rb
+- test/dummy-rails/app/models/application_record.rb
+- test/dummy-rails/app/models/concerns/.keep
+- test/dummy-rails/app/views/layouts/application.html.erb
+- test/dummy-rails/app/views/layouts/mailer.html.erb
+- test/dummy-rails/app/views/layouts/mailer.text.erb
+- test/dummy-rails/bin/bundle
+- test/dummy-rails/bin/docker-entrypoint
+- test/dummy-rails/bin/importmap
+- test/dummy-rails/bin/rails
+- test/dummy-rails/bin/rake
+- test/dummy-rails/bin/setup
+- test/dummy-rails/config.ru
+- test/dummy-rails/config/application.rb
+- test/dummy-rails/config/boot.rb
+- test/dummy-rails/config/cable.yml
+- test/dummy-rails/config/credentials.yml.enc
+- test/dummy-rails/config/database.yml
+- test/dummy-rails/config/environment.rb
+- test/dummy-rails/config/environments/development.rb
+- test/dummy-rails/config/environments/production.rb
+- test/dummy-rails/config/environments/test.rb
+- test/dummy-rails/config/importmap.rb
+- test/dummy-rails/config/initializers/content_security_policy.rb
+- test/dummy-rails/config/initializers/filter_parameter_logging.rb
+- test/dummy-rails/config/initializers/inflections.rb
+- test/dummy-rails/config/initializers/permissions_policy.rb
+- test/dummy-rails/config/locales/en.yml
+- test/dummy-rails/config/puma.rb
+- test/dummy-rails/config/routes.rb
+- test/dummy-rails/config/storage.yml
+- test/dummy-rails/db/seeds.rb
+- test/dummy-rails/test/application_system_test_case.rb
+- test/dummy-rails/test/channels/application_cable/connection_test.rb
+- test/dummy-rails/test/controllers/.keep
+- test/dummy-rails/test/fixtures/files/.keep
+- test/dummy-rails/test/helpers/.keep
+- test/dummy-rails/test/integration/.keep
+- test/dummy-rails/test/mailers/.keep
+- test/dummy-rails/test/models/.keep
+- test/dummy-rails/test/system/.keep
+- test/dummy-rails/test/test_helper.rb
+- test/dummy-rails/vendor/.keep
+- test/dummy-rails/vendor/javascript/.keep
+- test/test_helper.rb
+- test/test_rails/test_rails-mermaid_erd_markdown.rb
+- test/util/mock_ERD.md
 homepage: https://github.com/humzahkiani/rails-mermaid_erd_markdown
 licenses:
 - MIT