rsql 0.2.9 → 0.2.10

data/.yardopts

@@ -0,0 +1,7 @@
+--private
+--no-private
+-r README.rdoc
+lib/**/*.rb
+-
+LICENSE
+example.rsqlrc.rdoc

data/README.rdoc

@@ -87,14 +87,12 @@ directly from the console (without echoing the characters typed):
 
 == GETTING STARTED
 
-This example walks through many features of RSQL including how to build up
-recipes:
+Try out the {file:example.rsqlrc.rdoc} for a painless introduction on how to
+leverage RSQL.
 
-Try out the simple examples in rdoc-ref:example.rsqlrc.rdoc for a painless
-introduciton for how to leverage RSQL.
-
-The file is available as example.rsqlrc installed with the gem or downloaded
-with the source.
+The file is available as
+{<tt>example.rsqlrc</tt>}[https://raw.github.com/bradrf/rsql/master/example.rsqlrc]
+installed with the gem or downloaded with the source.
 
 == LICENSE
 

data/bin/rsql

@@ -277,7 +277,7 @@ if opts.ssh_host
 
     password_retry_cnt = 0
 
-    unless opts.batch_input
+    unless opts.batch_output
         print "SSH #{opts.ssh_user}#{opts.ssh_user ? '@' : ''}#{opts.ssh_host}..."
         $stdout.flush
     end
@@ -297,7 +297,7 @@ if opts.ssh_host
         ssh_enabled = false
         Signal.trap('INT', 'IGNORE')
         Signal.trap('TERM') do
-            $stderr.puts 'Closing SSH connection...' unless opts.batch_input
+            $stderr.puts 'Closing SSH connection...' unless opts.batch_output
             ssh_enabled = false
         end
         ssh_opts = {:timeout => 15}
@@ -313,7 +313,7 @@ if opts.ssh_host
             ssh = Net::SSH.start(opts.ssh_host, opts.ssh_user, ssh_opts)
             ssh_opts.delete(:password)
             ssh_enabled = true
-            printf "connected (#{$$})..." unless opts.batch_input
+            printf "connected (#{$$})..." unless opts.batch_output
             $stdout.flush
         rescue Net::SSH::AuthenticationFailed
             if 2 < password_retry_cnt
@@ -337,7 +337,7 @@ if opts.ssh_host
         ensure
             if ssh_enabled
                 ssh.forward.local(opts.mysql_port, opts.mysql_host, opts.remote_mysql_port)
-                unless opts.batch_input
+                unless opts.batch_output
                     puts(opts.verbose ? "ready (#{opts.mysql_port} => #{opts.remote_mysql_port})" : 'ready')
                 end
                 File.open(ipc_fn,'w'){|f| f.puts('ready')}
@@ -393,7 +393,7 @@ if opts.ssh_host
     opts.mysql_host = '127.0.0.1'
 end
 
-unless opts.batch_input
+unless opts.batch_output
     print "MySQL #{opts.mysql_user}@#{opts.remote_mysql_host}..."
     $stdout.flush
 end
@@ -403,7 +403,7 @@ begin
     MySQLResults.conn = Mysql.new(opts.mysql_host, opts.mysql_user, opts.mysql_password,
                                   MySQLResults.database_name, opts.mysql_port)
     MySQLResults.conn.reconnect = true
-    puts 'connected' unless opts.batch_input
+    puts 'connected' unless opts.batch_output
 rescue Mysql::Error => ex
     if ex.message.include?('Client does not support authentication')
         $stderr.puts "failed to connect to #{mysql_conn} mysql server: unknown credentials?"

data/example.rsqlrc

@@ -13,7 +13,7 @@
 
 # To use this file, change directory to the one containing this file and run
 # RSQL connecting to your MySQL server (run rsql with no arguments for
-# usage--see rdoc-ref:README.rdoc for more details on command line parameters).
+# usage--see {file:README.rdoc} for more details on command line parameters).
 #
 #   rsql> .load 'example.rsqlrc';
 
@@ -34,7 +34,7 @@
 
 ################################################################################
 
-# Use of RSQL::EvalContext#register_init allows a block to be automatically
+# Use of {RSQL::EvalContext#register_init} allows a block to be automatically
 # invoked when this file is loaded. Often, this is useful to run set up routines
 # like setting MySQL variables for different read levels (e.g. <b><tt>SET
 # SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED</tt></b>). Any number of
@@ -51,7 +51,7 @@ CREATE TEMPORARY TABLE IF NOT EXISTS #{@rsql_table} (
 }, :desc => 'Sets up example table for trying out RSQL.'
 
 # This next recipe is building up a string with a single variable interpolated
