oraora 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea908b533f803251dad4a3c654c32da376f4026b
-  data.tar.gz: 708a8b06e602feaf36619098b5f585d6bed3505a
+  metadata.gz: d0525a9154b0f168548f8ba6665cd7e7fc06cf53
+  data.tar.gz: 2ad2f0ad89db333bb18a66f7272927174cdbb1cd
 SHA512:
-  metadata.gz: d9d0bad778bd145d9244ce38bf32bfba433d6c259bca2669e8666657e2818cd953ca5f5ffae409c446b57da319b6cc8892739a4c2c2d3daefbd5fdc0c8dc64fc
-  data.tar.gz: 59cc924133dcafbbf68d78b70606a6fb3a3d63122cec05fed7c6a4c29794ab700f61ac1437a2240a02c92681e8d52db658e0e020a7f1b56751e533a14899b2cf
+  metadata.gz: 8af2df15ac1afaa55550df03bd388a1af6aeb50ef356c6a87d19ba28e4565f371f0e122dd3c111c2493f21d0e7f4ed498a46a35a03ea91f209cf3e361d602a1f
+  data.tar.gz: 8c0d894792da339c2074fd07de15968fa502b8d97f28ebe848ee50dc96cf29facf108f8ab79a3e88c789375ec6eeb09b906c219dafad6abc22c6f7a822b04fb4

data/README.md

@@ -23,6 +23,8 @@ If you don't have Ruby, check one-click installer for Windows or rvm for Linux.
 
 ## Usage
 
+### Connecting to database
+
 Start oraora passing connection string as argument, just like you would connect to SQL*Plus:
 ```
 $ oraora user/password@DB
@@ -94,41 +96,68 @@ Note: `l` is aliased as `ls`. `d` is aliased as `desc` and `describe`.
 
 ### SQL
 
-Any input starting with SQL keyword like `SELECT`, `INSERT`, `CREATE`, ... is recognized as SQL and passed to database
-for execution.
+Any command starting with SQL keyword like `SELECT`, `CREATE`, `ALTER`, etc. is treated as SQL and passed to
+database for execution
+
+```
+~ $ SELECT * FROM dual;
+D
+-
+X
+
+[INFO] 1 row(s) selected
+```
 
 ### Context-aware SQL
 
-When in specific context, you can omit some obvious parts of SQL statements. For example, in context of a table following
-statements will work:
+Within specific context, you can omit some obvious keywords or identifiers at the beginning of SQL statements.
+For example, in context of a table following statements will work:
 ```
-~.SOME_TABLE $ SELECT;                  # implicit '... FROM SOME_TABLE'
-~.SOME_TABLE $ WHERE col = 1;           # implicit 'SELECT * FROM SOME_TABLE ...'
-~.SOME_TABLE $ SET col = 2;             # implicit 'UPDATE SOME_TABLE ...'
-~.SOME_TABLE $ ADD x INTEGER;           # implicit 'ALTER TABLE SOME_TABLE ...'
+~.SOME_TABLE $ SELECT;                  # implicit 'SELECT * FROM SOME_TABLE'
+~.SOME_TABLE $ WHERE col = 1;           # implicit 'SELECT * FROM SOME_TABLE WHERE col = 1'
+~.SOME_TABLE $ SET col = 2;             # implicit 'UPDATE SOME_TABLE SET col = 2'
+~.SOME_TABLE $ ADD x INTEGER;           # implicit 'ALTER TABLE SOME_TABLE ADD x INTEGER'
 ```
 
 Some other examples:
 ```
-~ $ IDENTIFIED BY oraora;               # implicit 'ALTER USER xxx ...'
-~.SOME_TABLE.COL $ WHERE x = 1;         # implicit 'SELECT COL FROM SOME_TABLE ...'
+~ $ IDENTIFIED BY oraora;               # implicit 'ALTER USER xxx IDENTIFIED BY oraora'
+~.SOME_TABLE.COL $ WHERE x = 1;         # implicit 'SELECT COL FROM SOME_TABLE WHERE x = 1'
 ~.SOME_TABLE.COL $ RENAME TO kol;       # implicit 'ALTER TABLE SOME_TABLE RENAME COLUMN col TO kol'
 ```
 
+### Tab completion
+
+Oraora has bash-style tab completion - hit `<TAB>` to autocomplete current word with SQL keyword or context. If there are
+multiple possible completions hit `<TAB>` twice to see the list.
+
+Also there are several quick templates defined. For example, type `S*`, then hit `<TAB>` to expand it into
+`SELECT * FROM `. Available templates are as follows:
+
+```
+s  => SELECT
+s* => SELECT * FROM
+c* => SELECT COUNT(*) FROM
+i  => INSERT
+u  => UPDATE
+d  => DELETE
+a  => ALTER
+c  => CREATE
+cr => CREATE OR REPLACE
+```
+
 ### Su / sudo
 
 `su` and `sudo` allow to switch to SYS session temporarily or execute a single statement as SYS, similarly to their
 unix counterparts. If you don't have SYS password for current connection in orafile, you will be prompted for it.
 ```
-$ oraora foo@DB
-~ $ SELECT * FROM boo.test;
-ERROR: Insufficient privileges
-~ $ sudo GRANT SELECT ON boo.test TO foo;
-Grant succeeded.
-~ $ SELECT * FROM boo.test;
-text
-------------
-Hello world!
+$ oraora test@DB
+~ $ CREATE TABLE test (a INTEGER);
+[ERROR] ORA-01031: insufficient privileges at 0
+~ $ sudo GRANT CREATE TABLE TO test;
+[INFO] 0 row(s) affected
+~ $ CREATE TABLE test (a INTEGER);
+[INFO] 0 row(s) affected
 ```
 
 ## Limitations

data/bin/oraora

@@ -8,15 +8,19 @@ begin
   # Options
   options = { log_level: Logger::INFO }
 
-  OptionParser.new do |opts|
-    opts.banner = "Usage: oraora [options] connection"
+  option_parser = OptionParser.new do |opts|
+    opts.banner = "Usage: oraora [options] connection_string"
 
     opts.on("-l LEVEL", "--log-level=LEVEL", [:debug, :info, :warn, :error], "Set message verbosity (debug, info, warn, error)") do |l|
       options[:log_level] = Logger.const_get(l.upcase)
     end
 
     opts.on("-h", "--help", "Show this message") { |h| puts opts; exit }
-  end.parse!
+  end
+  option_parser.parse!
+
+  # Check arguments
+  raise ArgumentError if ARGV.length == 0
 
   # Logger
   logger = Oraora::Logger.new(STDOUT, options[:log_level])
@@ -39,6 +43,9 @@ begin
 rescue OptionParser::ParseError => e
   puts "Options error: " + e.message
 
+rescue ArgumentError
+  puts option_parser.help
+
 rescue Oraora::Credentials::ParseError => e
   puts "Invalid connection string: " + e.message
 

data/lib/oraora/app.rb

@@ -1,3 +1,4 @@
+
 module Oraora
   class App
     class InvalidCommand < StandardError; end
@@ -14,7 +15,7 @@ module Oraora
       USER SESSION SCHEMA SYSTEM DATABASE
       REPLACE AND OR
     )
-    ORAORA_KEYWORDS = %w(c cd l ls d desc describe x exit su sudo - -- --- . ! /)
+    ORAORA_KEYWORDS = %w(c cd l ls d desc describe x exit su sudo - -- --- . ! ? /)
 
     attr_reader :meta, :context
 
@@ -32,6 +33,7 @@ module Oraora
       # Connect to Oracle
       @logger.debug "Connecting: #{@credentials}" + (@role ? " as #{@role}" : '')
       logon
+      @logger.info "Oraora v#{VERSION}. Type '?' for quick help"
       @user ||= @oci.username
       @context ||= Context.new(@user, schema: @user)
 
@@ -73,7 +75,7 @@ module Oraora
 
           rescue Interrupt
             if Time.now - last_interrupt < 2
-              @logger.warn "Exit on CTRL+C, "
+              @logger.warn "Exit on CTRL+C"
               terminate
             else
               @logger.warn "CTRL+C, hit again within 2 seconds to quit"
@@ -237,6 +239,10 @@ module Oraora
           @logger.debug "Command type: metadata refresh"
           @meta.purge_cache
 
+        when '?'
+          @logger.debug "Command type: help"
+          puts(HELP)
+
         # Unknown
         else
           raise InvalidCommand, "Invalid command: #{$1}"

data/lib/oraora/help.rb

@@ -0,0 +1,23 @@
+require 'oraora/completion'
+
+module Oraora
+  HELP = <<-HERE.reset_indentation
+    Oraora v#{VERSION} - https://github.com/kmehkeri/oraora
+
+    Commands reference:
+      c / cd [path]-        Change context (or home schema if path not provided)
+      l / ls [path]         List in path (or current context)
+      d / desc / describe   Describe path (or current context)
+      x / exit              Exit
+      sudo [command]        Execute a single command as SYS
+      su                    Spawn a subshell using SYS username
+      - / -- / ---          Navigate 1/2/3 levels up
+      .                     Navigate to database root
+      !                     Refresh metadata
+      ?                     Display this help
+      SELECT ...            or any other SQL keyword - execute
+
+    Quick templates (type then press <TAB> to expand):
+      #{Completion::TEMPLATES.collect { |template, expansion| "%-3s => %s" % [template, expansion] }.join("\n      ")}
+  HERE
+end

data/lib/oraora/version.rb

@@ -0,0 +1,3 @@
+module Oraora
+  VERSION = '0.1.1'
+end

data/oraora.gemspec

@@ -1,22 +1,27 @@
+require './lib/oraora/version'
+
 Gem::Specification.new do |s|
   s.name        = 'oraora'
-  s.version     = '0.1.0'
+  s.version     = Oraora::VERSION
   s.summary     = "Interactive command-line utility for Oracle"
-  s.description = "Interactive command-line utility for Oracle"
+  s.description = <<-EOS
+    SQL*Plus replacement for interactive work with Oracle, with tab-completion, colored output,
+    metadata navigation with context-aware SQL and more features
+  EOS
 
   s.author      = "kmehkeri"
   s.email       = 'kmehkeri@gmail.com'
-  s.homepage    = 'http://rubygems.org/gems/oraora'
+  s.homepage    = 'https://github.com/kmehkeri/oraora'
   s.license     = 'MIT'
 
   s.files       = `git ls-files`.split($/)
   s.executables = `git ls-files -- bin`.split($/).map { |f| File.basename(f)  }
 
-  s.add_runtime_dependency 'highline'
-  s.add_runtime_dependency 'ruby-oci8'
-  s.add_runtime_dependency 'indentation'
-  s.add_runtime_dependency 'colorize'
-  s.add_runtime_dependency 'bigdecimal'
+  s.add_runtime_dependency 'highline', '~> 1'
+  s.add_runtime_dependency 'ruby-oci8', '~> 2'
+  s.add_runtime_dependency 'indentation', '~> 0'
+  s.add_runtime_dependency 'colorize', '~> 0'
+  s.add_runtime_dependency 'bigdecimal', '~> 1'
 
-  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec', '~> 3'
 end

metadata

@@ -1,107 +1,109 @@
 --- !ruby/object:Gem::Specification
 name: oraora
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - kmehkeri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 00:00:00.000000000 Z
+date: 2015-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: ruby-oci8
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: indentation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bigdecimal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Interactive command-line utility for Oracle
+        version: '3'
+description: |2
+      SQL*Plus replacement for interactive work with Oracle, with tab-completion, colored output,
+      metadata navigation with context-aware SQL and more features
 email: kmehkeri@gmail.com
 executables:
 - oraora
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - LICENSE
 - README.md
 - bin/oraora
@@ -111,6 +113,7 @@ files:
 - lib/oraora/completion.rb
 - lib/oraora/context.rb
 - lib/oraora/credentials.rb
+- lib/oraora/help.rb
 - lib/oraora/logger.rb
 - lib/oraora/meta.rb
 - lib/oraora/meta/column.rb
@@ -124,10 +127,11 @@ files:
 - lib/oraora/meta/view.rb
 - lib/oraora/oci.rb
 - lib/oraora/terminal.rb
+- lib/oraora/version.rb
 - oraora.gemspec
 - spec/context_spec.rb
 - spec/credentials_spec.rb
-homepage: http://rubygems.org/gems/oraora
+homepage: https://github.com/kmehkeri/oraora
 licenses:
 - MIT
 metadata: {}
@@ -137,17 +141,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Interactive command-line utility for Oracle