dbi 0.4.0

data/lib/dbi/utils/tableformatter.rb

@@ -0,0 +1,112 @@
+module DBI
+    module Utils
+        # Formats a resultset in a textual table, suitable for printing.
+        module TableFormatter
+
+            def self.coerce(obj) # :nodoc:
+                # FIXME this is probably short-sighted.
+                obj = "NULL" if obj.nil?
+                obj = (obj.kind_of?(Array) or obj.kind_of?(Hash)) ? obj.inspect : obj.to_s
+                return obj
+            end
+
+            # Perform the formatting.
+            #
+            # * +header+: table headers, as you'd expect they correspond to each column in the row.
+            # * +rows+: array of array (or DBI::Row) which represent the data.
+            # * +header_orient+: jusification of the header. :left, :right, or :center.
+            # * +rows_orient+: justification of the rows. same as +header_orient+.
+            # * +indent+: number of spaces to indent each line in the output.
+            # * +cellspace+: number of spaces to pad the cell on the left and right.
+            # * +pagebreak_after+: introduce a pagebreak each +n+ rows.
+            # * +output+: object that responds to `<<` which will contain the output. Default is STDOUT.
+            #
+            # If a block is provided, +output+ will be yielded each row if
+            # +pagebreak+ is nil, otherwise it will be yielded when the output
+            # is complete.
+            #--
+            # TODO: add a nr-column where the number of the column is shown
+            #++
+            def self.ascii(header, 
+                           rows, 
+                           header_orient=:left, 
+                           rows_orient=:left, 
+                           indent=2, 
+                           cellspace=1, 
+                           pagebreak_after=nil,
+                           output=STDOUT)
+
+                if rows.size == 0 or rows[0].size == 0
+                    output.puts "No rows selected"
+                    return
+                end
+
+                header_orient ||= :left
+                rows_orient   ||= :left
+                indent        ||= 2
+                cellspace     ||= 1
+
+                # pagebreak_after n-rows (without counting header or split-lines)
+                # yield block with output as param after each pagebreak (not at the end)
+
+                col_lengths = (0...(header.size)).collect do |colnr|
+                    [
+                        (0...rows.size).collect { |rownr|
+                        value = rows[rownr][colnr]
+                        coerce(value).size
+                    }.max,
+                        header[colnr].size
+                    ].max
+                end
+
+                indent = " " * indent
+
+                split_line = indent + "+"
+                col_lengths.each {|col| split_line << "-" * (col+cellspace*2) + "+" }
+
+                cellspace = " " * cellspace
+
+                output_row = proc {|row, orient|
+                    output << indent + "|"
+                    row.each_with_index {|c,i|
+                        output << cellspace
+
+                        str = coerce(c)
+
+                        output << case orient
+                        when :left then   str.ljust(col_lengths[i])
+                        when :right then  str.rjust(col_lengths[i])
+                        when :center then str.center(col_lengths[i])
+                        end 
+                        output << cellspace
+                        output << "|"
+                    }
+                    output << "\n" 
+                } 
+
+                rownr = 0
+
+                loop do 
+                    output << split_line + "\n"
+                    output_row.call(header, header_orient)
+                    output << split_line + "\n"
+                    if pagebreak_after.nil?
+                        rows.each {|ar| output_row.call(ar, rows_orient)}
+                        output << split_line + "\n"
+                        break
+                    end      
+
+                    rows[rownr,pagebreak_after].each {|ar| output_row.call(ar, rows_orient)}
+                    output << split_line + "\n"
+
+                    rownr += pagebreak_after
+
+                    break if rownr >= rows.size
+
+                    yield output if block_given?
+                end
+
+            end
+        end # module TableFormatter
+    end
+end

data/lib/dbi/utils/time.rb

