rsql 0.2.4 → 0.2.5

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (C) 2011 by brad+rsql@gigglewax.com
+Copyright (C) 2011-2012 by brad+rsql@gigglewax.com
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.rdoc

@@ -100,7 +100,7 @@ downloaded with the source.
 
 RSQL is licensed under the MIT License:
 
-Copyright (C) 2011 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
+Copyright (C) 2011-2012 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/bin/rsql

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-# Copyright (C) 2011 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
+# Copyright (C) 2011-2012 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -52,6 +52,9 @@ bn = File.basename($0, '.rb')
 
 eval_context = EvalContext.new
 
+# rewrite all double hyphen options into singles so both are supported
+ARGV.map!{|a| a.sub(/^--/,'-')}
+
 if i = ARGV.index('-rc')
     ARGV.delete_at(i)
     rc_fn = ARGV.delete_at(i)
@@ -146,13 +149,25 @@ end
 
 if i = ARGV.index('-ssh')
     require 'net/ssh'
+
     ARGV.delete_at(i)
+
     (ssh_host, ssh_user, ssh_password, ssh_port) = split_login(ARGV.delete_at(i))
+
+    default_config = File.join(ENV['HOME'], '.ssh', 'config')
+    if File.exists?(default_config)
+        ssh_cfghash = Net::SSH::Config.load(default_config, ssh_host)
+    end
+
+    if ssh_user.nil? || ssh_user.empty?
+        ssh_user = ssh_cfghash['user'] || ENV['USER'] || ENV['USERNAME']
+    end
 end
 
 if i = ARGV.index('-sshconfig')
     ARGV.delete_at(i)
     ssh_config = ARGV.delete_at(i)
+    ssh_cfghash = Net::SSH::Config.load(ssh_config, ssh_host)
 end
 
 if i = ARGV.index('-e')
@@ -167,7 +182,15 @@ if i = ARGV.index('-e')
     batch_input.strip!
 end
 
-if ARGV.size < 1
+show_usage = false
+ARGV.each do |a|
+    if a.start_with?('-')
+        $stderr.puts "unknown argument: #{a}"
+        show_usage = true
+    end
+end
+
+if ARGV.size < 1 || show_usage
     prefix = '        ' << ' ' * bn.size
     $stderr.puts <<USAGE
 
@@ -203,7 +226,8 @@ end
 
 MySQLResults.database_name = ARGV.shift
 
-unless $stdin.tty?
+if !$stdin.tty? && batch_input.nil?
+    # accept commands from stdin
     batch_input = $stdin.read.gsub(/\r?\n/,';')
 end
 
@@ -262,8 +286,9 @@ if ssh_host
     ssh_pid = Process.fork do
         File.open(ipc_fn,'w'){|f| f.puts('start')}
         ssh_enabled = false
-        Signal.trap('INT') do
-            $stderr.puts 'Shutting down...' unless batch_input
+        Signal.trap('INT', 'IGNORE')
+        Signal.trap('TERM') do
+            $stderr.puts 'Closing SSH connection...' unless batch_input
             ssh_enabled = false
         end
         opts = {:timeout => 15}
@@ -271,9 +296,7 @@ if ssh_host
         if verbose
             opts[:verbose] = :debug
             puts "SSH options: #{opts.inspect}"
-            if ssh_config
-                puts "SSH config: #{Net::SSH::Config.load(ssh_config, ssh_host).inspect}"
-            end
+            puts "SSH config: #{ssh_cfghash.inspect}"
         end
         begin
             opts[:password] = ssh_password if ssh_password
@@ -292,20 +315,44 @@ if ssh_host
                     retry
                 end
             end
+        rescue Timeout::Error => ex
+            $stderr.puts ex.message
+        ensure
+            if ssh_enabled
+                ssh.forward.local(mysql_port, mysql_host, remote_mysql_port)
+                unless batch_input
+                    puts(verbose ? "ready (#{mysql_port} => #{remote_mysql_port})" : 'ready')
+                end
+                File.open(ipc_fn,'w'){|f| f.puts('ready')}
+                ssh.loop(1) { ssh_enabled }
+            end
+            File.open(ipc_fn,'w'){|f| f.puts('fail')}
         end
