schema_to_dbml 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9032720a1b5f18280931f1c79673a0f1bd19fe11984b7648fe8a51daa4845cad
-  data.tar.gz: e255d62a37be7d8c1980ef5920f447993bff019119ac86cb45e2102d35a65ff1
+  metadata.gz: dc54963544b87bb99449b5bcb2129a64211378ffbfec57cfbbebce562bdf0c0b
+  data.tar.gz: 06c18c1b57f71d0c064ae1d01ee2df9de0600bd68da6748c657af1f51f819927
 SHA512:
-  metadata.gz: 51f4a20647f1a6a050b08e45c4d6d0a7c8be8dab2ae1ffed85bcfb94b08d002dd1291247bf6487494e661f5ce993e4378e5ef540542282bee5ae9c4096fb90f9
-  data.tar.gz: 84e5fdc4390ed090174685f6ac18c9f29e278bc82ea99452f5d8dccae9f874c49031daac59bc135c31a2befb990f1ad3795ec024d72bd12bea91697dff0634cc
+  metadata.gz: 7733b4a827bff5432bd663e6900f9c8cb7388b89b6eaabc7135cf01acfa09ff4f527262c127d9ec15fbe82cb5536a5fc96bf67511956572d34e78ae51c999a5f
+  data.tar.gz: e86975d104f9cc120f6a20e88d6a412534ef9b47286940a08f2ebaf3ec5a1d59ff7a7d7280995ada45f1676b9b91437a39b380ee29ea6f41002c6ba56aa53ef5

data/.rubocop.yml

@@ -1,8 +1,12 @@
+inherit_from: .rubocop_todo.yml
+
+require:
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.1.2
   Exclude:
-    - spec/lib/schema_to_dbml/support/*
-    - spec/shared_examples/*
+    - spec/support/**/*
     - vendor/bundle/**/*
   NewCops: enable
 
@@ -71,9 +75,9 @@ Style/RedundantFetchBlock:
 
 Style/MethodCallWithArgsParentheses:
   Enabled: false
- 
+
 Gemspec/DevelopmentDependencies:
   Enabled: false
 
 Metrics/ParameterLists:
-  Max: 7
+  Max: 8

data/.rubocop_todo.yml

@@ -0,0 +1,16 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-03-03 11:08:02 UTC using RuboCop version 1.61.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 2
+RSpec/MultipleExpectations:
+  Max: 3
+
+# Offense count: 1
+# Configuration parameters: AllowSubject.
+RSpec/MultipleMemoizedHelpers:
+  Max: 6

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/Gemfile.lock

@@ -1,60 +1,80 @@
 PATH
   remote: .
   specs:
-    schema_to_dbml (0.0.3)
+    schema_to_dbml (0.0.5)
       activesupport (>= 6.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.0.5)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
+      mutex_m
       tzinfo (~> 2.0)
     ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.6)
     byebug (11.1.3)
-    concurrent-ruby (1.2.2)
-    diff-lcs (1.5.0)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    diff-lcs (1.5.1)
     docile (1.4.0)
-    i18n (1.13.0)
+    drb (2.2.1)
+    i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    json (2.6.3)
-    minitest (5.18.0)
-    parallel (1.23.0)
-    parser (3.2.2.3)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    minitest (5.22.2)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.0.5)
       ast (~> 2.4.1)
       racc
-    racc (1.7.0)
+    racc (1.7.3)
     rainbow (3.1.1)
-    rake (13.0.6)
-    regexp_parser (2.8.1)
-    rexml (3.2.5)
-    rspec (3.12.0)
-      rspec-core (~> 3.12.0)
-      rspec-expectations (~> 3.12.0)
-      rspec-mocks (~> 3.12.0)
-    rspec-core (3.12.1)
-      rspec-support (~> 3.12.0)
-    rspec-expectations (3.12.2)
+    rake (13.1.0)
+    regexp_parser (2.9.0)
+    rexml (3.2.6)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-mocks (3.12.5)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.12.0)
-    rspec-support (3.12.0)
-    rubocop (1.52.1)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.0)
+    rubocop (1.61.0)
       json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
