ruby-plsql 0.1.0

data/spec/plsql/package_spec.rb

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Package" do
+  before(:all) do
+    plsql.connection = conn = OCI8.new("hr","hr","xe")
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE PACKAGE test_package IS
+        FUNCTION test_uppercase ( p_string VARCHAR2 )
+          RETURN VARCHAR2;
+      END;
+    EOS
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE PACKAGE BODY test_package IS
+        FUNCTION test_uppercase ( p_string VARCHAR2 )
+          RETURN VARCHAR2
+        IS
+        BEGIN
+          RETURN UPPER(p_string);
+        END test_uppercase;
+      END;
+    EOS
+
+  end
+  
+  after(:all) do
+    plsql.logoff
+  end
+  
+  before(:each) do
+  end
+  
+  it "should find existing package" do
+    PLSQL::Package.find(plsql, :test_package).should_not be_nil
+  end
+
+  it "should not find nonexisting package" do
+    PLSQL::Package.find(plsql, :qwerty123456).should be_nil
+  end
+
+  it "should find existing package in schema" do
+    plsql.test_package.class.should == PLSQL::Package
+  end
+
+  it "should execute package function and return correct value" do
+    plsql.test_package.test_uppercase('xxx').should == 'XXX'
+  end
+
+end

data/spec/plsql/procedure_spec.rb

@@ -0,0 +1,168 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Procedure with string parameters" do
+  
+  before(:all) do
+    plsql.connection = conn = OCI8.new("hr","hr","xe")
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE FUNCTION test_uppercase
+        ( p_string VARCHAR2 )
+        RETURN VARCHAR2
+      IS
+      BEGIN
+        RETURN UPPER(p_string);
+      END test_uppercase;
+    EOS
+  end
+  
+  after(:all) do
+    plsql.logoff
+  end
+  
+  it "should find existing procedure" do
+    PLSQL::Procedure.find(plsql, :test_uppercase).should_not be_nil
+  end
+
+  it "should not find nonexisting procedure" do
+    PLSQL::Procedure.find(plsql, :qwerty123456).should be_nil
+  end
+
+  it "should execute function and return correct value" do
+    plsql.test_uppercase('xxx').should == 'XXX'
+  end
+
+  it "should execute function with named parameters and return correct value" do
+    plsql.test_uppercase(:p_string => 'xxx').should == 'XXX'
+  end
+
+  it "should raise error if wrong number of arguments is passed" do
+    lambda { plsql.test_uppercase('xxx','yyy') }.should raise_error(ArgumentError)
+  end
+
+  it "should raise error if wrong named argument is passed" do
+    lambda { plsql.test_uppercase(:p_string2 => 'xxx') }.should raise_error(ArgumentError)
+  end
+  
+  it "should execute function with schema name specified" do
+    plsql.hr.test_uppercase('xxx').should == 'XXX'
+  end
+
+end
+
+describe "Procedure with numeric parameters" do
+  
+  before(:all) do
+    plsql.connection = conn = OCI8.new("hr","hr","xe")
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE FUNCTION test_sum
+        ( p_num1 NUMBER, p_num2 NUMBER )
+        RETURN NUMBER
+      IS
+      BEGIN
+        RETURN p_num1 + p_num2;
+      END test_sum;
+    EOS
+  end
+  
+  after(:all) do
+    plsql.logoff
+  end
+  
+  it "should process integer parameters" do
+    plsql.test_sum(123,456).should == 579
+  end
+
+  it "should process big integer parameters" do
+    plsql.test_sum(123123123123,456456456456).should == 579579579579
+  end
+
+  it "should process float parameters" do
+    plsql.test_sum(123.123,456.456).should == 579.579
+  end
+
+end
+
+describe "Procedure with date parameters" do
+  
+  before(:all) do
+    plsql.connection = conn = OCI8.new("hr","hr","xe")
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE FUNCTION test_date
+        ( p_date DATE )
+        RETURN DATE
+      IS
+      BEGIN
+        RETURN p_date + 1;
+      END test_date;
+    EOS
+  end
+  
+  after(:all) do
+    plsql.logoff
+  end
+  
+  it "should process date parameters" do
+    now = DateTime.new(2008,8,12,14,28,0)
+    plsql.test_date(now).should == now + 1
+  end
+
+  it "should process old date parameters" do
+    now = DateTime.new(1900,1,1,12,0,0)
+    plsql.test_date(now).should == now + 1
+  end
+
+end
+
+describe "Procedure with timestamp parameters" do
+  
+  before(:all) do
+    plsql.connection = conn = OCI8.new("hr","hr","xe")
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE FUNCTION test_timestamp
+        ( p_time TIMESTAMP )
+        RETURN TIMESTAMP
+      IS
+      BEGIN
+        RETURN p_time + 1;
+      END test_timestamp;
+    EOS
+  end
+  
+  after(:all) do
+    plsql.logoff
+  end
+  
+  it "should process timestamp parameters" do
+    now = Time.local(2008,8,12,14,28,0)
+    plsql.test_timestamp(now).should == now + 60*60*24
+  end
+
+end
+
+describe "Procedure with output parameters" do
+  before(:all) do
+    plsql.connection = conn = OCI8.new("hr","hr","xe")
+    plsql.connection.exec <<-EOS
+      CREATE OR REPLACE PROCEDURE test_copy
+        ( p_from VARCHAR2, p_to OUT VARCHAR2, p_to_double OUT VARCHAR2 )
+      IS
+      BEGIN
+        p_to := p_from;
+        p_to_double := p_from || p_from;
+      END test_copy;
+    EOS
+  end
+  
+  after(:all) do
+    plsql.logoff
+  end
+  
+  it "should return array with output parameters" do
+    plsql.test_copy("abc", nil, nil).should == { :p_to => "abc", :p_to_double => "abcabc" }
+  end
+
+  it "should return array with output parameters when called with named parameters" do
+    plsql.test_copy(:p_from => "abc", :p_to => nil, :p_to_double => nil).should == { :p_to => "abc", :p_to_double => "abcabc" }
+  end
+
+end

