active-dbml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8221dbee838a7444be8ba17b7e186639411170beed4acd2f6096bc4ce5d822f2
+  data.tar.gz: 2ef8374f20e734b3f0c34180cce1cb542d2e875998ff0693676728b356acbfbc
+SHA512:
+  metadata.gz: 062d762e36de8e9e80996ef58f289930fb28955c5dfb67a069bb6b28030ad3188b69660b6629283b1b9e203304410b70e41b9f806ff954828cdff2ad2ae90de0
+  data.tar.gz: bd8626a3d86dfa3004c5495084a81164cb108d93707e1ebae45e04b8adf4bab35d3428a9d08fe60ce3f2eb9071b5d90bf8ab6466e322da93cf4875a314205a73

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,47 @@
+# Active::Dbml
+
+ActiveDBML: A Gem for Bridging Database Design and Development
+
+ActiveDBML is a new, useful Ruby gem designed to streamline database development. At its core, this gem provides a Rake Task that outputs Database Markup Language (DBML) from ActiveRecord. Its primary aim is to alleviate discrepancies between database definitions and actual development, ensuring consistency across all stages of development.
+
+The purpose of developing this gem originated from the need to bridge the gap between DB definitions and development, providing a robust solution to a common problem. We hope that by making this gem publicly available, it will not only make the life of developers easier but also contribute to the broader software development community.
+
+ActiveDBML is open for improvements. We eagerly welcome and encourage pull requests and issue submissions. We envision this gem evolving, becoming more comprehensive, and better with collective input and efforts. Our ultimate goal is to enhance this gem further, based on your valuable feedback and contributions. Join us in this journey to make ActiveDBML an essential tool in every developer's toolkit.
+
+## Other language docs
+
+- [English](/)
+- [日本語](/docs/ja.md)
+
+
+## Usage
+
+``` sh
+$ rake active_dbml:export
+
+# or (In the case you want to specify the export destination)
+$ rake active_dbml:export["export/path.dbml"]
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem "active-dbml"
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install active-dbml
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/active_dbml_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/active/dbml .css

data/app/assets/stylesheets/active/dbml/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/active/dbml/application_controller.rb

@@ -0,0 +1,6 @@
+module Active
+  module Dbml
+    class ApplicationController < ActionController::Base
+    end
+  end
+end

data/app/helpers/active/dbml/application_helper.rb

@@ -0,0 +1,6 @@
+module Active
+  module Dbml
+    module ApplicationHelper
+    end
+  end
+end

data/app/jobs/active/dbml/application_job.rb

@@ -0,0 +1,6 @@
+module Active
+  module Dbml
+    class ApplicationJob < ActiveJob::Base
+    end
+  end
+end

data/app/mailers/active/dbml/application_mailer.rb

@@ -0,0 +1,8 @@
+module Active
+  module Dbml
+    class ApplicationMailer < ActionMailer::Base
+      default from: "from@example.com"
+      layout "mailer"
+    end
+  end
+end

data/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/views/layouts/active/dbml/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Active dbml</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "active/dbml/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Active::Dbml::Engine.routes.draw do
+end

data/lib/active/dbml/engine.rb

@@ -0,0 +1,7 @@
+module Active
+  module Dbml
+    class Engine < ::Rails::Engine
+      isolate_namespace Active::Dbml
+    end
+  end
+end

data/lib/active/dbml/version.rb

@@ -0,0 +1,5 @@
+module Active
+  module Dbml
+    VERSION = "0.1.0"
+  end
+end

data/lib/active/dbml.rb

@@ -0,0 +1,146 @@
+require "active/dbml/version"
+require "active/dbml/engine"
+
+module Active
+  module Dbml
+    def self.export_dbml(export_path)
+      dbml_file = File.new(export_path, 'w+')
+      models = get_model_list
+      dbml = generate_dbml(models)
+      dbml_file.puts(dbml)
+    end
+
+    def self.generate_dbml(models)
+      dbml_output = []
+      # 出力済みのEnumを追跡
+      enums_generated = Set.new
+
+      models.each do |model|
+        if ActiveRecord::Base.connection.table_exists?(model.table_name)
+          primary_key = get_primary_key(model)
+          foreign_keys = get_foreign_keys(model)
+
+          dbml_output << "Table #{model.table_name} {"
+
+          # Enumを取得
+          defined_enums = model.defined_enums.keys
+
+          # カラム情報を生成
+          generate_columns(dbml_output, model, primary_key, foreign_keys, defined_enums)
+
+          # Index情報の取得
+          generate_indexes(dbml_output, model)
+
+          # テーブルコメントの取得
+          generate_table_comment(dbml_output, model)
+
+          # テーブルを閉じる
+          dbml_output << "}\n"
+
+          # Enumの詳細を取得
+          generate_enums(dbml_output, model, enums_generated)
+        end
+      end
+
+      dbml_output.join("\n")
+    end
+
+    private
+    def self.get_primary_key(model)
+      model.primary_key
+    end
+
+    def self.get_foreign_keys(model)
+      foreign_keys = {}
+
+      model.reflect_on_all_associations.each do |association|
+        case association.macro
+        when :belongs_to
+          foreign_key = association.options[:foreign_key]
+          foreign_key_destination = "#{association.plural_name}.#{association.class_name.constantize.primary_key}"
+
+          association.class_name.constantize.reflect_on_all_associations.each do |relation_association|
+            if model.table_name.eql?(relation_association.plural_name)
+              case relation_association.macro
+              when :has_one
+                foreign_keys[foreign_key] = { destination: foreign_key_destination, relation_type: '-' }
+              when :has_many
+                foreign_keys[foreign_key] = { destination: foreign_key_destination, relation_type: '>' }
+              else
+              end
+            end
+          end
+        end
+      end
+
+      foreign_keys
+    end
+
+    def self.generate_columns(dbml_output, model, primary_key, foreign_keys, defined_enums)
+      model.columns.each do |column|
+        options = []
+        options.push 'pk' if primary_key.eql?(column.name)
+        options.push 'not null' if !column.null
+        options.push "note: '#{column.comment}'" if column.comment.present?
+        options.push "ref: #{foreign_keys[column.name][:relation_type]} #{foreign_keys[column.name][:destination]}" if foreign_keys.key?(column.name)
+
+        unless defined_enums.include?(column.name)
+          dbml_output << "  #{column.name} #{check_sql_type(column.sql_type)} #{"[#{options.join(', ')}]" if options.present?}"
+        else
+          dbml_output << "  #{column.name} #{column.name} #{"[#{options.join(', ')}]" if options.present?}"
+        end
+      end
+    end
+
+    def self.generate_indexes(dbml_output, model)
+      indexes = model.connection.indexes(model.table_name)
+      if indexes.present?
+        dbml_output << "\n  Indexes {"
+        indexes.each do |index|
+          dbml_output << "    #{index.columns[0]} [name: '#{index.name}']"
+        end
+        dbml_output << "  }"
+      end
+    end
+
+    def self.generate_table_comment(dbml_output, model)
+      table_comment = model.connection.table_comment(model.table_name)
+      if table_comment.present?
+        dbml_output << "\n  Note: '# #{table_comment}'"
+      end
+    end
+
+    def self.generate_enums(dbml_output, model, enums_generated)
+      model.defined_enums.each do |key, value|
+        # Enumがまだ出力されていない場合のみ出力
+        if key.present? && !enums_generated.include?(key)
+          dbml_output << "Enum #{key} {"
+          value.keys.each do |value_key|
+            dbml_output << "  #{value_key}"
+          end
+
+          dbml_output << "}\n"
+          # Enumを出力済みとして記録
+          enums_generated.add(key)
+        end
+      end
+    end
+
+    def self.check_sql_type(sql_type)
+      case sql_type
+        when 'tinyint(1)'
+          return 'boolean'
+        when 'datetime(6)'
+          return 'datetime'
+        else
+          return sql_type
+      end
+    end
+
+    def self.get_model_list
+      Rails.application.eager_load! unless Rails.configuration.cache_classes
+      # ApplicationRecord.descendants
+      ActiveRecord::Base.descendants
+    end
+  end
+end

data/lib/tasks/active_dbml.rake

@@ -0,0 +1,10 @@
+require 'active/dbml'
+
+namespace :active_dbml do
+  desc 'Export DBML'
+  task :export, [:export_path] => :environment do |t, args|
+    args.with_defaults(export_path: 'db/export.dbml')
+    Active::Dbml.export_dbml(args['export_path'])
+    puts "📣 Successfully exported DBML to #{args['export_path']}!"
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification
+name: active-dbml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ukmshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '7'
+description: Active::DBML is a new, useful Ruby gem designed to streamline database
+  development.
+email:
+- ukyo.mashiko@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/active_dbml_manifest.js
+- app/assets/stylesheets/active/dbml/application.css
+- app/controllers/active/dbml/application_controller.rb
+- app/helpers/active/dbml/application_helper.rb
+- app/jobs/active/dbml/application_job.rb
+- app/mailers/active/dbml/application_mailer.rb
+- app/models/application_record.rb
+- app/views/layouts/active/dbml/application.html.erb
+- config/routes.rb
+- lib/active/dbml.rb
+- lib/active/dbml/engine.rb
+- lib/active/dbml/version.rb
+- lib/tasks/active_dbml.rake
+homepage: https://github.com/ukmshi/ActiveDBML
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ukmshi/ActiveDBML
+  source_code_uri: https://github.com/ukmshi/ActiveDBML
+  changelog_uri: https://github.com/ukmshi/ActiveDBML/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.20
+signing_key: 
+specification_version: 4
+summary: 'Active::DBML: A Gem for Bridging Database Design and Development'
+test_files: []