ddg 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 257cc02abe88b39d7d8da6fa3cb5785c343d0a85
+  data.tar.gz: 1e3a4b9b20acd5b7ab46576da2f9ab23737ad189
+SHA512:
+  metadata.gz: d7d324f7b7f638b087722d78d598f1b597287228e1f4837817a3431fcc9e02c2d3a0ef16c00d44390f43685379d508bf68419c1f0f7910e9e4849fee714b67d5
+  data.tar.gz: 22179796a45419fc49ac42652856acb3b17e1ffe67e1711c5b61489ed5066b23e776b6647b26988ab2a2f005f1c16712db80cd7b025dceb4323f731f55f149e5

data/.gitignore

@@ -0,0 +1,7 @@
+.byebug_history
+.rbenv-vars
+.rspec_status
+coverage
+*.dot
+*.png
+tmp*

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - '*.gemspec'
+    - 'Rakefile'
+    - 'bin/ddg.rb'
+    - 'spec/*/**'
+    - 'vendor/*'
+    - 'vendor/*/**'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+# This allows classes without a top-level
+# documentation comment
+Style/Documentation:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2018-07-20
+### Added
+- Korean translation from @pierceh89.
+
+### Changed
+- Fix phrasing and spelling in German translation.
+
+### Removed
+- Section about "changelog" vs "CHANGELOG".

