dbml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8979759a1d1b3dc026d99323199313a0e35fca4fc0cf865a7ed256b1bf61054c
+  data.tar.gz: 93f4d97a7c07c9d94e9412cc781c0312007b7dd42c225ffc9fd64aec3fc9eb1f
+SHA512:
+  metadata.gz: 03d021e161615e622a88bac15a21c8fd633f60bed64b081d0479ee47df29478e5d9eb0465365269bf214c8f160bfb452de81e2e78114d033a60bf6d23131c087
+  data.tar.gz: 32bb14bc1df49cebf682b7b65aa5670e45130f182f6397d3df45ec26744fe4e394aa7050ffe0071e86b0e389dd1f6370b39ee6ab9c48238d37cea4985ecd890b

data/.github/workflows/test.yml

@@ -0,0 +1,32 @@
+name: Run tests
+
+on: [pull_request, push]
+
+jobs:
+  unit_tests:
+    name: Run unit tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 2.6
+
+      - name: Restore gems from cache
+        uses: actions/cache@v2
+        env:
+          cache-name: ruby-gems-cache
+        with:
+          path: ./.gems
+          key: ${{ runner.os }}-${{ env.cache-name }}-${{ hashFiles('**/dbml.gemspec') }}
+          restore-keys: |
+            ${{ runner.os }}-${{ env.cache-name }}-
+
+      - name: Install gems
+        run: bundle install --path=./.gems --jobs=4 
+
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dbml.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Simon Worthington
+
+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 @@
+# DBML
+
+Ruby library for [Database Markup Language (DBML)](https://www.dbml.org/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dbml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dbml
+
+## Usage
+
+```ruby
+require 'dbml'
+project = DBML::Parser.parse """
+  Table users {
+    id int64 [pk, unique]
+    name varchar [unique]
+    Note: 'add some more things in here!'
+  }"""
+puts project.tables.first.name
+# => "users"
+```
+
+## Development
+
+After checking out the repo, run `bundle install` to install dependencies. Then, run `rake test` to run the tests.
+
+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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/simonwo/dbml-ruby.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/dbml.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dbml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dbml'
+  spec.version       = DBML::VERSION
+  spec.authors       = ['Simon Worthington']
+  spec.email         = ['simon@simonwo.net']
+
+  spec.summary       = %q{Parser for Database Markup Language (DBML).}
+  spec.homepage      = 'https://github.com/simonwo/dbml-ruby'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rsec', '~> 1.0'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/dbml.rb

@@ -0,0 +1,244 @@
+require 'rsec'
+include Rsec::Helpers
+
+module DBML
+  Column     = Struct.new :name, :type, :settings
+  Table      = Struct.new :name, :alias, :notes, :columns, :indexes
+  Index      = Struct.new :fields, :settings
+  Expression = Struct.new :text
+  Enum       = Struct.new :name, :choices
+  EnumChoice = Struct.new :name, :settings
+  TableGroup = Struct.new :name, :tables
+  Project    = Struct.new :name, :notes, :settings, :tables, :enums, :table_groups
+  ProjectDef = Struct.new :name, :notes, :settings
+
+  module Parser
+    def self.long_or_short p
+      (':'.r >> p) | ('{'.r >> p << '}'.r)
+    end
+
+    def self.unwrap p, *_
+      if p.empty? then nil else p.first end
+    end
+
+    def self.comma_separated p
+      p.join(/, */.r.map {|_| nil}).star.map {|v| v.first.reject(&:nil?) }
+    end
+
+    def self.space_surrounded p
+      /\s*/.r >> p << /\s*/.r
+    end
+
+    def self.block type, name_parser, content_parser, &block
+      seq_(type.r >> name_parser, '{'.r >> space_surrounded(content_parser).star.map {|a| a.flatten(1) } << '}'.r, &block)
+    end
+
+    # ATOM parses true:        'true' => true
+    # ATOM parses false:       'false' => false
+    # ATOM parses null:        'null' => nil
+    # ATOM parses numbers:     '123.45678' => 123.45678
+    # ATOM parses strings:     "'string'" => "string"
+    # ATOM parses multilines:  "'''long\nstring'''" => "long\nstring"
+    # ATOM parses expressions: '`now()`' => DBML::Expression.new('now()')
+    BOOLEAN            = 'true'.r.map {|_| true } | 'false'.r.map {|_| false }
+    NULL               = 'null'.r.map {|_| nil }
+    NUMBER             = prim(:double)
+    EXPRESSION         = seq('`'.r, /[^`]+/.r, '`'.r)[1].map {|str| Expression.new str}
+    SINGLE_LING_STRING = seq("'".r, /[^']+/.r, "'".r)[1]
+    MULTI_LINE_STRING  = seq("'''".r, /([^']|'[^']|''[^'])+/m.r, "'''".r)[1].map do |string|
+      # MULTI_LINE_STRING ignores indentation on the first line: "'''  long\n    string'''" => "long\n  string"
+      # MULTI_LINE_STRING allows apostrophes: "'''it's a string with '' bunny ears'''" => "it's a string with '' bunny ears"
+      indent = string.match(/^\s*/m)[0].size
+      string.lines.map do |line|
+        raise "Indentation does not match" unless line =~ /\s{#{indent}}/
+        line[indent..]
+      end.join
+    end
+    STRING = SINGLE_LING_STRING | MULTI_LINE_STRING
+    ATOM = BOOLEAN | NULL | NUMBER | EXPRESSION | STRING
+
+    # Each setting item can take in 2 forms: Key: Value or keyword, similar to that of Python function parameters.
+    # Settings are all defined within square brackets: [setting1: value1, setting2: value2, setting3, setting4]
+    #
+    # SETTINGS parses key value settings: '[default: 123]' => {'default' => 123}
+    # SETTINGS parses keyword settings: '[not null]' => {'not null' => nil}
+    # SETTINGS parses many settings: "[some setting: 'value', primary key]" => {'some setting' => 'value', 'primary key' => nil}
+    SETTING = seq_(/[^,:\[\]\{\}\s][^,:\[\]]+/.r, (':'.r >> ATOM).maybe(&method(:unwrap))) {|(key, value)| {key => value} }
+    SETTINGS = ('['.r >> comma_separated(SETTING) << ']'.r).map {|values| values.reduce({}, &:update) }
+
+    # NOTE parses short notes: "Note: 'this is cool'" => 'this is cool'
+    # NOTE parses block notes: "Note {\n'still a single line of note'\n}" => 'still a single line of note'
+    # NOTE can use multilines:  "Note: '''this is\nnot reassuring'''" => "this is\nnot reassuring"
+    NOTE = 'Note'.r >> (long_or_short STRING)
+
+    # Index Definition
+    #
+    # Indexes allow users to quickly locate and access the data. Users can define single or multi-column indexes.
+    #
+    #     Table bookings {
+    #       id integer
+    #       country varchar
+    #       booking_date date
+    #       created_at timestamp
+    #
+    #       indexes {
+    #           (id, country) [pk] // composite primary key
+    #           created_at [note: 'Date']
+    #           booking_date
+    #           (country, booking_date) [unique]
+    #           booking_date [type: hash]
+    #           (`id*2`)
+    #           (`id*3`,`getdate()`)
+    #           (`id*3`,id)
+    #       }
+    #     }
+    #
+    # There are 3 types of index definitions:
+    #
+    # # Index with single field (with index name): CREATE INDEX on users (created_at)
+    # # Index with multiple fields (composite index): CREATE INDEX on users (created_at, country)
+    # # Index with an expression: CREATE INDEX ON films ( first_name + last_name )
+    # # (bonus) Composite index with expression: CREATE INDEX ON users ( country, (lower(name)) )
+    #
+    # INDEX parses single fields: 'id' => DBML::Index.new(['id'], {})
+    # INDEX parses composite fields: '(id, country)' => DBML::Index.new(['id', 'country'], {})
+    # INDEX parses expressions: '(`id*2`)' => DBML::Index.new([DBML::Expression.new('id*2')], {})
+    # INDEX parses settings: '(country, booking_date) [unique]' => DBML::Index.new(['country', 'booking_date'], {'unique' => nil})
+
+    INDEX_SINGLE = /[^\(\)\,\{\}\s]+/.r
+    INDEX_COMPOSITE = seq_('('.r, comma_separated(EXPRESSION | INDEX_SINGLE), ')'.r).inner.map {|v| unwrap(v) }
+    INDEX = seq_(INDEX_SINGLE.map {|field| [field] } | INDEX_COMPOSITE, SETTINGS.maybe).map do |(fields, settings)|
+      Index.new fields, unwrap(settings) || {}
+    end
+    INDEXES = block 'indexes', ''.r, INDEX do |(_, indexes)| indexes end
+
+    # Enum Definition
+    # ---------------
+    #
+    # Enum allows users to define different values of a particular column.
+    #
+    #     enum job_status {
+    #         created [note: 'Waiting to be processed']
+    #         running
+    #         done
+    #         failure
+    #     }
+    #
+    # ENUM parses empty blocks: "enum empty {\n}" => DBML::Enum.new('empty', [])
+    # ENUM parses settings: "enum setting {\none [note: 'something']\n}" => DBML::Enum.new('setting', [DBML::EnumChoice.new('one', {'note' => 'something'})])
+    # ENUM parses filled blocks: "enum filled {\none\ntwo}" =? DBML::Enum.new('filled', [DBML::EnumChoice.new('one', {}), DBML::EnumChoice.new('two', {})])
+
+    ENUM_CHOICE = seq_(/[^\{\}\s]+/.r, SETTINGS.maybe).map {|(name, settings)| EnumChoice.new name, unwrap(settings) }
+    ENUM = block 'enum', /\S+/.r, ENUM_CHOICE do |(name, choices)|
+      Enum.new name, choices
+    end
+
+    # Column Definition
+    # =================
+    # * name of the column is listed as column_name
+    # * type of the data in the column listed as column_type
+    # * supports all data types, as long as it is a single word (remove all spaces in the data type). Example, JSON, JSONB, decimal(1,2), etc.
+    # * column_name can be stated in just plain text, or wrapped in a double quote as "column name"
+    #
+    # Column Settings
+    # ---------------
+    # Each column can take have optional settings, defined in square brackets like:
+    #
+    #     Table buildings {
+    #         //...
+    #         address varchar(255) [unique, not null, note: 'to include unit number']
+    #         id integer [ pk, unique, default: 123, note: 'Number' ]
+    #     }
+    #
+    # COLUMN parses naked identifiers as names: 'column_name type' => DBML::Column.new('column_name', 'type', {})
+    # COLUMN parses quoted identifiers as names: '"column name" type' => DBML::Column.new('column name', 'type', {})
+    # COLUMN parses types: 'name string' => DBML::Column.new('name', 'string', {})
+    # COLUMN parses settings: 'name string [pk]' => DBML::Column.new('name', 'string', {'pk' => nil})
+
+    QUOTED_COLUMN_NAME = '"'.r >> /[^"]+/.r << '"'.r
+    UNQUOTED_COLUMN_NAME = /[^\{\}\s]+/.r
+    COLUMN_TYPE = /\S+/.r
+    COLUMN = seq_(
+      QUOTED_COLUMN_NAME | UNQUOTED_COLUMN_NAME,
+      COLUMN_TYPE,
+      SETTINGS.maybe
+    ) {|(name, type, settings)| Column.new name, type, unwrap(settings) || {} }
+
+    # Table Definition
+    #
+    #     Table table_name {
+    #       column_name column_type [column_settings]
+    #     }
+    #
+    # * title of database table is listed as table_name
+    # * list is wrapped in curly brackets {}, for indexes, constraints and table definitions.
+    # * string value is be wrapped in a single quote as 'string'
+    #
+    # TABLE_NAME parses identifiers: 'table_name' => ['table_name', nil]
+    # TABLE_NAME parses aliases: 'table_name as thingy' => ['table_name', 'thingy']
+    # TABLE parses empty tables: 'Table empty {}' => DBML::Table.new('empty', nil, [], [], [])
+    # TABLE parses notes: "Table with_notes {\nNote: 'this is a note'\n}" => DBML::Table.new('with_notes', nil, ['this is a note'], [], [])
+
+    TABLE_NAME = seq_(/[^\{\}\s]+/.r, ('as'.r >> /\S+/.r).maybe {|v| unwrap(v) })
+    TABLE = block 'Table', TABLE_NAME, (INDEXES | NOTE | COLUMN) do |((name, aliaz), objects)|
+      Table.new name, aliaz,
+        objects.select {|o| o.is_a? String },
+        objects.select {|o| o.is_a? Column },
+        objects.select {|o| (o.is_a? Array) && (o.all? {|e| e.is_a? Index })}.flatten
+    end
+
+    # TableGroup
+    # ==========
+    #
+    # TableGroup allows users to group the related or associated tables together.
+    #
+    #     TableGroup tablegroup_name { // tablegroup is case-insensitive.
+    #         table1
+    #         table2
+    #         table3
+    #     }
+    #
+    # TABLE_GROUP parses names: 'TableGroup group1 { }' => DBML::TableGroup.new('group1', [])
+    # TABLE_GROUP parses tables: "TableGroup group2 {\ntable1\ntable2\n}" => DBML::TableGroup.new('group2', ['table1', 'table2'])
+    TABLE_GROUP = block 'TableGroup', /\S+/.r, /[^\{\}\s]+/.r do |(name, tables)|
+      TableGroup.new name, tables
+    end
+
+    # Project Definition
+    # ==================
+    # You can give overall description of the project.
+    #
+    #     Project project_name {
+    #       database_type: 'PostgreSQL'
+    #       Note: 'Description of the project'
+    #     }
+    #
+    # PROJECT_DEFINITION parses names: 'Project my_proj { }' => DBML::ProjectDef.new('my_proj', [], {})
+    # PROJECT_DEFINITION parses notes: "Project my_porg { Note: 'porgs are cool!' }" => DBML::ProjectDef.new('my_porg', ['porgs are cool!'], {})
+    # PROJECT_DEFINITION parses settings: "Project my_cool {\ndatabase_type: 'PostgreSQL'\n}" => DBML::ProjectDef.new('my_cool', [], {'database_type' => 'PostgreSQL'})
+    PROJECT_DEFINITION = block 'Project', /\S+/.r, (NOTE | SETTING).star do |(name, objects)|
+      ProjectDef.new name,
+        objects.select {|o| o.is_a? String },
+        objects.select {|o| o.is_a? Hash }.reduce({}, &:update)
+    end
+
+    # PROJECT can be empty: "" => DBML::Project.new(nil, [], {}, [], [], [])
+    # PROJECT includes definition info: "Project p { Note: 'hello' }" => DBML::Project.new('p', ['hello'], {}, [], [], [])
+    # PROJECT includes tables: "Table t { }" => DBML::Project.new(nil, [], {}, [DBML::Table.new('t', nil, [], [], [])], [], [])
+    # PROJECT includes enums: "enum E { }" => DBML::Project.new(nil, [], {}, [], [DBML::Enum.new('E', [])], [])
+    # PROJECT includes table groups: "TableGroup TG { }" => DBML::Project.new(nil, [], {}, [], [], [DBML::TableGroup.new('TG', [])])
+    PROJECT = space_surrounded(PROJECT_DEFINITION | TABLE | TABLE_GROUP | ENUM).star do |objects|
+      definition = objects.find {|o| o.is_a? ProjectDef }
+      Project.new definition.nil? ? nil : definition.name,
+        definition.nil? ? [] : definition.notes,
+        definition.nil? ? {} : definition.settings,
+        objects.select {|o| o.is_a? Table },
+        objects.select {|o| o.is_a? Enum },
+        objects.select {|o| o.is_a? TableGroup }
+    end
+
+    def self.parse str
+      PROJECT.eof.parse! str.gsub(/\/{2}.*$/, '')
+    end
+  end
+end

data/lib/dbml/version.rb

@@ -0,0 +1,3 @@
+module DBML
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: dbml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Worthington
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rsec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- simon@simonwo.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- dbml.gemspec
+- lib/dbml.rb
+- lib/dbml/version.rb
+homepage: https://github.com/simonwo/dbml-ruby
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Parser for Database Markup Language (DBML).
+test_files: []