data/spec/plsql/schema_spec.rb

@@ -0,0 +1,68 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Schema" do
+  
+  it "should create Schema object" do
+    plsql.class.should == PLSQL::Schema
+  end
+  
+end
+
+describe "Connection" do
+  
+  before(:each) do
+    @conn = OCI8.new("hr","hr","xe")
+  end
+
+  after(:each) do
+    @conn.logoff
+  end
+
+  it "should connect to test database" do
+    plsql.connection = @conn
+    plsql.connection.should == @conn
+  end
+
+  it "should connect to test database using connection alias" do
+    plsql(:hr).connection = @conn
+    plsql(:hr).connection.should == @conn
+  end
+  
+  it "should return schema name" do
+    plsql.connection = @conn
+    plsql.schema_name.should == 'HR'
+  end
+
+  it "should return nil schema name if not connected" do
+    plsql(:xxx).schema_name.should == nil
+  end
+
+end
+
+describe "Named Schema" do
+  before(:all) do
+    @conn = OCI8.new("hr","hr","xe")
+    plsql.connection = @conn
+  end
+
+  after(:all) do
+    @conn.logoff
+  end
+
+  it "should find existing schema" do
+    plsql.hr.class.should == PLSQL::Schema
+  end
+
+  it "should have the same connection as default schema" do
+    plsql.hr.connection.should == @conn
+  end
+
+  it "should return schema name" do
+    plsql.hr.schema_name.should == 'HR'
+  end
+
+  it "should not find named schema if specified twice" do
+    lambda { plsql.hr.hr }.should raise_error(ArgumentError)
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+require File.expand_path(File.dirname(__FILE__) + "/../lib/ruby_plsql")

data/tasks/deployment.rake

