schema_to_dbml 0.0.5 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc54963544b87bb99449b5bcb2129a64211378ffbfec57cfbbebce562bdf0c0b
-  data.tar.gz: 06c18c1b57f71d0c064ae1d01ee2df9de0600bd68da6748c657af1f51f819927
+  metadata.gz: 4108364b1e7c9cd89e4ae413c1282b2140bcb6b4ce5758eeb37ded7eabe26dcf
+  data.tar.gz: 9ad7bf887518c4cefdb84101e3ab5bd1c76876e973dd3d0fc49148739034cb2d
 SHA512:
-  metadata.gz: 7733b4a827bff5432bd663e6900f9c8cb7388b89b6eaabc7135cf01acfa09ff4f527262c127d9ec15fbe82cb5536a5fc96bf67511956572d34e78ae51c999a5f
-  data.tar.gz: e86975d104f9cc120f6a20e88d6a412534ef9b47286940a08f2ebaf3ec5a1d59ff7a7d7280995ada45f1676b9b91437a39b380ee29ea6f41002c6ba56aa53ef5
+  metadata.gz: fc6519ae82320a59e075f63069455dec421c0cc4cfc15897a4d10dbb3a51d3a1e8ce8916efcddfa6075e44da2d6989613eea2c927efa26c0a1a56f5d5e8cef4f
+  data.tar.gz: 5748195dbe7347e88672f6ca0171cc4d00091a94cb6120d1a4c49780ba2461e0104542c36dbbcf9002f1468d4c5508e032a8be4009262ccf5f04dbbe8e39b062

data/.rubocop.yml

@@ -81,3 +81,9 @@ Gemspec/DevelopmentDependencies:
 
 Metrics/ParameterLists:
   Max: 8
+
+RSpec/NestedGroups:
+  Max: 4
+
+RSpec/MessageSpies:
+  EnforcedStyle: receive

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    schema_to_dbml (0.0.5)
+    schema_to_dbml (0.0.6)
       activesupport (>= 6.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.2)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -19,18 +19,18 @@ GEM
       tzinfo (~> 2.0)
     ast (2.4.2)
     base64 (0.2.0)
-    bigdecimal (3.1.6)
+    bigdecimal (3.1.8)
     byebug (11.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     docile (1.4.0)
     drb (2.2.1)
-    i18n (1.14.1)
+    i18n (1.14.5)
       concurrent-ruby (~> 1.0)
-    json (2.7.1)
+    json (2.7.2)
     language_server-protocol (3.17.0.3)
-    minitest (5.22.2)
+    minitest (5.24.0)
     mutex_m (0.2.0)
     parallel (1.24.0)
     parser (3.3.0.5)
@@ -38,9 +38,10 @@ GEM
       racc
     racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.1.0)
+    rake (13.2.1)
     regexp_parser (2.9.0)
-    rexml (3.2.6)
+    rexml (3.2.8)
+      strscan (>= 3.0.9)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
@@ -54,7 +55,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.0)
-    rubocop (1.61.0)
+    rubocop (1.62.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
@@ -62,19 +63,22 @@ GEM
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.1)
+    rubocop-ast (1.31.2)
       parser (>= 3.3.0.4)
     rubocop-capybara (2.20.0)
       rubocop (~> 1.41)
     rubocop-factory_bot (2.25.1)
       rubocop (~> 1.41)
-    rubocop-rspec (2.27.0)
+    rubocop-rspec (2.29.1)
       rubocop (~> 1.40)
       rubocop-capybara (~> 2.17)
       rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.2)
+      rubocop (~> 1.40)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -82,6 +86,7 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    strscan (3.1.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)

data/README.md

@@ -58,7 +58,7 @@ custom_project_notes: |
   - Utilizes the custom primary key for better indexing
   - Specifies the appropriate database type (e.g., PostgreSQL)
   - Provides meaningful project information and descriptions
