ironruby-dbi 0.1.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/dbd/general/test_database.rb

@@ -0,0 +1,195 @@
+@class = Class.new(DBDConfig.testbase(DBDConfig.current_dbtype)) do
+
+  def test_empty_query
+    ["", " ", "\t"].each do |str|
+      [:do, :prepare, :execute, :select_one, :select_all].each do |call|
+        assert_raises(DBI::InterfaceError) do
+          @dbh.send(call, str)
+        end
+      end
+    end
+  end
+
+  def test_ping
+    assert @dbh.ping
+    # XXX if it isn't obvious, this should be tested better. Not sure what
+    # good behavior is yet.
+  end
+
+  def test_columns
+    assert_nothing_raised do
+      cols = @dbh.columns("precision_test")
+
+      assert(cols)
+      assert_kind_of(Array, cols)
+      assert_equal(4, cols.length)
+
+      # the first column should always be "text_field" and have the following
+      # properties:
+      assert_equal("text_field", cols[0]["name"])
+      assert(!cols[0]["nullable"])
+
+      assert_equal(20, cols[0]["precision"])
+      # scale can be either nil or 0 for character types.
+      case cols[0]["scale"]
+        when nil
+          assert_equal(nil, cols[0]["scale"])
+        when 0
+          assert_equal(0, cols[0]["scale"])
+        else
+          flunk "scale can be either 0 or nil for character types"
+      end
+
+      assert_equal(
+              DBI::Type::Varchar.object_id,
+              DBI::TypeUtil.type_name_to_module(cols[0]["type_name"]).object_id
+      )
+
+      # the second column should always be "integer_field" and have the following
+      # properties:
+      assert_equal("integer_field", cols[1]["name"])
+      assert(cols[1]["nullable"])
+      assert_equal(1, cols[2]["scale"])
+      assert_equal(2, cols[2]["precision"])
+
+      assert_equal(
+              DBI::Type::Integer.object_id,
+              DBI::TypeUtil.type_name_to_module(cols[1]["type_name"]).object_id
+      )
+
+      # the second column should always be "integer_field" and have the following
+      # properties:
+      assert_equal("decimal_field", cols[2]["name"])
+      assert(cols[2]["nullable"])
+      assert_equal(1, cols[2]["scale"])
+      assert_equal(2, cols[2]["precision"])
+      assert_equal(
+              DBI::Type::Decimal.object_id,
+              DBI::TypeUtil.type_name_to_module(cols[2]["type_name"]).object_id
+      )
+
+      # the second column should always be "numeric_field" and have the following
+      # properties:
+      assert_equal("numeric_field", cols[3]["name"])
+      assert(cols[3]["nullable"])
+      assert_equal(6, cols[3]["scale"])
+      assert_equal(30, cols[3]["precision"])
+      assert_equal(
+              DBI::Type::Decimal.object_id,
+              DBI::TypeUtil.type_name_to_module(cols[3]["type_name"]).object_id
+      )
+
+      # finally, we ensure that every column in the array is a ColumnInfo
+      # object
+      cols.each { |col| assert_kind_of(DBI::ColumnInfo, col) }
+    end
+  end
+
+  def test_prepare
+    @sth = @dbh.prepare('select * from names')
+
+    assert @sth
+    assert_kind_of DBI::StatementHandle, @sth
+
+    @sth.finish
+  end
+
+  def test_do
+    assert_equal 1, @dbh.do("insert into names (name, age) values (@name, @age)", {:name => "Billy", :age => 21})
+
+    @sth = @dbh.prepare("select * from names where name = @name")
+    @sth.execute :name => "Billy"
+
+    assert_equal ["Billy", 21], @sth.fetch
+    @sth.finish
+  end
+
+  def test_tables
+    tables = @dbh.tables.sort
+
+    # since this is a general test, let's prune the system tables
+    # FIXME not so sure if this should be a general test anymore.
+    if dbtype == "odbc"
+      tables -= [
+              "administrable_role_authorizations",
+              "applicable_roles",
+              "attributes",
+              "check_constraint_routine_usage",
+              "check_constraints",
+              "column_domain_usage",
+              "column_privileges",
+              "column_udt_usage",
+              "columns",
+              "constraint_column_usage",
+              "constraint_table_usage",
+              "data_type_privileges",
+              "domain_constraints",
+              "domain_udt_usage",
+              "domains",
+              "element_types",
+              "enabled_roles",
+              "information_schema_catalog_name",
+              "key_column_usage",
+              "parameters",
+              "referential_constraints",
+              "role_column_grants",
+              "role_routine_grants",
+              "role_table_grants",
+              "role_usage_grants",
+              "routine_privileges",
+              "routines",
+              "schemata",
+              "sequences",
+              "sql_features",
+              "sql_implementation_info",
+              "sql_languages",
+              "sql_packages",
+              "sql_parts",
+              "sql_sizing",
+              "sql_sizing_profiles",
+              "table_constraints",
+              "table_privileges",
+              "tables",
+              "triggered_update_columns",
+              "triggers",
+              "usage_privileges",
+              "view_column_usage",
+              "view_routine_usage",
+              "view_table_usage",
+              "views"
+      ]
+    end
+
+    case dbtype
+      when "postgresql"
+        tables.reject! { |x| x =~ /^pg_/ }
+        assert_equal %w(array_test bit_test blob_test boolean_test bytea_test db_specific_types_test enum_type_test field_types_test names precision_test time_test timestamp_test view_names), tables
+      when 'sqlite3'
+        assert_equal %w(bit_test blob_test boolean_test db_specific_types_test field_types_test names names_defined_with_spaces precision_test time_test timestamp_test view_names), tables
+      else
+        assert_equal %w(bit_test blob_test boolean_test db_specific_types_test field_types_test names precision_test time_test timestamp_test view_names), tables
+    end
+  end
+
+  def test_attrs
+    # test defaults
+    assert @dbh["AutoCommit"] # should be true
+
+    # test setting
+    assert !(@dbh["AutoCommit"] = false)
+    assert !@dbh["AutoCommit"]
+
+    # test committing an outstanding transaction
+    @sth = @dbh.prepare("insert into names (name, age) values (@name, @age)")
+    @sth.execute(:name => "Billy", :age => 22)
+    @sth.finish
+
+    assert @dbh["AutoCommit"] = true # should commit at this point
+
+    @sth = @dbh.prepare("select * from names where name = @name")
+    @sth.execute(:name => "Billy")
+    res = @sth.fetch
+    @sth.finish
+    assert_equal [ "Billy", 22 ], res
+  end
+end