gadget 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f6feadef1150080b07735c8d7d83516d87bceea9
+  data.tar.gz: 9c74000e08c87120b794c6871f8126198c9d248b
+SHA512:
+  metadata.gz: e0ce84932a8c25607920db5a7111e8a3e37c70fc4eb6c486c467d0b7fd488246f880a0853e9bc226f100f750db631197f5ae7290fb1d266fcba30df01f8e7985
+  data.tar.gz: 1a6fc7958a2c250af87035cb7619270db989462a02c052b6db2e9bfd1ec3fd12fefe7154415bf6150e9cd511848dd0816f4c49fdafafd8b7a4aad2cd75dd5326

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/.ruby-gemset
+/.ruby-version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Craig S. Cottingham
+
+MIT License
+
+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,51 @@
+# Gadget
+
+Some methods for getting metadata and other deep details from a PostgreSQL database.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gadget'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gadget
+
+## Usage
+
+`#tables(conn)`
+
+Returns a list of all tables in the schema reachable through `conn`.
+
+`#columns(conn, tablename=nil)`
+
+Returns a list of all columns in the schema reachable through `conn`.
+If `tablename` is given, returns the columns in only that table.
+
+`#foreign_keys(conn, tablename=nil)`
+
+Returns a list of all foreign keys in the schema reachable through `conn`.
+If `tablename` is given, returns the foreign keys in only that table.
+
+`#dependencies(conn)`
+
+Returns a structure representing the dependencies between tables in the schema reachable through `conn`.
+Table A is defined as dependent on table B if A contains a foreign key reference to B.
+
+`#tables_in_dependency_order(conn)`
+
+Returns a list of all tables in the schema reachable through `conn`, ordered such that any given table
+appears later in the list than all of its dependencies.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/gadget

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+
+require 'gadget'
+
+require 'pg'
+
+dbname = ARGV.shift
+
+conn = PG::Connection.open(:dbname => dbname)
+tables = Gadget.tables_in_dependency_order(conn)
+conn.close
+p tables

data/gadget.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gadget/version'
+
+Gem::Specification.new do | spec |
+  spec.name          = 'gadget'
+  spec.version       = Gadget::VERSION
+  spec.authors       = [ 'Craig S. Cottingham' ]
+  spec.email         = [ 'craig.cottingham@gmail.com' ]
+  spec.summary       = %q{Some methods for getting metadata and other deep details from a PostgreSQL database.}
+  spec.description   = File.read(File.join(File.dirname(__FILE__), 'README.md'))
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = [ 'lib' ]
+
+  spec.add_dependency             'pg',       '~> 0.17.0'
+
+  spec.add_development_dependency 'bundler',  '~> 1.3'
+  spec.add_development_dependency 'rake'
+end

data/lib/gadget.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+require 'pg'
+require 'tsort'
+
+require 'gadget/version'
+
+module Gadget
+
+  class TsortableHash < Hash
+    include ::TSort
+    alias tsort_each_node each_key
+    def tsort_each_child(node, &block)
+      (fetch(node) || []).each(&block)
+    end
+  end
+
+  def self.tables(conn)
+    rs = conn.exec("SELECT c.oid, t.tablename FROM pg_tables t INNER JOIN pg_class c ON c.relname=t.tablename WHERE t.schemaname='public' ORDER BY t.tablename")
+    tuples = rs.reduce({}) { | h, row | h[row['tablename']] = { :oid => row['oid'] }; h }
+    rs.clear
+    tuples
+  end
+
+  def self.columns(conn, tablename = nil)
+    sql = <<-END_OF_SQL
+SELECT t.tablename, a.attname
+FROM pg_attribute a
+INNER JOIN pg_class c ON a.attrelid=c.oid
+INNER JOIN pg_tables t ON c.relname=t.tablename
+    END_OF_SQL
+    if tablename.nil?
+      rs = conn.exec(sql)
+    else
+      sql += " WHERE t.tablename=$1"
+      rs = conn.exec_params(sql, [ tablename ])
+    end
+    # tuples = rs.map { | row | row }
+    tuples = rs.reduce({}) { | h, row | h[row['tablename']] ||= { :columns => [] }; h[row['tablename']][:columns] << row['attname']; h }
+    rs.clear
+    tuples
+  end
+
+  def self.foreign_keys(conn, tablename = nil)
+    sql = <<-END_OF_SQL
+SELECT t1.tablename AS tablename, t2.tablename AS refname
+FROM pg_constraint
+INNER JOIN pg_class c1 ON pg_constraint.conrelid=c1.oid
+INNER JOIN pg_tables t1 ON c1.relname=t1.tablename
+INNER JOIN pg_class c2 ON pg_constraint.confrelid=c2.oid
+INNER JOIN pg_tables t2 ON c2.relname=t2.tablename
+WHERE t1.schemaname='public'
+AND t2.schemaname='public'
+AND pg_constraint.contype='f'
+    END_OF_SQL
+    if tablename.nil?
+      rs = conn.exec(sql)
+    else
+      sql += " AND t1.tablename=$1"
+      rs = conn.exec_params(sql, [ tablename ])
+    end
+    tuples = rs.reduce({}) { | h, row | h[row['tablename']] ||= { :refs => [] }; h[row['tablename']][:refs] << row['refname']; h }
+    rs.clear
+    tuples
+  end
+
+  def self.dependencies(conn)
+    tables = self.tables(conn)
+    foreign_keys = self.foreign_keys(conn)
+    dependencies = tables.reduce({}) do | h, (tablename, _) |
+      h[tablename] = []
+      refs = foreign_keys[tablename]
+      unless refs.nil?
+        refs[:refs].each { | ref | h[tablename] << ref }
+      end
+      h
+    end
+  end
+
+  def self.tables_in_dependency_order(conn)
+    self.dependencies(conn).reduce(TsortableHash.new) { | h, (k, v) | h[k] = v; h }.tsort
+  end
+
+  def self.dependency_graph(conn)
+    puts "digraph dependencies {"
+    self.dependencies(conn).each do | tablename, deps |
+      if deps.empty?
+        puts %Q<"#{tablename}">
+      else
+        deps.each { | dep | puts %Q|"#{tablename}" -> "#{dep}"| }
+      end
+    end
+    puts "}"
+  end
+
+end

data/lib/gadget/version.rb

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

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: gadget
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Craig S. Cottingham
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: |
+  # Gadget
+
+  Some methods for getting metadata and other deep details from a PostgreSQL database.
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+      gem 'gadget'
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install gadget
+
+  ## Usage
+
+  `#tables(conn)`
+
+  Returns a list of all tables in the schema reachable through `conn`.
+
+  `#columns(conn, tablename=nil)`
+
+  Returns a list of all columns in the schema reachable through `conn`.
+  If `tablename` is given, returns the columns in only that table.
+
+  `#foreign_keys(conn, tablename=nil)`
+
+  Returns a list of all foreign keys in the schema reachable through `conn`.
+  If `tablename` is given, returns the foreign keys in only that table.
+
+  `#dependencies(conn)`
+
+  Returns a structure representing the dependencies between tables in the schema reachable through `conn`.
+  Table A is defined as dependent on table B if A contains a foreign key reference to B.
+
+  `#tables_in_dependency_order(conn)`
+
+  Returns a list of all tables in the schema reachable through `conn`, ordered such that any given table
+  appears later in the list than all of its dependencies.
+
+  ## Contributing
+
+  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request
+email:
+- craig.cottingham@gmail.com
+executables:
+- gadget
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/gadget
+- gadget.gemspec
+- lib/gadget.rb
+- lib/gadget/version.rb
+homepage: ''
+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.2.0.rc.1
+signing_key: 
+specification_version: 4
+summary: Some methods for getting metadata and other deep details from a PostgreSQL
+  database.
+test_files: []