oci8_simple 0.1.1 → 0.2.0

data/README.rdoc

@@ -5,7 +5,7 @@ command-line scripts to aid automation.  This is *not* meant to replace an ORM s
 The only prerequisite to running this code is that you have installed the ruby-oci8 gem on your machine. 
 
 == Installation
-[sudo] gem install oci8-simple
+  gem install oci8_simple
 
 == Configuration
 To configure environments and schema settings, edit the 
@@ -24,11 +24,9 @@ All logging is done to ~/.oci8_simple/oci8_simple.log
 
 == Examples 
 * Initialize a client against the development schema
-    client = Oci8Simple.new
+    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.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
@@ -49,6 +47,8 @@ All logging is done to ~/.oci8_simple/oci8_simple.log
         INSERT INTO T1 VALUES(b,a);
       END;
     SQL
+* Run a query against stage schema
+    Oci8Simple::Client.new("stage").run('select id, name from foos') => [[2, "lol"], [3, "hey"], ...]  
     
 == Contributing to oci8_simple
  

data/Rakefile

@@ -29,7 +29,7 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
+  test.pattern = 'test/**/*_test.rb'
   test.verbose = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/oci8_simple/cli.rb

@@ -0,0 +1,27 @@
+module Oci8Simple
+  # == Description
+  # A very thin wrapper around Oci8Simple::Client that formats the output
+  # as CSV (suitable for printing on the console)
+  # == Usage
+  #   cli = Oci8Simple::Cli.new
+  #   cli.run "select id, name from foos" # "3, Bacon\n5, Cheese Puffs\n..."
+  class Cli
+    attr_accessor :env, :client
+    
+    def initialize(env=nil)
+      self.env = env
+    end
+    
+    def run(sql)
+      format(client.run(sql))
+    end
+    
+    def format(arr)
+      arr.map{|row| row.join(", ")}.join("\n")
+    end
+    
+    def client
+      @client ||= Client.new(env)
+    end
+  end
+end

data/lib/oci8_simple/client.rb

@@ -0,0 +1,89 @@
+#!/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 Client
+    USER_DIR = File.join(ENV["HOME"], ".oci8_simple")
+    CONFIG_FILE = File.join(USER_DIR, "database.yml")
+    LOG_FILE = File.join(USER_DIR, "oci8_simple.log")
+  
+    attr_accessor :log_file, :env
+  
+    # * env is the environment heading in your database.yml file
+    def initialize(env=nil)
+      self.env = env || "development"
+      conn.autocommit = true
+    end
+
+    def log_file
+      @log_file ||= File.open(LOG_FILE, 'a')
+    end
+  
+    def run(sql)
+      log(sql)
+      result = []
+      conn.exec(sql) do |r|
+        row = []
+        r.map do |col|
+          if col.class == BigDecimal
+            row << col.to_i
+          elsif col.class == OCI8::CLOB
+            row << col.read
+          else
+            row << col.to_s
+          end
+        end
+        result << row
+      end
+      result
+    end
+  
+    def config
+      @config ||= YAML.load_file(CONFIG_FILE)[env]
+    end
+  
+    private
+    
+    def conn
+      @conn ||= OCI8.new(config["username"], config["password"], config["database"])
+    end
+
+    def log(str)
+      log_file.puts "#{Time.now} - #{@env} - #{str}"
+    end
+  end
+end

data/lib/oci8_simple.rb

@@ -1,143 +1,10 @@
-#!/usr/bin/env ruby
-
 require 'rubygems'
-gem 'ruby-oci8'
-require 'oci8'
 require 'pp'
 require 'bigdecimal'
 require 'yaml'
 
-# 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. 
-# 
-# == Installation
-# [sudo] gem install oci8-simple
-# 
-# == Configuration
-# To configure environments and schema settings, edit the 
-# database.yml file in ~/.oci8_simple/
-#   development:
-#     database: oracle.hostname:1521/sid
-#     username: foo_dev
-#     password: OMG333
-#   test:
-#     database: oracle.hostname:1521/sid
-#     username: foo_test
-#     password: OMG333
-# 
-# == Logging
-# All logging is done to ~/.oci8_simple/oci8_simple.log
-# 
-# == Examples 
-# * Initialize a client against the development schema
-#     client = Oci8Simple.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.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 Oci8Simple
-  USER_DIR = File.join(ENV["HOME"], ".oci8_simple")
-  CONFIG_FILE = File.join(USER_DIR, "database.yml")
-  LOG_FILE = File.join(USER_DIR, "oci8_simple.log")
-  
-  attr_accessor :log_file, :puts_mode, :env
-  
-  # * env is the environment heading in your database.yml file
-  # * uname is the username you want to use (defaults to config["username"])
-  # * puts_mode is whether you want to format the result for printing to a terminal (defaults to false)
-  def initialize(env="development", uname=nil, puts_mode=false)
-    @env = env
-    @uname = uname
-    @puts_mode = puts_mode
-    conn.autocommit = true
-  end
-
-  def log_file
-    @log_file ||= File.open(LOG_FILE, 'a')
-  end
-  
-  def run(sql)
-    log(sql)
-    result = []
-    conn.exec(sql) do |r|
-      row = []
-      r.map do |col|
-        if col.class == BigDecimal
-          row << col.to_i
-        elsif col.class == OCI8::CLOB
-          row << col.read
-        else
-          row << col.to_s
-        end
-      end
-      result << row
-    end
-
-    if @puts_mode
-      result.map{|row| row.join(", ")}.join("\n")
-    else
-      if(result.length == 1 && result[0].length == 1)
-        result[0][0]
-      else
-        result
-      end
-    end
-  end
-  
-  def config
-    @config ||= YAML.load_file(CONFIG_FILE)[@env]
-  end
-  
-  private
-    def conn
-      @o ||= OCI8.new(@uname || config["username"], config["password"], config["database"])
-    end
-  
-    def log(str)
-      log_file.puts "#{Time.now} - #{@env} - #{str}"
-    end
-    
-    def self.help
-      <<-HELP
-  Run arbitrary SQL against an Oracle schema. The default schema is the one defined
-  in the development section of your ~/.oci8_simple/database.yml file.
-
-  You do not need to include a semicolon to end a statement. The statement should be enclosed in single
-  or double quotes. 
-
-  Usage: #{$0} SQL [ENV]
-  Example: #{$0} 'select id from users' stage
-  HELP
-    end
-end 
+gem 'ruby-oci8'
+require 'oci8'
 
-if __FILE__ == $0
-  if(["-h", "--help"].include?(ARGV[0]) || ARGV.empty?)
-    Oci8Simple.help
-  else
-    sql = ARGV[0] || ""
-    env = ARGV[1] || "development"
-    Oci8Simple.new(env).run(sql)
-  end
-end
+require 'oci8_simple/client'
+require 'oci8_simple/cli'

data/oci8_simple.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oci8_simple}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Billy Reisinger"]
@@ -26,9 +26,12 @@ Gem::Specification.new do |s|
     "Rakefile",
     "VERSION",
     "lib/oci8_simple.rb",
+    "lib/oci8_simple/cli.rb",
+    "lib/oci8_simple/client.rb",
     "oci8_simple.gemspec",
-    "test/helper.rb",
-    "test/test_oci8_simple.rb"
+    "test/cli_test.rb",
+    "test/client_test.rb",
+    "test/helper.rb"
   ]
   s.homepage = %q{http://github.com/unclebilly/oci8_simple}
   s.licenses = ["MIT"]
@@ -36,8 +39,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.5.2}
   s.summary = %q{Run single statements against an arbitrary Oracle schema.}
   s.test_files = [
-    "test/helper.rb",
-    "test/test_oci8_simple.rb"
+    "test/cli_test.rb",
+    "test/client_test.rb",
+    "test/helper.rb"
   ]
 
   if s.respond_to? :specification_version then

data/test/cli_test.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), 'helper')
+class CliTest < Test::Unit::TestCase
+  context "Given a table and some data" do
+    setup do
+      @client = Oci8Simple::Client.new("test")
+      @client.run "DROP TABLE OCI8_SIMPLE_TEST CASCADE CONSTRAINTS" rescue nil
+      @client.run <<-SQL
+        CREATE TABLE "OCI8_SIMPLE_TEST"
+          (
+            "ID"             NUMBER(38,0) NOT NULL ENABLE,
+            "NAME"           VARCHAR2(400 CHAR) NOT NULL ENABLE,
+            "TEXTS"          CLOB
+          )
+      SQL
+      @client.run "INSERT INTO OCI8_SIMPLE_TEST (ID, NAME, TEXTS) VALUES (1, 'Johnny', 'OMG')"
+      @client.run "INSERT INTO OCI8_SIMPLE_TEST (ID, NAME, TEXTS) VALUES (2, 'Jenny', 'OMG')"
+      @cli = Oci8Simple::Cli.new("test")
+    end
+    context "with an env" do
+      setup do
+        @cli = Oci8Simple::Cli.new("test")
+      end
+      should "format results for the command line" do
+        assert_equal("1, Johnny, OMG\n2, Jenny, OMG", @cli.run("select * from oci8_simple_test"))
+      end
+    end
+    context "without an env" do
+      setup do
+        @cli = Oci8Simple::Cli.new
+      end
+      should "default to development" do
+        assert_equal("development", @cli.client.env)
+      end
+    end
+  end
+end

data/test/{test_oci8_simple.rb → client_test.rb}

@@ -1,15 +1,15 @@
-require 'helper'
+require File.join(File.dirname(__FILE__), 'helper')
 
-class TestOci8Simple < Test::Unit::TestCase
+class ClientTest < Test::Unit::TestCase
   context "A client" do
     should "default to development environment" do
-      @client = Oci8Simple.new
+      @client = Oci8Simple::Client.new
       assert_equal "development", @client.env
     end
   end
   context "Given a table" do
     setup do
-      @client = Oci8Simple.new("test", nil, false)
+      @client = Oci8Simple::Client.new("test")
       @client.run "DROP TABLE OCI8_SIMPLE_TEST CASCADE CONSTRAINTS" rescue nil
       @client.run <<-SQL
         CREATE TABLE "OCI8_SIMPLE_TEST"
@@ -26,33 +26,22 @@ class TestOci8Simple < Test::Unit::TestCase
         INSERT INTO OCI8_SIMPLE_TEST (ID, NAME, TEXTS) VALUES (2, 'Jenny', 'OMG')
       SQL
     end
-    context "when puts mode is false the client" do
-      setup do
-      end
+    context "the client" do
       should "be able to run a simple query with a single result" do
-        assert_equal 2, @client.run("select count(*) from OCI8_SIMPLE_TEST")
+        assert_equal [[2]], @client.run("select count(*) from OCI8_SIMPLE_TEST")
       end
       should "be able to run a simple query with multiple results and multiple columns" do
         assert_equal [["1", "Johnny", "OMG"], ["2", "Jenny", "OMG"]], @client.run("select * from OCI8_SIMPLE_TEST")
       end
     
       should "have logged something" do
-        File.unlink(Oci8Simple::LOG_FILE)
-        assert(!File.exists?(Oci8Simple::LOG_FILE))
-        @client = Oci8Simple.new("test", nil, false)
+        File.unlink(Oci8Simple::Client::LOG_FILE)
+        assert(!File.exists?(Oci8Simple::Client::LOG_FILE))
+        @client = Oci8Simple::Client.new("test")
         @client.run "select NULL from dual"
         @client.log_file.close
-        assert(File.exists?(Oci8Simple::LOG_FILE))
-        assert(!(0 == File.size(Oci8Simple::LOG_FILE)))
-      end
-    end
-    context "when puts mode is true the client" do
-      setup do
-        @client.puts_mode = true
-      end
-      should "format result" do
-        result = @client.run("select * from OCI8_SIMPLE_TEST")
-        assert_equal "1, Johnny, OMG\n2, Jenny, OMG", result
+        assert(File.exists?(Oci8Simple::Client::LOG_FILE))
+        assert(!(0 == File.size(Oci8Simple::Client::LOG_FILE)))
       end
     end
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oci8_simple
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 1
-  version: 0.1.1
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Billy Reisinger
@@ -116,9 +116,12 @@ files:
 - Rakefile
 - VERSION
 - lib/oci8_simple.rb
+- lib/oci8_simple/cli.rb
+- lib/oci8_simple/client.rb
 - oci8_simple.gemspec
+- test/cli_test.rb
+- test/client_test.rb
 - test/helper.rb
-- test/test_oci8_simple.rb
 has_rdoc: true
 homepage: http://github.com/unclebilly/oci8_simple
 licenses: 
@@ -154,5 +157,6 @@ signing_key:
 specification_version: 3
 summary: Run single statements against an arbitrary Oracle schema.
 test_files: 
+- test/cli_test.rb
+- test/client_test.rb
 - test/helper.rb
-- test/test_oci8_simple.rb