oci8_simple 0.5.0 → 0.6.0

data/README.rdoc

@@ -8,7 +8,8 @@ This gem installs a few command-line scripts:
   * a command to run arbitrary SQL
 * <code>describe   </code>
   * a command to describe a table
-
+* <code>show       </code>
+  * a command to list things in the database (tables, views, etc.)
 You can also use oci8_simple in your Ruby scripts by creating an instance of <code>Oci8Simple::Client</code> 
 (see more below).
 
@@ -37,8 +38,9 @@ an existing file into this directory if you already have one.
 All logging is done to <code>~/.oci8_simple/oci8_simple.log</code>.
 
 == Command-Line Examples
-This gem installs a bin script called <code>oci8_simple</code>.  The script allows you to 
-run single statements against an arbitrary Oracle schema via the command line.
+=== oci8_simple
+This script allows you to run single statements against an 
+arbitrary Oracle schema via the command line.
 
   Run a query against development schema
     oci8_simple "select id, name from flavors" 
@@ -49,10 +51,10 @@ run single statements against an arbitrary Oracle schema via the command line.
   Help
     oci8_simple --help
 
-
-<code>oci8_simple</code> also comes with a bin script called <code>describe</code>. This script 
-shows a simple description of a table, including the column names (sorted), the type and size for 
-each column, and the nullable status of the column.
+=== describe
+This script shows a description of a table, including the column names (sorted), 
+the type and size for each column, the nullable status of the column, and the default
+value, if any.
 
   Show column information for a table named "holidays"
     describe holidays
@@ -60,6 +62,19 @@ each column, and the nullable status of the column.
   Help
     describe --help
     
+=== show
+This command can list the following items in the database: 
+functions, packages, procedures, sequences, synonyms, tables, types, and views.
+
+  Show a list of all tables in the database
+    show tables
+    
+  Show a list of all views in the database
+    show views
+  
+  Help
+    show --help
+    
 == Code Examples 
 * Initialize a client against the development schema
     require 'rubygems'

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/bin/show

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'oci8_simple'
+
+Oci8Simple::Show.run_from_argv

data/lib/oci8_simple/cli.rb

@@ -6,6 +6,8 @@ module Oci8Simple
   #   cli = Oci8Simple::Cli.new
   #   cli.run "select id, name from foos" # "3, Bacon\n5, Cheese Puffs\n..."
   class Cli
+    include Command
+    
     attr_accessor :env, :client
     
     def initialize(env=nil)
@@ -29,14 +31,7 @@ module Oci8Simple
     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!
+      o = parse_options(self.usage)
       if(ARGV[0].nil?)
         puts o
       else

data/lib/oci8_simple/command.rb

@@ -0,0 +1,24 @@
+module Oci8Simple
+  module Command
+    def self.included(base)
+      base.extend ClassMethods
+    end
+    
+    module ClassMethods
+      
+      # Returns an OptionParser object. 
+      def parse_options(banner)
+        o = OptionParser.new do |opt|
+          opt.banner = banner
+          opt.on("-v", "--version", "Show version") do
+            puts "#{self.to_s} #{Oci8Simple::VERSION}"
+            exit
+          end
+        end
+        o.parse!
+        o
+      end
+      
+    end
+  end
+end

data/lib/oci8_simple/describe.rb

@@ -5,6 +5,8 @@ module Oci8Simple
   # == Usage
   #   Oci8Simple::Describe.new("development").run("users")
   class Describe
+    include Command
+    
     SPACE_BETWEEN=2
     FIELDS=[
       {:select => "NULLABLE",           :header => "Required", :content => :format_nullable, :right => true},
@@ -35,18 +37,11 @@ module Oci8Simple
     end
   
     def self.usage
-      "Usage: #{0} TABLE_NAME [ENVIRONMENT]"
+      "Usage: #{$0} TABLE_NAME [ENVIRONMENT]"
     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!
+      o = parse_options(self.usage)
       if(ARGV[0].nil?)
         puts o
       else

data/lib/oci8_simple/show.rb

@@ -0,0 +1,49 @@
+module Oci8Simple
+  class Show
+    include Command
+    
+    TYPES={
+      "functions" =>  "Function",
+      "packages"  =>  "Package",
+      "procedures" => "Procedure",
+      "sequences" =>  "Sequence",
+      "synonyms"  =>  "Synonym",
+      "tables" =>     "Table",
+      "types" =>      "Type",
+      "views" =>      "View"
+    }
+    
+    def run(type)
+      clazz = eval("OCI8::Metadata::#{TYPES[type]}")
+      objects = client.send(:conn).describe_schema(client.config["username"]).all_objects.find_all{|f| f.class == clazz}
+      objects.map(&:obj_name).map(&:downcase).sort
+    end
+    
+    def initialize(env=nil)
+      @env = env || "development"
+    end
+    
+    def self.run_from_argv
+      o = parse_options(self.usage)
+      if(ARGV[0].nil? || TYPES[ARGV[0]].nil?)
+        puts o
+      else
+        puts self.new(ARGV[1]).run(ARGV[0])
+      end
+    end
+    
+    def self.usage
+      <<-STR
+Usage: #{$0} TYPE [ENVIRONMENT]
+
+TYPE is one of: #{TYPES.keys.sort.join(", ")}
+STR
+    end
+    
+    private
+    
+    def client
+      @client ||= Oci8Simple::Client.new(@env)
+    end
+  end
+end

data/lib/oci8_simple.rb

@@ -1,12 +1,20 @@
 require 'rubygems'
-require 'pp'
+
+require 'abbrev'
 require 'bigdecimal'
-require 'yaml'
 require 'optparse'
+require 'pp'
+require 'yaml'
 
 gem 'ruby-oci8'
 require 'oci8'
 
+require 'oci8_simple/command'
 require 'oci8_simple/cli'
 require 'oci8_simple/client'
-require 'oci8_simple/describe'
+require 'oci8_simple/describe'
+require 'oci8_simple/show'
+
+module Oci8Simple
+  VERSION = File.read(File.join(File.dirname(__FILE__), '..', 'VERSION'))
+end

data/oci8_simple.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oci8_simple}
-  s.version = "0.5.0"
+  s.version = "0.6.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-30}
+  s.date = %q{2011-07-06}
   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"]
+  s.executables = ["show", "oci8_simple", "describe"]
   s.extra_rdoc_files = [
     "README.rdoc"
   ]
@@ -28,15 +28,19 @@ Gem::Specification.new do |s|
     "VERSION",
     "bin/describe",
     "bin/oci8_simple",
+    "bin/show",
     "lib/oci8_simple.rb",
     "lib/oci8_simple/cli.rb",
     "lib/oci8_simple/client.rb",
+    "lib/oci8_simple/command.rb",
     "lib/oci8_simple/describe.rb",
+    "lib/oci8_simple/show.rb",
     "oci8_simple.gemspec",
     "test/cli_test.rb",
     "test/client_test.rb",
     "test/describe_test.rb",
-    "test/helper.rb"
+    "test/helper.rb",
+    "test/show_test.rb"
   ]
   s.homepage = %q{http://github.com/unclebilly/oci8_simple}
   s.licenses = ["MIT"]
@@ -47,7 +51,8 @@ Gem::Specification.new do |s|
     "test/cli_test.rb",
     "test/client_test.rb",
     "test/describe_test.rb",
-    "test/helper.rb"
+    "test/helper.rb",
+    "test/show_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/show_test.rb

@@ -0,0 +1,124 @@
+require File.join(File.dirname(__FILE__), 'helper')
+class ShowTest < Test::Unit::TestCase
+  def setup
+    @client = Oci8Simple::Client.new("test")
+    @show =   Oci8Simple::Show.new("test")
+  end
+  def teardown
+    
+  end
+  context "Show tables" do
+    setup do
+      @client.run "drop table oci8_simple_test"   rescue nil
+      @client.run "drop table oci8_simple_test_2" rescue nil
+      @client.run <<-SQL
+        CREATE TABLE "OCI8_SIMPLE_TEST" ("ID" NUMBER(38,0) DEFAULT 7 NOT NULL ENABLE)
+      SQL
+      @client.run <<-SQL
+        CREATE TABLE "OCI8_SIMPLE_TEST_2" ("ID" NUMBER(38,0) NOT NULL ENABLE)
+      SQL
+    end
+    should "list the tables" do
+      assert_equal ["oci8_simple_test","oci8_simple_test_2"], @show.run("tables")
+    end
+  end
+  
+  context "Show functions" do
+    setup do
+      @client.run "drop function oci8_simple_function" rescue nil
+      @client.run <<-SQL
+        CREATE FUNCTION oci8_simple_function 
+        RETURN NUMBER 
+        IS num NUMBER(1,0);
+        BEGIN 
+          SELECT 1 INTO num FROM DUAL;
+          RETURN(num); 
+        END
+      SQL
+    end
+    should "list the functions" do
+      assert_equal ["oci8_simple_function"], @show.run("functions")
+    end
+  end
+  
+  context "Show packages" do
+    setup do
+      @client.run "drop package oci8_simple_package" rescue nil
+      @client.run <<-SQL
+        CREATE OR REPLACE PACKAGE oci8_simple_package AS 
+           FUNCTION something(id NUMBER, foo NUMBER) 
+              RETURN NUMBER; 
+        END oci8_simple_package
+      SQL
+    end
+    should "list the packages" do
+      assert_equal ["oci8_simple_package"], @show.run("packages")
+    end
+  end
+  
+  context "Show procedures" do
+    setup do
+      @client.run "drop procedure oci8_simple_procedure" rescue nil
+      @client.run <<-SQL
+        CREATE PROCEDURE oci8_simple_procedure AS
+         BEGIN
+            SELECT 1 FROM DUAL;
+         END
+      SQL
+    end
+    should "list the procedures" do
+      assert_equal ["oci8_simple_procedure"], @show.run("procedures")
+    end
+  end
+  
+  context "Show sequences" do
+    setup do
+      @client.run "drop sequence oci8_simple_sequence" rescue nil
+      @client.run <<-SQL
+        CREATE SEQUENCE oci8_simple_sequence
+      SQL
+    end
+    should "list the sequences" do
+      assert_equal ["oci8_simple_sequence"], @show.run("sequences")
+    end
+  end
+  
+  context "show synonyms" do
+    setup do
+      @client.run "drop synonym oci8_simple_synonym" rescue nil
+      @client.run <<-SQL
+        CREATE SYNONYM oci8_simple_synonym 
+           FOR DUAL
+      SQL
+    end
+    should "list the synonyms" do
+      assert_equal ["oci8_simple_synonym"], @show.run("synonyms")
+    end
+  end
+  
+  context "show types" do
+    setup do
+      @client.run "drop type oci8_simple_type" rescue nil
+      @client.run <<-SQL
+        CREATE TYPE oci8_simple_type AS OBJECT
+          ( id  NUMBER(6))
+      SQL
+    end
+    should "list the types" do
+      assert_equal ["oci8_simple_type"], @show.run("types")
+    end
+  end
+  
+  context "show views" do
+    setup do
+      @client.run "drop view oci8_simple_view" rescue nil
+      @client.run <<-SQL
+        CREATE VIEW oci8_simple_view AS 
+          SELECT sysdate AS dabba FROM DUAL
+      SQL
+    end
+    should "list the views" do
+      assert_equal ["oci8_simple_view"], @show.run("views")
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oci8_simple
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: 
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Billy Reisinger
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 -05:00
+date: 2011-07-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -116,6 +116,7 @@ description: |-
     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: 
+- show
 - oci8_simple
 - describe
 extensions: []
@@ -132,15 +133,19 @@ files:
 - VERSION
 - bin/describe
 - bin/oci8_simple
+- bin/show
 - lib/oci8_simple.rb
 - lib/oci8_simple/cli.rb
 - lib/oci8_simple/client.rb
+- lib/oci8_simple/command.rb
 - lib/oci8_simple/describe.rb
+- lib/oci8_simple/show.rb
 - oci8_simple.gemspec
 - test/cli_test.rb
 - test/client_test.rb
 - test/describe_test.rb
 - test/helper.rb
+- test/show_test.rb
 has_rdoc: true
 homepage: http://github.com/unclebilly/oci8_simple
 licenses: 
@@ -180,3 +185,4 @@ test_files:
 - test/client_test.rb
 - test/describe_test.rb
 - test/helper.rb
+- test/show_test.rb