-        if ssh_enabled
-            ssh.forward.local(mysql_port, mysql_host, remote_mysql_port)
-            unless batch_input
-                puts(verbose ? "ready (#{mysql_port} => #{remote_mysql_port})" : 'ready')
+    end
+
+    at_exit do
+        if ssh_pid && 0 <= ssh_pid
+            begin
+                Process.kill('TERM', ssh_pid)
+                killed = false
+                5.times do
+                    if Process.waitpid(ssh_pid, Process::WNOHANG)
+                        killed = true
+                        break
+                    end
+                    sleep 1
+                end
+                Process.kill('KILL', ssh_pid) unless killed
+            rescue Exception => ex
+                $stderr.puts ex.message
+                $stderr.puts ex.backtrace if verbose
             end
-            File.open(ipc_fn,'w'){|f| f.puts('ready')}
-            ssh.loop(1) { ssh_enabled }
         end
-        File.open(ipc_fn,'w'){|f| f.puts('fail')}
+        File.unlink(ipc_fn) if File.exists?(ipc_fn)
     end
 
     ipc_state = ''
-    60.times do
+    15.times do
         sleep(1)
         File.open(ipc_fn,'r'){|f| ipc_state = f.gets.strip}
         break if ipc_state == 'ready' || ipc_state == 'fail'
@@ -314,6 +361,8 @@ if ssh_host
     File.unlink(ipc_fn)
 
     unless ipc_state == 'ready'
+        # give the child time to exit
+        sleep(0.5)
         $stderr.puts "failed to connect to #{ssh_host} SSH host"
         exit 1
     end
@@ -332,6 +381,7 @@ mysql_conn = "#{mysql_host}:#{remote_mysql_port || mysql_port}"
 begin
     MySQLResults.conn = Mysql.new(mysql_host, mysql_user, mysql_password,
                                   MySQLResults.database_name, mysql_port)
+    MySQLResults.conn.reconnect = true
     puts 'connected' unless batch_input
 rescue Mysql::Error => ex
     if ex.message.include?('Client does not support authentication')
@@ -377,7 +427,7 @@ cmd_thread = Thread.new do
         else
             puts '',"[#{mysql_user}@#{ssh_host||mysql_host}:#{MySQLResults.database_name}]"
             input = ''
-            prompt = bn + '> '
+            prompt = eval_context.prompt || (bn + '> ')
             loop do
                 str = Readline.readline(prompt)
                 if str.nil?
@@ -410,28 +460,37 @@ cmd_thread = Thread.new do
             next
         end
 
-        me[:running] = true
         break if cmds.run!(eval_context) == :done
-        me[:running] = false
     end
 end
 
+# keep a secondary connection to allow us to kill off a running query
+kill_conn = Mysql.new(mysql_host, mysql_user, mysql_password,
+                      MySQLResults.database_name, mysql_port)
+
 Signal.trap('INT') do
-    if cmd_thread[:running] && MySQLResults.conn
-        $stderr.puts 'Interrupting MySQL query...'
-        safe_timeout(MySQLResults.conn, :close, 'MySQL')
-        MySQLResults.conn = nil
+    # emulate MySQL's behavior
+    if MySQLResults.conn && MySQLResults.conn.busy?
+        tid = MySQLResults.conn.thread_id
+        $stderr.puts "Ctrl-C -- sending \"KILL QUERY #{tid}\" to server..."
+        kill_conn.kill(tid)
+        10.times do
+            break unless MySQLResults.conn.busy?
+            sleep(0.5)
+        end
+        MySQLResults.conn.select_db(MySQLResults.database_name)
+    else
+        $stderr.puts 'Ctrl-C -- exit!'
+        cmd_thread[:shutdown] = true
+        sleep(0.3)
+        cmd_thread.kill
     end
-    $stderr.puts 'Shutting down...'
-    cmd_thread[:shutdown] = true
-    sleep(0.3)
-    cmd_thread.kill
 end
 
 Signal.trap('CHLD') do
     $stderr.puts "SSH child (#{ssh_pid}) stopped--shutting down..."
-    if cmd_thread[:running] && MySQLResults.conn
-        $stderr.puts 'Interrupting MySQL query...'
+    if MySQLResults.conn && MySQLResults.conn.busy?
+        $stderr.puts 'Closing MySQL connection...'
         safe_timeout(MySQLResults.conn, :close, 'MySQL')
         MySQLResults.conn = nil
     end
@@ -461,13 +520,3 @@ if Readline::HISTORY.any?
     end
     File.open(history_fn, 'w') {|f| YAML.dump(Readline::HISTORY.to_a, f)}
 end
-
-if ssh_pid && 0 <= ssh_pid
-    begin
-        Process.kill('INT', ssh_pid)
-        Process.waitpid(ssh_pid)
-    rescue Exception => ex
-        $stderr.puts ex.message
-        $stderr.puts ex.backtrace if verbose
-    end
-end