-custom_primary_key: "id integer [pk, unique, note: 'Unique identifier and primary key']"
+custom_primary_key: "id integer [pk, unique, note: '''Unique identifier and primary key''']"
 custom_dbml_content: ''
 custom_dbml_file_path: 'db/schema.dbml'
 ```
@@ -80,7 +80,7 @@ custom_project_notes: |
 custom_dbml_content: |
   enum object_status {
     created [note: 'Initial status']
-    pending  
+    pending
     finished
     cancelled
   }
@@ -89,6 +89,11 @@ custom_dbml_content: |
     table_2
     table_3
   }
+custom_tables:
+  my_table:
+    attributes:
+      my_attribute:
+        type: object_status
 ```
 
 After that, you can use the SchemaToDbml to generate the DBML content as usual.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require_relative 'lib/schema_to_dbml'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/configuration.rb

@@ -8,6 +8,7 @@ class Configuration
     @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_tables = yaml_data['custom_tables']
   end
 
   attr_accessor :custom_database_type,
@@ -15,5 +16,6 @@ class Configuration
                 :custom_dbml_file_path,
                 :custom_primary_key,
                 :custom_project_name,
-                :custom_project_notes
+                :custom_project_notes,
+                :custom_tables
 end

data/lib/rake_tasks/schema_to_dbml.rake

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
 namespace :schema_to_dbml do
-  desc 'build dmbl.yml'
-  task :generate, %i[schema_path] => [:environment] do |_t, args|
+  desc 'Build dbml.yml'
+  task :generate, [:schema_path] do |_t, args|
     schema = args[:schema_path]
+    raise 'Schema path must be provided' unless schema
+
+    SchemaToDbml.load_configuration_from_yaml
     SchemaToDbml.new.generate(schema:)
   end
 end

data/lib/schema_to_dbml/build_dbml_content.rb

@@ -20,7 +20,7 @@ class BuildDbmlContent
   def project_header
     header = "Project #{project_name} {\n"
     header += "  database_type: '#{custom_database_type}'\n"
-    header += "  Note: '#{custom_project_notes}'\n"
+    header += "  Note: '''#{custom_project_notes}'''\n"
     header += '}'
     header
   end

data/lib/schema_to_dbml/configs/custom_config.yml

@@ -7,6 +7,6 @@ custom_project_notes: |
   - Utilizes the custom primary key for better indexing
   - Specifies the appropriate database type (e.g., PostgreSQL)
   - Provides meaningful project information and descriptions
-custom_primary_key: "id integer [pk, unique, note: 'Unique identifier and primary key']"
+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_tables_formatter.rb

@@ -14,7 +14,7 @@ class DbmlTablesFormatter
   end
 
   def format(table_name:, table_comment:, table_attributes:)
-    columns = build_columns(table_attributes)
+    columns = build_columns(table_name, table_attributes)
     indexes = build_indexes(table_attributes)
 
     format_dbml(table_name, columns, indexes, table_comment)
@@ -22,14 +22,16 @@ class DbmlTablesFormatter
 
   private
 
-  def build_columns(table_attributes)
+  def build_columns(table_name, table_attributes)
     columns = []
 
+    custom_table_attributes = configuration.custom_tables&.dig(table_name, 'attributes')
     table_attributes.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:, limit:)
+      custom_type = custom_table_attributes&.dig(name, 'type')
+      formatted_type = format_type(type: custom_type || type, array:, limit:)
 
       final_values = [formatted_default, formatted_null, formatted_comment].compact.reject(&:empty?)
       columns << build_line(name, formatted_type, final_values)
@@ -63,7 +65,7 @@ class DbmlTablesFormatter
     dbml_table << "#{TAB}#{custom_primary_key}\n"
     dbml_table << columns.join("\n")
     dbml_table << indexes if indexes
-    dbml_table << "\n#{TAB}Note: '#{table_comment}'" unless table_comment.to_s.empty?
+    dbml_table << "\n#{TAB}Note: '''#{table_comment}'''" unless table_comment.to_s.empty?
     dbml_table << "\n}"
     dbml_table
   end

data/lib/schema_to_dbml/formatters/fields_formatter.rb

@@ -52,7 +52,9 @@ module Formatters
         note.gsub!(mapper[:from], mapper[:to])
       end
 
-      "note: '#{note}'"
+      note = "#{note} " if note[-1, 1] == "'"
+
+      "note: '''#{note}'''"
     end
   end
 end

data/lib/schema_to_dbml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_dbml
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.7
 platform: ruby
 authors:
 - Ricardo Ribeiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler