schema_to_dbml 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d1c7e55da915704ade42e031926565a591aa815626fcf0f54ef9f75a9e85875
-  data.tar.gz: 80e1485742492b48126ab3ef28023b72c67f86d1512f97f751b9c7bd05ff1180
+  metadata.gz: 2d437e4d75d3d034a51e6a63d2e5f56ce5b8a95364fd785f354e5ffcad7e5956
+  data.tar.gz: b16dd77e8f191da41fb875582873aeb0c7d53cfa9029c47b805733838585f42b
 SHA512:
-  metadata.gz: c4e534e1ed44995890a6d4cfa425c5157e83d9b29299a77783c4d7a1e427fd55732410c915262f71e02a274a4390315ca548c2ce73ec585f7d3c5ca4b4fcdc8a
-  data.tar.gz: fa702214c60f1e94c587c4509d94816ce2cebd0e1ad441441dfe5a4cbb634018d56ae0ebc49ffe87e5fcbb5c89273b62effdd34021bc65e0601ab8a5d77a6e23
+  metadata.gz: 3cb923fdc024dadc60b8d9e309895dbebd0d471c3f8fc0b50e85b5c27ea09df3b771741d8eb0c4a9ae92dc3ae174ce6043661cc95fa7adc2f2697acc51b08a36
+  data.tar.gz: afa0177a0764031887e62fc0feaea2019c8faf2693b289fdf6794db04064abbfe61aed045b7bf40903b8463c26247a575c5a096b5aae1a351c4ffe84cdcce150

data/CONTRIBUTE.md

@@ -0,0 +1,68 @@
+# Contributing to `schema_to_dbml`
+
+Welcome! We're excited that you're interested in contributing to `schema_to_dbml`, an open-source project. By contributing, you can help improve the project, fix bugs, add new features, and enhance its overall quality.
+
+The following guidelines will help you understand how you can contribute effectively. We encourage you to read them carefully before getting started.
+
+## Ways to Contribute
+
+There are several ways in which you can contribute to the project:
+
+1. **Reporting Issues**: If you come across any bugs or have suggestions for improvements, please open an issue on the project's GitHub repository. Make sure to provide as much information as possible, including steps to reproduce the issue and any relevant error messages.
+
+2. **Submitting Pull Requests (PRs)**: You can help by fixing bugs, adding new features, or improving the existing codebase. If you're planning to work on a significant change, it's best to open an issue first to discuss it with the maintainers and ensure it aligns with the project's goals.
+
+## Getting Started
+
+To contribute code changes to `schema_to_dbml`, follow these steps:
+
+1. Fork the project repository to your GitHub account.
+
+2. Clone the forked repository to your local machine:
+   ```
+   git clone https://github.com/your-username/schema_to_dbml.git
+   ```
+
+3. Create a new branch for your changes:
+   ```
+   git checkout -b my-branch-name
+   ```
+
+4. Make the necessary changes and improvements to the codebase.
+
+5. Test your changes thoroughly to ensure they work as expected.
+
+6. Commit your changes with a descriptive commit message:
+   ```
+   git commit -m "Add feature XYZ"
+   ```
+
+7. Push your changes to your forked repository:
+   ```
+   git push origin my-branch-name
+   ```
+
+8. Open a pull request (PR) on the original repository. Provide a detailed description of your changes, including the problem they solve or the feature they add. Also, reference any related issues in the PR description.
+
+## Code Guidelines
+
+To maintain a consistent codebase, please adhere to the following guidelines:
+
+- Follow the existing code style and naming conventions used in the project.
+- Write clear and concise code and documentation.
+- Add tests for any new features or modifications to existing functionality.
+- Ensure that all tests pass before submitting your changes.
+
+## Communication
+
+The project's GitHub repository is the primary channel for communication. Feel free to open issues for bug reports, feature requests, or general discussions related to the project.
+
+## Code of Conduct
+
+Please note that this project follows a [Code of Conduct](https://github.com/ricardojcribeiro/schema_to_dbml/blob/develop/CODE_OF_CONDUCT.md). We expect all contributors to adhere to the code when participating in the project.
+
+## Acknowledgments
+
+Contributors play a vital role in the success of any open-source project. Your efforts and contributions will be acknowledged in the project's documentation and release notes.
+
+Thank you for your interest in contributing to `schema_to_dbml`. Together, we can make the project even better!

data/Gemfile.lock

@@ -1,22 +1,32 @@
 PATH
   remote: .
   specs:
-    schema_to_dbml (0.0.1)
+    schema_to_dbml (0.0.2)
+      activesupport (>= 6.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
     ast (2.4.2)
     byebug (11.1.3)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
     json (2.6.3)
-    parallel (1.22.1)
-    parser (3.2.2.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.7.0)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
     rspec (3.12.0)
       rspec-core (~> 3.12.0)
@@ -31,7 +41,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.12.0)
     rspec-support (3.12.0)
-    rubocop (1.49.0)
+    rubocop (1.51.0)
       json (~> 2.3)
       parallel (~> 1.10)
       parser (>= 3.2.0.0)
@@ -41,7 +51,7 @@ GEM
       rubocop-ast (>= 1.28.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.28.0)
+    rubocop-ast (1.28.1)
       parser (>= 3.2.1.0)
     ruby-progressbar (1.13.0)
     simplecov (0.22.0)
@@ -50,10 +60,13 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.4.2)
 
 PLATFORMS
   x86_64-darwin-22
+  x86_64-linux
 
 DEPENDENCIES
   bundler

data/README.md

@@ -43,47 +43,69 @@ This will output the generated DBML content.
 
 ## Custom Configuration
 
-If you want to customize the DBML content, you can create a YAML configuration file with your desired properties. 
-By default, the SchemaToDbml will try to load the configuration from `schema_to_dbml/configs/custom_config.yml`.
-
-Here's an example of the configuration file:
+If you want to customize the DBML content, you can create a YAML configuration file with your desired properties.
+By default, the SchemaToDbml will load the below default configuration
 
 ```yaml
-custom_project_name: 'My Project'
-custom_database_type: 'PostgreSQL'
-custom_project_notes: 'This is my project.'
-custom_primary_key: 'id [pk]'
+custom_project_name: 'dbml_database_definition'
+custom_database_type: "'PostgreSQL'"
+custom_project_notes: |
+  # My Project Notes
+  This is a **project** that documents the database. Here are some key points:
+
+  - 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_dbml_content: ''
 ```
 
 You can change the properties as you want. After that, you can load the configuration by calling:
 
 ```ruby
-SchemaToDbml.load_configuration_from_yaml('/path/to/your/custom_config.yml')
+SchemaToDbml.load_configuration_from_yaml(file_path: '/path/to/your/custom_config.yml')
 ```
 
-Or you can pass the configuration directly:
+Example of custom yaml configurations:
 
 ```ruby
-config = Configuration.new
-config.custom_project_name = 'My Project'
-config.custom_database_type = 'PostgreSQL'
-config.custom_project_notes = 'This is my project.'
-config.custom_primary_key = 'id'
-
-SchemaToDbml.configure(config)
+custom_database_type: 'PostgreSQL'
+custom_project_name: 'my_project_database'
+custom_project_notes: |
+  # My Project Database
+  This database is designed to support the operations of my project, a leading platform on my core business
+custom_dbml_content: |
+  enum object_status {
+    created [note: 'Initial status']
+    pending  
+    finished
+    cancelled
+  }
+  TableGroup my_table_group {
+    table_1
+    table_2
+    table_3
+  }
 ```
 
 After that, you can use the SchemaToDbml to generate the DBML content as usual.
 
 ## Development
 
+
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle install`.
+
+For proposing changes, create a new branch and make your changes there. Do not change the version number in `version.rb`.  After you've done your changes, open a new Pull Request (PR) for your changes to be reviewed.
+
+The maintainers will review your PR. If approved, they will update the version number in `version.rb` and run `bundle exec rake release`. This will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org/).
+
+Remember, direct changes to the version number and releases are not allowed. All changes should go through a Pull Request and should be approved by the maintainers.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/schema_to_dbml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/schema_to_dbml/blob/main/CODE_OF_CONDUCT.md).
+Please read the [contribution guideline](https://github.com/ricardojcribeiro/schema_to_dbml/blob/develop/CONTRIBUTE.md)
 
 ## License
 
@@ -91,4 +113,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the SchemaToDbml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/schema_to_dbml/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the SchemaToDbml project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ricardojcribeiro/schema_to_dbml/blob/develop/CODE_OF_CONDUCT.md).

data/lib/configuration.rb

@@ -1,8 +1,17 @@
 # frozen_string_literal: true
 
 class Configuration
-  attr_accessor :custom_primary_key,
-                :custom_database_type,
+  def configure_from_hash(yaml_data)
+    @custom_database_type = yaml_data['custom_database_type']
+    @custom_dbml_content = yaml_data['custom_dbml_content']
+    @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_project_name,
-                :custom_project_notes
+                :custom_project_notes,
+                :custom_primary_key
 end

data/lib/schema_to_dbml/build_dbml_content.rb

@@ -10,6 +10,7 @@ class BuildDbmlContent
     dbml << project_header
     dbml << tables_section(converted[:tables])
     dbml << relations_section(converted[:relations])
+    dbml << custom_dbml_content
 
     dbml.join("\n\n")
   end
@@ -18,7 +19,7 @@ class BuildDbmlContent
 
   def project_header
     header = "Project #{project_name} {\n"
-    header += "  database_type: #{custom_database_type}\n"
+    header += "  database_type: '#{custom_database_type}'\n"
     header += "  Note: '#{custom_project_notes}'\n"
     header += '}'
     header
@@ -44,5 +45,9 @@ class BuildDbmlContent
     configuration.custom_project_notes
   end
 
+  def custom_dbml_content
+    configuration.custom_dbml_content
+  end
+
   attr_reader :configuration
 end

data/lib/schema_to_dbml/configs/custom_config.yml

@@ -1,5 +1,5 @@
 custom_project_name: 'dbml_database_definition'
-custom_database_type: "'PostgreSQL'"
+custom_database_type: 'PostgreSQL'
 custom_project_notes: |
   # My Project Notes
   This is a **project** that documents the database. Here are some key points:
@@ -8,3 +8,4 @@ custom_project_notes: |
   - 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_dbml_content: ''

data/lib/schema_to_dbml/dbml_relations_formatter.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/inflector'
+
 class DbmlRelationsFormatter
   # Formats a database relationship for a DBML file
   #
@@ -21,26 +23,17 @@ class DbmlRelationsFormatter
 
   private
 
-  def default_foreign_key_column(to_table)
-    "#{singularize(to_table)}_id"
-  end
-
   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
   end
 
-  def build_reference_string(ref_name, from_table, column, to_table)
-    "Ref #{ref_name}:#{from_table}.#{column} - #{to_table}.id"
+  def default_foreign_key_column(to_table)
+    "#{to_table.singularize}_id"
   end
 
-  # Singularizes a word
-  #
-  # @param word [String] the word to singularize
-  #
-  # @return [String] the singularized word
-  def singularize(word)
-    word.sub(/(?:([^aeiouy])y|s)$/, '\1').sub(/ies$/, 'y')
+  def build_reference_string(ref_name, from_table, column, to_table)
+    "Ref #{ref_name}:#{from_table}.#{column} - #{to_table}.id"
   end
 end

data/lib/schema_to_dbml/errors/configuration_file_not_found_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Errors
+  class ConfigurationFileNotFoundError < StandardError
+    def initialize(message = 'Configuration file was not found')
+      super
+    end
+  end
+end

data/lib/schema_to_dbml/formatters/default_field_formatter_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module DefaultFieldFormatterHelper
+  DEFAULT_ARRAY_REGEX = [/default: (\[.*?\])/, 'default: \'\1\''].freeze
+  DEFAULT_BOOLEAN_REGEX = [/default: (true|false)/, 'default: \1'].freeze
+  DEFAULT_HASH_REGEX = [/default: (\{(?:[^}]*?)\})/, 'default: \'\1\''].freeze
+  DEFAULT_NUMBER_REGEX = [/default: (\d+(?:\.\d+)?)/, 'default: \1'].freeze
+  DEFAULT_STRING_REGEX = [/default: "(.*?)"/, 'default: \'\1\''].freeze
+  DEFAULT_LAMBDA_REGEX = [/default: -> \{ "(.*?)" \}/, 'default: `\1`'].freeze
+
+  DEFAULT_PATTERNS = [
+    DEFAULT_ARRAY_REGEX,
+    DEFAULT_BOOLEAN_REGEX,
+    DEFAULT_HASH_REGEX,
+    DEFAULT_NUMBER_REGEX,
+    DEFAULT_STRING_REGEX,
+    DEFAULT_LAMBDA_REGEX
+  ].freeze
+end

data/lib/schema_to_dbml/formatters/fields_formatter.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require_relative 'default_field_formatter_helper'
+
 module Formatters
   module FieldsFormatter
+    include DefaultFieldFormatterHelper
     TYPE_MAPPER = {
       string: 'varchar',
       integer: 'int',
@@ -22,7 +25,11 @@ module Formatters
     def format_default(default:)
       return '' if default.to_s.empty?
 
-      "default: #{default}"
+      DEFAULT_PATTERNS.each do |pattern, replacement|
+        default = default.gsub(pattern, replacement)
+      end
+
+      default
     end
 
     def format_null(null:)

data/lib/schema_to_dbml/helpers/constants.rb

@@ -3,9 +3,9 @@
 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>.*?)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/m
 
-    COLUMNS_REGEXP = /t\.(?<type>\w+)\s+"(?<name>\w+)"(?:,\s+default:\s+(?<default>[^,\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))?.*/
 
     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

data/lib/schema_to_dbml/version.rb

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

data/lib/schema_to_dbml.rb

@@ -1,9 +1,11 @@
 # frozen_string_literal: true
 
 require 'yaml'
+require 'active_support/core_ext/hash'
 require_relative 'configuration'
 require_relative 'schema_to_dbml/build_dbml_content'
 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'
 
@@ -12,27 +14,24 @@ class SchemaToDbml
 
   class << self
     def configuration
-      @configuration ||= begin
-        config = Configuration.new
-        load_configuration_from_yaml(DEFAULT_CONFIG_FILE, config)
-        config
-      end
+      @configuration ||= Configuration.new
     end
 
-    def load_configuration_from_yaml(file_path, config = configuration)
-      raise 'Configuration file not found Error' unless File.exist?(file_path)
+    def load_configuration_from_yaml(file_path: DEFAULT_CONFIG_FILE)
+      raise Errors::ConfigurationFileNotFoundError unless File.exist?(file_path)
 
       yaml_data = YAML.load_file(file_path)
-      configure(config) do |c|
-        c.custom_primary_key = yaml_data['custom_primary_key']
-        c.custom_database_type = yaml_data['custom_database_type']
-        c.custom_project_name = yaml_data['custom_project_name']
-        c.custom_project_notes = yaml_data['custom_project_notes']
-      end
+      yaml_data = merge_with_defaults(file_path, yaml_data)
+
+      configuration.configure_from_hash(yaml_data)
     end
 
-    def configure(config = configuration)
-      yield(config)
+    def merge_with_defaults(file_path, yaml_data)
+      return yaml_data unless file_path != DEFAULT_CONFIG_FILE
+
+      default_settings = YAML.load_file(DEFAULT_CONFIG_FILE)
+
+      default_settings.deep_merge!(yaml_data)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_to_dbml
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ricardo Ribeiro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-06 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.0
 description: This gem provides functionality for parsing a Rails schema.rb file and
   generating a corresponding DBML file.
 email:
@@ -105,10 +119,10 @@ files:
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTE.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - lib/configuration.rb
@@ -118,7 +132,9 @@ files:
 - lib/schema_to_dbml/configs/custom_config.yml
 - lib/schema_to_dbml/dbml_relations_formatter.rb
 - lib/schema_to_dbml/dbml_tables_formatter.rb
+- lib/schema_to_dbml/errors/configuration_file_not_found_error.rb
 - 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/helpers/constants.rb
 - lib/schema_to_dbml/schema_converter.rb

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2023 Ricardo Ribeiro
-
-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.