data/lib/rsql.rb

@@ -2,7 +2,7 @@
 # Commands using an EvalContext for handling recipes.
 #
 module RSQL
-    VERSION = '0.2.4'
+    VERSION = '0.2.5'
 
     require 'rsql/mysql_results'
     require 'rsql/eval_context'

data/lib/rsql/commands.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (C) 2011 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
+# Copyright (C) 2011-2012 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -82,7 +82,11 @@ module RSQL
                             match_before_bang = nil
                             break
                         end
-                        new_bangs[key.strip] = val.to_sym
+                        if val.strip == 'nil'
+                            new_bangs[key.strip] = nil
+                        else
+                            new_bangs[key.strip] = val.to_sym
+                        end
                     end
                     next unless match_before_bang
                     match = match_before_bang
@@ -145,10 +149,16 @@ module RSQL
                     results.send(cmd.displayer)
                 elsif EvalResults === results
                     last_results = nil
-                    if results.stdout && 0 < results.stdout.size
-                        puts results.stdout.string
+                    if MySQLResults === results.value
+                        # This happens if their recipe returns MySQL
+                        # results...just display it like above.
+                        results.value.send(cmd.displayer)
+                    else
+                        if results.stdout && 0 < results.stdout.size
+                            puts results.stdout.string
+                        end
+                        puts "=> #{results.value.inspect}" if results.value
                     end
-                    puts "=> #{results.value.inspect}" if results.value
                 end
             end
         end
@@ -213,7 +223,8 @@ module RSQL
                     begin
                         last_results = MySQLResults.query(value, eval_context)
                     rescue MySQLResults::MaxRowsException => ex
-                        $stderr.puts "refusing to process #{ex.rows} rows (max: #{ex.max})"
+                        $stderr.puts "refusing to process #{ex.rows} rows (max: #{ex.max})--" <<
+                            "consider raising this via set_max_rows"
                     rescue Mysql::Error => ex
                         $stderr.puts ex.message
                     rescue Exception => ex

data/lib/rsql/eval_context.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (C) 2011 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
+# Copyright (C) 2011-2012 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -24,8 +24,8 @@ module RSQL
     require 'time'
 
     ################################################################################
-    # This class wraps all dynamic evaluation and serves as the reflection
-    # class for adding methods dynamically.
+    # This class wraps all dynamic evaluation and serves as the reflection class
+    # for adding methods dynamically.
     #
     class EvalContext
 
@@ -35,19 +35,26 @@ module RSQL
         HEXSTR_LIMIT = 32
 
         def initialize(verbose=false)
+            @prompt       = nil
             @verbose      = verbose
             @hexstr_limit = HEXSTR_LIMIT
             @results      = nil
 
             @loaded_fns         = []
+            @loaded_fns_state   = {}
             @init_registrations = []
             @bangs              = {}
+            @global_bangs       = {}
 
             @registrations = {
                 :version => Registration.new('version', [], {},
                     method(:version),
                     'version',
                     'Version information about RSQL, the client, and the server.'),
+                :help => Registration.new('help', [], {},
+                    method(:help),
+                    'help',
+                    'Show short syntax help.'),
                 :reload => Registration.new('reload', [], {},
                     method(:reload),
                     'reload',
@@ -71,6 +78,7 @@ module RSQL
             }
         end
 
+        attr_reader :prompt
         attr_accessor :bangs, :verbose
 
         def call_init_registrations
@@ -82,6 +90,9 @@ module RSQL
         end
 
         def load(fn, opt=nil)
+            @loaded_fns << fn unless @loaded_fns_state.key?(fn)
+            @loaded_fns_state[fn] = :loading
+
             # this should only be done after we have established a
             # mysql connection, so this option allows rsql to load the
             # init file immediately and then later make the init
@@ -102,6 +113,7 @@ module RSQL
             }.value
 
             if Exception === ret
+                @loaded_fns_state[fn] = :failed
                 if @verbose
                     $stderr.puts("#{ex.class}: #{ex.message}", ex.backtrace)
                 else
@@ -110,7 +122,7 @@ module RSQL
                 end
                 ret = false
             else
-                @loaded_fns << fn unless @loaded_fns.include?(fn)
+                @loaded_fns_state[fn] = :loaded
                 call_init_registrations unless @skipping_init_registrations
                 ret = true
             end
@@ -121,12 +133,35 @@ module RSQL
         end
 
         def reload
