sqlite3 1.4.2 → 1.7.2

data/lib/sqlite3/database.rb

@@ -18,7 +18,7 @@ module SQLite3
   #     end
   #   end
   #
-  # It wraps the lower-level methods provides by the selected driver, and
+  # It wraps the lower-level methods provided by the selected driver, and
   # includes the Pragmas module for access to various pragma convenience
   # methods.
   #
@@ -39,7 +39,22 @@ module SQLite3
 
     class << self
 
-      alias :open :new
+      # Without block works exactly as new.
+      # With block, like new closes the database at the end, but unlike new
+      # returns the result of the block instead of the database instance.
+      def open( *args )
+        database = new(*args)
+
+        if block_given?
+          begin
+            yield database
+          ensure
+            database.close
+          end
+        else
+          database
+        end
+      end
 
       # Quotes the given string, making it safe to use in an SQL statement.
       # It replaces all instances of the single-quote character with two
@@ -56,15 +71,27 @@ module SQLite3
 
     # call-seq: SQLite3::Database.new(file, options = {})
     #
-    # Create a new Database object that opens the given file. If utf16
-    # is +true+, the filename is interpreted as a UTF-16 encoded string.
+    # Create a new Database object that opens the given file.
+    #
+    # Supported permissions +options+:
+    # - the default mode is <tt>READWRITE | CREATE</tt>
+    # - +:readonly+: boolean (default false), true to set the mode to +READONLY+
+    # - +:readwrite+: boolean (default false), true to set the mode to +READWRITE+
+    # - +:flags+: set the mode to a combination of SQLite3::Constants::Open flags.
+    #
+    # Supported encoding +options+:
+    # - +:utf16+: boolean (default false), is the filename's encoding UTF-16 (only needed if the filename encoding is not UTF_16LE or BE)
+    #
+    # Other supported +options+:
+    # - +:strict+: boolean (default false), disallow the use of double-quoted string literals (see https://www.sqlite.org/quirks.html#double_quoted_string_literals_are_accepted)
+    # - +:results_as_hash+: boolean (default false), return rows as hashes instead of arrays
+    # - +:type_translation+: boolean (default false), enable type translation
+    # - +:default_transaction_mode+: one of +:deferred+ (default), +:immediate+, or +:exclusive+. If a mode is not specified in a call to #transaction, this will be the default transaction mode.
     #
-    # By default, the new database will return result rows as arrays
-    # (#results_as_hash) and has type translation disabled (#type_translation=).
-
     def initialize file, options = {}, zvfs = nil
       mode = Constants::Open::READWRITE | Constants::Open::CREATE
 
+      file = file.to_path if file.respond_to? :to_path
       if file.encoding == ::Encoding::UTF_16LE || file.encoding == ::Encoding::UTF_16BE || options[:utf16]
         open16 file
       else
@@ -87,6 +114,10 @@ module SQLite3
         end
 
         open_v2 file.encode("utf-8"), mode, zvfs
+
+        if options[:strict]
+          disable_quirk_mode
+        end
       end
 
       @tracefunc        = nil
@@ -99,6 +130,7 @@ module SQLite3
       @type_translation = options[:type_translation]
       @type_translator  = make_type_translator @type_translation
       @readonly         = mode & Constants::Open::READONLY != 0
+      @default_transaction_mode = options[:default_transaction_mode] || :deferred
 
       if block_given?
         begin
@@ -111,9 +143,7 @@ module SQLite3
 
     def type_translation= value # :nodoc:
       warn(<<-eowarn) if $VERBOSE
-#{caller[0]} is calling SQLite3::Database#type_translation=
-SQLite3::Database#type_translation= is deprecated and will be removed
-in version 2.0.0.
+#{caller[0]} is calling `SQLite3::Database#type_translation=` which is deprecated and will be removed in version 2.0.0.
       eowarn
       @type_translator  = make_type_translator value
       @type_translation = value
@@ -184,9 +214,7 @@ in version 2.0.0.
         end
 
         warn(<<-eowarn) if $VERBOSE
-#{caller[0]} is calling SQLite3::Database#execute with nil or multiple bind params
-without using an array.  Please switch to passing bind parameters as an array.
-Support for bind parameters as *args will be removed in 2.0.0.
+#{caller[0]} is calling `SQLite3::Database#execute` with nil or multiple bind params without using an array.  Please switch to passing bind parameters as an array. Support for bind parameters as *args will be removed in 2.0.0.
         eowarn
       end
 
@@ -237,15 +265,13 @@ Support for bind parameters as *args will be removed in 2.0.0.
     # rows.
     #
     # See also #execute_batch2 for additional ways of
-    # executing statments.
+    # executing statements.
     def execute_batch( sql, bind_vars = [], *args )
       # FIXME: remove this stuff later
       unless [Array, Hash].include?(bind_vars.class)
         bind_vars = [bind_vars]
         warn(<<-eowarn) if $VERBOSE
-#{caller[0]} is calling SQLite3::Database#execute_batch with bind parameters
-that are not a list of a hash.  Please switch to passing bind parameters as an
-array or hash. Support for this behavior will be removed in version 2.0.0.
+#{caller[0]} is calling `SQLite3::Database#execute_batch` with bind parameters that are not a list of a hash.  Please switch to passing bind parameters as an array or hash. Support for this behavior will be removed in version 2.0.0.
         eowarn
       end
 
@@ -258,9 +284,7 @@ array or hash. Support for this behavior will be removed in version 2.0.0.
         end
 
         warn(<<-eowarn) if $VERBOSE
-#{caller[0]} is calling SQLite3::Database#execute_batch with nil or multiple bind params
-without using an array.  Please switch to passing bind parameters as an array.
-Support for this behavior will be removed in version 2.0.0.
+#{caller[0]} is calling `SQLite3::Database#execute_batch` with nil or multiple bind params without using an array.  Please switch to passing bind parameters as an array. Support for this behavior will be removed in version 2.0.0.
         eowarn
       end
 
@@ -294,7 +318,7 @@ Support for this behavior will be removed in version 2.0.0.
     # a block can be passed to parse the values accordingly.
     #
     # See also #execute_batch for additional ways of
-    # executing statments.
+    # executing statements.
     def execute_batch2(sql, &block)
       if block_given?
         result = exec_batch(sql, @results_as_hash)
@@ -307,7 +331,7 @@ Support for this behavior will be removed in version 2.0.0.
     end
 
     # This is a convenience method for creating a statement, binding
-    # paramters to it, and calling execute:
+    # parameters to it, and calling execute:
     #
     #   result = db.query( "select * from foo where a=?", [5])
     #   # is the same as
@@ -327,9 +351,7 @@ Support for this behavior will be removed in version 2.0.0.
         end
 
         warn(<<-eowarn) if $VERBOSE
-#{caller[0]} is calling SQLite3::Database#query with nil or multiple bind params
-without using an array.  Please switch to passing bind parameters as an array.
-Support for this will be removed in version 2.0.0.
+#{caller[0]} is calling `SQLite3::Database#query` with nil or multiple bind params without using an array.  Please switch to passing bind parameters as an array. Support for this will be removed in version 2.0.0.
         eowarn
       end
 
@@ -536,10 +558,10 @@ Support for this will be removed in version 2.0.0.
     #   db.create_aggregate_handler( LengthsAggregateHandler )
     #   puts db.get_first_value( "select lengths(name) from A" )
     def create_aggregate_handler( handler )
-      # This is a compatiblity shim so the (basically pointless) FunctionProxy
+      # This is a compatibility shim so the (basically pointless) FunctionProxy
       # "ctx" object is passed as first argument to both step() and finalize().
       # Now its up to the library user whether he prefers to store his
-      # temporaries as instance varibales or fields in the FunctionProxy.
+      # temporaries as instance variables or fields in the FunctionProxy.
       # The library user still must set the result value with
       # FunctionProxy.result= as there is no backwards compatible way to
       # change this.
@@ -574,7 +596,7 @@ Support for this will be removed in version 2.0.0.
     # The functions arity is the arity of the +step+ method.
     def define_aggregator( name, aggregator )
       # Previously, this has been implemented in C. Now this is just yet
-      # another compatiblity shim
+      # another compatibility shim
       proxy = Class.new do
         @template = aggregator
         @name = name
@@ -612,8 +634,10 @@ Support for this will be removed in version 2.0.0.
     # by SQLite, so attempting to nest a transaction will result in a runtime
     # exception.
     #
-    # The +mode+ parameter may be either <tt>:deferred</tt> (the default),
+    # The +mode+ parameter may be either <tt>:deferred</tt>,
     # <tt>:immediate</tt>, or <tt>:exclusive</tt>.
+    # If `nil` is specified, the default transaction mode, which was
+    # passed to #initialize, is used.
     #
     # If a block is given, the database instance is yielded to it, and the
     # transaction is committed when the block terminates. If the block
@@ -624,7 +648,8 @@ Support for this will be removed in version 2.0.0.
     # If a block is not given, it is the caller's responsibility to end the
     # transaction explicitly, either by calling #commit, or by calling
     # #rollback.
-    def transaction( mode = :deferred )
+    def transaction( mode = nil )
+      mode = @default_transaction_mode if mode.nil?
       execute "begin #{mode.to_s} transaction"
 
       if block_given?

data/lib/sqlite3/pragmas.rb

@@ -11,7 +11,7 @@ module SQLite3
 
     # Returns +true+ or +false+ depending on the value of the named pragma.
     def get_boolean_pragma( name )
-      get_first_value( "PRAGMA #{name}" ) != "0"
+      get_first_value( "PRAGMA #{name}" ) != 0
     end
 
     # Sets the given pragma to the given boolean value. The value itself
@@ -42,11 +42,11 @@ module SQLite3
     # Requests the given pragma (and parameters), and if the block is given,
     # each row of the result set will be yielded to it. Otherwise, the results
     # are returned as an array.
-    def get_query_pragma( name, *parms, &block ) # :yields: row
-      if parms.empty?
+    def get_query_pragma( name, *params, &block ) # :yields: row
+      if params.empty?
         execute( "PRAGMA #{name}", &block )
       else
-        args = "'" + parms.join("','") + "'"
+        args = "'" + params.join("','") + "'"
         execute( "PRAGMA #{name}( #{args} )", &block )
       end
     end
@@ -260,7 +260,7 @@ module SQLite3
     def full_column_names=( mode )
       set_boolean_pragma "full_column_names", mode
     end
-  
+
     def fullfsync
       get_boolean_pragma "fullfsync"
     end
@@ -356,7 +356,7 @@ module SQLite3
     def parser_trace=( mode )
       set_boolean_pragma "parser_trace", mode
     end
-  
+
     def query_only
       get_boolean_pragma "query_only"
     end
@@ -543,6 +543,13 @@ module SQLite3
 
         tweak_default(new_row) if needs_tweak_default
 
+        # Ensure the type value is downcased.  On Mac and Windows
+        # platforms this value is now being returned as all upper
+        # case.
+        if new_row['type']
+          new_row['type'] = new_row['type'].downcase
+        end
+
         if block_given?
           yield new_row
         else

data/lib/sqlite3/resultset.rb

@@ -20,18 +20,14 @@ module SQLite3
 
       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
+#{caller[0]} is calling `#{self.class}#types` which is deprecated and 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
+#{caller[0]} is calling `#{self.class}#fields` which is deprecated and 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
@@ -45,18 +41,14 @@ object that created this object
 
       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
+#{caller[0]} is calling `#{self.class}#types` which is deprecated and 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
+#{caller[0]} is calling `#{self.class}#fields` which is deprecated and 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

data/lib/sqlite3/statement.rb

@@ -137,7 +137,8 @@ module SQLite3
         column_name column
       end
       @types = Array.new(column_count) do |column|
-        column_decltype column
+        val = column_decltype(column)
+        val.nil? ? nil : val.downcase
       end
     end
   end

data/lib/sqlite3/translator.rb

@@ -36,14 +36,13 @@ module SQLite3
     # 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
+#{caller[0]} is calling `SQLite3::Translator#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
+    # absence 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 )

data/lib/sqlite3/version.rb

@@ -1,16 +1,14 @@
 module SQLite3
 
-  VERSION = '1.4.2'
+  VERSION = "1.7.2"
 
   module VersionProxy
-
     MAJOR = 1
-    MINOR = 4
+    MINOR = 7
     TINY  = 2
     BUILD = nil
 
     STRING = [ MAJOR, MINOR, TINY, BUILD ].compact.join( "." )
-    #:beta-tag:
 
     VERSION = ::SQLite3::VERSION
   end
@@ -18,7 +16,7 @@ module SQLite3
   def self.const_missing(name)
     return super unless name == :Version
     warn(<<-eowarn) if $VERBOSE
-#{caller[0]}: SQLite::Version will be removed in sqlite3-ruby version 2.0.0
+#{caller[0]}: `SQLite::Version` will be removed in sqlite3-ruby version 2.0.0
     eowarn
     VersionProxy
   end

data/test/helper.rb

@@ -1,6 +1,15 @@
 require 'sqlite3'
 require 'minitest/autorun'
 
+if ENV['GITHUB_ACTIONS'] == 'true' || ENV['CI']
+  $VERBOSE = nil
+end
+
+puts "info: sqlite3-ruby version: #{SQLite3::VERSION}/#{SQLite3::VersionProxy::STRING}"
+puts "info: sqlite3 version: #{SQLite3::SQLITE_VERSION}/#{SQLite3::SQLITE_LOADED_VERSION}"
+puts "info: sqlcipher?: #{SQLite3.sqlcipher?}"
+puts "info: threadsafe?: #{SQLite3.threadsafe?}"
+
 unless RUBY_VERSION >= "1.9"
   require 'iconv'
 end