sqlite3 0.0.0 → 0.0.1

data/lib/sqlite3/statement.rb

@@ -0,0 +1,231 @@
+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)
+      raise ArgumentError, "nil argument passed as sql text" unless sql
+      @db = db
+      @driver = @db.driver
+      @closed = false
+      @results = @columns = nil
+      result, @handle, @remainder = @driver.prepare(@db.handle, sql)
+      Error.check(result, @db)
+    end
+
+    # Closes the statement by finalizing the underlying statement
+    # handle. The statement must not be used after being closed.
+    def close
+      must_be_open!
+      @closed = true
+      @driver.finalize(@handle)
+    end
+
+    # Returns true if the underlying statement has been closed.
+    def closed?
+      @closed
+    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.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
+
+    # 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)
+      must_be_open!
+      reset! if active?
+      if Fixnum === param
+        case value
+        when Bignum then
+          @driver.bind_int64(@handle, param, value)
+        when Integer then
+          if value >= (2 ** 31)
+            @driver.bind_int64(@handle, param, value)
+          else
+            @driver.bind_int(@handle, param, value)
+          end
+        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
+        param = param.to_s
+        param = ":#{param}" unless param[0] == ?:
+        index = @driver.bind_parameter_index(@handle, param)
+        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)
+      must_be_open!
+      reset! if active?
+
+      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
+
+    # Resets the statement. This is typically done internally, though it might
+    # occassionally be necessary to manually reset the statement.
+    def reset!(clear_result=true)
+      @driver.reset(@handle)
+      @results = nil if clear_result
+    end
+
+    # Returns true if the statement is currently active, meaning it has an
+    # open result set.
+    def active?
+      not @results.nil?
+    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
+      must_be_open!
+
+      @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
+
+    # 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
+
+  end
+
+end

data/lib/sqlite3/translator.rb

@@ -0,0 +1,109 @@
+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
+      @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_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

data/lib/sqlite3/value.rb

@@ -0,0 +1,62 @@
+require "sqlite3/constants"
+
+module SQLite3
+
+  class Value
+    attr_reader :handle
+
+    def initialize(db, handle)
+      @driver = db.driver
+      @handle = handle
+    end
+
+    def null?
+      type == :null
+    end
+
+    def to_blob
+      @driver.value_blob(@handle)
+    end
+
+    def length(utf16 = false)
+      if utf16
+        @driver.value_bytes16(@handle)
+      else
+        @driver.value_bytes(@handle)
+      end
+    end
+
+    def to_f
+      @driver.value_double(@handle)
+    end
+
+    def to_i
+      @driver.value_int(@handle)
+    end
+
+    def to_int64
+      @driver.value_int64(@handle)
+    end
+
+    def to_s(utf16 = false)
+      @driver.value_text(@handle, utf16)
+    end
+
+    def type
+      case @driver.value_type(@handle)
+      when Constants::ColumnType::INTEGER
+        :int
+      when Constants::ColumnType::FLOAT
+        :float
+      when Constants::ColumnType::TEXT
+        :text
+      when Constants::ColumnType::BLOB
+        :blob
+      when Constants::ColumnType::NULL
+        :null
+      end
+    end
+
+  end
+
+end

data/lib/sqlite3/version.rb

@@ -0,0 +1,14 @@
+module SQLite3
+
+  module Version
+
+    MAJOR = 1
+    MINOR = 2
+    TINY  = 4
+
+    STRING = [ MAJOR, MINOR, TINY ].join(".")
+    #:beta-tag:
+
+  end
+
+end

data/test/helper.rb

@@ -1,10 +1,11 @@
-require 'rubygems'
-require 'test/unit'
-require 'shoulda'
+require "rubygems"
+gem "test-unit"
+require "test/unit"
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'sqlite3'
+require "sqlite3"
 
 class Test::Unit::TestCase
+
 end

data/test/test_database_initialization.rb

@@ -0,0 +1,26 @@
+require "helper"
+
+class TestDatabaseInitialization < Test::Unit::TestCase
+  def setup
+    @db_filename = "test_database.db"
+    File.delete(@db_filename) if File.exists?(@db_filename)
+    @db = SQLite3::Database.new(@db_filename)
+  end
+
+  def teardown
+    File.delete(@db_filename) if File.exists?(@db_filename)
+  end
+
+  def test_database_file_exists
+    assert File.exists?(@db_filename)
+  end
+
+  def test_database_opened
+    assert_false @db.closed?
+  end
+
+  def test_database_closing
+    @db.close
+    assert @db.closed?
+  end
+end