data/Gemfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    ddg (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    byebug (10.0.2)
+    diff-lcs (1.3)
+    docile (1.3.0)
+    jaro_winkler (1.5.1)
+    json (2.1.0)
+    lazy_priority_queue (0.1.1)
+    mysql2 (0.5.2)
+    parallel (1.12.1)
+    parser (2.5.1.2)
+      ast (~> 2.4.0)
+    pg (1.0.0)
+    powerpack (0.1.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rgl (0.5.3)
+      lazy_priority_queue (~> 0.1.0)
+      stream (~> 0.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    rubocop (0.58.1)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      powerpack (~> 0.1)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.9.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    stream (0.5)
+    unicode-display_width (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  byebug
+  ddg!
+  mysql2
+  pg
+  rake (~> 10.0)
+  rgl
+  rspec (~> 3.0)
+  rubocop
+  simplecov
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brandon Powers
+
+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,190 @@
+# Database Dependency Graph (DDG)
+
+![build-status](https://travis-ci.com/brandon-powers/ddg.svg?token=K9gDMpa56TyPTDdHanqY&branch=master)
+
+**ddg** is a tool for building and manipulating database dependency graphs. Hence, the origin of the abbreviation.
+
+The database dependency graph is defined as follows: a directed, acyclic graph (DAG) where nodes represent tables and edges represent dependencies based on foreign key constraint(s). It currently supports two behaviors:
+1. Determining the evaluation order and optionally performing a task on each node in the evaluation order.
+2. Generating an image file containing a graph diagram of the database dependency graph.
+
+The data stores that **ddg** supports are the following:
+- MySQL
+- PostgreSQL
+- Redshift
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ddg'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ddg
+
+## Usage
+
+**To initialize a dependency graph**:
+
+```ruby
+require 'dependency_graph'
+
+graph = DependencyGraph.new(
+  adapter: :postgresql,
+  database: 'database',
+  user: 'user',
+  password: 'password',
+  port: 12345,
+  host: 'www.example.com'
+)
+```
+
+**To print the evaluation order**:
+
+```ruby
+puts(graph.evaluation_order)
+
+# >> [users, reports, user_reports]
+```
+
+**To perform an action on each node, in the evaluation order**:
+
+```ruby
+graph.evaluation_order do |node|
+  ETL.incremental_load(node)
+end
+```
+
+**To generate a graph.png image of the dependency graph**:
+
+```ruby
+graph.visualize
+```
+
+**To use the dependency graph with a CLI**:
+
+```sh
+$ ddg -a postgresql -d dev -u dev_ro -x password123 -p 16379 -h dev.com --evaluation-order
+# >> [users, reports, user_reports]
+```
+
+**To use the dependency graph with a Rake command**:
+
+```sh
+$ bundle exec rake ddg:evaluation_order
+# >> [users, reports, user_reports]
+```
+
+## More on Adapters
+
+In theory, any data store that supports the information schema (ANSI-standard) is supported by the existing SQL used to extract table to foreign key mappings. However, if a data store is not currently supported, an adapter can be written rather easily by creating a new class inheriting from `DDG::Adapter::Base`.
+
+To add an adapter that supports the information schema:
+
+```ruby
+# frozen_string_literal: true
+
+require 'ddg/adapter/base'
+
+module DDG
+  module Adapter
+    class DataStore < Base
+      # TODO: Implement the constructor by assigning a client to @db.
+      def initialize(config)
+        @db = DataStoreClient.new(
+          host: config[:host],
+          port: config[:port],
+          username: config[:user],
+          password: config[:password],
+          database: config[:database]
+        )
+      end
+
+      # TODO: Implement the select function, which executes
+      # the SQL contained in the `sql` parameter and
+      # returns an Array of Hashes, representing named rows.
+      def select(sql)
+        [{}]
+      end
+    end
+  end
+end
+```
+
+To add an adapter that does NOT support the information schema:
+
+```ruby
+# frozen_string_literal: true
+
+require 'ddg/adapter/base'
+
+module DDG
+  module Adapter
+    class DataStore < Base
+      # TODO: Implement the constructor by assigning a client to @db.
+      def initialize(config)
+        @db = DataStoreClient.new
+      end
+
+      # TODO: Implement the following instance method.
+      #
+      # Retrieves a mapping from table to a
+      # set of its foreign key constraints.
+      #
+      # Example:
+      #   {
+      #     user_reports: [
+      #       :users,
+      #       :reports,
+      #       ...
+      #     ],
+      #     ...
+      #   }
+      #
+      # @return [Hash]
+      def tables_with_foreign_keys; end
+    end
+  end
+end
+```
+
+From the PostgreSQL documentation on information schema querying: "Only those constraints are shown for which the current user has write access to the referencing table (by way of being the owner or having some privilege other than SELECT)."
+
+The SQL to extract the foreign keys of each table was heavily influenced, barring minor changes, from this article: https://msdn.microsoft.com/en-us/library/aa175805(SQL.80).aspx.
+
+## Contributing
+
+Make sure to copy the `hooks/` directory into your local `.git/hooks/` directory to ensure the git hooks for this project run. Most notably, there exists a pre-commit hook that runs tests and a linter over the code, failing the commit if the tests or linter fails.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/brandon-powers/ddg.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TODO
+  - Fix integration with Travis-CI.
+  - Write documentation on DDG in this README.
+  - Create a GIF at the top-level of the README to demonstrate basic usage and grab attention.
+  - Clearly define external development and testing dependencies.
+  - Tag gem at 0.1.0 and publish it to RubyGems.
+  - Write an example application that uses this gem, and highlight or link it in the documentation here.
+  - Write a blog post on DDG for Medium.
+  - Share blog post and GitHub project on HackerNews, LinkedIn, Twitter, Instagram?, Facebook, Personal Website?.
+
+## Architecture and Design Goals
+  - Duck-typing over abstract class hierarchy
+  - Adapter interface that is extensible
+  - Adapter Factory uses Factory OO pattern
+  - Both data warehouses/dimensional models and general-purpose usage, in any relational database
+  - Measured performance and benchmark testing
+  - CI/CD integration with Travis-CI
+  - Example application that uses this gem/functionality
+  - SemVer, CHANGELOG-compliant

data/Rakefile

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'ddg'
+require 'pg'
+require 'mysql2'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+  t.rspec_opts = '--format documentation'
+end
+
+RuboCop::RakeTask.new(:rubocop) do |t|
+  t.options = ['--display-cop-names']
+  t.options = ['-c', '.rubocop.yml']
+end
+
+task(default: %i[spec rubocop])
+
+namespace :ddg do
+  desc 'Print the evaluation order of the database specified by the environment'
+  task :evaluation_order do
+    ddg = DDG::DependencyGraph.new(
+      ENV['ADAPTER'].to_sym,
+      host: ENV['HOST'],
+      port: ENV['PORT'],
+      database: ENV['DATABASE'],
+      user: ENV['USER'],
+      password: ENV['PASSWORD']
+    )
+    puts(ddg.evaluation_order)
+  end
+end
+
+namespace :db do
+  namespace :setup do
+    desc 'Creates a PostgreSQL database with tables ' \
+         'that have referential constraints on each other'
+    task :postgresql do
+      conn = PG.connect(
+        user: ENV['TEST_USER'],
+        host: ENV['TEST_HOST'],
+        port: ENV['TEST_PORT'],
+        dbname: ENV['TEST_DATABASE'],
+        password: ENV['TEST_PASSWORD']
+      )
+      postgresql_schema = File.read('db/schemata/postgresql.sql')
+      conn.exec(postgresql_schema)
+    end
+
+    desc 'Creates a MySQL database with tables ' \
+         'that have referential constraints on each other'
+    task :mysql do
+      conn = Mysql2::Client.new(
+        username: ENV['TEST_USER'],
+        host: ENV['TEST_HOST'],
+        port: ENV['TEST_PORT'],
+        database: ENV['TEST_DATABASE'],
+        password: ENV['TEST_PASSWORD']
+      )
+      mysql_schema = File.read('db/schemata/mysql.sql')
+
+      mysql_schema.strip.split(';').each do |query|
+        conn.query(query)
+      end
+    end
+  end
+
+  namespace :teardown do
+    desc 'Deletes the PostgreSQL database created with db:setup:postgresql'
+    task :postgresql do
+      conn = PG.connect(
+        user: ENV['TEST_USER'],
+        host: ENV['TEST_HOST'],
+        port: ENV['TEST_PORT'],
+        dbname: ENV['TEST_DATABASE'],
+        password: ENV['TEST_PASSWORD']
+      )
+
+      conn.exec('DROP TABLE IF EXISTS user_reports CASCADE;')
+      conn.exec('DROP TABLE IF EXISTS users CASCADE;')
+      conn.exec('DROP TABLE IF EXISTS reports CASCADE;')
+      conn.close
+
+      drop_database_sql = "DROP DATABASE #{ENV['TEST_DATABASE']};"
+      drop_user_sql = "DROP USER #{ENV['TEST_USER']};"
+
+      system("sudo -u postgres psql -c \"#{drop_database_sql}\" 1>/dev/null 2>&1")
+      system("sudo -u postgres psql -c \"#{drop_user_sql}\" 1>/dev/null 2>&1")
+    end
+
+    desc 'Deletes the MySQL database created with db:setup:mysql'
+    task :mysql do
+      conn = Mysql2::Client.new(
+        username: ENV['TEST_USER'],
+        host: ENV['TEST_HOST'],
+        port: ENV['TEST_PORT'],
+        database: ENV['TEST_DATABASE'],
+        password: ENV['TEST_PASSWORD']
+      )
+
+      conn.query('DROP TABLE IF EXISTS user_reports CASCADE;')
+      conn.query('DROP TABLE IF EXISTS users CASCADE;')
+      conn.query('DROP TABLE IF EXISTS reports CASCADE;')
+      conn.close
+
+      drop_database_sql = "DROP DATABASE #{ENV['TEST_DATABASE']};"
+      drop_user_sql = "DROP USER '#{ENV['TEST_USER']}'@'#{ENV['TEST_HOST']}';"
+
+      system("sudo mysql -u root -p -e \"#{drop_database_sql}\" 1>/dev/null 2>&1")
+      system("sudo mysql -u root -p -e \"#{drop_user_sql}\" 1>/dev/null 2>&1")
+    end
+  end
+end

data/bin/ddg.rb

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+BASE_DIR = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(BASE_DIR) unless $LOAD_PATH.include?(BASE_DIR)
+
+require 'ddg'
+require 'optparse'
+
+class CLI
+  def initialize
+    @config = {}
+    @actions = { evaluation_order: false }
+    @adapter = nil
+    @opts = option_parser
+  end
+
+  def option_parser
+    OptionParser.new do |o|
+      o.on('--help', 'Display this message') do
+        STDERR.puts(o)
+        exit 0
+      end
+
+      o.on('-a', '--adapter ADAPTER', String, 'Adapter') do |adapter|
+        @adapter = adapter.to_sym
+      end
+
+      o.on('-u', '--user USER', String, 'User') do |user|
+        @config[:user] = user.to_s
+      end
+
+      o.on('-W', '--password PASSWORD', String, 'Password') do |password|
+        @config[:password] = password.to_s
+      end
+
+      o.on('-p', '--port PORT', String, 'Port') do |port|
+        @config[:port] = port.to_s
+      end
+
+      o.on('-h', '--host HOST', String, 'Host') do |host|
+        @config[:host] = host.to_s
+      end
+
+      o.on('-d', '--database DATABASE', String, 'Database') do |database|
+        @config[:database] = database.to_s
+      end
+
+      evaluation_order_str = 'Print the evaluation order of the database ' \
+                             'dependency graph specified by the environment'
+
+      o.on('-e', '--evaluation-order', evaluation_order_str) do |evaluation_order|
+        @actions[:evaluation_order] = evaluation_order
+      end
+
+      o.on('-v', '--visualize FORMAT, FILENAME', Array, 'Generate a <filename>.<format> image file') do |visualize|
+        @config[:format] = visualize[0]
+        @config[:filename] = visualize[1]
+      end
+    end
+  end
+
+  def parse!(args)
+    @opts.parse!(args)
+
+    # TODO: These defaults should move to #initialize.
+    #
+    # Default to using environment variables,
+    # typically via .rbenv-vars.
+    @config[:host] = ENV['HOST']
+    @config[:port] = ENV['PORT']
+    @config[:user] = ENV['USER']
+    @config[:password] = ENV['PASSWORD']
+    @config[:database] = ENV['DATABASE']
+    @adapter = ENV['ADAPTER'].to_sym
+
+    graph = DDG::DependencyGraph.new(@adapter, @config)
+
+    puts(graph.evaluation_order) if @actions[:evaluation_order]
+    graph.visualize(@config[:format], @config[:filename]) if @config[:format] && @config[:filename]
+  end
+end
+
+cli = CLI.new
+cli.parse!(ARGV)

data/db/schemata/mysql.sql

@@ -0,0 +1,33 @@
+CREATE TABLE IF NOT EXISTS `users` (
+  `id` INTEGER AUTO_INCREMENT,
+  `name` VARCHAR(150) NOT NULL,
+  `created_at` DATE,
+  `updated_at` DATE,
+
+  PRIMARY KEY (`id`)
+)
+ENGINE = InnoDB;
+
+CREATE TABLE IF NOT EXISTS `reports` (
+  `id` INTEGER AUTO_INCREMENT,
+  `name` VARCHAR(150) NOT NULL,
+  `created_at` DATE,
+  `updated_at` DATE,
+
+  PRIMARY KEY (`id`)
+)
+ENGINE = InnoDB;
+
+CREATE TABLE IF NOT EXISTS `user_reports` (
+  `id` INTEGER AUTO_INCREMENT,
+  `user_id` INTEGER,
+  `report_id` INTEGER,
+  `name` VARCHAR(150) NOT NULL,
+  `created_at` DATE,
+  `updated_at` DATE,
+
+  PRIMARY KEY (`id`),
+  FOREIGN KEY (`user_id`) REFERENCES `users` (`id`),
+  FOREIGN KEY (`report_id`) REFERENCES `reports` (`id`)
+)
+ENGINE = InnoDB;

data/db/schemata/postgresql.sql

@@ -0,0 +1,29 @@
+CREATE TABLE users (
+  id INTEGER NOT NULL,
+  name VARCHAR,
+  created_at TIMESTAMP,
+  updated_at TIMESTAMP,
+
+  PRIMARY KEY(id)
+);
+
+CREATE TABLE reports (
+  id INTEGER NOT NULL,
+  name VARCHAR,
+  created_at TIMESTAMP,
+  updated_at TIMESTAMP,
+
+  PRIMARY KEY(id)
+);
+
+CREATE TABLE user_reports (
+  id INTEGER NOT NULL,
+  user_id INTEGER NOT NULL,
+  report_id INTEGER NOT NULL,
+  created_at TIMESTAMP,
+  updated_at TIMESTAMP,
+
+  PRIMARY KEY(id),
+  FOREIGN KEY (user_id) REFERENCES users(id),
+  FOREIGN KEY (report_id) REFERENCES reports(id)
+);

data/ddg.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ddg/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'ddg'
+  spec.version = DDG::VERSION
+  spec.authors = ['Brandon Powers']
+  spec.email = ['brandonkpowers@gmail.com']
+
+  spec.summary = 'DDG is a tool for building and ' \
+                 'manipulating database dependency graphs (DDG).'
+  spec.description = ''
+  spec.homepage = 'https://github.com/brandon-powers/ddg'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files`.split("\n")
+  spec.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.bindir = 'bin'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  spec.add_development_dependency 'rgl'
+  spec.add_development_dependency 'pg'
+  spec.add_development_dependency 'mysql2'
+
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'byebug'
+end

data/dot-rbenv-vars

@@ -0,0 +1,11 @@
+ADAPTER=postgresql
+USER=user
+PASSWORD=password
+DATABASE=database
+HOST=host
+PORT=port
+TEST_USER=ddg_test_user
+TEST_PASSWORD=ddg_test_password
+TEST_DATABASE=ddg_test_db
+TEST_HOST=localhost
+TEST_PORT=5432

data/hooks/pre-commit

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+bundle exec rake

data/lib/ddg.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'ddg/dependency_graph'
+require 'ddg/version'

data/lib/ddg/adapter/base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module DDG
+  module Adapter
+    class Base
+      # Retrieves a mapping from table to a
+      # set of its foreign key constraints.
+      #
+      # This query is supported by any relational
+      # database that supports the ANSI information
+      # schema standard.
+      #
+      # Example:
+      #   {
+      #     user_reports: [
+      #       :users,
+      #       :reports,
+      #       ...
+      #     ],
+      #     ...
+      #   }
+      #
+      # @return [Hash]
+      def tables_with_foreign_keys
+        records = select(foreign_key_sql)
+
+        records.each_with_object({}) do |record, table_to_fk|
+          table_name = record[:table_name].to_sym
+          referenced_table_name = record[:referenced_table_name].to_sym
+
+          table_to_fk[table_name] = [] unless table_to_fk.key?(table_name)
+
+          if !table_to_fk[table_name].include?(referenced_table_name) &&
+             table_name != referenced_table_name
+            table_to_fk[table_name] << referenced_table_name
+          end
+        end
+      end
+
+      private
+
+      def foreign_key_sql
+        <<~SQL
+          SELECT
+            kcu1.table_name AS table_name,
+            kcu2.table_name AS referenced_table_name
+          FROM information_schema.referential_constraints AS rc
+          INNER JOIN information_schema.key_column_usage AS kcu1
+            ON kcu1.constraint_catalog = rc.constraint_catalog
+            AND kcu1.constraint_schema = rc.constraint_schema
+            AND kcu1.constraint_name = rc.constraint_name
+          INNER JOIN information_schema.key_column_usage AS kcu2
+            ON kcu2.constraint_catalog = rc.unique_constraint_catalog
+            AND kcu2.constraint_schema = rc.unique_constraint_schema
+            AND kcu2.constraint_name = rc.unique_constraint_name
+            AND kcu2.ordinal_position = kcu1.ordinal_position
+          ;
+        SQL
+      end
+    end
+  end
+end

data/lib/ddg/adapter/mysql.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'ddg/adapter/base'
+require 'mysql2'
+require 'json'
+
+module DDG
+  module Adapter
+    class MySQL < Base
+      def initialize(config)
+        @db = Mysql2::Client.new(
+          host: config[:host],
+          port: config[:port],
+          username: config[:user],
+          password: config[:password],
+          database: config[:database]
+        )
+      end
+
+      def select(sql)
+        @db.query(sql).to_a.map do |row|
+          JSON.parse(row.to_json, symbolize_names: true)
+        end
+      end
+    end
+  end
+end

data/lib/ddg/adapter/postgresql.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'ddg/adapter/base'
+require 'pg'
+require 'json'
+
+module DDG
+  module Adapter
+    class PostgreSQL < Base
+      def initialize(config)
+        @db = PG::Connection.open(
+          host: config[:host],
+          port: config[:port],
+          user: config[:user],
+          password: config[:password],
+          dbname: config[:database]
+        )
+      end
+
+      def select(sql)
+        @db.exec(sql).to_a.map do |row|
+          JSON.parse(row.to_json, symbolize_names: true)
+        end
+      end
+    end
+  end
+end

data/lib/ddg/adapter_factory.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ddg/adapter/postgresql'
+require 'ddg/adapter/mysql'
+
+module DDG
+  class AdapterFactory
+    class << self
+      def adapter(adapter, config)
+        case adapter
+        when :postgresql, :redshift
+          Adapter::PostgreSQL.new(config)
+        when :mysql
+          Adapter::MySQL.new(config)
+        end
+      end
+    end
+  end
+end

data/lib/ddg/dependency_graph.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'ddg/adapter_factory'
+require 'rgl/adjacency'
+require 'rgl/topsort'
+require 'rgl/dot'
+
+module DDG
+  class DependencyGraph
+    attr_reader(
+      :adapter,
+      :graph
+    )
+
+    def initialize(adapter, config)
+      @adapter = AdapterFactory.adapter(adapter, config)
+      @graph = RGL::DirectedAdjacencyGraph.new
+      @evaluation_order = []
+    end
+
+    def evaluation_order
+      return @evaluation_order unless @evaluation_order.empty?
+      build_graph unless graph_built?
+
+      @evaluation_order = @graph.topsort_iterator.to_a.reverse
+      @evaluation_order.each { |table| yield(table) } if block_given?
+      @evaluation_order
+    end
+
+    def visualize(format, filename)
+      build_graph unless graph_built?
+      @graph.write_to_graphic_file(fmt = format, dotfile = filename)
+    end
+
+    def build_graph
+      @adapter.tables_with_foreign_keys.each do |table, foreign_keys|
+        foreign_keys.each do |foreign_key|
+          @graph.add_edge(table, foreign_key)
+        end
+      end
+    end
+
+    private
+
+    def graph_built?
+      !@graph.edges.empty? && !@graph.vertices.empty?
+    end
+  end
+end

data/lib/ddg/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module DDG
+  VERSION = '0.1.0'
+end

data/spec/ddg/adapter/mysql_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ddg/adapter/mysql'
+
+RSpec.describe DDG::Adapter::MySQL do
+  before(:all) do
+    system('bundle exec rake db:setup:mysql')
+  end
+
+  after(:all) do
+    system('bundle exec rake db:teardown:mysql')
+  end
+
+  let(:config) do
+    {
+      database: ENV['TEST_DATABASE'],
+      user: ENV['TEST_USER'],
+      host: ENV['TEST_HOST'],
+      port: ENV['TEST_PORT'],
+      password: ENV['TEST_PASSWORD']
+    }
+  end
+
+  describe '#tables_with_foreign_keys' do
+    context 'when there are tables with foreign keys in the database' do
+      let(:expected_table_to_fks) do
+        {
+          user_reports: %i[
+            reports
+            users
+          ]
+        }
+      end
+
+      it 'returns a mapping from table to an array of foreign keys' do
+        adapter = DDG::Adapter::MySQL.new(config)
+        table_to_fks = adapter.tables_with_foreign_keys
+        expect(table_to_fks).to eq(expected_table_to_fks)
+      end
+    end
+  end
+end

data/spec/ddg/adapter/postgresql_spec.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ddg/adapter/postgresql'
+
+RSpec.describe DDG::Adapter::PostgreSQL do
+  before(:all) do
+    system('bundle exec rake db:setup:postgresql')
+  end
+
+  after(:all) do
+    system('bundle exec rake db:teardown:postgresql')
+  end
+
+  let(:config) do
+    {
+      database: ENV['TEST_DATABASE'],
+      user: ENV['TEST_USER'],
+      host: ENV['TEST_HOST'],
+      port: ENV['TEST_PORT'],
+      password: ENV['TEST_PASSWORD']
+    }
+  end
+
+  describe '#tables_with_foreign_keys' do
+    context 'when there are tables with foreign keys in the database' do
+      let(:expected_table_to_fks) do
+        {
+          user_reports: %i[
+            users
+            reports
+          ]
+        }
+      end
+
+      it 'returns a mapping from table to an array of foreign keys' do
+        adapter = DDG::Adapter::PostgreSQL.new(config)
+        table_to_fks = adapter.tables_with_foreign_keys
+        expect(table_to_fks).to eq(expected_table_to_fks)
+      end
+    end
+  end
+end

data/spec/ddg/adapter_factory_spec.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ddg/adapter_factory'
+
+RSpec.describe DDG::AdapterFactory do
+  before(:all) do
+    system('bundle exec rake db:setup:postgresql')
+    system('bundle exec rake db:setup:mysql')
+  end
+
+  after(:all) do
+    system('bundle exec rake db:teardown:postgresql')
+    system('bundle exec rake db:teardown:mysql')
+  end
+
+  let(:config) do
+    {
+      database: ENV['TEST_DATABASE'],
+      user: ENV['TEST_USER'],
+      host: ENV['TEST_HOST'],
+      port: ENV['TEST_PORT'],
+      password: ENV['TEST_PASSWORD']
+    }
+  end
+
+  describe '::adapter' do
+    context 'when PostgreSQL is passed with valid configuration' do
+      it 'returns an instance of DDG::Adapter::PostgreSQL' do
+        adapter = DDG::AdapterFactory.adapter(:postgresql, config)
+        expect(adapter).to be_a(DDG::Adapter::PostgreSQL)
+      end
+    end
+
+    context 'when Redshift is passed with valid configuration' do
+      it 'returns an instance of DDG::Adapter::PostgreSQL' do
+        adapter = DDG::AdapterFactory.adapter(:redshift, config)
+        expect(adapter).to be_a(DDG::Adapter::PostgreSQL)
+      end
+    end
+
+    context 'when MySQL is passed with valid configuration' do
+      it 'returns an instance of DDG::Adapter::MySQL' do
+        adapter = DDG::AdapterFactory.adapter(:mysql, config)
+        expect(adapter).to be_a(DDG::Adapter::MySQL)
+      end
+    end
+  end
+end

data/spec/ddg/dependency_graph_spec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+require 'ddg/dependency_graph'
+
+RSpec.describe DDG::DependencyGraph do
+  before(:all) do
+    system('bundle exec rake db:setup:postgresql')
+    system('bundle exec rake db:setup:mysql')
+  end
+
+  after(:all) do
+    system('bundle exec rake db:teardown:postgresql')
+    system('bundle exec rake db:teardown:mysql')
+  end
+
+  let(:adapter) { :postgresql }
+  let(:config) do
+    {
+      database: ENV['TEST_DATABASE'],
+      user: ENV['TEST_USER'],
+      host: ENV['TEST_HOST'],
+      port: ENV['TEST_PORT'],
+      password: ENV['TEST_PASSWORD']
+    }
+  end
+
+  describe '#initialize' do
+    context 'when given valid configuration' do
+      it 'initializes an instance of DependencyGraph' do
+        graph = DDG::DependencyGraph.new(adapter, config)
+        expect(graph).to be_a(DDG::DependencyGraph)
+        expect(graph.adapter).to be_a(DDG::Adapter::Base)
+        expect(graph.graph).to_not be_nil
+      end
+    end
+  end
+
+  describe '#evaluation_order' do
+    context 'when users, reports, and user_reports exist in a PostgreSQL database' do
+      it 'returns the correct evaluation order given referential constraints' do
+        graph = DDG::DependencyGraph.new(adapter, config)
+        expect(graph.evaluation_order).to eq(%i[users reports user_reports])
+      end
+    end
+
+    context 'when users, reports, and user_reports exist in a MySQL database' do
+      let(:adapter) { :mysql }
+
+      it 'returns the correct evaluation order given referential constraints' do
+        graph = DDG::DependencyGraph.new(adapter, config)
+        expect(graph.evaluation_order).to eq(%i[reports users user_reports])
+      end
+    end
+  end
+
+  describe '#build_graph' do
+    it 'builds the dependency graph' do
+      graph = DDG::DependencyGraph.new(adapter, config)
+      graph.build_graph
+      expect(graph.graph).to_not be_nil
+    end
+  end
+end

data/spec/ddg_spec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe DDG do
+  it 'has a version number' do
+    expect(DDG::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'simplecov'
+SimpleCov.start
+
+require 'bundler/setup'
+require 'ddg'
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = '.rspec_status'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: ddg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brandon Powers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rgl
+  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: pg
+  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: mysql2
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: byebug
+  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'
+description: ''
+email:
+- brandonkpowers@gmail.com
+executables:
+- ddg.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/ddg.rb
+- db/schemata/mysql.sql
+- db/schemata/postgresql.sql
+- ddg.gemspec
+- dot-rbenv-vars
+- hooks/pre-commit
+- lib/ddg.rb
+- lib/ddg/adapter/base.rb
+- lib/ddg/adapter/mysql.rb
+- lib/ddg/adapter/postgresql.rb
+- lib/ddg/adapter_factory.rb
+- lib/ddg/dependency_graph.rb
+- lib/ddg/version.rb
+- spec/ddg/adapter/mysql_spec.rb
+- spec/ddg/adapter/postgresql_spec.rb
+- spec/ddg/adapter_factory_spec.rb
+- spec/ddg/dependency_graph_spec.rb
+- spec/ddg_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/brandon-powers/ddg
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: DDG is a tool for building and manipulating database dependency graphs (DDG).
+test_files: []