schema_to_dbml 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d437e4d75d3d034a51e6a63d2e5f56ce5b8a95364fd785f354e5ffcad7e5956
-  data.tar.gz: b16dd77e8f191da41fb875582873aeb0c7d53cfa9029c47b805733838585f42b
+  metadata.gz: 01e5c423d835476a25d170272a5d89e762f051951176a21df6b6d62235b0a9c0
+  data.tar.gz: 51a2746ca61db2fae5125b0cf368c4bbca195d7f042b07b5444740e393c0a381
 SHA512:
-  metadata.gz: 3cb923fdc024dadc60b8d9e309895dbebd0d471c3f8fc0b50e85b5c27ea09df3b771741d8eb0c4a9ae92dc3ae174ce6043661cc95fa7adc2f2697acc51b08a36
-  data.tar.gz: afa0177a0764031887e62fc0feaea2019c8faf2693b289fdf6794db04064abbfe61aed045b7bf40903b8463c26247a575c5a096b5aae1a351c4ffe84cdcce150
+  metadata.gz: 9aaefc5b170b0cb209df1b8ab12f80ae7293eb9859cc5470d07af3a84cc55a6546917e23c401de24ba17dc630bd08e297b901af838d6fceac5340d69ed4fe277
+  data.tar.gz: bd6ae1da9afff47e053d851e538a3e3e36a266dc822a98ddfd1b2b81989b814100ba0a6dece7e3c47cadb538530315e582d042fe6bc193e1a36a01dba41cad96

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -69,9 +69,6 @@ Style/RedundantAssignment:
 Style/RedundantFetchBlock:
   Enabled: true
 
-Style/Documentation:
-  Enabled: false
-
 Style/MethodCallWithArgsParentheses:
   Enabled: false
  
@@ -79,4 +76,4 @@ Gemspec/DevelopmentDependencies:
   Enabled: false
 
 Metrics/ParameterLists:
-  Max: 7
+  Max: 8

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    schema_to_dbml (0.0.2)
+    schema_to_dbml (0.0.4)
       activesupport (>= 6.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.4.3)
+    activesupport (7.0.6)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -17,16 +17,19 @@ GEM
     concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
-    i18n (1.13.0)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
     json (2.6.3)
-    minitest (5.18.0)
+    language_server-protocol (3.17.0.3)
+    minitest (5.18.1)
     parallel (1.23.0)
-    parser (3.2.2.1)
+    parser (3.2.2.3)
       ast (~> 2.4.1)
+      racc
+    racc (1.7.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.8.0)
+    regexp_parser (2.8.1)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -41,17 +44,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.51.0)
+    rubocop (1.54.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.0.0)
+      parser (>= 3.2.2.3)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.1)
+    rubocop-ast (1.29.0)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
@@ -65,6 +69,7 @@ GEM
     unicode-display_width (2.4.2)
 
 PLATFORMS
+  arm64-darwin-21
   x86_64-darwin-22
   x86_64-linux
 

data/README.md

@@ -35,11 +35,13 @@ require 'schema_to_dbml'
 # Load configuration from default file
 SchemaToDbml.configuration
 
+# This will output the generated DBML content
 dbml_content = SchemaToDbml.new.convert(schema: 'db/schema.rb')
 puts dbml_content
-```
 
-This will output the generated DBML content.
+# This will generate the file (db/schema.dbml) with the above content
+SchemaToDbml.new.generate(schema: 'db/schema.rb')
+```
 
 ## Custom Configuration
 
@@ -58,6 +60,7 @@ custom_project_notes: |
   - Provides meaningful project information and descriptions
 custom_primary_key: "id integer [pk, unique, note: 'Unique identifier and primary key']"
 custom_dbml_content: ''
+custom_dbml_file_path: 'db/schema.dbml'
 ```
 
 You can change the properties as you want. After that, you can load the configuration by calling:

data/lib/configuration.rb

@@ -4,14 +4,16 @@ class Configuration
   def configure_from_hash(yaml_data)
     @custom_database_type = yaml_data['custom_database_type']
     @custom_dbml_content = yaml_data['custom_dbml_content']
+    @custom_dbml_file_path = yaml_data['custom_dbml_file_path']
+    @custom_primary_key = yaml_data['custom_primary_key']
     @custom_project_name = yaml_data['custom_project_name']
     @custom_project_notes = yaml_data['custom_project_notes']
-    @custom_primary_key = yaml_data['custom_primary_key']
   end
 
   attr_accessor :custom_database_type,
                 :custom_dbml_content,
+                :custom_dbml_file_path,
+                :custom_primary_key,
                 :custom_project_name,
-                :custom_project_notes,
-                :custom_primary_key
+                :custom_project_notes
 end

data/lib/rake_tasks/load.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'rake'
+
+Dir[File.join(File.dirname(__FILE__), '**/*.rake')].each do |rake|
+  load rake
+end

data/lib/rake_tasks/schema_to_dbml.rake

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+namespace :schema_to_dbml do
+  desc 'build dmbl.yml'
+  task :generate, %i[schema_path] => [:environment] do |_t, args|
+    schema = args[:schema_path]
+    SchemaToDbml.new.generate(schema:)
+  end
+end

data/lib/schema_to_dbml/build_dbml_file.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'helpers/constants'
-require_relative './dbml_tables_formatter'
-require_relative './dbml_relations_formatter'
+require_relative 'dbml_tables_formatter'
+require_relative 'dbml_relations_formatter'
 
 class SchemaConverter
   include Helpers::Constants

data/lib/schema_to_dbml/configs/custom_config.yml

@@ -9,3 +9,4 @@ custom_project_notes: |
   - Provides meaningful project information and descriptions
 custom_primary_key: "id integer [pk, unique, note: 'Unique identifier and primary key']"
 custom_dbml_content: ''
+custom_dbml_file_path: 'db/schema.dbml'

data/lib/schema_to_dbml/dbml_relations_formatter.rb

@@ -17,7 +17,7 @@ class DbmlRelationsFormatter
     ref_name = generate_reference_name(from_table, to_table, column)
     ref = build_reference_string(ref_name, from_table, column, to_table)
 
-    ref += " [delete: #{on_delete}]" if on_delete
+    format_on_delete(ref, on_delete)
     ref
   end
 
@@ -25,7 +25,7 @@ class DbmlRelationsFormatter
 
   def generate_reference_name(from_table, to_table, column)
     ref_name = "fk_rails_#{from_table}_#{to_table}"
-    ref_name += "_#{column}" if column != default_foreign_key_column(to_table)
+    ref_name << "_#{column}" if column != default_foreign_key_column(to_table)
     ref_name
   end
 
@@ -36,4 +36,11 @@ class DbmlRelationsFormatter
   def build_reference_string(ref_name, from_table, column, to_table)
     "Ref #{ref_name}:#{from_table}.#{column} - #{to_table}.id"
   end
+
+  def format_on_delete(ref, on_delete)
+    return unless on_delete
+
+    on_delete = 'set null' if on_delete == 'nullify'
+    ref << " [delete: #{on_delete}]"
+  end
 end

data/lib/schema_to_dbml/dbml_tables_formatter.rb

@@ -22,11 +22,11 @@ class DbmlTablesFormatter
   def build_columns(parsed_columns)
     columns = []
 
-    parsed_columns.scan(COLUMNS_REGEXP).each do |type, name, default, null, comment, _precision, array|
+    parsed_columns.scan(COLUMNS_REGEXP).each do |type, name, default, null, comment, _precision, array, limit|
       formatted_comment = format_comment(comment:)
       formatted_default = format_default(default:)
       formatted_null = format_null(null:)
-      formatted_type = format_type(type:, array:)
+      formatted_type = format_type(type:, array:, limit:)
 
       final_values = [formatted_default, formatted_null, formatted_comment].compact.reject(&:empty?)
       columns << build_line(name, formatted_type, final_values)

data/lib/schema_to_dbml/formatters/fields_formatter.rb

@@ -5,6 +5,10 @@ require_relative 'default_field_formatter_helper'
 module Formatters
   module FieldsFormatter
     include DefaultFieldFormatterHelper
+    COMMENT_MAPPER = [
+      { from: "'", to: "\\\\'" },
+      { from: '\"', to: '"' }
+    ].freeze
     TYPE_MAPPER = {
       string: 'varchar',
       integer: 'int',
@@ -12,12 +16,13 @@ module Formatters
       datetime: 'timestamp'
     }.freeze
 
-    def format_type(type:, array:)
+    def format_type(type:, array:, limit:)
       return '' if type.to_s.empty?
 
       parsed = TYPE_MAPPER[type.to_sym] || type.to_s
 
       return "#{parsed}[]" if array == 'true'
+      return "#{parsed}(#{limit})" if limit
 
       parsed
     end
@@ -41,7 +46,12 @@ module Formatters
     def format_comment(comment:)
       return '' if comment.to_s.empty?
 
-      "note: '#{comment}'"
+      note = comment.dup
+      COMMENT_MAPPER.each do |mapper|
+        note.gsub!(mapper[:from], mapper[:to])
+      end
+
+      "note: '#{note}'"
     end
   end
 end

data/lib/schema_to_dbml/helpers/constants.rb

@@ -2,12 +2,33 @@
 
 module Helpers
   module Constants
-    # rubocop:disable Layout/LineLength
-    TABLES_REGEXP = /create_table\s+"(?<table_name>\w+)"(?:,\s+comment:\s+"(?<comment>.*?)")?(?:,\s+force:\s+:cascade)?\s+do\s+\|t\|\n(?<table_content>(?:.*?)(?:".*?")*.*?)(?<=\n)\s+end/m
+    TABLES_REGEXP = /
+      create_table\s+"(?<table_name>\w+)"
+      (?:,\s+comment:\s+"(?<comment>.*?)")?
+      (?:,\s+force:\s+:cascade)?
+      \s+do\s+\|t\|
+      \n
+      (?<table_content>(?:.*?)(?:".*?")*.*?)
+      (?<=\n)
+      \s+end
+    /xm
 
-    COLUMNS_REGEXP = /t\.(?<type>\w+)\s+"(?<name>\w+)"(?:,\s+(?<default>default:[^,\n]+?(?=(?:,\s)|$)))?(?:,\s+(?<null>null:\s+\w+))?(?:,\s+comment:\s+"(?<comment>[^"]+)")?(?:,\s+precision:\s+(?<precision>\d+))?(?:,\s+array:\s+(?<array>true|false))?.*/
+    COLUMNS_REGEXP = /
+      t\.(?<type>\w+)\s+"(?<name>\w+)"
+      (?:
+        (?:,\s+(?<default>default:[^,\n]+?(?=(?:,\s)|$)))?
+        (?:,\s+(?<null>null:\s+\w+))?
+        (?:,\s+comment:\s+"(?<comment>[^"\\]*(?:\\.[^"\\]*)*)")?
+        (?:,\s+precision:\s+(?<precision>\d+))?
+        (?:,\s+array:\s+(?<array>true|false))?
+        (?:,\s+limit:\s+(?<limit>\d+))?
+      )*
+    /x
 
-    RELATIONS_REGEXP = /add_foreign_key\s+"(?<from_table>\w+)",\s+"(?<to_table>\w+)"(?:,\s+column:\s+"(?<column>\w+)")?(?:,\s+on_delete:\s+:(?<on_delete>\w+))?/
-    # rubocop:enable Layout/LineLength
+    RELATIONS_REGEXP = /
+      add_foreign_key\s+"(?<from_table>\w+)",\s+"(?<to_table>\w+)"
+      (?:,\s+column:\s+"(?<column>\w+)")?
+      (?:,\s+on_delete:\s+:(?<on_delete>\w+))?
+    /x
   end
 end

data/lib/schema_to_dbml/schema_converter.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require_relative 'helpers/constants'
-require_relative './dbml_tables_formatter'
-require_relative './dbml_relations_formatter'
+require_relative 'dbml_tables_formatter'
+require_relative 'dbml_relations_formatter'
 
 class SchemaConverter
   include Helpers::Constants

data/lib/schema_to_dbml/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class SchemaToDbml
-  VERSION = '0.0.2'
+  VERSION = '0.0.4'
 end

data/lib/schema_to_dbml.rb

@@ -8,6 +8,7 @@ require_relative 'schema_to_dbml/errors/schema_file_not_found_error'
 require_relative 'schema_to_dbml/errors/configuration_file_not_found_error'
 require_relative 'schema_to_dbml/schema_converter'
 require_relative 'schema_to_dbml/version'
+require_relative 'rake_tasks/load'
 
 class SchemaToDbml
   DEFAULT_CONFIG_FILE = File.join(__dir__, 'schema_to_dbml/configs/custom_config.yml')
@@ -43,6 +44,12 @@ class SchemaToDbml
     @schema_converter = schema_converter
   end
 
+  def generate(schema:)
+    content = convert(schema:)
+
+    File.write(self.class.configuration.custom_dbml_file_path, content)
+  end
+
   def convert(schema:)
     converted = schema_converter.convert(schema_content: schema_content(schema))
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_dbml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Ricardo Ribeiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,7 +116,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTE.md
@@ -126,6 +128,8 @@ files:
 - README.md
 - Rakefile
 - lib/configuration.rb
+- lib/rake_tasks/load.rb
+- lib/rake_tasks/schema_to_dbml.rake
 - lib/schema_to_dbml.rb
 - lib/schema_to_dbml/build_dbml_content.rb
 - lib/schema_to_dbml/build_dbml_file.rb