-# into it (our table name) through RSQL::EvalContext#register. The string will
+# into it (our table name) through {RSQL::EvalContext#register}. The string will
 # then be used as if typed at the command line.
 #
 #   rsql> .cleanup_example;
@@ -73,7 +73,7 @@ DROP TEMPORARY TABLE IF EXISTS #{@rsql_table}
 #
 #   rsql> .fill_table;
 #
-# Notice the use of the RSQL::EvalContext#hexify and RSQL::EvalContext#squeeze!
+# Notice the use of the {RSQL::EvalContext#hexify} and {RSQL::EvalContext#squeeze!}
 # helper methods.
 #
 register :fill_table, :desc => 'Populate the example table.' do
@@ -112,7 +112,7 @@ SELECT name, value FROM #{@rsql_table} WHERE #{val} <= value
 
 # Sometimes we make mistakes (never!). Normally, the command history kept in
 # RSQL only stores the last thing entered at the prompt--not any query that the
-# previous command may have generated and invoked.  When writing a recipe that
+# previous command may have generated and invoked. When writing a recipe that
 # generates a query that has an error reported by MySQL, it is really handy to
 # see the generated SQL.
 #
@@ -122,7 +122,7 @@ SELECT name, value FROM #{@rsql_table} WHERE #{val} <= value
 #   rsql> .bad_query;
 #
 # So the command in our history is the recipe and not the query. To see the
-# query the RSQL::EvalContext#history has a helper method ready for us:
+# query the {RSQL::EvalContext#history} has a helper method ready for us:
 #
 #   rsql> .history;
 #
@@ -137,8 +137,8 @@ SELECT name, value FROM #{@rsql_table} WHERE valu < 10000
 #
 #   rsql> select name, value from rsql_example ! value => humanize_bytes;
 #
-# The RSQL::EvalContext#humanize_bytes is another helper method. There are
-# several others available. Check out the RSQL::EvalContext class for details.
+# The {RSQL::EvalContext#humanize_bytes} is another helper method. There are
+# several others available. Check out the {RSQL::EvalContext} class for details.
 #
 # Additional mappings can be added, separated by commas.
 #
@@ -184,10 +184,10 @@ SELECT name FROM #{@rsql_table}
 #
 #   rsql> select name, value from rsql_example | p @results;
 #
-# The RSQL::EvalContext class manages the results from a previous query in the
+# The {RSQL::EvalContext} class manages the results from a previous query in the
 # <b><tt>@results</tt></b> member variable accessible by any Ruby recipe
-# code. This is an instance of the RSQL::MySQLResults class. Below we make use
-# of the RSQL::MySQLResults#each_hash method to walk over all rows. There are
+# code. This is an instance of the {RSQL::MySQLResults} class. Below we make use
+# of the {RSQL::MySQLResults#each_hash} method to walk over all rows. There are
 # other helpful routines available.
 #
 # Here's an example that writes a simple report of the data we are working
@@ -215,8 +215,9 @@ end
 #
 # After running this, a <b><tt>myobj.yml</tt></b> file should be created in the
 # local directory containing all the content from the query. To accomplish this,
-# the RSQL::EvalContext#safe_save method is invoked which serializes our object
-# so that we may later decided to run some post processing on the content.
+# the {RSQL::EvalContext#safe_save} method is invoked which serializes our
+# object so that we may later decided to run some post processing on the
+# content.
 #
 # Inspect the YAML[http://www.yaml.org/] content written out:
 #
@@ -246,7 +247,7 @@ SELECT name, value
 # Sometimes it just isn't enough to be able to rely on generating SQL queries
 # and piping into handlers. Sometimes we just need to roll up our sleeves and
 # run queries directly so we can start processing results and dealing with
-# presentation all on our own. That's where the RSQL::EvalContext#query helper
+# presentation all on our own. That's where the {RSQL::EvalContext#query} helper
 # comes in handy.
 #
 # The intention here is to just create a series of sentences out of two separate
@@ -262,7 +263,7 @@ register :show_sentences, :desc => 'Show results as sentences.' do
     end
 end
 
-# The RSQL::MySQLResults class built in to RSQL handles binary content
+# The {RSQL::MySQLResults} class built in to RSQL handles binary content
 # gracefully, automatically converting it to something a little nicer to our
 # consoles than just dumping it. It converts it into a hexadecimal string.
 #
@@ -280,7 +281,7 @@ SELECT * FROM #{@rsql_table} WHERE stuff=#{hexify stuff}
 }, :desc => 'Find some hex stuff.'
 
 # There are many other things to try out left as an "exercise for the
-# reader". Browsing the RSQL::EvalContext and RSQL::MySQLResults classes would
-# be an excellent start.
+# reader". Browsing the {RSQL::EvalContext} and {RSQL::MySQLResults} classes
+# would be an excellent start.
 
 # vi: set filetype=ruby

data/example.rsqlrc.rdoc

@@ -13,7 +13,7 @@ this temporary table.
  
 To use this file, change directory to the one containing this file and run
 RSQL connecting to your MySQL server (run rsql with no arguments for
-usage--see rdoc-ref:README.rdoc for more details on command line parameters).
+usage--see {file:README.rdoc} for more details on command line parameters).
 
 <tt>rsql> .load 'example.rsqlrc';</tt>
  
@@ -34,7 +34,7 @@ period on a command.
  
 ---
  
-Use of RSQL::EvalContext#register_init allows a block to be automatically
+Use of {RSQL::EvalContext#register_init} allows a block to be automatically
 invoked when this file is loaded. Often, this is useful to run set up routines
 like setting MySQL variables for different read levels (e.g. <b><tt>SET
 SESSION TRANSACTION ISOLATION LEVEL READ COMMITTED</tt></b>). Any number of
@@ -51,7 +51,7 @@ Here we are merely setting up the example table.
  }, :desc => 'Sets up example table for trying out RSQL.'
  
 This next recipe is building up a string with a single variable interpolated
-into it (our table name) through RSQL::EvalContext#register. The string will
+into it (our table name) through {RSQL::EvalContext#register}. The string will
 then be used as if typed at the command line.
 
 <tt>rsql> .cleanup_example;</tt>
@@ -73,7 +73,7 @@ Here we are just populating the table (if it isn't already).
 
 <tt>rsql> .fill_table;</tt>
 
-Notice the use of the RSQL::EvalContext#hexify and RSQL::EvalContext#squeeze!
+Notice the use of the {RSQL::EvalContext#hexify} and {RSQL::EvalContext#squeeze!}
 helper methods.
 
  register :fill_table, :desc => 'Populate the example table.' do
@@ -112,7 +112,7 @@ passed in.
  
 Sometimes we make mistakes (never!). Normally, the command history kept in
 RSQL only stores the last thing entered at the prompt--not any query that the
-previous command may have generated and invoked.  When writing a recipe that
+previous command may have generated and invoked. When writing a recipe that
 generates a query that has an error reported by MySQL, it is really handy to
 see the generated SQL.
 
@@ -122,7 +122,7 @@ arrow" key to see the previous command.
 <tt>rsql> .bad_query;</tt>
 
 So the command in our history is the recipe and not the query. To see the
-query the RSQL::EvalContext#history has a helper method ready for us:
+query the {RSQL::EvalContext#history} has a helper method ready for us:
 
 <tt>rsql> .history;</tt>
 
@@ -137,8 +137,8 @@ humanize? Try this command:
 
 <tt>rsql> select name, value from rsql_example ! value => humanize_bytes;</tt>
 
-The RSQL::EvalContext#humanize_bytes is another helper method. There are
-several others available. Check out the RSQL::EvalContext class for details.
+The {RSQL::EvalContext#humanize_bytes} is another helper method. There are
+several others available. Check out the {RSQL::EvalContext} class for details.
 
 Additional mappings can be added, separated by commas.
 
@@ -184,10 +184,10 @@ this:
 
 <tt>rsql> select name, value from rsql_example | p @results;</tt>
 
-The RSQL::EvalContext class manages the results from a previous query in the
+The {RSQL::EvalContext} class manages the results from a previous query in the
 <b><tt>@results</tt></b> member variable accessible by any Ruby recipe
-code. This is an instance of the RSQL::MySQLResults class. Below we make use
-of the RSQL::MySQLResults#each_hash method to walk over all rows. There are
+code. This is an instance of the {RSQL::MySQLResults} class. Below we make use
+of the {RSQL::MySQLResults#each_hash} method to walk over all rows. There are
 other helpful routines available.
 
 Here's an example that writes a simple report of the data we are working
@@ -215,8 +215,9 @@ want to process results and keep our data around in a file.
 
 After running this, a <b><tt>myobj.yml</tt></b> file should be created in the
 local directory containing all the content from the query. To accomplish this,
-the RSQL::EvalContext#safe_save method is invoked which serializes our object
-so that we may later decided to run some post processing on the content.
+the {RSQL::EvalContext#safe_save} method is invoked which serializes our
+object so that we may later decided to run some post processing on the
+content.
 
 Inspect the YAML[http://www.yaml.org/] content written out:
 
@@ -246,7 +247,7 @@ Here we simply expand the arguments.
 Sometimes it just isn't enough to be able to rely on generating SQL queries
 and piping into handlers. Sometimes we just need to roll up our sleeves and
 run queries directly so we can start processing results and dealing with
-presentation all on our own. That's where the RSQL::EvalContext#query helper
+presentation all on our own. That's where the {RSQL::EvalContext#query} helper
 comes in handy.
 
 The intention here is to just create a series of sentences out of two separate
@@ -262,7 +263,7 @@ queries.
      end
  end
  
-The RSQL::MySQLResults class built in to RSQL handles binary content
+The {RSQL::MySQLResults} class built in to RSQL handles binary content
 gracefully, automatically converting it to something a little nicer to our
 consoles than just dumping it. It converts it into a hexadecimal string.
 
@@ -280,7 +281,7 @@ RSQL makes querying for hex strings from within a recipe easy too.
  }, :desc => 'Find some hex stuff.'
  
 There are many other things to try out left as an "exercise for the
-reader". Browsing the RSQL::EvalContext and RSQL::MySQLResults classes would
-be an excellent start.
+reader". Browsing the {RSQL::EvalContext} and {RSQL::MySQLResults} classes
+would be an excellent start.
  
 

data/lib/rsql/mysql_results.rb

@@ -24,6 +24,7 @@
 #
 require 'mysqlplus'
 
+# @private
 class Mysql # :nodoc:
     alias :query :async_query
 end

data/lib/rsql.rb

@@ -1,11 +1,11 @@
 # A module encapsulating classes to manage MySQLResults and process
 # Commands using an EvalContext for handling recipes.
 #
-# See the rdoc-ref:example.rsqlrc.rdoc file for a simple tutorial and usage
+# See the {file:example.rsqlrc.rdoc} file for a simple tutorial and usage
 # information.
 #
 module RSQL
-    VERSION = '0.2.9'
+    VERSION = '0.2.10'
 
     require 'rsql/mysql_results'
     require 'rsql/eval_context'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rsql
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 3
   prerelease: 
   segments: 
   - 0
   - 2
-  - 9
-  version: 0.2.9
+  - 10
+  version: 0.2.10
 platform: ruby
 authors: 
 - Brad Robel-Forrest
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-15 00:00:00 Z
+date: 2012-02-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: net-ssh
@@ -118,10 +118,12 @@ extra_rdoc_files:
 - LICENSE
 - example.rsqlrc.rdoc
 files: 
+- .yardopts
 - LICENSE
 - README.rdoc
 - bin/rsql
 - example.rsqlrc
+- example.rsqlrc.rdoc
 - extra/mysql-client-5.1.59-1.tgz
 - lib/rsql.rb
 - lib/rsql/commands.rb
@@ -130,7 +132,6 @@ files:
 - test/test_commands.rb
 - test/test_eval_context.rb
 - test/test_mysql_results.rb
-- example.rsqlrc.rdoc
 homepage: https://rubygems.org/gems/rsql
 licenses: []