sqlite3-ruby 0.9.0-mswin32

data/lib/sqlite3/resultset.rb

@@ -0,0 +1,172 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'sqlite3/constants'
+require 'sqlite3/errors'
+
+module SQLite3
+
+  # The ResultSet object encapsulates the enumerability of a query's output.
+  # It is a simple cursor over the data that the query returns. It will
+  # very rarely (if ever) be instantiated directly. Instead, client's should
+  # obtain a ResultSet instance via Statement#execute.
+  class ResultSet
+    include Enumerable
+
+    # A trivial module for adding a +types+ accessor to an object.
+    module TypesContainer
+      attr_accessor :types
+    end
+
+    # A trivial module for adding a +fields+ accessor to an object.
+    module FieldsContainer
+      attr_accessor :fields
+    end
+
+    # Create a new ResultSet attached to the given database, using the
+    # given sql text.
+    def initialize( db, stmt )
+      @db = db
+      @driver = @db.driver
+      @stmt = stmt
+      commence
+    end
+
+    # A convenience method for compiling the virtual machine and stepping
+    # to the first row of the result set.
+    def commence
+      result = @driver.step( @stmt.handle )
+      check result
+      @first_row = true
+    end
+    private :commence
+
+    def check( result )
+      @eof = ( result == Constants::ErrorCode::DONE )
+      found = ( result == Constants::ErrorCode::ROW )
+      Error.check( result, @db ) unless @eof || found
+    end
+    private :check
+
+    # Reset the cursor, so that a result set which has reached end-of-file
+    # can be rewound and reiterated.
+    def reset( *bind_params )
+      @driver.reset( @stmt.handle )
+      @stmt.bind_params( *bind_params )
+      @eof = false
+      commence
+    end
+
+    # Query whether the cursor has reached the end of the result set or not.
+    def eof?
+      @eof
+    end
+
+    # Obtain the next row from the cursor. If there are no more rows to be
+    # had, this will return +nil+. If type translation is active on the
+    # corresponding database, the values in the row will be translated
+    # according to their types.
+    #
+    # The returned value will be an array, unless Database#results_as_hash has
+    # been set to +true+, in which case the returned value will be a hash.
+    #
+    # For arrays, the column names are accessible via the +fields+ property,
+    # and the column types are accessible via the +types+ property.
+    #
+    # For hashes, the column names are the keys of the hash, and the column
+    # types are accessible via the +types+ property.
+    def next
+      return nil if @eof
+
+      unless @first_row
+        result = @driver.step( @stmt.handle )
+        check result
+      end
+
+      @first_row = false
+
+      unless @eof
+        row = []
+        @driver.data_count( @stmt.handle ).times do |column|
+          case @driver.column_type( @stmt.handle, column )
+            when Constants::ColumnType::NULL then
+              row << nil
+            when Constants::ColumnType::BLOB then
+              row << @driver.column_blob( @stmt.handle, column )
+            else
+              row << @driver.column_text( @stmt.handle, column )
+          end
+        end
+
+        if @db.type_translation
+          row = @stmt.types.zip( row ).map do |type, value|
+            @db.translator.translate( type, value )
+          end
+        end
+
+        if @db.results_as_hash
+          new_row = Hash[ *( @stmt.columns.zip( row ).flatten ) ]
+          row.each_with_index { |value,idx| new_row[idx] = value }
+          row = new_row
+        else
+          row.extend FieldsContainer unless row.respond_to?(:fields)
+          row.fields = @stmt.columns
+        end
+
+        row.extend TypesContainer
+        row.types = @stmt.types
+
+        return row
+      end
+
+      nil
+    end
+
+    # Required by the Enumerable mixin. Provides an internal iterator over the
+    # rows of the result set.
+    def each
+      while row=self.next
+        yield row
+      end
+    end
+
+    def types
+      @stmt.types
+    end
+
+    def columns
+      @stmt.columns
+    end
+
+  end
+
+end

data/lib/sqlite3/statement.rb

@@ -0,0 +1,218 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'sqlite3/errors'
+require 'sqlite3/resultset'
+
+class String
+  def to_blob
+    SQLite3::Blob.new( self )
+  end
+end
+
+module SQLite3
+
+  # A class for differentiating between strings and blobs, when binding them
+  # into statements.
+  class Blob < String; end
+
+  # A statement represents a prepared-but-unexecuted SQL query. It will rarely
+  # (if ever) be instantiated directly by a client, and is most often obtained
+  # via the Database#prepare method.
+  class Statement
+
+    # This is any text that followed the first valid SQL statement in the text
+    # with which the statement was initialized. If there was no trailing text,
+    # this will be the empty string.
+    attr_reader :remainder
+
+    # The underlying opaque handle used to access the SQLite @driver.
+    attr_reader :handle
+
+    # Create a new statement attached to the given Database instance, and which
+    # encapsulates the given SQL text. If the text contains more than one
+    # statement (i.e., separated by semicolons), then the #remainder property
+    # will be set to the trailing text.
+    def initialize( db, sql, utf16=false )
+      @db = db
+      @driver = @db.driver
+      result, @handle, @remainder = @driver.prepare( @db.handle, sql )
+      Error.check( result, @db )
+    end
+
+    def close
+      @driver.finalize( @handle )
+    end
+
+    # Binds the given variables to the corresponding placeholders in the SQL
+    # text.
+    #
+    # See Database#execute for a description of the valid placeholder
+    # syntaxes.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table where a=? and b=?" )
+    #   stmt.bind_params( 15, "hello" )
+    #
+    # See also #execute, #bind_param, Statement#bind_param, and
+    # Statement#bind_params.
+    def bind_params( *bind_vars )
+      index = 1
+      bind_vars.each do |var|
+        if Hash === var
+          var.each { |key, val| bind_param key, val }
+        else
+          bind_param index, var
+          index += 1
+        end
+      end
+    end
+
+    # Binds value to the named (or positional) placeholder. If +param+ is a
+    # Fixnum, it is treated as an index for a positional placeholder.
+    # Otherwise it is used as the name of the placeholder to bind to.
+    #
+    # See also #bind_params.
+    def bind_param( param, value )
+      if Fixnum === param
+        case value
+          when Integer then
+            @driver.bind_int( @handle, param, value )
+          when Numeric then
+            @driver.bind_double( @handle, param, value.to_f )
+          when Blob then
+            @driver.bind_blob( @handle, param, value )
+          when nil then
+            @driver.bind_null( @handle, param )
+          else
+            @driver.bind_text( @handle, param, value )
+        end
+      else
+        index = @driver.bind_parameter_index(
+          @handle, param.to_s )
+        raise Exception, "no such bind parameter '#{param}'" if index == 0
+        bind_param index, value
+      end
+    end
+
+    # Execute the statement. This creates a new ResultSet object for the
+    # statement's virtual machine. If a block was given, the new ResultSet will
+    # be yielded to it; otherwise, the ResultSet will be returned.
+    #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table" )
+    #   stmt.execute do |result|
+    #     ...
+    #   end
+    #
+    # See also #bind_params, #execute!.
+    def execute( *bind_vars )
+      @driver.reset( @handle ) if @results
+
+      bind_params *bind_vars unless bind_vars.empty?
+      @results = ResultSet.new( @db, self )
+
+      if block_given?
+        yield @results
+      else
+        return @results
+      end
+    end
+
+    # Execute the statement. If no block was given, this returns an array of
+    # rows returned by executing the statement. Otherwise, each row will be
+    # yielded to the block.
+    #
+    # Any parameters will be bound to the statement using #bind_params.
+    #
+    # Example:
+    #
+    #   stmt = db.prepare( "select * from table" )
+    #   stmt.execute! do |row|
+    #     ...
+    #   end
+    #
+    # See also #bind_params, #execute.
+    def execute!( *bind_vars )
+      result = execute( *bind_vars )
+      rows = [] unless block_given?
+      while row = result.next
+        if block_given?
+          yield row
+        else
+          rows << row
+        end
+      end
+      rows
+    end
+
+    # Return an array of the column names for this statement. Note that this
+    # may execute the statement in order to obtain the metadata; this makes it
+    # a (potentially) expensive operation.
+    def columns
+      get_metadata unless @columns
+      return @columns
+    end
+
+    # Return an array of the data types for each column in this statement. Note
+    # that this may execute the statement in order to obtain the metadata; this
+    # makes it a (potentially) expensive operation.
+    def types
+      get_metadata unless @types
+      return @types
+    end
+
+    # A convenience method for obtaining the metadata about the query. Note
+    # that this will actually execute the SQL, which means it can be a
+    # (potentially) expensive operation.
+    def get_metadata
+      @columns = []
+      @types = []
+
+      column_count = @driver.column_count( @handle )
+      column_count.times do |column|
+        @columns << @driver.column_name( @handle, column )
+        @types << @driver.column_decltype( @handle, column )
+      end
+
+      @columns.freeze
+      @types.freeze
+    end
+    private :get_metadata
+
+  end
+
+end

data/lib/sqlite3/translator.rb

@@ -0,0 +1,135 @@
+#--
+# =============================================================================
+# Copyright (c) 2004, Jamis Buck (jgb3@email.byu.edu)
+# All rights reserved.
+# 
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+# 
+#     * Redistributions of source code must retain the above copyright notice,
+#       this list of conditions and the following disclaimer.
+# 
+#     * Redistributions in binary form must reproduce the above copyright
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+# 
+#     * The names of its contributors may not be used to endorse or promote
+#       products derived from this software without specific prior written
+#       permission.
+# 
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+# =============================================================================
+#++
+
+require 'time'
+
+module SQLite3
+
+  # The Translator class encapsulates the logic and callbacks necessary for
+  # converting string data to a value of some specified type. Every Database
+  # instance may have a Translator instance, in order to assist in type
+  # translation (Database#type_translation).
+  #
+  # Further, applications may define their own custom type translation logic
+  # by registering translator blocks with the corresponding database's
+  # translator instance (Database#translator).
+  class Translator
+
+    # Create a new Translator instance. It will be preinitialized with default
+    # translators for most SQL data types.
+    def initialize
+      @translators = Hash.new( proc { |type,value| value } )
+      register_default_translators
+    end
+
+    # Add a new translator block, which will be invoked to process type
+    # translations to the given type. The type should be an SQL datatype, and
+    # may include parentheses (i.e., "VARCHAR(30)"). However, any parenthetical
+    # information is stripped off and discarded, so type translation decisions
+    # are made solely on the "base" type name.
+    #
+    # The translator block itself should accept two parameters, "type" and
+    # "value". In this case, the "type" is the full type name (including
+    # parentheses), so the block itself may include logic for changing how a
+    # type is translated based on the additional data. The "value" parameter
+    # is the (string) data to convert.
+    #
+    # The block should return the translated value.
+    def add_translator( type, &block ) # :yields: type, value
+      @translators[ type_name( type ) ] = block
+    end
+
+    # Translate the given string value to a value of the given type. In the
+    # absense of an installed translator block for the given type, the value
+    # itself is always returned. Further, +nil+ values are never translated,
+    # and are always passed straight through regardless of the type parameter.
+    def translate( type, value )
+      unless value.nil?
+        @translators[ type_name( type ) ].call( type, value )
+      end
+    end
+
+    # A convenience method for working with type names. This returns the "base"
+    # type name, without any parenthetical data.
+    def type_name( type )
+      type = $1 if type =~ /^(.*?)\(/
+      type.upcase
+    end
+    private :type_name
+
+    # Register the default translators for the current Translator instance.
+    # This includes translators for most major SQL data types.
+    def register_default_translators
+      [ "date",
+        "datetime",
+        "time" ].each { |type| add_translator( type ) { |t,v| Time.parse( v ) } }
+
+      [ "decimal",
+        "float",
+        "numeric",
+        "double",
+        "real",
+        "dec",
+        "fixed" ].each { |type| add_translator( type ) { |t,v| v.to_f } }
+
+      [ "integer",
+        "smallint",
+        "mediumint",
+        "int",
+        "bigint" ].each { |type| add_translator( type ) { |t,v| v.to_i } }
+
+      [ "bit",
+        "bool",
+        "boolean" ].each do |type|
+        add_translator( type ) do |t,v|
+          !( v.strip.gsub(/00+/,"0") == "0" ||
+             v.downcase == "false" ||
+             v.downcase == "f" ||
+             v.downcase == "no" ||
+             v.downcase == "n" )
+        end
+      end
+
+      add_translator( "timestamp" ) { |type, value| Time.at( value.to_i ) }
+      add_translator( "tinyint" ) do |type, value|
+        if type =~ /\(\s*1\s*\)/
+          value.to_i == 1
+        else
+          value.to_i
+        end
+      end
+    end
+    private :register_default_translators
+
+  end
+
+end