dbgrapher 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 216e0bf448c9a04b8878009c8d74bcac49ef2a59ed242f14f6f224bd94200157
+  data.tar.gz: '08cdfb6be53b59e0a3bbf643dd1dacf171ec2e85a89ef720f9aa3a007dd113ae'
+SHA512:
+  metadata.gz: 29914d7a7c53ced3cb7a15ed449f916f1aa3527d39cd5318a46b04eb603bba62dcd4287e1c44bef036d9b9b46bb93490d15efada9fc2c364b3fa1fcc7b441f75
+  data.tar.gz: 920a12eb8ee1ae88e79facbd75a9be1e71cb275f594a213884478fd744f623d158d000488643dd8c6da29212101beb4210b5b9e4cc8a300a6714daf1d7196c34

data/.github/env.json

@@ -0,0 +1,10 @@
+{
+  "googleDrive": {
+    "developerKey": "",
+    "clientId": "",
+    "appId": ""
+  },
+  "oneDrive": {
+    "clientId": ""
+  }
+}

data/.github/workflows/ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  cd:
+    runs-on: ubuntu-latest
+    steps:
+      # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '2.7'
+      - run: bundle
+      - run: bundle exec rspec
+

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.byebug_history

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dbgrapher.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0", :groups => [:test]
+gem "byebug", "~> 11.1", :groups => [:development, :test]

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    dbgrapher (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    diff-lcs (1.4.4)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug (~> 11.1)
+  dbgrapher!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Ara Yeressian
+
+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,49 @@
+[![CI](https://github.com/ayeressian/dbgrapher_gem/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/ayeressian/dbgrapher_gem/actions/workflows/ci.yml)
+
+# Dbgrapher
+
+This is a library that provides rake task to be used with rails application to generate dbgrapher.com db schema file.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dbgrapher'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install dbgrapher
+
+In the lib/tasks directory create dbgrapher.rake file with the following content
+
+```ruby
+require "dbgrapher/rake_task"
+
+Dbgrapher::RakeTask.new()
+```
+
+Then run
+
+    rake dbgrapher:gen
+
+In the `db/schema directory` it will generate `dbgrapher.json` file.
+Now in your browser (preferably chrome) navigate to [dbgrapher.com](https://dbgrapher.com). In the "Please select a cloud provider." dialog select "None". In the following dialog select "Open". Open the `db/schema/dbgrapher.json` file. Move the tables to appropriate positions. Then from "File" top menu select save. In case you're not using chrome you should select "Download" from "File" top menu and copy the downloaded file to the `db/schema/dbgrapher.json`.
+Every time a new table is being added to the database the top procedure should be performed. Note its only necessary to position the newly added tables, the previously positioned table positions are persisted.
+Don't forget to commit your dbgrapher.json file. It contains information about the table positions.
+
+## 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 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/ayeressian/dbgrapher_gem.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dbgrapher"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dbgrapher.gemspec

@@ -0,0 +1,30 @@
+require_relative 'lib/dbgrapher/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dbgrapher"
+  spec.version       = Dbgrapher::VERSION
+  spec.authors       = ["Ara Yeressian"]
+  spec.email         = ["yeressian@tuta.io"]
+
+  spec.summary       = "This library provides rake task to be used with rails application to generate dbgrapher.com db schema file"
+  # spec.description   = %q{TODO: Write a longer description or delete this line.}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ayeressian/dbgrapher_gem"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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.licenses = ['MIT']
+end

data/lib/dbgrapher/generate.rb

@@ -0,0 +1,53 @@
+module Dbgrapher
+  class Generate
+    def initialize(schema_path:)
+      @schema_path = schema_path
+    end
+
+    def run()
+      @result = File.exists?(@schema_path) ?
+        JSON.parse(File.read(@schema_path), { :symbolize_names => true }) :
+        { tables: [] }
+      @deleted_tables = @result[:tables].map { |table| table[:name] }
+      ActiveRecord::Base.connection.tables.each(&self.method(:parse_table))
+      @result[:tables] = @result[:tables].filter { |table| !@deleted_tables.find { |deleted_table| table[:name] === deleted_table } }
+      File.write(@schema_path, JSON.pretty_generate(@result))
+    end
+
+    private
+
+    def parse_column(column, table_name)
+      fks = ActiveRecord::Base.connection.foreign_keys(table_name)
+      pks = ActiveRecord::Base.connection.primary_keys(table_name)
+      formatted_column = {
+        name: column.name,
+        type: column.type,
+      }
+
+      fk = fks.find { |fk| fk.options[:column] === column.name }
+
+      if !fk.nil?
+        formatted_column[:fk] = {
+          table: fk.to_table,
+          column: fk.options[:primary_key],
+        }
+      end
+
+      formatted_column[:pk] = true if pks.find { |pk| pk === column.name }
+
+      formatted_column
+    end
+
+    def parse_table(table_name)
+      table = @result[:tables].find { |table| table[:name] === table_name }
+      new_table = table.nil?
+      @deleted_tables.delete_if { |deleted_table| deleted_table === table_name }
+      table ||= {
+        name: table_name,
+      }
+
+      table[:columns] = ActiveRecord::Base.connection.columns(table_name).map { |column| parse_column(column, table_name) }
+      @result[:tables].push(table) if new_table
+    end
+  end
+end

data/lib/dbgrapher/rake_task.rb

@@ -0,0 +1,17 @@
+require "dbgrapher/version"
+require "dbgrapher/generate"
+require "rake"
+
+module Dbgrapher
+  class RakeTask
+    include Rake::DSL
+    def initialize(task_namespace: :dbgrapher, schema_path: './db/dbgrapher.json')
+      namespace(task_namespace) do
+        desc "Generates dbgrapher.json"
+        task gen: :environment do
+          Dbgrapher::Generate.new(schema_path: schema_path).run
+        end
+      end
+    end
+  end
+end

data/lib/dbgrapher/version.rb

@@ -0,0 +1,3 @@
+module Dbgrapher
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: dbgrapher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ara Yeressian
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-04-14 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- yeressian@tuta.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/env.json"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dbgrapher.gemspec
+- lib/dbgrapher/generate.rb
+- lib/dbgrapher/rake_task.rb
+- lib/dbgrapher/version.rb
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/ayeressian/dbgrapher_gem
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: This library provides rake task to be used with rails application to generate
+  dbgrapher.com db schema file
+test_files: []