vorax 0.1.0pre

data/spec/sql/drop_user.sql

@@ -0,0 +1,10 @@
+set verify off
+set feedback off
+
+prompt Dropping VORAX_TEST user...
+
+drop user vorax_test cascade;
+
+prompt Done.
+
+quit

data/spec/sql/muci.spc

@@ -0,0 +1,24 @@
+create or replace package muci as
+  
+  MY_CONSTANT1 constant varchar2(100) := 'abc';
+  MY_CONSTANT2 constant integer := 10;
+
+  ex_no_data_found exception;
+  pragma exception_init(ex_no_data_found, -20000);
+
+  ex_custom exception;
+  pragma exception_init(ex_custom, -20001);
+
+  cursor my_cursor is
+    select * from user_tables;
+
+  type population_type is table of varchar2(100);
+
+  g_var1 integer;
+  g_var2 varchar2(100) := 'xyz';
+
+  procedure my_proc(p1 integer);
+  function my_func(param1 varchar2, param2 boolean := true) return boolean;
+
+end;
+/

data/spec/sql/setup_user.sql

@@ -0,0 +1,22 @@
+set verify off
+set feedback off
+
+prompt Create VORAX_TEST user
+
+grant create session, 
+      create table, 
+      create view,
+      create sequence,
+      create procedure,
+      create type,
+      create synonym,
+      unlimited tablespace
+   to vorax_test identified by xxx;
+
+grant select on v_$sesstat to vorax_test;
+grant select on v_$statname to vorax_test;
+grant select on v_$mystat to vorax_test;
+
+prompt Done.
+
+quit

data/spec/sql/test.pkg

@@ -0,0 +1,67 @@
+create or replace package test as
+
+  g_var varchar2(100);
+
+  procedure test(p1 integer);
+  function muci(x varchar2, y clob) return boolean;
+
+end test;
+/
+
+create or replace package body test as
+
+  lg_var_private varchar2(100);
+  
+  procedure private_proc(p integer) as
+
+    l_var varchar2(100);
+
+    /* local function */
+    funzcction abc return boolean as
+    begin
+      return true;
+    end;
+    
+    procedure xyz as
+    begin
+      null;
+    end;
+
+  begin
+    l_var := 'abc';
+    for x in (select * from dual) loop
+      null;
+    end loop;
+    select dummy into l_var from dual;
+    if l_var is not null then
+      dbms_output.put_line('yessss baby!');
+    end if;
+    dbms_output.put_line('a loop is following');
+    loop
+      exit when l_var = 'X';
+      dbms_output.put_line('should not be here');
+    end loop;
+    dbms_output.put_line('that''s all folks!');
+  end;
+
+  procedure test(p1 integer) as
+  begin
+    dbms_output.put_line('just a test');
+    begin
+      null;
+    exception
+      when others then
+        null;
+    end;
+  end;
+
+  function muci(x varchar2, y clob) return boolean as
+  begin
+    return false;
+  end;
+
+begin
+  g_var := 'test';
+end test;
+/
+

data/spec/sqlplus_spec.rb

@@ -0,0 +1,52 @@
+# encoding: UTF-8
+
+include Vorax
+
+describe 'sqlplus' do
+
+  before(:each) do# {{{
+    @sp = Sqlplus.new('sqlplus')
+    @prep = [VORAX_CSTR, 
+             "set tab off", 
+             "set linesize 10000", 
+             "set echo off",
+             "set pause off",
+             "set define &",
+             "set termout on",
+             "set verify off",
+             "set pagesize 4"].join("\n")
+    @result = ""
+  end# }}}
+
+  it 'should work with utf8' do# {{{
+    @sp.exec('select name from employees where id=1;', :prep => @prep + "\ncolumn name format a20")
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = "
+SQL> 
+NAME
+--------------------
+Tică Șerban
+
+SQL> "
+    @result.should eq(expected)
+  end# }}}
+
+  it 'should work with substitution variables' do# {{{
+    begin
+      pack_file = Tempfile.new(['vorax', '.sql'])
+      @sp.exec("accept var prompt \"Enter var: \"\nprompt &var", :prep => @prep, :pack_file => pack_file.path)
+      Timeout::timeout(10) {
+        @result << @sp.read_output(32767) while @result !~ /Enter var: \z/
+        @sp.send_text("muci\n")
+        @result << @sp.read_output(32767) while @result !~ /muci\n\z/
+      }
+    ensure
+      pack_file.unlink
+    end
+  end# }}}
+
+  after(:each) do# {{{
+    @sp.terminate
+  end# }}}
+
+end

data/spec/stmt_inspector_spec.rb