-            @loaded_fns.each{|fn| self.load(fn, false)}
-            puts "loaded: #{@loaded_fns.inspect}"
+            # some files may be loaded by other files, if so, we don't want to
+            # reload them again here
+            @loaded_fns.each{|fn| @loaded_fns_state[fn] = nil}
+            @loaded_fns.each{|fn| self.load(fn, :skip_init_registrations) if @loaded_fns_state[fn] == nil}
+
+            # load up the inits after all the normal registrations are ready
+            call_init_registrations
+
+            # report all the successfully loaded ones
+            loaded = []
+            @loaded_fns.each{|fn,state| loaded << fn if @loaded_fns_state[fn] == :loaded}
+            puts "loaded: #{loaded.inspect}"
         end
 
         def bang_eval(field, val)
-            if bang = @bangs[field]
+            # allow individual bangs to override global ones, even if they're nil
+            if @bangs.key?(field)
+                bang = @bangs[field]
+            else
+                @global_bangs.each do |m,b|
+                    if (String === m && m == field.to_s) ||
+                        (Regexp === m && m.match(field.to_s))
+                        bang = b
+                        break
+                    end
+                end
+            end
+
+            if bang
                 begin
                     val = Thread.new{ eval("#{bang}(val)") }.value
                 rescue Exception => ex
@@ -421,6 +456,18 @@ module RSQL
                      "server:v#{MySQLResults.conn.server_info}"
             end
 
+            # Show a short amount of information about acceptable syntax.
+            #
+            def help            # :doc:
+                puts <<EOF
+
+Converting values on the fly:
+
+  rsql> select name, value from rsql_example ! value => humanize_bytes;
+
+EOF
+            end
+
             # Provide a helper utility in the event a registered
             # method would like to make its own queries.
             #
@@ -438,13 +485,21 @@ module RSQL
                 nil
             end
 
+            # Register bangs to evaluate on all displayers as long as a column
+            # match is located. Bang keys may be either exact string matches or
+            # regular expressions.
+            #
+            def register_global_bangs(bangs)
+                @global_bangs.merge!(bangs)
+            end
+
             # Exactly like register below except in addition to registering as
             # a usable call for later, we will also use these as soon as we
             # have a connection to MySQL.
             #
             def register_init(sym, *args, &block) # :doc:
                 register(sym, *args, &block)
-                @init_registrations << sym
+                @init_registrations << sym unless @init_registrations.include?(sym)
             end
 
             # If given a block, allow the block to be called later, otherwise,

data/lib/rsql/mysql_results.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (C) 2011 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
+# Copyright (C) 2011-2012 by Brad Robel-Forrest <brad+rsql@gigglewax.com>
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,9 +19,16 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
-module RSQL
+# The standard MySQL hooks block Ruby threads, this interface provides an
+# asynchronous query.
+#
+require 'mysqlplus'
 
-    require 'mysql'
+class Mysql
+    alias :query :async_query
+end
+
+module RSQL
 
     ########################################
     # A wrapper to make it easier to work with MySQL results (and prettier).

data/test/test_eval_context.rb

@@ -30,8 +30,8 @@ class TestEvalContext < Test::Unit::TestCase
     def test_reload
         orig = $stdout
         $stdout = out = StringIO.new
-        @conn.expects(:query).with(instance_of(String)).returns(nil).times(2)
-        @conn.expects(:affected_rows).returns(0).times(2)
+        @conn.expects(:query).with(instance_of(String)).returns(nil)
+        @conn.expects(:affected_rows).returns(0)
         @ctx.safe_eval('reload', nil, out)
         assert_match(/loaded: .+?example.rsqlrc/, out.string)
     ensure
@@ -117,7 +117,8 @@ class TestEvalContext < Test::Unit::TestCase
     end
 
     def test_complete
-        assert_equal(18, @ctx.complete('').size)
+        out = @ctx.complete('')
+        assert_equal(19, out.size, out.inspect)
         assert_equal(['version'], @ctx.complete('v'))
         assert_equal(['.version'], @ctx.complete('.v'))
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsql
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: 
   segments: 
   - 0
   - 2
-  - 4
-  version: 0.2.4
+  - 5
+  version: 0.2.5
 platform: ruby
 authors: 
 - Brad Robel-Forrest
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-09 00:00:00 Z
+date: 2012-01-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
@@ -34,19 +34,19 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: mysql
+  name: mysqlplus
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 47
+        hash: 31
         segments: 
-        - 2
-        - 8
         - 0
-        version: 2.8.0
+        - 1
+        - 2
+        version: 0.1.2
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency