oci8_simple 0.4.2 → 0.5.0

data/Rakefile

@@ -15,9 +15,9 @@ Jeweler::Tasks.new do |gem|
   gem.name = "oci8_simple"
   gem.homepage = "http://github.com/unclebilly/oci8_simple"
   gem.license = "MIT"
-  gem.summary = %Q{Run single statements against an arbitrary Oracle schema.}
-  gem.description = %Q{Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
-  command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+  gem.summary = %Q{Command-line tools for interacting with an Oracle database.}
+  gem.description = %Q{Command-line tools for interacting with an Oracle database. This client is intended to be used 
+  to aid development and automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
   The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine.}
   gem.email = "billy.reisinger@gmail.com"
   gem.authors = ["Billy Reisinger"]

data/VERSION

@@ -1 +1 @@
-0.4.2
+0.5.0

data/lib/oci8_simple/cli.rb

@@ -1,4 +1,3 @@
-require 'optparse'
 module Oci8Simple
   # == Description
   # A very thin wrapper around Oci8Simple::Client that handles ARGV / options and

data/lib/oci8_simple/client.rb

@@ -1,44 +1,39 @@
-#!/usr/bin/env ruby
-
-
-# Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
-# command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
-# The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine. 
-# 
-# == Logging
-# All logging is done to ~/.oci8_simple/oci8_simple.log
-# 
-# == Examples 
-# * Initialize a client against the development schema
-#     client = Oci8Simple::Client.new
-# * Run a simple select query against development schema
-#     client.run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
-# * Run a simple select query against stage schema
-#     Oci8Simple:Client.new("stage").run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
-# * Update something
-#     client.run <<-SQL
-#       UPDATE foos SET bar='baz' WHERE id=1233
-#     SQL
-# * Run some DDL
-#     client.run <<-SQL
-#       CREATE TABLE foos (
-#          ID NUMBER(38) NOT NULL
-#       )
-#     SQL
-# * Run some PL/SQL
-#     client.run <<-SQL
-#       DECLARE
-#         a NUMBER;
-#         b NUMBER;
-#       BEGIN
-#         SELECT e,f INTO a,b FROM T1 WHERE e>1;
-#         INSERT INTO T1 VALUES(b,a);
-#       END;
-#     SQL
 module Oci8Simple
   class ConfigError < Exception; end
   class LogError < Exception; end
   
+  # Run SQL and PL/SQL statements against an Oracle schema. 
+  # 
+  # == Logging
+  # All logging is done to ~/.oci8_simple/oci8_simple.log
+  # 
+  # == Examples 
+  # * Initialize a client against the development schema
+  #     client = Oci8Simple::Client.new
+  # * Run a simple select query against development schema
+  #     client.run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
+  # * Run a simple select query against stage schema
+  #     Oci8Simple:Client.new("stage").run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]
+  # * Update something
+  #     client.run <<-SQL
+  #       UPDATE foos SET bar='baz' WHERE id=1233
+  #     SQL
+  # * Run some DDL
+  #     client.run <<-SQL
+  #       CREATE TABLE foos (
+  #          ID NUMBER(38) NOT NULL
+  #       )
+  #     SQL
+  # * Run some PL/SQL
+  #     client.run <<-SQL
+  #       DECLARE
+  #         a NUMBER;
+  #         b NUMBER;
+  #       BEGIN
+  #         SELECT e,f INTO a,b FROM T1 WHERE e>1;
+  #         INSERT INTO T1 VALUES(b,a);
+  #       END;
+  #     SQL
   class Client
     USER_DIR = File.join(ENV["HOME"], ".oci8_simple")
     CONFIG_FILE = File.join(USER_DIR, "database.yml")

data/lib/oci8_simple/describe.rb

@@ -1,59 +1,131 @@
-class Oci8Simple::Describe
-  def initialize(env=nil)
-    @env = env || "development"
-  end
+module Oci8Simple
+  # == Description
+  # This class creates a string describing a table's columns, intended to be 
+  # displayed in a fixed-width font.
+  # == Usage
+  #   Oci8Simple::Describe.new("development").run("users")
+  class Describe
+    SPACE_BETWEEN=2
+    FIELDS=[
+      {:select => "NULLABLE",           :header => "Required", :content => :format_nullable, :right => true},
+      {:select => "lower(COLUMN_NAME)", :header=> "Name"},
+      {:select => "lower(DATA_TYPE)",   :header => "Type"},
+      {:select => "DATA_LENGTH",        :header => "Size", :content => :format_size},
+      {:select => "CHAR_USED",          :header => "Char?", :content => :format_char_used},   
+      {:select => "CHAR_LENGTH",        :header => "Char_size", :content => :format_char_length},
+      {:select => "DATA_PRECISION",     :header => "Precision"}, 
+      {:select => "DATA_SCALE",         :header => "Scale"},
+      {:select => "DATA_DEFAULT",       :header => "Default", :content => :format_default, :max => 10}
+    ]
   
-  def run(table)
-    description = client.conn.describe_table(table)
-    c = description.columns.sort{|a,b| a.name <=> b.name }
-    max_name = max(c.map(&:name)) + 3
-    max_type = max(c.map {|col| type_and_size(col)}) + 1
-    c.map do |col|
-      "\"#{col.name}\"".ljust(max_name, ' ') + type_and_size(col).ljust(max_type, ' ') + null(col)
-    end.map(&:upcase).join("\n")
-  end
+    def run(table)
+      sql = <<-SQL
+        select #{select_fields} 
+        from user_tab_columns 
+        where table_name='#{table.upcase}' 
+        order by column_name asc
+      SQL
+      results = client.run(sql)
+      calculate_widths(results)
+      format_results(results)
+    end
   
-  def null(col)
-    col.nullable? ? "" : "NOT NULL"
-  end
+    def initialize(env=nil)
+      @env = env || "development"
+    end
   
-  def type_and_size(col)
-    str = "#{col.data_type}"
-    if(col.data_type.to_s =~ /varchar/i)
-      str << "(#{col.char_size} CHAR)"
-    elsif(col.data_type == :number)
-      str << "(#{col.precision})"
+    def self.usage
+      "Usage: #{0} TABLE_NAME [ENVIRONMENT]"
     end
-    str
-  end
   
-  def max(arr)
-    arr.map(&:length).max
-  end
+    def self.run_from_argv
+      o = OptionParser.new do |opt|
+        opt.banner = usage
+        opt.on("-v", "--version", "Show version") do
+          puts "version #{File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))}"
+          exit
+        end
+      end
+      o.parse!
+      if(ARGV[0].nil?)
+        puts o
+      else
+        puts self.new(ARGV[1]).run(ARGV[0])
+      end
+    end
   
-  def self.usage
-    "Usage: #{0} TABLE_NAME [ENVIRONMENT]"
-  end
+    private
   
-  def self.run_from_argv
-    o = OptionParser.new do |opt|
-      opt.banner = usage
-      opt.on("-v", "--version", "Show version") do
-        puts "version #{File.read(File.join(File.dirname(__FILE__), '..', '..', 'VERSION'))}"
-        exit
+    def format_nullable(value, row)
+      value == 'N' ? '*' : ' '
+    end
+
+    def format_char_used(value, row)
+      value == 'C' ? "*" : ' '
+    end
+  
+    def format_char_length(value, row)
+      row[FIELDS.index{|f| f[:select] == "CHAR_USED"}] == "C" ? value.to_s : ""
+    end
+  
+    def format_size(value, row)
+      row[FIELDS.index{|f| f[:select] == "lower(DATA_TYPE)"}] =~ /lob/i ? "" : value.to_s
+    end
+  
+    def format_default(value, row)
+      value = value.to_s.strip.gsub(/^'(.+)'$/,'\1')
+    
+      if(value.length > 10)
+        value = value[0..9] + "..."
       end
+      value
     end
-    o.parse!
-    if(ARGV[0].nil?)
-      puts o
-    else
-      puts self.new(ARGV[1]).run(ARGV[0])
+  
+    def select_fields
+      FIELDS.map{|f| f[:select]}.join(",")
+    end
+  
+    def max(column, header)
+      max = header.length
+      column.each {|s| max = s.length if s.length > max}
+      max + SPACE_BETWEEN
+    end
+
+    def header
+      FIELDS.map{|f| f[:header].ljust(f[:max], ' ')}.join("")
     end
-  end
   
-  private
+    def calculate_widths(results)
+      FIELDS.each_with_index do |hsh,i|
+        if(hsh[:max].nil?)
+          hsh[:max] = max(results.map{|row| row[i].to_s}, hsh[:header])
+        end
+      end
+    end
   
-  def client
-    @client ||= Oci8Simple::Client.new(@env)
+    def format_results(results)
+      arr = []
+      arr << header
+      arr << "-" * arr[0].length
+      results.each do |result|
+        str = ""
+        result.each_with_index do |col, i|
+          field = FIELDS[i]
+          value = field[:content].nil? ? col.to_s : send(field[:content], col, result)
+          if(field[:right])
+            str << value.rjust(field[:max] - SPACE_BETWEEN, ' ')
+            str << ' ' * SPACE_BETWEEN
+          else
+            str << value.ljust(field[:max], ' ')
+          end
+        end
+        arr << str
+      end
+      arr.join("\n")
+    end
+  
+    def client
+      @client ||= Oci8Simple::Client.new(@env)
+    end
   end
 end

data/lib/oci8_simple.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'pp'
 require 'bigdecimal'
 require 'yaml'
+require 'optparse'
 
 gem 'ruby-oci8'
 require 'oci8'

data/oci8_simple.gemspec

@@ -5,13 +5,13 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oci8_simple}
-  s.version = "0.4.2"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Billy Reisinger"]
-  s.date = %q{2011-06-11}
-  s.description = %q{Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
-  command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+  s.date = %q{2011-06-30}
+  s.description = %q{Command-line tools for interacting with an Oracle database. This client is intended to be used 
+  to aid development and automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
   The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine.}
   s.email = %q{billy.reisinger@gmail.com}
   s.executables = ["oci8_simple", "describe"]
@@ -42,7 +42,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Run single statements against an arbitrary Oracle schema.}
+  s.summary = %q{Command-line tools for interacting with an Oracle database.}
   s.test_files = [
     "test/cli_test.rb",
     "test/client_test.rb",

data/test/describe_test.rb

@@ -7,8 +7,9 @@ class DescribeTest < Test::Unit::TestCase
       @client.run <<-SQL
         CREATE TABLE "OCI8_SIMPLE_TEST"
           (
-            "NAME"           VARCHAR2(400 CHAR) NOT NULL ENABLE,
-            "ID"             NUMBER(38,0) NOT NULL ENABLE,
+            "NAME"           VARCHAR2(400 CHAR) DEFAULT 'FOO' NOT NULL ENABLE,
+            "ID"             NUMBER(38,0) DEFAULT 7 NOT NULL ENABLE,
+            "LONG_THING"     VARCHAR(2000 CHAR) DEFAULT '#{"a " * 50}' NOT NULL ENABLE,
             "TEXTS"          CLOB
           )
       SQL
@@ -19,10 +20,16 @@ class DescribeTest < Test::Unit::TestCase
       end
       should "format results for the command line" do
         expected=<<-STR
-"ID"    NUMBER(38)         NOT NULL
-"NAME"  VARCHAR2(400 CHAR) NOT NULL
-"TEXTS" CLOB               
+Required  Name        Type      Size  Char?  Char_size  Precision  Scale  Default   
+------------------------------------------------------------------------------------
+       *  id          number    22                      38         0      7         
+       *  long_thing  varchar2  4000  *      2000                         a a a a a ...
+       *  name        varchar2  1600  *      400                          FOO       
+          texts       clob                                                          
 STR
+        # puts
+        # puts expected.chop
+        # puts @describe.run("oci8_simple_test")
         assert_equal(expected.chop, @describe.run("oci8_simple_test"))
       end
     end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: 
   segments: 
   - 0
-  - 4
-  - 2
-  version: 0.4.2
+  - 5
+  - 0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Billy Reisinger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-11 00:00:00 -05:00
+date: 2011-06-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -111,8 +111,8 @@ dependencies:
   type: :runtime
   requirement: *id006
 description: |-
-  Run single statements against an arbitrary Oracle schema. This client is intended to be used by simple
-    command-line scripts to aid automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
+  Command-line tools for interacting with an Oracle database. This client is intended to be used 
+    to aid development and automation.  This is *not* meant to replace an ORM such as ActiveRecord + OracleEnhancedAdapter.
     The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine.
 email: billy.reisinger@gmail.com
 executables: 
@@ -174,7 +174,7 @@ rubyforge_project:
 rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Run single statements against an arbitrary Oracle schema.
+summary: Command-line tools for interacting with an Oracle database.
 test_files: 
 - test/cli_test.rb
 - test/client_test.rb