-      parser (>= 3.2.2.3)
+      parser (>= 3.3.0.2)
       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)
+      rubocop-ast (>= 1.30.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.29.0)
-      parser (>= 3.2.1.0)
+    rubocop-ast (1.31.1)
+      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 (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
       docile (~> 1.1)
@@ -64,10 +84,11 @@ GEM
     simplecov_json_formatter (0.1.4)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.4.2)
+    unicode-display_width (2.5.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-23
   x86_64-darwin-22
   x86_64-linux
 
@@ -77,6 +98,7 @@ DEPENDENCIES
   rake
   rspec
   rubocop
+  rubocop-rspec
   schema_to_dbml!
   simplecov
 

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
@@ -18,8 +18,8 @@ class SchemaConverter
   def convert(schema_content:)
     tables = []
     relations = []
-    schema_content.scan(TABLES_REGEXP).each do |table_name, table_comment, columns|
-      tables << dbml_tables_formatter.format(table_name:, table_comment:, parsed_columns: columns)
+    schema_content.scan(TABLES_REGEXP).each do |table_name, table_comment, table_attributes|
+      tables << dbml_tables_formatter.format(table_name:, table_comment:, table_attributes:)
     end
 
     schema_content.scan(RELATIONS_REGEXP).each do |from_table, to_table, column, on_delete|

data/lib/schema_to_dbml/dbml_tables_formatter.rb

@@ -1,32 +1,35 @@
 # frozen_string_literal: true
 
 require_relative 'formatters/fields_formatter'
+require_relative 'formatters/index_formatter'
 require_relative 'helpers/constants'
 
 class DbmlTablesFormatter
   include Helpers::Constants
   include Formatters::FieldsFormatter
+  include Formatters::IndexFormatter
 
   def initialize(configuration: SchemaToDbml.configuration)
     @configuration = configuration
   end
 
-  def format(table_name:, table_comment:, parsed_columns:)
-    columns = build_columns(parsed_columns)
+  def format(table_name:, table_comment:, table_attributes:)
+    columns = build_columns(table_attributes)
+    indexes = build_indexes(table_attributes)
 
-    format_dbml(table_name, columns, table_comment)
+    format_dbml(table_name, columns, indexes, table_comment)
   end
 
   private
 
-  def build_columns(parsed_columns)
+  def build_columns(table_attributes)
     columns = []
 
-    parsed_columns.scan(COLUMNS_REGEXP).each do |type, name, default, null, comment, _precision, array|
+    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:)
+      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)
@@ -35,6 +38,18 @@ class DbmlTablesFormatter
     columns
   end
 
+  def build_indexes(table_definition)
+    indexes = []
+
+    table_definition.scan(INDEXES_REGEXP) do |columns, index_name, unique|
+      indexes << format_index(columns, index_name, unique)
+    end
+
+    return if indexes.empty?
+
+    "\n#{TAB}indexes {\n#{indexes.join("\n")}\n#{TAB}}"
+  end
+
   def build_line(name, formatted_type, final_values)
     line = "  #{name} #{formatted_type}"
 
@@ -43,11 +58,12 @@ class DbmlTablesFormatter
     line << " [#{final_values.join(',')}]"
   end
 
-  def format_dbml(table_name, columns, table_comment)
+  def format_dbml(table_name, columns, indexes, table_comment)
     dbml_table = "Table #{table_name} {\n"
-    dbml_table << "  #{custom_primary_key}\n"
+    dbml_table << "#{TAB}#{custom_primary_key}\n"
     dbml_table << columns.join("\n")
-    dbml_table << "\n  Note: '#{table_comment}'" unless table_comment.to_s.empty?
+    dbml_table << indexes if indexes
+    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

@@ -5,6 +5,11 @@ 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 +17,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 +47,12 @@ module Formatters
     def format_comment(comment:)
       return '' if comment.to_s.empty?
 
-      "note: '#{comment.gsub("'", "\\\\'")}'"
+      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/formatters/index_formatter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative '../helpers/constants'
+
+module Formatters
+  module IndexFormatter
+    include Helpers::Constants
+
+    def format_index(columns, index_name, unique)
+      formatted_columns = format_index_columns(columns)
+      formatted_settings = format_index_settings(unique)
+      formatted_name = "name: '#{index_name}'"
+      formatted_values = [formatted_settings, formatted_name].compact.join(', ')
+
+      "#{TAB * 2}(#{formatted_columns}) [#{formatted_values}]"
+    end
+
+    private
+
+    def format_index_columns(columns)
+      columns.gsub('"', '').split(', ').join(', ')
+    end
+
+    def format_index_settings(unique)
+      # There are other possible settings for indexes
+      # but for now we will only add unique
+      # https://dbml.dbdiagram.io/docs/#index-definition
+      return unless unique
+
+      'unique'
+    end
+  end
+end

data/lib/schema_to_dbml/helpers/constants.rb

@@ -2,13 +2,15 @@
 
 module Helpers
   module Constants
+    TAB = '  '
+
     TABLES_REGEXP = /
       create_table\s+"(?<table_name>\w+)"
       (?:,\s+comment:\s+"(?<comment>.*?)")?
       (?:,\s+force:\s+:cascade)?
       \s+do\s+\|t\|
       \n
-      (?<table_content>(?:.*?)(?:".*?")*.*?)
+      (?<table_attributes>(?:.*?)(?:".*?")*.*?)
       (?<=\n)
       \s+end
     /xm
@@ -18,12 +20,19 @@ module Helpers
       (?:
         (?:,\s+(?<default>default:[^,\n]+?(?=(?:,\s)|$)))?
         (?:,\s+(?<null>null:\s+\w+))?
-        (?:,\s+comment:\s+"(?<comment>[^"]+)")?
+        (?:,\s+comment:\s+"(?<comment>[^"\\]*(?:\\.[^"\\]*)*)")?
         (?:,\s+precision:\s+(?<precision>\d+))?
         (?:,\s+array:\s+(?<array>true|false))?
+        (?:,\s+limit:\s+(?<limit>\d+))?
       )*
     /x
 
+    INDEXES_REGEXP = /
+      t\.index\s+\[(?<columns>[^\]]+)\]
+      (?:,\s+name:\s+"(?<name>[^"\\]*(?:\\.[^"\\]*)*)")?
+      (?:,\s+unique:\s+(?<unique>true|false))?
+    /x
+
     RELATIONS_REGEXP = /
       add_foreign_key\s+"(?<from_table>\w+)",\s+"(?<to_table>\w+)"
       (?:,\s+column:\s+"(?<column>\w+)")?

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
@@ -18,8 +18,8 @@ class SchemaConverter
   def convert(schema_content:)
     tables = []
     relations = []
-    schema_content.scan(TABLES_REGEXP).each do |table_name, table_comment, columns|
-      tables << dbml_tables_formatter.format(table_name:, table_comment:, parsed_columns: columns)
+    schema_content.scan(TABLES_REGEXP).each do |table_name, table_comment, table_attributes|
+      tables << dbml_tables_formatter.format(table_name:, table_comment:, table_attributes:)
     end
 
     schema_content.scan(RELATIONS_REGEXP).each do |from_table, to_table, column, on_delete|

data/lib/schema_to_dbml/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_dbml
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Ricardo Ribeiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-06-21 00:00:00.000000000 Z
+date: 2024-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +132,8 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTE.md
@@ -139,6 +155,7 @@ files:
 - lib/schema_to_dbml/errors/schema_file_not_found_error.rb
 - lib/schema_to_dbml/formatters/default_field_formatter_helper.rb
 - lib/schema_to_dbml/formatters/fields_formatter.rb
+- lib/schema_to_dbml/formatters/index_formatter.rb
 - lib/schema_to_dbml/helpers/constants.rb
 - lib/schema_to_dbml/schema_converter.rb
 - lib/schema_to_dbml/version.rb
@@ -166,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A Ruby on Rails gem for converting schema.rb files to DBML.