sqlite3-static 3.12.2

data/lib/sqlite3/resultset.rb

@@ -0,0 +1,195 @@
+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, clients should
+  # obtain a ResultSet instance via Statement#execute.
+  class ResultSet
+    include Enumerable
+
+    class ArrayWithTypes < Array # :nodoc:
+      attr_accessor :types
+    end
+
+    class ArrayWithTypesAndFields < Array # :nodoc:
+      attr_writer :types
+      attr_writer :fields
+
+      def types
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#types.  This method will be removed in
+sqlite3 version 2.0.0, please call the `types` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @types
+      end
+
+      def fields
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#fields.  This method will be removed in
+sqlite3 version 2.0.0, please call the `columns` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @fields
+      end
+    end
+
+    # The class of which we return an object in case we want a Hash as
+    # result.
+    class HashWithTypesAndFields < Hash # :nodoc:
+      attr_writer :types
+      attr_writer :fields
+
+      def types
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#types.  This method will be removed in
+sqlite3 version 2.0.0, please call the `types` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @types
+      end
+
+      def fields
+        warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling #{self.class}#fields.  This method will be removed in
+sqlite3 version 2.0.0, please call the `columns` method on the SQLite3::ResultSet
+object that created this object
+        eowarn
+        @fields
+      end
+
+      def [] key
+        key = fields[key] if key.is_a? Numeric
+        super key
+      end
+    end
+
+    # Create a new ResultSet attached to the given database, using the
+    # given sql text.
+    def initialize db, stmt
+      @db   = db
+      @stmt = stmt
+    end
+
+    # Reset the cursor, so that a result set which has reached end-of-file
+    # can be rewound and reiterated.
+    def reset( *bind_params )
+      @stmt.reset!
+      @stmt.bind_params( *bind_params )
+      @eof = false
+    end
+
+    # Query whether the cursor has reached the end of the result set or not.
+    def eof?
+      @stmt.done?
+    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
+      if @db.results_as_hash
+        return next_hash
+      end
+
+      row = @stmt.step
+      return nil if @stmt.done?
+
+      if @db.type_translation
+        row = @stmt.types.zip(row).map do |type, value|
+          @db.translator.translate( type, value )
+        end
+      end
+
+      if row.respond_to?(:fields)
+        # FIXME: this can only happen if the translator returns something
+        # that responds to `fields`.  Since we're removing the translator
+        # in 2.0, we can remove this branch in 2.0.
+        row = ArrayWithTypes.new(row)
+      else
+        # FIXME: the `fields` and `types` methods are deprecated on this
+        # object for version 2.0, so we can safely remove this branch
+        # as well.
+        row = ArrayWithTypesAndFields.new(row)
+      end
+
+      row.fields = @stmt.columns
+      row.types = @stmt.types
+      row
+    end
+
+    # Required by the Enumerable mixin. Provides an internal iterator over the
+    # rows of the result set.
+    def each
+      while node = self.next
+        yield node
+      end
+    end
+
+    # Provides an internal iterator over the rows of the result set where
+    # each row is yielded as a hash.
+    def each_hash
+      while node = next_hash
+        yield node
+      end
+    end
+
+    # Closes the statement that spawned this result set.
+    # <em>Use with caution!</em> Closing a result set will automatically
+    # close any other result sets that were spawned from the same statement.
+    def close
+      @stmt.close
+    end
+
+    # Queries whether the underlying statement has been closed or not.
+    def closed?
+      @stmt.closed?
+    end
+
+    # Returns the types of the columns returned by this result set.
+    def types
+      @stmt.types
+    end
+
+    # Returns the names of the columns returned by this result set.
+    def columns
+      @stmt.columns
+    end
+
+    # Return the next row as a hash
+    def next_hash
+      row = @stmt.step
+      return nil if @stmt.done?
+
+      # FIXME: type translation is deprecated, so this can be removed
+      # in 2.0
+      if @db.type_translation
+        row = @stmt.types.zip(row).map do |type, value|
+          @db.translator.translate( type, value )
+        end
+      end
+
+      # FIXME: this can be switched to a regular hash in 2.0
+      row = HashWithTypesAndFields[*@stmt.columns.zip(row).flatten]
+
+      # FIXME: these methods are deprecated for version 2.0, so we can remove
+      # this code in 2.0
+      row.fields = @stmt.columns
+      row.types = @stmt.types
+      row
+    end
+  end
+end

data/lib/sqlite3/statement.rb

@@ -0,0 +1,144 @@
+require 'sqlite3/errors'
+require 'sqlite3/resultset'
+
+class String
+  def to_blob
+    SQLite3::Blob.new( self )
+  end
+end
+
+module SQLite3
+  # 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
+    include Enumerable
+
+    # 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
+
+    # 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.flatten.each do |var|
+        if Hash === var
+          var.each { |key, val| bind_param key, val }
+        else
+          bind_param index, var
+          index += 1
+        end
+      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 )
+      reset! if active? || done?
+
+      bind_params(*bind_vars) unless bind_vars.empty?
+      @results = ResultSet.new(@connection, self)
+
+      step if 0 == column_count
+
+      yield @results if block_given?
+      @results
+    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, &block )
+      execute(*bind_vars)
+      block_given? ? each(&block) : to_a
+    end
+
+    # Returns true if the statement is currently active, meaning it has an
+    # open result set.
+    def active?
+      !done?
+    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
+
+    def each
+      loop do
+        val = step
+        break self if done?
+        yield val
+      end
+    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
+      must_be_open!
+      get_metadata unless @types
+      @types
+    end
+
+    # Performs a sanity check to ensure that the statement is not
+    # closed. If it is, an exception is raised.
+    def must_be_open! # :nodoc:
+      if closed?
+        raise SQLite3::Exception, "cannot use a closed statement"
+      end
+    end
+
+    private
+    # 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 = Array.new(column_count) do |column|
+        column_name column
+      end
+      @types = Array.new(column_count) do |column|
+        column_decltype column
+      end
+    end
+  end
+end

data/lib/sqlite3/translator.rb

@@ -0,0 +1,118 @@
+require 'time'
+require 'date'
+
+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 } )
+      @type_name_cache = {}
+      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
+      warn(<<-eowarn) if $VERBOSE
+#{caller[0]} is calling `add_translator`.
+Built in translators are deprecated and will be removed in version 2.0.0
+      eowarn
+      @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?
+        # FIXME: this is a hack to support Sequel
+        if type && %w{ datetime timestamp }.include?(type.downcase)
+          @translators[ type_name( type ) ].call( type, value.to_s )
+        else
+          @translators[ type_name( type ) ].call( type, value )
+        end
+      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_name_cache[type] ||= begin
+        type = "" if type.nil?
+        type = $1 if type =~ /^(.*?)\(/
+        type.upcase
+      end
+    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
+      [ "time",
+        "timestamp" ].each { |type| add_translator( type ) { |t, v| Time.parse( v ) } }
+
+      add_translator( "date" ) { |t,v| Date.parse(v) }
+      add_translator( "datetime" ) { |t,v| DateTime.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( "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