sbfaulkner-rsql 0.9.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 unwwwired.net
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,13 @@
+rsql
+===========
+ 
+Command-line access to ODBC datasources.
+ 
+ 
+Example
+=======
+ 
+$ rsql mydsn -u user -p password
+
+ 
+Copyright (c) 2008 unwwwired.net, released under the MIT license

data/Rakefile

@@ -0,0 +1,11 @@
+require 'rubygems'
+Gem::manage_gems
+require 'rake/gempackagetask'
+
+load File.join(File.dirname(__FILE__),'rsql.gemspec')
+
+Rake::GemPackageTask.new(SPEC) do |pkg|
+  pkg.need_tar = true
+end
+
+task :default => :package

data/bin/rsql

@@ -0,0 +1,89 @@
+#!/usr/bin/ruby
+#
+# RSQL Copyright © 2007-2008 unwwwired.net
+# Created by: S. Brent Faulkner (brentf@unwwwired.net) 2007-08-29
+#
+
+require 'getoptlong'
+require 'readline' 
+include Readline 
+require 'shellwords' 
+include Shellwords
+require 'singleton'
+
+require 'odbc'
+
+require 'rsql/odbc'
+require 'rsql/rsql'
+
+
+module RSQL
+  COMMAND = File.basename($0)
+
+  opts = GetoptLong.new(
+    [ "--execute", "-e", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--mode", "-m", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--password", "-p", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--quiet", "-q", GetoptLong::NO_ARGUMENT ],
+    [ "--user", "-u", GetoptLong::REQUIRED_ARGUMENT ],
+    [ "--verbose", "-v", GetoptLong::NO_ARGUMENT ]
+  )
+
+  opts.each do |opt, arg|
+    OPTIONS[opt[/--(.*)/,1].to_sym] = arg
+  end
+
+  # to hide the noise from the ODBC driver
+  STDERR.reopen("/dev/null") unless OPTIONS[:verbose]
+
+  if ARGV.length > 1
+    puts "#{COMMAND}: too many arguments"
+    exit
+  end
+
+  if OPTIONS[:execute]
+    # a command requires a database
+    if ARGV.length < 1
+      puts "#{COMMAND}: no database specified"
+      exit
+    end
+    # force quiet-mode if command provided
+    OPTIONS[:quiet] = true
+  end
+
+  # set format for output
+  begin
+    ODBC::Statement.mode = OPTIONS[:mode]
+  rescue => e
+    puts "#{COMMAND}: #{e}"
+    exit
+  end
+
+  # quiet-mode wins over verbose-mode
+  OPTIONS.delete :verbose if OPTIONS[:quiet]
+
+  puts "#{COMMAND} v0.9.4 - Copyright (c) 2007-2008 unwwwired.net" unless OPTIONS[:quiet]
+
+  begin
+    # use dsn if provided
+    begin
+      RSQL.instance.use(ARGV[0]) if ARGV.length > 0
+    rescue ODBC::Error => error
+      puts "ERROR: #{error}"
+    end
+
+    if OPTIONS[:execute]
+      RSQL.execute OPTIONS[:execute]
+    else
+      # get (and process) each command line in turn
+      while command = readline("#{COMMAND}> ", true)
+        RSQL.execute command
+      end
+    end
+  rescue SystemExit
+    puts "Bye" unless OPTIONS[:quiet]
+  rescue => exception
+    puts %Q(INTERNAL ERROR: #{exception}\n#{exception.backtrace.join("\n")})
+  end
+
+end

data/lib/rsql/odbc.rb

@@ -0,0 +1,103 @@
+# extend ruby-odbc for printing result sets
+
+module ODBC
+  
+  class Column
+    def alias
+      @alias ||= name
+    end
+    def alias=(value)
+      @alias = value
+    end
+    def index
+      @index ||= -1
+    end
+    def index=(value)
+      @index = value
+    end
+    def width
+      @width ||= self.alias.length
+    end
+    def width=(value)
+      @width = value
+    end
+  end
+  
+  class Statement
+    class << self
+      def mode
+        @mode ||= 'column'
+      end
+      
+      def mode=(value)
+        value = value.to_s
+        Kernel.raise ArgumentError, "mode should be either 'column' or 'csv'" unless %w(column csv).include?(value)
+        @mode = value
+      end
+    end
+    
+    def print(aliases = nil)
+
+      # get the column names, etc.
+      displayed_columns = columns(true)
+
+      # set column indices
+      displayed_columns.each_with_index do |c,i|
+        c.index = i
+      end
+
+      # set column aliases (if provided)
+      if aliases
+        displayed_columns.collect! do |c|
+          c if c.alias = aliases[c.name.to_sym]
+        end.compact!
+      end
+
+      # fetch the data
+      # TODO: handle huge result sets better... maybe paginate or base column width on initial n-record set
+      resultset = fetch_all
+
+      case self.class.mode
+      when 'column'
+        # determine the column widths (might be realy slow with large result sets)
+        resultset.each do |r|
+          displayed_columns.each do |c|
+            if value = r[c.index]
+              value = value.to_s
+              c.width = value.length if value.length > c.width
+            end
+          end
+        end unless resultset.nil?
+
+        # prepare the horizontal rule for header and footer
+        rule = "+-" + displayed_columns.collect { |c| '-' * c.width }.join("-+-") + "-+"
+        # output header
+        puts rule
+        puts "| " + displayed_columns.collect { |c| c.alias.ljust(c.width,' ') }.join(" | ") + " |"
+        puts rule
+
+        # output each row
+        resultset.each do |r|
+          puts "| " + displayed_columns.collect { |c| r[c.index].to_s.ljust(c.width, ' ') }.join(" | ") + " |"
+        end unless resultset.nil?
+
+        # output footer
+        puts rule
+      when 'csv'
+        # output header
+        puts displayed_columns.collect { |c| c.alias.inspect }.join(",")
+        # output each row
+        resultset.each do |r|
+          # TODO: use FasterCSV to emit the data, since this does escape the text, but not in a manner that can be consumed by FasterCSV
+          puts displayed_columns.collect { |c| r[c.index].to_s.inspect }.join(",")
+        end unless resultset.nil?
+      end
+    end
+  end
+  
+  class TimeStamp
+    def to_s
+      "%04d-%02d-%02d %02d:%02d:%02d.%03u" % [ year, month, day, hour, minute, second, fraction ]
+    end
+  end
+end

data/lib/rsql/rsql.rb

@@ -0,0 +1,203 @@
+module RSQL
+  OPTIONS = { :mode => 'column', :password => '', :user => ENV['USER'] }
+
+  class RSQL < Object
+    include Singleton
+    
+    class << self
+      def execute(command)
+        # split command into POSIX tokens
+        if args = shellwords(command)
+          # extract the actual command name
+          method_name = args.shift
+          # make sure there was a command
+          unless method_name.nil?
+            # if the command name corresponds to a method
+            if instance.respond_to?(method_name)
+              # invoke it
+              instance.send(method_name, *args)
+            else
+              # otherwise, hand it off to ODBC
+              instance.send :execute, command
+            end
+          end
+        end
+      rescue => error
+        puts "ERROR: #{error}"
+      end
+    end
+
+    private
+
+    def initialize
+      @dsn = nil
+      @database = nil
+    end
+
+    def execute(command)
+      unless @database.nil?
+        begin
+          @database.run(command) do |result|
+            begin
+              result.print
+            rescue
+              raise
+            ensure
+              result.drop
+            end
+          end
+        rescue
+          raise
+        end
+      else
+        puts "No dsn selected"
+      end
+    end
+    
+    public
+
+    def commit
+      unless @database.nil?
+        begin
+          @database.commit
+        rescue
+          puts "ERROR: Commit failed"
+          raise
+        end
+      else
+        puts "No dsn selected"
+      end
+    end
+    
+    def describe(table, column = nil)
+      unless @database.nil?
+        begin
+          if column
+            statement = @database.columns(table, column)
+          else
+            statement = @database.columns(table)
+          end
+        rescue
+          raise
+        else
+          begin
+            statement.print :COLUMN_NAME => 'Field', :TYPE_NAME => 'Type', :COLUMN_SIZE => 'Size', :IS_NULLABLE => 'Null', :COLUMN_DEF => 'Default'
+          rescue
+            raise
+          ensure
+            statement.drop
+          end
+        end
+      else
+        puts "No dsn selected"
+      end
+    end
+    
+    def help
+      puts "COMMIT"
+      puts "DESCRIBE table"
+      puts "HELP"
+      puts "QUIT"
+      puts "SET AUTOCOMMIT=value"
+      puts "SHOW TABLES [LIKE pattern]"
+      puts "USE dsn"
+    end
+
+    def quit
+      exit
+    end
+  
+    def set(expression)
+      unless @database.nil?
+        matches = /([a-z]*)=(.*)/.match(expression)
+        if matches
+          variable,value = matches[1,2]
+          case variable.downcase
+          when "autocommit"
+            begin
+              @database.autocommit = (1.coerce(value)[0] != 0)
+            rescue ArgumentError
+              raise(StandardError, "Variable '#{variable}' can't be set to the value of '#{value}'")
+            else
+              puts "autocommit set to #{@database.autocommit}"
+            end
+          else
+            raise(StandardError, "Unknown system variable '#{variable}'")
+          end
+        else
+          raise(StandardError, "Syntax error at '#{expression}'")
+        end
+      else
+        puts "No dsn selected"
+      end
+    end
+    
+    def show(what, *args)
+      unless @database.nil?
+        case what.downcase
+        when 'tables'
+          source = @dsn
+          begin
+            if opt = args.shift
+              if opt.downcase == 'like'
+                if pattern = args.shift
+                  statement = @database.tables(pattern)
+                  source += " (#{pattern})"
+                else
+                  raise(StandardError, "Missing pattern after '#{opt}'")
+                end
+              else
+                raise(StandardError, "Syntax error at '#{opt}'")
+              end
+            else
+              statement = @database.tables
+            end
+          rescue
+            raise
+          else
+            unless statement.nil?
+              begin
+                statement.print :TABLE_NAME => "Tables_in_#{source}"
+              rescue
+                raise
+              ensure
+                statement.drop
+              end
+            else
+              puts "No tables to show"
+            end
+          end
+        else
+          raise(StandardError, "Syntax error at '#{what}'")
+        end
+      else
+        puts "No dsn selected"
+      end
+    end
+    
+    def use(dsn)
+      begin
+        unless @database.nil?
+          begin
+            if @database.connected?
+              # in case of pending transaction
+              @database.rollback unless @database.autocommit
+              @database.disconnect
+            end
+          rescue
+          end
+        end
+        @dsn = dsn
+        @database = ODBC.connect(@dsn, OPTIONS[:user], OPTIONS[:password])
+      rescue
+        puts "ERROR: Unable to connect to DSN '#{@dsn}' as user '#{OPTIONS[:user]}'"
+        @database = nil
+        @dsn = nil
+        raise
+      else
+        puts "Database changed" unless OPTIONS[:quiet]
+      end
+    end
+    
+  end
+end

data/rsql.gemspec

@@ -0,0 +1,20 @@
+SPEC = Gem::Specification.new do |s| 
+  # identify the gem
+  s.name = "rsql" 
+  s.version = "0.9.4" 
+  s.author = "S. Brent Faulkner" 
+  s.email = "brentf@unwwwired.net" 
+  s.homepage = "http://www.unwwwired.net" 
+  # platform of choice
+  s.platform = Gem::Platform::RUBY 
+  # description of gem
+  s.summary = "A ruby implementation of an interactive SQL command-line for ODBC" 
+  s.files = %w(bin/rsql lib/rsql/odbc.rb lib/rsql/rsql.rb MIT-LICENSE Rakefile README rsql.gemspec)
+  s.require_path = "lib" 
+  # s.autorequire = "rsql" 
+  # s.test_file = "test/rsql.rb" 
+  s.has_rdoc = true 
+  s.extra_rdoc_files = ["README"] 
+  # s.add_dependency("BlueCloth", ">= 0.0.4") 
+  s.executables = ["rsql"]
+end 

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification 
+name: sbfaulkner-rsql
+version: !ruby/object:Gem::Version 
+  version: 0.9.4
+platform: ruby
+authors: 
+- S. Brent Faulkner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: brentf@unwwwired.net
+executables: 
+- rsql
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- bin/rsql
+- lib/rsql/odbc.rb
+- lib/rsql/rsql.rb
+- MIT-LICENSE
+- Rakefile
+- README
+- rsql.gemspec
+has_rdoc: true
+homepage: http://www.unwwwired.net
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A ruby implementation of an interactive SQL command-line for ODBC
+test_files: []
+