psql 0.0.1

data/.gitignore

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

data/.pryrc

@@ -0,0 +1,2 @@
+$: << './lib'
+require 'psql'

data/.wrong

@@ -0,0 +1 @@
+color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in psql.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'minitest' do
+  watch( %r|^test/(.*)\/?(.*)_test\.rb| )
+  watch( %r|^lib/(.*)([^/]+)\.rb|       ){ |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch( 'test/test_helper.rb'          ){ 'test' }
+  watch( 'Gemfile.lock'                 ){ 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeremy Ruppel
+
+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,57 @@
+# PSQL
+
+A simple ruby library for consuming the `psql` command. Created in order to
+simply and quickly describe a PostgreSQL table without having to go through
+ActiveRecord, so that's basically all you can do right now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'psql'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install psql
+
+## Usage
+
+If you have the following schema in a database named `blog`:
+
+                  Table "public.posts"
+|    Column    |          Type         | Modifiers |
+|--------------|-----------------------|-----------|
+| id           | integer               | not null  |
+| title        | character varying(55) |           |
+| body         | text                  |           |
+
+``` ruby
+db = PSQL::Database.new 'blog'             # => instance of PSQL::Database
+db.table( 'posts' )                        # => instance of PSQL::Table
+db.table( 'posts' ).column( 'title' )      # => instance of PSQL::Column
+db.table( 'posts' ).column( 'title' ).type # => :string
+
+ # And the grand finale:
+
+PSQL[ 'blog' ][ 'posts' ][ 'title' ].type # => :string
+```
+
+**PSQL** has no dependency on rails, but it can try and auto-detect your
+rails database name if `RAILS_ENV` is set:
+
+``` ruby
+ENV[ 'RAILS_ENV' ]        # => "development"
+PSQL::Database.new :rails # => attempts to locate database.yml and determine the database name
+```
+
+## 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,30 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task :default => :test
+
+namespace :db do
+
+  desc 'Create the test database'
+  task :create do
+    sh 'createdb psql_gem_test'
+  end
+
+  desc 'Migrate the test database'
+  task :migrate do
+    sh 'psql --file ./test/fixtures/database.sql psql_gem_test'
+  end
+
+  task :setup => [ :create, :migrate ]
+  task :reset => [ :drop, :setup ]
+
+  desc 'Drop the test database'
+  task :drop do
+    sh 'dropdb psql_gem_test'
+  end
+end

data/lib/psql.rb

@@ -0,0 +1,25 @@
+require 'psql/version'
+
+module PSQL
+  autoload :Column,   'psql/column'
+  autoload :Database, 'psql/database'
+  autoload :Table,    'psql/table'
+
+  def []( name )
+    Database.new name
+  end
+  module_function :[]
+end
+
+require 'cocaine'
+require 'csv'
+
+def PSQL( command, params )
+  cmd = Cocaine::CommandLine.new 'psql', '-tAc "%s" :dbname' % [ command ]
+
+  if headers = params.delete( :headers )
+    CSV.parse cmd.run( params ), :headers => headers, :col_sep => '|'
+  else
+    cmd.run params
+  end
+end

data/lib/psql/column.rb

@@ -0,0 +1,32 @@
+module PSQL
+  class Column
+
+    ##
+    #
+    def initialize( name, raw_type, modifiers=nil )
+      @name, @raw_type, @modifiers = name, raw_type, modifiers
+    end
+    attr_reader :name, :raw_type, :modifiers
+
+    ##
+    #
+    def type
+      case raw_type
+      when 'integer'
+        :integer
+      when 'double precision'
+        :float
+      when 'boolean'
+        :boolean
+      when /^character varying/
+        :string
+      when 'text'
+        :text
+      when 'date'
+        :date
+      when 'timestamp without time zone'
+        :datetime
+      end
+    end
+  end
+end

data/lib/psql/database.rb

@@ -0,0 +1,56 @@
+module PSQL
+  class Database
+
+    ##
+    #
+    def initialize( name )
+      @name = case name
+      when String
+        name
+      when :rails
+        find_rails_database_name
+      end
+    end
+    attr_reader :name
+
+    ##
+    # Finds a database object by name. Objects are tables, views, or
+    # sequences.
+    def object( object_name )
+      object = objects.find do |obj|
+        obj[ 'name' ] == object_name
+      end
+
+      if !object
+        raise "Database #{name} does not have an object named '#{object_name}'."
+      end
+
+      klass = PSQL.const_get object[ 'type' ].capitalize
+      klass.new object[ 'name' ], name
+    end
+    alias :[] :object
+
+    private
+
+    ##
+    # Lists all of the objects in this database. Objects are
+    # tables, views, and sequences.
+    def objects
+      PSQL '\d', :dbname => name, :headers => %w| schema name type owner |
+    end
+
+    ##
+    #
+    def find_rails_database_name
+      require 'yaml'
+
+      raise(<<-EOS.strip) unless ENV[ 'RAILS_ENV' ]
+      Cannot automatically determine rails database name because RAILS_ENV is not set.
+      EOS
+
+      file = `find . -name database.yml`.chomp
+      hash = YAML.load_file( file )
+      hash[ ENV[ 'RAILS_ENV' ] ][ 'database' ]
+    end
+  end
+end

data/lib/psql/table.rb

@@ -0,0 +1,41 @@
+module PSQL
+  class Table
+
+    ##
+    #
+    def initialize( name, dbname )
+      @name, @dbname = name, dbname
+    end
+    attr_reader :name, :dbname
+
+    ##
+    #
+    def column( column_name )
+      column = columns.find do |col|
+        col[ 'name' ] == column_name
+      end
+
+      if !column
+        raise "Table #{name} does not have a column named '#{column_name}'."
+      end
+
+      Column.new column[ 'name' ], column[ 'type' ], column[ 'modifiers' ]
+    end
+    alias :[] :column
+
+    def column_names
+      columns.map { |col| col[ 'name' ] }
+    end
+
+    private
+
+    ##
+    #
+    def columns
+      @columns ||= PSQL '\d :name',
+        :name    => name,
+        :dbname  => dbname,
+        :headers => %w| name type modifiers |
+    end
+  end
+end

data/lib/psql/version.rb

@@ -0,0 +1,3 @@
+module PSQL
+  VERSION = '0.0.1'
+end

data/psql.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'psql/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "psql"
+  gem.version       = PSQL::VERSION
+  gem.authors       = ["Jeremy Ruppel"]
+  gem.email         = ["jeremy.ruppel@gmail.com"]
+  gem.description   = %q{A simple ruby library for consuming the `psql` command.}
+  gem.summary       = %q{A simple ruby library for consuming the `psql` command.}
+  gem.homepage      = 'https://github.com/jeremyruppel/psql'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'cocaine', '0.5.1'
+
+  gem.add_development_dependency 'wrong',          '0.7.0'
+  gem.add_development_dependency 'pry',            '0.9.12'
+  gem.add_development_dependency 'guard-minitest', '0.5.0'
+  gem.add_development_dependency 'rb-fsevent',     '~> 0.9'
+end

data/test/fixtures/database.sql

@@ -0,0 +1,13 @@
+-- ===================================================================
+-- = Name: posts; Type: TABLE; Schema: public; Owner: 0; Tablespace: =
+-- ===================================================================
+
+CREATE TABLE posts (
+    id integer NOT NULL,
+    title character varying(255),
+    body text,
+    created_at timestamp without time zone,
+    published_on date,
+    published boolean,
+    rating double precision
+);

data/test/fixtures/database.yml

@@ -0,0 +1,6 @@
+development:
+  adapter:  postgresql
+  database: psql_gem_development
+test:
+  adapter:  postgresql
+  database: psql_gem_test

data/test/psql/column_test.rb

@@ -0,0 +1,39 @@
+require 'test_helper'
+
+class ColumnTest < MiniTest::Unit::TestCase
+
+  def test_stores_attributes
+    col = PSQL::Column.new 'foo', 'bar', 'baz'
+    assert { col.name      == 'foo' }
+    assert { col.raw_type  == 'bar' }
+    assert { col.modifiers == 'baz' }
+  end
+  def test_integer_type
+    col = PSQL::Column.new 'id', 'integer'
+    assert { col.type == :integer }
+  end
+  def test_float_type
+    col = PSQL::Column.new 'rating', 'double precision'
+    assert { col.type == :float }
+  end
+  def test_boolean_type
+    col = PSQL::Column.new 'published', 'boolean'
+    assert { col.type == :boolean }
+  end
+  def test_string_type
+    col = PSQL::Column.new 'title', 'character varying(255)'
+    assert { col.type == :string }
+  end
+  def test_text_type
+    col = PSQL::Column.new 'body', 'text'
+    assert { col.type == :text }
+  end
+  def test_datetime_type
+    col = PSQL::Column.new 'created_at', 'timestamp without time zone'
+    assert { col.type == :datetime }
+  end
+  def test_date_type
+    col = PSQL::Column.new 'published_on', 'date'
+    assert { col.type == :date }
+  end
+end

data/test/psql/database_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class DatabaseTest < MiniTest::Unit::TestCase
+
+  def test_stores_database_name
+    db = PSQL::Database.new 'psql_gem_test'
+    assert { db.name == 'psql_gem_test' }
+  end
+  def test_reads_rails_database_config
+    ENV[ 'RAILS_ENV' ] = 'test'
+    db = PSQL::Database.new :rails
+    assert { db.name == 'psql_gem_test' }
+  end
+  def test_object_raises_error_if_not_found
+    db = PSQL::Database.new 'psql_gem_test'
+    assert { rescuing { db.object( 'foo' ) }.message =~ /Database psql_gem_test does not have an object named 'foo'./ }
+  end
+  def test_object_returns_table_object
+    db = PSQL::Database.new 'psql_gem_test'
+    assert { db.object( 'posts' ).is_a?( PSQL::Table ) }
+  end
+  def test_hash_access_returns_table_object
+    db = PSQL::Database.new 'psql_gem_test'
+    assert { db[ 'posts' ].is_a?( PSQL::Table ) }
+  end
+end

data/test/psql/table_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class TableTest < MiniTest::Unit::TestCase
+
+  def test_stores_name_and_database_name
+    table = PSQL::Table.new 'foo', 'bar'
+    assert { table.name == 'foo' }
+    assert { table.dbname == 'bar' }
+  end
+  def test_column_raises_error_if_not_found
+    table = PSQL::Table.new 'posts', 'psql_gem_test'
+    assert { rescuing { table.column( 'foo' ) }.message =~ /Table posts does not have a column named 'foo'./ }
+  end
+  def test_column_returns_column_object
+    table = PSQL::Table.new 'posts', 'psql_gem_test'
+    assert { table.column( 'title' ).is_a?( PSQL::Column ) }
+  end
+  def test_hash_access_returns_column_object
+    table = PSQL::Table.new 'posts', 'psql_gem_test'
+    assert { table[ 'title' ].is_a?( PSQL::Column ) }
+  end
+  def test_column_names
+    table = PSQL::Table.new 'posts', 'psql_gem_test'
+    assert { table.column_names == %w| id title body created_at published_on published rating | }
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'minitest/autorun'
+require 'wrong/adapters/minitest'
+require 'psql'
+
+# class DatabaseTestRunner < MiniTest::Unit
+#
+#   def _run_suites(*)
+#     before_suite
+#     super
+#   ensure
+#     after_suite
+#   end
+#
+#   def before_suite
+#     `createdb psql_gem_test`
+#   end
+#
+#   def after_suite
+#     `dropdb psql_gem_test`
+#   end
+# end
+#
+# MiniTest::Unit.runner = DatabaseTestRunner.new

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: psql
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Ruppel
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: wrong
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.12
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: A simple ruby library for consuming the `psql` command.
+email:
+- jeremy.ruppel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .pryrc
+- .wrong
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/psql.rb
+- lib/psql/column.rb
+- lib/psql/database.rb
+- lib/psql/table.rb
+- lib/psql/version.rb
+- psql.gemspec
+- test/fixtures/database.sql
+- test/fixtures/database.yml
+- test/psql/column_test.rb
+- test/psql/database_test.rb
+- test/psql/table_test.rb
+- test/test_helper.rb
+homepage: https://github.com/jeremyruppel/psql
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple ruby library for consuming the `psql` command.
+test_files:
+- test/fixtures/database.sql
+- test/fixtures/database.yml
+- test/psql/column_test.rb
+- test/psql/database_test.rb
+- test/psql/table_test.rb
+- test/test_helper.rb
+has_rdoc: