rsql 0.1.7 → 0.1.8

data/README.rdoc

@@ -29,6 +29,9 @@ RSQL is invoked from the comamnd line using:
 -version::
   Display the version of RSQL that is installed.
 
+-verbose::
+  Display details on SSH connections and evaluation stack traces.
+
 -rc _rcfile_::
   Override loading the .rsqlrc file from the HOME directory for one in
   a different location.
@@ -43,6 +46,10 @@ RSQL is invoked from the comamnd line using:
 -ssh _ssh_host_::
   Establish an SSH connection before connecting to the MySQL host.
 
+-sshconfig _ssh_config_::
+  Use a specific SSH configuration file instead of the ones
+  dynamically determined.
+
 -e [_query_]::
   Run a query from the command line (i.e. not interactive). If a
   _query_ is not provided, STDIN will be read. Multiple commands can

data/bin/rsql

@@ -121,6 +121,9 @@ if ARGV.delete('-version')
     exit
 end
 
+verbose = ARGV.delete('-verbose')
+eval_context.verbose = verbose
+
 if i = ARGV.index('-maxrows')
     ARGV.delete_at(i)
     MySQLResults.max_rows = ARGV.delete_at(i).to_i
@@ -139,6 +142,11 @@ if i = ARGV.index('-ssh')
     (ssh_host, ssh_user, ssh_password) = split_login(ARGV.delete_at(i))
 end
 
+if i = ARGV.index('-sshconfig')
+    ARGV.delete_at(i)
+    ssh_config = ARGV.delete_at(i)
+end
+
 if i = ARGV.index('-e')
     ARGV.delete_at(i)
     batch_input = ''
@@ -155,9 +163,9 @@ if ARGV.size < 1
     prefix = '        ' << ' ' * bn.size
     $stderr.puts <<USAGE
 
-usage: #{bn} [-version] [-help]
+usage: #{bn} [-version] [-help] [-verbose]
 #{prefix}[-rc <rcfile>] [-maxrows <max>] [-batch <field_separator>]
-#{prefix}[-ssh [<ssh_user>[:<ssh_password>]@]<ssh_host>]
+#{prefix}[-ssh [<ssh_user>[:<ssh_password>]@]<ssh_host>] [-sshconfig <ssh_config>]
 #{prefix}[<mysql_user>[:<mysql_password>]@]<mysql_host>
 #{prefix}[<database>] [-e <remaining_args_as_input>]
 
@@ -234,6 +242,11 @@ if ssh_host
     ssh = nil
     ssh_thread = Thread.new do
         opts = {:timeout => 15}
+        opts.merge!(Net::SSH::Config.load(ssh_config, ssh_host)) if ssh_config
+        if verbose
+            opts[:verbose] = :debug
+            puts "SSH options: #{opts.inspect}"
+        end
         begin
             opts[:password] = ssh_password if ssh_password
             ssh = Net::SSH.start(ssh_host, ssh_user, opts)

data/lib/rsql.rb

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

data/lib/rsql/eval_context.rb

@@ -29,18 +29,19 @@ module RSQL
     #
     class EvalContext
 
-        Registration = Struct.new(:name, :args, :bangs, :block, :usage, :desc)
+        Registration = Struct.new(:name, :args, :bangs, :block, :usage, :desc, :source)
 
         HEXSTR_LIMIT = 32
 
-        def initialize
+        def initialize(verbose=false)
+            @verbose      = verbose
             @hexstr_limit = HEXSTR_LIMIT
-            @results = nil
-            @last_query = nil
+            @results      = nil
+            @last_query   = nil
 
-            @loaded_fns = []
+            @loaded_fns         = []
             @init_registrations = []
-            @bangs = {}
+            @bangs              = {}
 
             @registrations = {
                 :version => Registration.new('version', [], {},
@@ -51,6 +52,10 @@ module RSQL
                                             method(:reload),
                                             'reload',
                                             'Reload the rsqlrc file.'),
+                :desc => Registration.new('desc', [], {},
+                                          method(:desc),
+                                          'desc',
+                                          'Describe the content of a recipe.'),
                 :last_query => Registration.new('last_query', [], {},
                                                 Proc.new{puts(@last_query)},
                                                 'last_query',
@@ -66,7 +71,7 @@ module RSQL
             }
         end
 
-        attr_accessor :bangs
+        attr_accessor :bangs, :verbose
 
         def call_init_registrations
             @init_registrations.each do |sym|
@@ -125,11 +130,18 @@ module RSQL
             end
 
             # same relaxed call to load too
-            if m = /^\s*load\s+'(.+)'\s*$/.match(content)
+            if m = content.match(/^\s*load\s+'(.+)'\s*$/)
                 self.load(m[1])
                 return
             end
 
+            # help out the poor user and fix up any describes
+            # requested so they don't need to remember that it needs
+            # to be a symbol passed in
+            if m = content.match(/^\s*desc\s+([^:]\S+)\s*$/)
+                content = "desc :#{m[1]}"
+            end
+
             if stdout
                 # capture stdout
                 orig_stdout = $stdout
@@ -139,7 +151,11 @@ module RSQL
             begin
                 value = Thread.new{ eval('$SAFE=2;' + content) }.value
             rescue Exception => ex
-                $stderr.puts(ex.message.gsub(/\(eval\):\d+:/,''))
+                if @verbose
+                    $stderr.puts("#{ex.class}: #{ex.message}", ex.backtrace)
+                else
+                    $stderr.puts(ex.message.gsub(/\(eval\):\d+:/,''))
+                end
             ensure
                 $stdout = orig_stdout if stdout
             end
@@ -229,6 +245,128 @@ module RSQL
                 return nil
             end
 
+            def params(block)
+                params = ''
+
+                if block.arity != 0 && block.arity != -1 &&
+                        block.inspect.match(/@(.+):(\d+)>$/)
+                    fn = $1
+                    lineno = $2.to_i
+
+                    if fn == '(eval)'
+                        $stderr.puts 'refusing to search an eval block'
+                        return params
+                    end
+
+                    File.open(fn) do |f|
+                        i = 0
+                        found = false
+                        while line = f.gets
+                            i += 1
+                            next if i < lineno
+
+                            unless found
+                                # give up if no start found within 20
+                                # lines
+                                break if lineno + 20 < i
+                                if m = line.match(/(\{|do)(.*)$/)
+                                    # adjust line to be the remainder
+                                    # after the start
+                                    line = m[2]
+                                    found = true
+                                else
+                                    next
+                                end
+                            end
+
+                            if m = line.match(/^\s*\|([^\|]*)\|/)
+                                params = "(#{m[1]})"
+                                break
+                            end
+
+                            # if the params aren't here then we'd
+                            # better only have whitespace otherwise
+                            # this block doesn't have params...even
+                            # though arity says it should
+                            next if line.match(/^\s*$/)
+                            $stderr.puts 'unable to locate params'
+                            break
+                        end
+                    end
+                end
+
+                return params
+            end
+
+            def desc(sym)
+                unless Symbol === sym
+                    $stderr.puts("must provide a Symbol--try prefixing it with a colon (:)")
+                    return
+                end
+
+                unless reg = @registrations[sym]
+                    $stderr.puts "nothing registered as #{sym}"
+                    return
+                end
+
+                if Method === reg.block
+                    $stderr.puts "refusing to describe the #{sym} method"
+                    return
+                end
+
+                if !reg.source && reg.block.inspect.match(/@(.+):(\d+)>$/)
+                    fn = $1
+                    lineno = $2.to_i
+
+                    if fn == __FILE__
+                        $stderr.puts "refusing to describe EvalContext##{sym}"
+                        return
+                    end
+
+                    if fn == '(eval)'
+                        $stderr.puts 'unable to describe body for an eval block'
+                        return
+                    end
+
+                    File.open(fn) do |f|
+                        source = ''
+                        i = 0
+                        ending = nil
+                        found = false
+
+                        while line = f.gets
+                            i += 1
+                            next unless ending || i == lineno
+                            source << line
+                            unless ending
+                                unless m = line.match(/\{|do/)
+                                    $stderr.puts "unable to locate block beginning at #{fn}:#{lineno}"
+                                    return
+                                end
+                                ending = m[0] == '{' ? '\}' : 'end'
+                                next
+                            end
+                            if m = line.match(/^#{ending}/)
+                                found = true
+                                break
+                            end
+                        end
+
+                        if found
+                            reg.source = source
+                        else
+                            reg.source = ''
+                        end
+                    end
+                end
+
+                if reg.source && reg.source.any?
+                    puts reg.source
+                else
+                    $stderr.puts "unable to locate body for #{sym}"
+                end
+            end
+
             # Show all the pertinent version data we have about our
             # software and the mysql connection.
             #
@@ -270,7 +408,8 @@ module RSQL
                 desc = '' unless desc
 
                 if block.nil?
-                    sql = sqeeze!(args.pop)
+                    source = args.pop
+                    sql = sqeeze!(source.dup)
 
                     argstr = args.join(',')
                     usage << "(#{argstr})" unless argstr.empty?
@@ -279,10 +418,11 @@ module RSQL
                     block = Thread.new{ eval(blockstr) }.value
                     args = []
                 else
-                    usage << "(#{block.arity})" unless 0 == block.arity
+                    source = nil
+                    usage << params(block)
                 end
 
-                @registrations[sym] = Registration.new(name, args, bangs, block, usage, desc)
+                @registrations[sym] = Registration.new(name, args, bangs, block, usage, desc, source)
             end
 
             # Convert a list of values into a comma-delimited string,

data/lib/rsql/mysql_results.rb

@@ -226,6 +226,10 @@ module RSQL
         #
         attr_reader :affected_rows
 
+        # Get the amount of elapsed time taken by the query.
+        #
+        attr_reader :elapsed
+
         # Determine if there are any results.
         #
         def any?
@@ -247,13 +251,16 @@ module RSQL
         # Get a row from the table hashed with the field names.
         #
         def [](index)
-            if index < 0 || !@fields || !@table || @table.size <= index
+            if !@fields || !@table
+                return nil
+            end
+            if row = @table[index]
+                hash = {}
+                @fields.each_with_index {|f,i| hash[f.name] = row[i]}
+                return hash
+            else
                 return nil
             end
-            hash = {}
-            row = @table[index]
-            @fields.each_with_index {|f,i| hash[f.name] = row[i]}
-            return hash
         end
 
         # Iterate through each row of the table hashed with the field

data/test/test_eval_context.rb

@@ -19,8 +19,6 @@ class TestEvalContext < Test::Unit::TestCase
     include RSQL
 
     def setup
-        @orig_stdout = $stdout
-        $stdout = @strout = StringIO.new
         @conn = MySQLResults.conn = mock('Mysql')
         @conn.expects(:query).with(instance_of(String)).returns(nil)
         @conn.expects(:affected_rows).returns(0)
@@ -28,13 +26,13 @@ class TestEvalContext < Test::Unit::TestCase
         @ctx.load(File.join(File.dirname(__FILE__),'..','example.rsqlrc'))
     end
 
-    def teardown
-        $stdout = @orig_stdout
-    end
-
     def test_load
-        @ctx.reload
-        assert_match(/loaded: .+?example.rsqlrc/, @strout.string)
+        orig = $stdout
+        $stdout = out = StringIO.new
+        @ctx.safe_eval('reload', nil, out)
+        assert_match(/loaded: .+?example.rsqlrc/, out.string)
+    ensure
+        $stdout = orig
     end
 
     def test_eval
@@ -64,9 +62,55 @@ class TestEvalContext < Test::Unit::TestCase
         assert_match(/usage\s+description/, out.string)
     end
 
+    def test_params
+        val = @ctx.safe_eval('params(@registrations[:fill_table].block)', nil, nil)
+        assert_equal('', val)
+        val = @ctx.safe_eval('params(@registrations[:save_values].block)', nil, nil)
+        assert_equal('(fn)', val)
+    end
+
+    def test_desc
+        out = StringIO.new
+        err = StringIO.new
+        orig_err = $stderr
+
+        $stderr = err
+        val = @ctx.safe_eval('desc max_rows', nil, out)
+        $sterr = orig_err
+        assert_equal('', out.string)
+        assert_equal('refusing to describe EvalContext#max_rows',
+                     err.string.chomp)
+
+        err.string = ''
+        $stderr = err
+        val = @ctx.safe_eval('desc :sldkfjas', nil, out)
+        $sterr = orig_err
+        assert_equal('', out.string)
+        assert_equal('nothing registered as sldkfjas', err.string.chomp)
+
+        err.string = ''
+        $stderr = err
+        val = @ctx.safe_eval('desc :version', nil, out)
+        $sterr = orig_err
+        assert_equal('', out.string)
+        assert_equal('refusing to describe the version method', err.string.chomp)
+
+        out.string = ''
+        val = @ctx.safe_eval('desc :cleanup_example', nil, out)
+        assert_equal('DROP TEMPORARY TABLE IF EXISTS #{@rsql_table}', out.string.strip)
+
+        out.string = ''
+        val = @ctx.safe_eval('desc :to_report', nil, out)
+        lines = out.string.split($/)
+        assert_match(/^register .+ do$/, lines[0])
+        assert_match(/^\s+puts/, lines[-2])
+        assert_match(/^end$/, lines[-1])
+        assert_equal(12, lines.size)
+    end
+
     def test_complete
         @conn.expects(:list_dbs).returns([])
-        assert_equal(17, @ctx.complete('').size)
+        assert_equal(18, @ctx.complete('').size)
         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: 21
+  hash: 11
   prerelease: 
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Brad Robel-Forrest
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-23 00:00:00 Z
+date: 2011-06-03 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
@@ -33,6 +33,64 @@ dependencies:
         version: 2.1.0
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rcov
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: |
   RSQL makes working with a MySQL command line more convenient through
   the use of recipes and embedding the common operation of using a SSH
@@ -95,7 +153,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.8.2
+rubygems_version: 1.8.5
 signing_key: 
 specification_version: 3
 summary: Ruby based MySQL command line with recipes.