@@ -0,0 +1,52 @@
+module DBI
+    #
+    # Represents a Time
+    #
+    # DEPRECATED: Please use a regular Time or DateTime object.
+   class Time
+      attr_accessor :hour, :minute, :second
+
+      private
+      # DBI::Time.new(hour = 0, minute = 0, second = 0)
+      # DBI::Time.new(Time)
+      #
+      # Creates and returns a new DBI::Time object.  Unlike the Time object
+      # in the standard library, accepts an hour, minute and second, or a
+      # Time object.
+      def initialize(hour=0, minute=0, second=0)
+         case hour
+            when ::Time
+               @hour, @minute, @second = hour.hour, hour.min, hour.sec
+               @original_time = hour
+            else
+               @hour, @minute, @second = hour, minute, second
+         end
+      end
+
+      public
+      
+      deprecate :initialize, :public
+
+      alias :min :minute
+      alias :min= :minute=
+      alias :sec :second
+      alias :sec= :second=
+
+      # Returns a new Time object based on the hour, minute and second, using
+      # the current year, month and day.  If a Time object was passed to the
+      # constructor, returns that object instead.
+      def to_time
+         if @original_time
+            @original_time
+         else
+            t = ::Time.now
+            ::Time.local(t.year, t.month, t.day, @hour, @minute, @second)
+         end
+      end
+
+      # Returns a DBI::Time object as a string in HH:MM:SS format.
+      def to_s
+         sprintf("%02d:%02d:%02d", @hour, @minute, @second)
+      end
+   end
+end

data/lib/dbi/utils/timestamp.rb

@@ -0,0 +1,96 @@
+module DBI
+    #
+    # Represents a Timestamp.
+    #
+    # DEPRECATED: Please use a regular DateTime object.
+    #
+   class Timestamp
+      attr_accessor :year, :month, :day
+      attr_accessor :hour, :minute, :second
+      attr_writer   :fraction
+
+      private
+      # DBI::Timestamp(year=0,month=0,day=0,hour=0,min=0,sec=0,fraction=nil)
+      # DBI::Timestamp(Time)
+      # DBI::Timestamp(Date)
+      #
+      # Creates and returns a new DBI::Timestamp object.  This is similar to
+      # a Time object in the standard library, but it also contains fractional
+      # seconds, expressed in nanoseconds.  In addition, the constructor
+      # accepts either a Date or Time object.
+      def initialize(year=0, month=0, day=0, hour=0, min=0, sec=0, fraction=nil)
+         case year
+            when ::Time
+               @year, @month, @day = year.year, year.month, year.day 
+               @hour, @minute, @second, @fraction = year.hour, year.min, year.sec, nil 
+               @original_time = year
+            when ::Date
+               @year, @month, @day = year.year, year.month, year.day 
+               @hour, @minute, @second, @fraction = 0, 0, 0, nil 
+               @original_date = year
+            else
+               @year, @month, @day = year, month, day
+               @hour, @minute, @second, @fraction = hour, min, sec, fraction
+         end
+      end
+
+      public
+      
+      deprecate :initialize, :public
+
+      # Returns true if +timestamp+ has a year, month, day, hour, minute,
+      # second and fraction equal to the comparing object.
+      #
+      # Returns false if the comparison fails for any reason.
+      def ==(timestamp)
+         @year == timestamp.year and @month == timestamp.month and
+         @day == timestamp.day and @hour == timestamp.hour and
+         @minute == timestamp.minute and @second == timestamp.second and
+         (fraction() == timestamp.fraction)
+      rescue
+         false
+      end
+
+      # Returns fractional seconds, or 0 if not set.
+      def fraction
+         @fraction || 0
+      end
+
+      # Aliases
+      alias :mon :month
+      alias :mon= :month=
+      alias :mday :day
+      alias :mday= :day=
+      alias :min :minute
+      alias :min= :minute=
+      alias :sec :second
+      alias :sec= :second=
+
+      # Returns a DBI::Timestamp object as a string in YYYY-MM-DD HH:MM:SS
+      # format.  If a fraction is present, then it is appended in ".FF" format.
+      def to_s
+         string = sprintf("%04d-%02d-%02d %02d:%02d:%02d",
+             @year, @month, @day, @hour, @minute, @second) 
+
+         if @fraction
+            fraction = ("%.9f" % (@fraction.to_i / 1e9)).
+                        to_s[1..-1].gsub(/0{1,8}$/, "")
+            string += fraction
+         end
+
+         string
+      end
+
+      # Returns a new Time object based on the year, month and day or, if a
+      # Time object was passed to the constructor, returns that object.
+      def to_time
+         @original_time || ::Time.local(@year, @month, @day, @hour, @minute, @second)
+      end
+
+      # Returns a new Date object based on the year, month and day or, if a
+      # Date object was passed to the constructor, returns that object.
+      def to_date
+         @original_date || ::Date.new(@year, @month, @day)
+      end
+   end
+end

data/lib/dbi/utils/xmlformatter.rb

@@ -0,0 +1,73 @@
+module DBI
+    module Utils
+        # Formats results in XML.
+        module XMLFormatter
+            # Generate XML for a row. The column names will surround the the values as tags.
+            #
+            # * +dbrow+: the array of the result row.
+            # * +rowtag+: the name of the tag that encapsulates a row.
+            # * +output+: Object that responds to `<<`.
+            #
+            def self.row(dbrow, rowtag="row", output=STDOUT)
+                #XMLFormatter.extended_row(dbrow, "row", [],  
+                output << "<#{rowtag}>\n"
+                dbrow.each_with_name do |val, name|
+                    output << "  <#{name}>" + textconv(val) + "</#{name}>\n" 
+                end
+                output << "</#{rowtag}>\n"
+            end
+
+            # good lord, what a mess.
+            #
+            # nil in cols_as_tag, means "all columns expect those listed in cols_in_row_tag"
+            # add_row_tag_attrs are additional attributes which are inserted into the row-tag
+            def self.extended_row(dbrow, rowtag="row", cols_in_row_tag=[], cols_as_tag=nil, add_row_tag_attrs={}, output=STDOUT)
+                if cols_as_tag.nil?
+                    cols_as_tag = dbrow.column_names - cols_in_row_tag
+                end
+
+                output << "<#{rowtag}"
+                add_row_tag_attrs.each do |key, val|  
+                    # TODO: use textconv ? " substitution?
+                    output << %{ #{key}="#{textconv(val)}"}
+                end
+                cols_in_row_tag.each do |key|
+                    # TODO: use textconv ? " substitution?
+                    output << %{ #{key}="#{dbrow[key]}"}
+                end
+                output << ">\n"
+
+                cols_as_tag.each do |key|
+                    output << "  <#{key}>" + textconv(dbrow[key]) + "</#{key}>\n" 
+                end
+                output << "</#{rowtag}>\n"
+            end
+
+            # generate a full XML representation of the table.
+            # 
+            # Arguments and output are similar to #row, with the exception of
+            # +roottag+, which is a container for the individual row tags.
+            #
+            def self.table(rows, roottag = "rows", rowtag = "row", output=STDOUT)
+                output << '<?xml version="1.0" encoding="UTF-8" ?>'
+                output << "\n<#{roottag}>\n"
+                rows.each do |row|
+                    row(row, rowtag, output)
+                end
+                output << "</#{roottag}>\n"
+            end
+
+            class << self
+                private
+                # Your standard XML entity conversions.
+                def textconv(str)
+                    str = str.to_s.gsub('&', "&#38;")
+                    str = str.gsub('\'', "&#39;")
+                    str = str.gsub('"', "&#34;")
+                    str = str.gsub('<', "&#60;")
+                    str.gsub('>', "&#62;")
+                end
+            end # class self
+        end # module XMLFormatter
+    end
+end

data/test/dbi/tc_columninfo.rb

@@ -0,0 +1,94 @@
+############################################################
+# tc_columninfo.rb
+#
+# Test case for the DBI::ColumnInfo class.
+############################################################
+$LOAD_PATH.unshift(Dir.pwd)
+$LOAD_PATH.unshift(File.dirname(Dir.pwd))
+$LOAD_PATH.unshift("../../lib")
+$LOAD_PATH.unshift("../../lib/dbi")
+$LOAD_PATH.unshift("lib")
+
+require "dbi/columninfo"
+require "test/unit"
+
+class TC_DBI_ColumnInfo < Test::Unit::TestCase
+   def setup
+      @colinfo = DBI::ColumnInfo.new(
+         "name"      => "test",
+         "sql_type"  => "numeric",
+         "type_name" => "test_type_name",
+         "precision" => 2,
+         "scale"     => 2,
+         "default"   => 100.00,
+         "nullable"  => false,
+         "indexed"   => true,
+         "primary"   => true,
+         "unique"    => false
+      )
+      @keys = %w/name sql_type type_name precision scale default nullable
+         indexed primary unique
+      /
+   end
+   
+   def test_constructor
+      assert_nothing_raised{ DBI::ColumnInfo.new }
+
+      assert_nothing_raised do
+          DBI::ColumnInfo.new({"foo" => "bar", "baz" => "quux"})
+          DBI::ColumnInfo.new({:foo => "bar", :baz => "quux"})
+      end
+
+      assert_raise(TypeError) do
+          DBI::ColumnInfo.new({"foo" => "bar", :foo => "quux"})
+      end
+   end
+
+   def test_accessors
+       assert_nothing_raised do
+           @keys.each do |x|
+               assert_equal(@colinfo[x], @colinfo[x.to_sym])
+               assert_equal(@colinfo.send(x.to_sym), @colinfo[x.to_sym])
+               @colinfo[x] = "poop"
+               assert_equal("poop", @colinfo[x])
+               assert_equal("poop", @colinfo[x.to_sym])
+           end
+       end
+   end
+
+   def test_precision_basic
+      assert_respond_to(@colinfo, :size)
+      assert_respond_to(@colinfo, :size=)
+      assert_respond_to(@colinfo, :length)
+      assert_respond_to(@colinfo, :length=)
+   end
+
+   def test_scale_basic
+      assert_respond_to(@colinfo, :decimal_digits)
+      assert_respond_to(@colinfo, :decimal_digits=)
+   end
+
+   def test_default_value_basic
+      assert_respond_to(@colinfo, :default_value)
+      assert_respond_to(@colinfo, :default_value=)
+   end
+
+   def test_unique_basic
+      assert_respond_to(@colinfo, :is_unique)
+   end
+
+   def test_keys
+      assert_respond_to(@colinfo, :keys)
+      assert_equal(@keys.sort, @colinfo.keys.collect { |x| x.to_s }.sort)
+   end
+   
+   def test_respond_to_hash_methods
+      assert_respond_to(@colinfo, :each)
+      assert_respond_to(@colinfo, :empty?)
+      assert_respond_to(@colinfo, :has_key?)
+   end
+
+   def teardown
+      @colinfo = nil
+   end
+end

data/test/dbi/tc_date.rb

@@ -0,0 +1,88 @@
+##############################################################################
+# tc_date.rb
+#
+# Test case for the DBI::Date class (currently) located in the utils.rb file.
+##############################################################################
+$LOAD_PATH.unshift(Dir.pwd)
+$LOAD_PATH.unshift(File.dirname(Dir.pwd))
+$LOAD_PATH.unshift("../../lib")
+$LOAD_PATH.unshift("../../lib/dbi")
+$LOAD_PATH.unshift("lib")
+
+require 'date'
+require 'dbi'
+require 'test/unit'
+
+Deprecate.set_action(proc { })
+
+class TC_DBI_Date < Test::Unit::TestCase
+   def setup
+      @date     = Date.new
+      @time     = Time.now
+      @dbi_date = DBI::Date.new
+   end
+
+   def test_constructor
+      assert_nothing_raised{ DBI::Date.new(2006) }
+      assert_nothing_raised{ DBI::Date.new(2006, 1) }
+      assert_nothing_raised{ DBI::Date.new(2006, 1, 20) }
+      assert_nothing_raised{ DBI::Date.new(Date.new) }
+      assert_nothing_raised{ DBI::Date.new(Time.now) }
+   end
+
+   def test_year
+      assert_respond_to(@dbi_date, :year)
+      assert_respond_to(@dbi_date, :year=)
+      assert_equal(0, @dbi_date.year)
+   end
+
+   def test_month
+      assert_respond_to(@dbi_date, :month)
+      assert_respond_to(@dbi_date, :month=)
+   end
+
+   # An alias for :month, :month=
+   def test_mon
+      assert_respond_to(@dbi_date, :mon)
+      assert_respond_to(@dbi_date, :mon=)
+      assert_equal(0, @dbi_date.mon)
+   end
+
+   def test_day
+      assert_respond_to(@dbi_date, :day)
+      assert_respond_to(@dbi_date, :day=)
+      assert_equal(0, @dbi_date.day)
+   end
+
+   # An alias for :day, :day=
+   def test_mday
+      assert_respond_to(@dbi_date, :mday)
+      assert_respond_to(@dbi_date, :mday=)
+   end
+
+   def test_to_time
+      assert_respond_to(@dbi_date, :to_time)
+      assert_equal(@time, DBI::Date.new(@time).to_time)
+      assert_equal(@time.object_id, DBI::Date.new(@time).to_time.object_id)
+   end
+
+   def test_to_date
+      assert_respond_to(@dbi_date, :to_date)
+      assert_equal(@date, DBI::Date.new(@date).to_date)
+      assert_equal(@date.object_id, DBI::Date.new(@date).to_date.object_id)
+   end
+
+   # We test .to_s because it has an explicit implementation
+   def test_to_s
+      assert_respond_to(@dbi_date, :to_s)
+      assert_nothing_raised{ @dbi_date.to_s }
+      assert_kind_of(String, @dbi_date.to_s)
+      assert_equal("0000-00-00", @dbi_date.to_s)
+   end
+
+   def teardown
+      @date = nil
+      @time = nil
+      @dbi_date = nil
+   end
+end