@@ -0,0 +1,84 @@
+# encoding: UTF-8
+
+include Vorax
+include Parser
+
+describe 'stmt_inspector' do
+
+  it 'should work with a complex query' do# {{{
+    text = '
+      with 
+        tab as (select * from dba_users), 
+        t2 as (select * from v$session) 
+      select d.*, c.table_name
+        from sys.dual  d  inner join
+             (select c. from cat c) c on (d.c = c.c) outer join
+             dba_tables on (x=y)
+      union
+      select t.*, x
+        from muci t, buci 
+      where 1=2;
+    '
+    #puts text
+    inspector = StmtInspector.new(text)
+    #pp inspector.data_source
+    inspector.data_source.size.should == 7
+    inspector.data_source.should include(ExprRef.new("select * from dba_users", (29..51), "tab"))
+    inspector.data_source.should include(ExprRef.new("select * from v$session", (71..93), "t2"))
+    inspector.data_source.should include(TableRef.new("sys.dual", "d"));
+    inspector.data_source.should include(ExprRef.new("select c. from cat c", (179..198), 'c'));
+    inspector.data_source.should include(TableRef.new("dba_tables", nil));
+    inspector.data_source.should include(TableRef.new("muci", "t"));
+    inspector.data_source.should include(TableRef.new("buci", nil));
+    inspector.query_fields.should eq(["d.*", "c.table_name"])
+  end# }}}
+
+  it 'should get alias on an inner context' do# {{{
+    text = '
+      with 
+        tab as (select * from dba_users), 
+        t2 as (select * from v$session) 
+      select d.*, c.table_name
+        from sys.dual  d  inner join
+             (select * from (select * from cat) c) c on (d.c = c.c) outer join
+             dba_tables on (x=y)
+      union
+      select t.*, x
+        from muci t, buci 
+      where 1=2;
+    '
+    inspector = StmtInspector.new(text)
+    ds = inspector.data_source(186);
+    ds.size.should == 8
+    ds.should include(ExprRef.new("select * from cat", (15..31), "c"))
+    ds.should include(ExprRef.new("select * from dba_users", (29..51), "tab"))
+    ds.should include(ExprRef.new("select * from v$session", (71..93), "t2"))
+    ds.should include(TableRef.new("sys.dual", "d"));
+    ds.should include(ExprRef.new("select * from (select * from cat) c", (179..213), 'c'));
+    ds.should include(TableRef.new("dba_tables", nil));
+    ds.should include(TableRef.new("muci", "t"));
+    ds.should include(TableRef.new("buci", nil));
+  end# }}}
+
+  it 'should get columns for the provided alias' do# {{{
+    text = '
+      with 
+        tab as (select * from (select user_id, user_name, password, x.* from dba_users, (select c1, c2, from dual) x)), 
+        t2 as (select * from v$session) 
+      select d.*, c.table_name
+        from sys.dual  d  inner join
+             (select * from (select * from cat) c) c on (d.c = c.c) outer join
+             dba_tables on (x=y)
+      union
+      select t.*, x.*
+        from muci t, buci x
+      where 1=2;
+    '
+    inspector = StmtInspector.new(text)
+    inspector.find_alias('x', 0).columns.should eq(["buci.*"])
+    inspector.find_alias('x', 63).columns.should eq(["c1", "c2"])
+    inspector.find_alias('tab', 0).columns.should eq(["user_id", "user_name", "password", "c1", "c2"])
+  end# }}}
+
+end
+

data/spec/tablezip_spec.rb

@@ -0,0 +1,111 @@
+# encoding: UTF-8
+
+include Vorax
+
+describe 'tablezip layout' do
+
+  before(:each) do# {{{
+    @sp = Sqlplus.new('sqlplus')
+    @sp.default_convertor = :tablezip
+    @prep = [VORAX_CSTR, 
+             "set tab off", 
+             "set linesize 10000", 
+             "set markup html on", 
+             "set echo off",
+             "set pause off",
+             "set define &",
+             "set termout on",
+             "set verify off",
+             "set pagesize 4"].join("\n")
+    @result = ""
+  end# }}}
+
+  it 'should work with multiple statements' do# {{{
+    @sp.exec("select * from dual;\nselect * from departments where id <= 2;", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+DUM
+---
+X  
+
+SQL>
+
+ID NAME        DESCRIPTION                        
+-- ----------- -----------------------------------
+ 1 Bookkeeping This department is responsible for:
+               - financial reporting              
+               - analysis                         
+               - other boring tasks               
+ 2 Marketing                                      
+
+SQL>
+OUTPUT
+    #puts @result
+    @result.should eq(expected)
+  end# }}}
+
+  it 'should work with multi line records' do# {{{
+    @sp.exec("select * from departments where id <= 10;", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+ID NAME             DESCRIPTION                        
+-- ---------------- -----------------------------------
+ 1 Bookkeeping      This department is responsible for:
+                    - financial reporting              
+                    - analysis                         
+                    - other boring tasks               
+ 2 Marketing                                           
+ 3 Deliveries                                          
+ 4 CRM                                                 
+
+ID NAME             DESCRIPTION                        
+-- ---------------- -----------------------------------
+ 5 Legal Stuff                                         
+ 6 Management       The bad guys department            
+ 7 Cooking                                             
+ 8 Public Relations                                    
+
+ID NAME             DESCRIPTION                        
+-- ---------------- -----------------------------------
+ 9 Aquisitions                                         
+10 Cleaning                                            
+
+10 rows selected.
+
+SQL>
+OUTPUT
+    @result.should eq(expected)
+  end# }}}
+
+it 'should work with accept prompts' do# {{{
+  begin
+    pack_file = Tempfile.new(['vorax', '.sql'])
+    @sp.exec("accept var prompt \"Enter var: \"\nprompt &var", :prep => @prep, :pack_file => pack_file.path)
+    Timeout::timeout(10) {
+      @result << @sp.read_output(32767) while @result !~ /Enter var:\z/
+      @sp.send_text("muci\n")
+      @result << @sp.read_output(32767) while @result !~ /muci\n\z/
+    }
+  ensure
+    pack_file.unlink
+  end
+end# }}}
+
+it 'should work with <pre> tags' do# {{{
+    @sp.exec("set autotrace traceonly explain\nselect * from dual;", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    @result.should match(/SELECT STATEMENT/)
+end# }}}
+
+  after(:each) do# {{{
+    @sp.terminate
+  end# }}}
+
+end
+

data/spec/vertical_spec.rb

@@ -0,0 +1,150 @@
+# encoding: UTF-8
+
+include Vorax
+
+describe 'vertical layout' do
+
+  before(:each) do# {{{
+    @sp = Sqlplus.new('sqlplus')
+    @sp.default_convertor = :vertical
+    @prep = [VORAX_CSTR, 
+             "set tab off", 
+             "set linesize 10000", 
+             "set markup html on", 
+             "set echo off",
+             "set pause off",
+             "set define &",
+             "set termout on",
+             "set verify off",
+             "set pagesize 4"].join("\n")
+    @result = ""
+  end# }}}
+
+  it 'should work with pagesize=0' do# {{{
+    @sp.exec("select * from departments where id<=3;", :prep => @prep + "\nset pagesize 0")
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+ : 1
+ : Bookkeeping
+ : This department is responsible for:
+   - financial reporting
+   - analysis
+   - other boring tasks
+------------------------------------------------------------
+ : 2
+ : Marketing
+ :  
+------------------------------------------------------------
+ : 3
+ : Deliveries
+ :  
+------------------------------------------------------------
+
+SQL>
+OUTPUT
+    @result.should eq(expected)
+  end# }}}
+
+  it 'should work with unicode special chars' do# {{{
+    @sp.exec("select * from employees where id=1;", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+ID            : 1
+NAME          : Tică Șerban
+SALARY        : 570
+DEPARTMENT_ID : 1
+------------------------------------------------------------
+
+SQL>
+OUTPUT
+    #puts @result
+    @result.should eq(expected)
+  end# }}}
+
+  it 'should work with one single line record' do# {{{
+    @sp.exec("select * from departments where id=2;", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+ID          : 2
+NAME        : Marketing
+DESCRIPTION :  
+------------------------------------------------------------
+
+SQL>
+OUTPUT
+    @result.should eq(expected)
+  end# }}}
+
+  it 'should work with one multiline record' do# {{{
+    @sp.exec("select * from departments where id=1;", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+ID          : 1
+NAME        : Bookkeeping
+DESCRIPTION : This department is responsible for:
+              - financial reporting
+              - analysis
+              - other boring tasks
+------------------------------------------------------------
+
+SQL>
+OUTPUT
+    @result.should eq(expected)
+  end# }}}
+
+  it 'should work with multiple lines' do# {{{
+    @sp.exec("select * from departments where id in (1, 2);", :prep => @prep)
+    @result << @sp.read_output(32767) while @sp.busy?
+    expected = <<OUTPUT
+
+SQL>
+
+ID          : 1
+NAME        : Bookkeeping
+DESCRIPTION : This department is responsible for:
+              - financial reporting
+              - analysis
+              - other boring tasks
+------------------------------------------------------------
+ID          : 2
+NAME        : Marketing
+DESCRIPTION :  
+------------------------------------------------------------
+
+SQL>
+OUTPUT
+    @result.should eq(expected)
+  end# }}}
+
+it 'should work with accept prompts' do# {{{
+  begin
+    pack_file = Tempfile.new(['vorax', '.sql'])
+    @sp.exec("accept var prompt \"Enter var: \"\nprompt &var", :prep => @prep, :pack_file => pack_file.path)
+    Timeout::timeout(10) {
+      @result << @sp.read_output(32767) while @result !~ /Enter var:\z/
+      @sp.send_text("muci\n")
+      @result << @sp.read_output(32767) while @result !~ /muci\n\z/
+    }
+  ensure
+    pack_file.unlink
+  end
+end# }}}
+
+  after(:each) do# {{{
+    @sp.terminate
+  end# }}}
+
+end
+

data/vorax.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vorax/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "vorax"
+  gem.version       = Vorax::VERSION
+  gem.authors       = ["Alexandru Tica"]
+  gem.email         = ["alexandru.tica@gmail.com"]
+  gem.description   = %q{Provides the logic required by Vorax, an Oracle IDE for geeks. Even the main goal of this gem is to support Vorax, it can also be used as it is to interact with a hidden SqlPLUS process or to parse SQL/PLSQL code.}
+  gem.summary       = %q{Vorax ruby code companion.}
+  gem.homepage      = ""
+
+  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_development_dependency "rspec", "~> 2.6"
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: vorax
+version: !ruby/object:Gem::Version
+  version: 0.1.0pre
+  prerelease: 5
+platform: ruby
+authors:
+- Alexandru Tica
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: Provides the logic required by Vorax, an Oracle IDE for geeks. Even the
+  main goal of this gem is to support Vorax, it can also be used as it is to interact
+  with a hidden SqlPLUS process or to parse SQL/PLSQL code.
+email:
+- alexandru.tica@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vorax.rb
+- lib/vorax/base_funnel.rb
+- lib/vorax/output/html_convertor.rb
+- lib/vorax/output/html_funnel.rb
+- lib/vorax/output/pagezip_convertor.rb
+- lib/vorax/output/tablezip_convertor.rb
+- lib/vorax/output/vertical_convertor.rb
+- lib/vorax/output/zip_convertor.rb
+- lib/vorax/parser/argument.rb~
+- lib/vorax/parser/body_split.rb
+- lib/vorax/parser/conn_string.rb
+- lib/vorax/parser/grammars/alias.rb
+- lib/vorax/parser/grammars/alias.rl
+- lib/vorax/parser/grammars/column.rb
+- lib/vorax/parser/grammars/column.rl
+- lib/vorax/parser/grammars/common.rl
+- lib/vorax/parser/grammars/package_spec.rb
+- lib/vorax/parser/grammars/package_spec.rl
+- lib/vorax/parser/grammars/plsql_def.rb
+- lib/vorax/parser/grammars/plsql_def.rl
+- lib/vorax/parser/grammars/statement.rb
+- lib/vorax/parser/grammars/statement.rl
+- lib/vorax/parser/parser.rb
+- lib/vorax/parser/plsql_structure.rb
+- lib/vorax/parser/plsql_walker.rb
+- lib/vorax/parser/statement_inspector.rb~
+- lib/vorax/parser/stmt_inspector.rb
+- lib/vorax/parser/target_ref.rb
+- lib/vorax/sqlplus.rb
+- lib/vorax/version.rb
+- lib/vorax/vorax_io.rb
+- spec/column_spec.rb
+- spec/conn_string_spec.rb
+- spec/package_spec_spec.rb
+- spec/pagezip_spec.rb
+- spec/parser_spec.rb
+- spec/plsql_structure_spec.rb
+- spec/spec_helper.rb
+- spec/sql/create_objects.sql
+- spec/sql/dbms_crypto.spc
+- spec/sql/dbms_crypto.~spc
+- spec/sql/dbms_stats.spc
+- spec/sql/drop_user.sql
+- spec/sql/muci.spc
+- spec/sql/setup_user.sql
+- spec/sql/test.pkg
+- spec/sqlplus_spec.rb
+- spec/stmt_inspector_spec.rb
+- spec/tablezip_spec.rb
+- spec/vertical_spec.rb
+- vorax.gemspec
+homepage: ''
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Vorax ruby code companion.
+test_files:
+- spec/column_spec.rb
+- spec/conn_string_spec.rb
+- spec/package_spec_spec.rb
+- spec/pagezip_spec.rb
+- spec/parser_spec.rb
+- spec/plsql_structure_spec.rb
+- spec/spec_helper.rb
+- spec/sql/create_objects.sql
+- spec/sql/dbms_crypto.spc
+- spec/sql/dbms_crypto.~spc
+- spec/sql/dbms_stats.spc
+- spec/sql/drop_user.sql
+- spec/sql/muci.spc
+- spec/sql/setup_user.sql
+- spec/sql/test.pkg
+- spec/sqlplus_spec.rb
+- spec/stmt_inspector_spec.rb
+- spec/tablezip_spec.rb
+- spec/vertical_spec.rb
+has_rdoc: