rsql 0.2.1 → 0.2.2

data/README.rdoc

@@ -14,13 +14,13 @@ to an intermediary host for access to the SQL server.
   gem install rsql
 
 Alternatively, RSQL can be downloaded as a tar.gz or zip and run
-directly from within the unpacked source directory. The only
-requirement is that SSH functionality will be disabled unless the
-Net::SSH Ruby library is installed and available.
+directly from within the unpacked source directory as long as the
+MySQL Ruby library is available. SSH functionality will be disabled
+unless the Net::SSH Ruby library is also installed and available.
 
 == USAGE
 
-RSQL is invoked from the comamnd line using:
+RSQL is invoked from the command line using:
 
   rsql [<options>] <mysql_host> [<database>] [-e [<query>]]
 
@@ -40,7 +40,7 @@ RSQL is invoked from the comamnd line using:
   Override the maximum number of rows to process.
 
 -batch _field_separator_::
-  Run in batch mode using the separator specifed (e.g. a /t will
+  Run in batch mode using the separator specified (e.g. a /t will
   separate fields with a tab character).
 
 -ssh _ssh_host_::
@@ -79,10 +79,10 @@ the colon and the at sign):
 
 Connect as the "readonly" user to the "internal.database.acme.com"
 host's MySQL server after establishing a SSH tunnel to the
-"external.acme.com" gateway. In this case, we are either expecting
-that our SSH configuration is set up with the right user name. Because
-we did not provide a password for MySQL, one will be obtained directly
-from the console (without echoing the characters typed):
+"external.acme.com" gateway. In this case, we are expecting that our
+SSH configuration is set up with the right user name. Because we did
+not provide a password for MySQL, one will be obtained directly from
+the console (without echoing the characters typed):
 
   rsql -ssh external.acme.com readonly@internal.database.acme.com
 

data/example.rsqlrc

@@ -124,7 +124,7 @@ SELECT name, value FROM #{@rsql_table} WHERE #{val} <= value
 # So the command in our history is the recipe and not the query. To
 # see the query the EvalContext has a recipe ready for us:
 #
-#   rsql> .last_query;
+#   rsql> .history;
 #
 register :bad_query, %q{
 SELECT name, value FROM #{@rsql_table} WHERE valu < 10000
@@ -222,6 +222,10 @@ end
 # serializes our object so that we may later decided to run some post
 # processing on the content.
 #
+# Inspect the YAML content written out:
+#
+#   rsql> .puts IO.read('myobj.yml');
+#
 register :save_values, :desc => 'Save results from a query into a file.' do |fn|
     myobj = {}
     @results.each_hash do |row|

data/lib/rsql/eval_context.rb

@@ -37,7 +37,6 @@ module RSQL
             @verbose      = verbose
             @hexstr_limit = HEXSTR_LIMIT
             @results      = nil
-            @last_query   = nil
 
             @loaded_fns         = []
             @init_registrations = []
@@ -45,29 +44,29 @@ module RSQL
 
             @registrations = {
                 :version => Registration.new('version', [], {},
-                                             method(:version),
-                                             'version',
-                                             'RSQL version information.'),
+                    method(:version),
+                    'version',
+                    'Version information about RSQL, the client, and the server.'),
                 :reload => Registration.new('reload', [], {},
-                                            method(:reload),
-                                            'reload',
-                                            'Reload the rsqlrc file.'),
+                    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',
-                                                'Print the last query made from generated results.'),
+                    method(:desc),
+                    'desc',
+                    'Describe the content of a recipe.'),
+                :history => Registration.new('history', [], {},
+                    method(:history),
+                    'history(cnt=1)',
+                    'Print recent queries made (request a count or use :all for entire list).'),
                 :set_max_rows => Registration.new('set_max_rows', [], {},
-                                                  Proc.new{|r| MySQLResults.max_rows = r},
-                                                  'set_max_rows',
-                                                  'Set the maximum number of rows to process.'),
+                    Proc.new{|r| MySQLResults.max_rows = r},
+                    'set_max_rows',
+                    'Set the maximum number of rows to process.'),
                 :max_rows => Registration.new('max_rows', [], {},
-                                              Proc.new{MySQLResults.max_rows},
-                                              'max_rows',
-                                              'Get the maximum number of rows to process.'),
+                    Proc.new{MySQLResults.max_rows},
+                    'max_rows',
+                    'Get the maximum number of rows to process.'),
             }
         end
 