@@ -0,0 +1,34 @@
+desc 'Release the website and new gem version'
+task :deploy => [:check_version, :website, :release] do
+  puts "Remember to create SVN tag:"
+  puts "svn copy svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/trunk " +
+    "svn+ssh://#{rubyforge_username}@rubyforge.org/var/svn/#{PATH}/tags/REL-#{VERS} "
+  puts "Suggested comment:"
+  puts "Tagging release #{CHANGES}"
+end
+
+desc 'Runs tasks website_generate and install_gem as a local deployment of the gem'
+task :local_deploy => [:website_generate, :install_gem]
+
+task :check_version do
+  unless ENV['VERSION']
+    puts 'Must pass a VERSION=x.y.z release version'
+    exit
+  end
+  unless ENV['VERSION'] == VERS
+    puts "Please update your version.rb to match the release version, currently #{VERS}"
+    exit
+  end
+end
+
+desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
+task :install_gem_no_doc => [:clean, :package] do
+  sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"
+end
+
+namespace :manifest do
+  desc 'Recreate Manifest.txt to include ALL files'
+  task :refresh do
+    `rake check_manifest | patch -p0 > Manifest.txt`
+  end
+end

data/tasks/environment.rake

@@ -0,0 +1,7 @@
+task :ruby_env do
+  RUBY_APP = if RUBY_PLATFORM =~ /java/
+    "jruby"
+  else
+    "ruby"
+  end unless defined? RUBY_APP
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/*"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/*/*_spec.rb']
+end

data/tasks/website.rake

@@ -0,0 +1,17 @@
+desc 'Generate website files'
+task :website_generate => :ruby_env do
+  (Dir['website/**/*.txt'] - Dir['website/version*.txt']).each do |txt|
+    sh %{ #{RUBY_APP} script/txt2html #{txt} > #{txt.gsub(/txt$/,'html')} }
+  end
+end
+
+desc 'Upload website files to rubyforge'
+task :website_upload do
+  host = "#{rubyforge_username}@rubyforge.org"
+  remote_dir = "/var/www/gforge-projects/#{PATH}/"
+  local_dir = 'website'
+  sh %{rsync -aCv #{local_dir}/ #{host}:#{remote_dir}}
+end
+
+desc 'Generate and upload website files'
+task :website => [:website_generate, :website_upload, :publish_docs]

data/website/index.html

@@ -0,0 +1,110 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <link rel="stylesheet" href="stylesheets/screen.css" type="text/css" media="screen" />
+  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  <title>
+      Ruby API for PL/SQL
+  </title>
+  <script src="javascripts/rounded_corners_lite.inc.js" type="text/javascript"></script>
+<style>
+
+</style>
+  <script type="text/javascript">
+    window.onload = function() {
+      settings = {
+          tl: { radius: 10 },
+          tr: { radius: 10 },
+          bl: { radius: 10 },
+          br: { radius: 10 },
+          antiAlias: true,
+          autoPad: true,
+          validTags: ["div"]
+      }
+      var versionBox = new curvyCorners(settings, document.getElementById("version"));
+      versionBox.applyCornersToAll();
+    }
+  </script>
+</head>
+<body>
+<div id="main">
+
+    <h1>Ruby API for PL/SQL</h1>
+    <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/ruby-plsql"; return false'>
+      <p>Get Version</p>
+      <a href="http://rubyforge.org/projects/ruby-plsql" class="numbers">0.1.0</a>
+    </div>
+    <h1>&#x2192; &#8216;ruby-plsql&#8217;</h1>
+
+
+	<h2>What</h2>
+
+
+	<p>ruby-plsql gem provides simple Ruby <span class="caps">API</span> for calling Oracle PL/SQL procedures. This gem requires ruby-oci8 for connection to Oracle database.</p>
+
+
+	<h2>Installing</h2>
+
+
+	<p><pre class='syntax'><span class="ident">sudo</span> <span class="ident">gem</span> <span class="ident">install</span> <span class="ident">ruby</span><span class="punct">-</span><span class="ident">plsql</span></pre></p>
+
+
+	<h2>The basics</h2>
+
+
+	<p>Read <a href="http://blog.rayapps.com/2008/03/15/ruby-plsql-gem-simple-ruby-api-for-plsql-procedures/">this blog post first.</a></p>
+
+
+	<p>Usage examples:</p>
+
+
+	<p><pre class='syntax'>
+<span class="ident">require</span> <span class="punct">&quot;</span><span class="string">ruby_plsql</span><span class="punct">&quot;</span>
+
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">connection</span> <span class="punct">=</span> <span class="constant">OCI8</span><span class="punct">.</span><span class="ident">new</span><span class="punct">(&quot;</span><span class="string">hr</span><span class="punct">&quot;,&quot;</span><span class="string">hr</span><span class="punct">&quot;,&quot;</span><span class="string">xe</span><span class="punct">&quot;)</span>
+
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">test_uppercase</span><span class="punct">('</span><span class="string">xxx</span><span class="punct">')</span>              <span class="comment"># =&gt; &quot;XXX&quot;</span>
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">test_uppercase</span><span class="punct">(</span><span class="symbol">:p_string</span> <span class="punct">=&gt;</span> <span class="punct">'</span><span class="string">xxx</span><span class="punct">')</span> <span class="comment"># =&gt; &quot;XXX&quot;</span>
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">test_copy</span><span class="punct">(&quot;</span><span class="string">abc</span><span class="punct">&quot;,</span> <span class="constant">nil</span><span class="punct">,</span> <span class="constant">nil</span><span class="punct">)</span>         <span class="comment"># =&gt; { :p_to =&gt; &quot;abc&quot;, :p_to_double =&gt; &quot;abcabc&quot; }</span>
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">test_copy</span><span class="punct">(</span><span class="symbol">:p_from</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">abc</span><span class="punct">&quot;,</span> <span class="symbol">:p_to</span> <span class="punct">=&gt;</span> <span class="constant">nil</span><span class="punct">,</span> <span class="symbol">:p_to_double</span> <span class="punct">=&gt;</span> <span class="constant">nil</span><span class="punct">)</span>
+                                         <span class="comment"># =&gt; { :p_to =&gt; &quot;abc&quot;, :p_to_double =&gt; &quot;abcabc&quot; }</span>
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">hr</span><span class="punct">.</span><span class="ident">test_uppercase</span><span class="punct">('</span><span class="string">xxx</span><span class="punct">')</span>           <span class="comment"># =&gt; &quot;XXX&quot;</span>
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">test_package</span><span class="punct">.</span><span class="ident">test_uppercase</span><span class="punct">('</span><span class="string">xxx</span><span class="punct">')</span> <span class="comment"># =&gt; 'XXX'</span>
+
+<span class="ident">plsql</span><span class="punct">.</span><span class="ident">logoff</span>
+</pre></p>
+
+
+	<p>See more examples in RSpec tests in spec directory of gem.</p>
+
+
+	<h2>Feedback</h2>
+
+
+	<p>Submit your feedback as comments <a href="http://blog.rayapps.com/2008/03/15/ruby-plsql-gem-simple-ruby-api-for-plsql-procedures/">here.</a></p>
+
+
+	<h2>How to submit patches</h2>
+
+
+	<p>Submit bugs and patches to <a href="http://rubyforge.org/tracker/?group_id=5816">RubyForge</a></p>
+
+
+	<p>The trunk repository is <code>http://ruby-plsql.rubyforge.org/svn/</code> for anonymous access.</p>
+
+
+	<h2>License</h2>
+
+
+	<p>This code is free to use under the terms of the <span class="caps">MIT</span> license.</p>
+    <p class="coda">
+      <a href="http://blog.rayapps.com">Raimonds Simanovskis</a>, 16th March 2008<br>
+      Theme extended from <a href="http://rb2js.rubyforge.org/">Paul Battley</a>
+    </p>
+</div>
+
+<!-- insert site tracking codes here, like Google Urchin -->
+
+</body>
+</html>