@@ -176,8 +175,6 @@ module RSQL
                 $stdout = orig_stdout if stdout
             end
 
-            @last_query = value if String === value
-
             return value
         end
 
@@ -264,7 +261,10 @@ module RSQL
                 return nil
             end
 
-            def params(block)
+            # Attempt to locate the parameters of a given block by
+            # searching its source.
+            #
+            def params(name, block)
                 params = ''
 
                 if block.arity != 0 && block.arity != -1 &&
@@ -273,7 +273,7 @@ module RSQL
                     lineno = $2.to_i
 
                     if fn == '(eval)'
-                        $stderr.puts 'refusing to search an eval block'
+                        $stderr.puts "refusing to search an eval block for :#{name}"
                         return params
                     end
 
@@ -288,7 +288,7 @@ module RSQL
                                 # give up if no start found within 20
                                 # lines
                                 break if lineno + 20 < i
-                                if m = line.match(/(\{|do)(.*)$/)
+                                if m = line.match(/(\{|do\b)(.*)$/)
                                     # adjust line to be the remainder
                                     # after the start
                                     line = m[2]
@@ -308,7 +308,7 @@ module RSQL
                             # this block doesn't have params...even
                             # though arity says it should
                             next if line.match(/^\s*$/)
-                            $stderr.puts 'unable to locate params'
+                            $stderr.puts "unable to locate params for :#{name}"
                             break
                         end
                     end
@@ -401,6 +401,13 @@ module RSQL
                 MySQLResults.query(content, self, *args)
             end
 
+            def history(cnt=1)
+                if h = MySQLResults.history(cnt)
+                    h.each{|q| puts '', q}
+                end
+                nil
+            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.
@@ -438,7 +445,7 @@ module RSQL
                     args = []
                 else
                     source = nil
-                    usage << params(block)
+                    usage << params(name, block)
                 end
 
                 @registrations[sym] = Registration.new(name, args, bangs, block, usage, desc, source)

data/lib/rsql/mysql_results.rb

@@ -37,7 +37,9 @@ module RSQL
         @@field_separator = ' '
         @@max_rows        = 1000
         @@database_name   = nil
-        @@name_cache     = {}
+        @@name_cache      = {}
+        @@history         = []
+        @@max_history     = 10
 
         class MaxRowsException < RangeError
             def initialize(rows, max)
@@ -89,6 +91,24 @@ module RSQL
             #
             def database_name=(database); @@database_name = database; end
 
+            # Get a list of the most recent query strings.
+            #
+            def history(cnt=:all)
+                if Integer === cnt 
+                    @@history[-cnt,cnt]
+                else
+                    @@history
+                end
+            end
+
+            # Get the maximum number of historical entries to retain.
+            #
+            def get_max_history; @@max_history; end
+
+            # Set the maximum number of historical entries to retain.
+            #
+            def set_max_history=(count); @@max_history = count; end
+
             # Get the list of databases available.
             #
             def databases
@@ -163,6 +183,9 @@ module RSQL
             # Get results from a query.
             #
             def query(sql, eval_context, raw=false, max_rows=@@max_rows)
+                @@history.shift if @@max_history <= @@history.size 
+                @@history << sql
+
                 start   = Time.now.to_f
                 results = @@conn.query(sql)
                 elapsed = Time.now.to_f - start.to_f

data/lib/rsql.rb

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

data/test/test_eval_context.rb

@@ -65,9 +65,9 @@ class TestEvalContext < Test::Unit::TestCase
     end
 
     def test_params
-        val = @ctx.safe_eval('params(@registrations[:fill_table].block)', nil, nil)
+        val = @ctx.safe_eval('params("ft", @registrations[:fill_table].block)', nil, nil)
         assert_equal('', val)
-        val = @ctx.safe_eval('params(@registrations[:save_values].block)', nil, nil)
+        val = @ctx.safe_eval('params("sv", @registrations[:save_values].block)', nil, nil)
         assert_equal('(fn)', val)
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsql
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: 
   segments: 
   - 0
   - 2
-  - 1
-  version: 0.2.1
+  - 2
+  version: 0.2.2
 platform: ruby
 authors: 
 - Brad Robel-Forrest
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-24 00:00:00 Z
+date: 2011-09-25 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh