sqlite3 1.7.3 → 2.5.0

data/lib/sqlite3/resultset.rb

@@ -1,8 +1,7 @@
-require 'sqlite3/constants'
-require 'sqlite3/errors'
+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
@@ -10,68 +9,18 @@ module SQLite3
   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` 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` 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
-    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` 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` 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
-
-      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
+      @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 )
+    def reset(*bind_params)
       @stmt.reset!
-      @stmt.bind_params( *bind_params )
-      @eof = false
+      @stmt.bind_params(*bind_params)
     end
 
     # Query whether the cursor has reached the end of the result set or not.
@@ -80,9 +29,7 @@ module SQLite3
     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.
+    # had, this will return +nil+.
     #
     # 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.
@@ -93,36 +40,13 @@ module SQLite3
     # 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?
-
-      row = @db.translate_from_db @stmt.types, row
-
-      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
+      @stmt.step
     end
 
     # Required by the Enumerable mixin. Provides an internal iterator over the
     # rows of the result set.
     def each
-      while node = self.next
+      while (node = self.next)
         yield node
       end
     end
@@ -130,7 +54,7 @@ module SQLite3
     # 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
+      while (node = next_hash)
         yield node
       end
     end
@@ -162,18 +86,11 @@ module SQLite3
       row = @stmt.step
       return nil if @stmt.done?
 
-      # FIXME: type translation is deprecated, so this can be removed
-      # in 2.0
-      row = @db.translate_from_db @stmt.types, row
-
-      # 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
+      @stmt.columns.zip(row).to_h
     end
   end
+
+  class HashResultSet < ResultSet # :nodoc:
+    alias_method :next, :next_hash
+  end
 end

data/lib/sqlite3/statement.rb

@@ -1,9 +1,9 @@
-require 'sqlite3/errors'
-require 'sqlite3/resultset'
+require "sqlite3/errors"
+require "sqlite3/resultset"
 
 class String
   def to_blob
-    SQLite3::Blob.new( self )
+    SQLite3::Blob.new(self)
   end
 end
 
@@ -19,6 +19,23 @@ module SQLite3
     # this will be the empty string.
     attr_reader :remainder
 
+    # call-seq: SQLite3::Statement.new(db, sql)
+    #
+    # 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)
+      raise ArgumentError, "prepare called on a closed database" if db.closed?
+
+      sql = sql.encode(Encoding::UTF_8) if sql && sql.encoding != Encoding::UTF_8
+
+      @connection = db
+      @columns = nil
+      @types = nil
+      @remainder = prepare db, sql
+    end
+
     # Binds the given variables to the corresponding placeholders in the SQL
     # text.
     #
@@ -32,7 +49,7 @@ module SQLite3
     #
     # See also #execute, #bind_param, Statement#bind_param, and
     # Statement#bind_params.
-    def bind_params( *bind_vars )
+    def bind_params(*bind_vars)
       index = 1
       bind_vars.flatten.each do |var|
         if Hash === var
@@ -58,16 +75,16 @@ module SQLite3
     #   end
     #
     # See also #bind_params, #execute!.
-    def execute( *bind_vars )
+    def execute(*bind_vars)
       reset! if active? || done?
 
       bind_params(*bind_vars) unless bind_vars.empty?
-      @results = ResultSet.new(@connection, self)
+      results = @connection.build_result_set self
 
-      step if 0 == column_count
+      step if column_count == 0
 
-      yield @results if block_given?
-      @results
+      yield results if block_given?
+      results
     end
 
     # Execute the statement. If no block was given, this returns an array of
@@ -84,9 +101,9 @@ module SQLite3
     #   end
     #
     # See also #bind_params, #execute.
-    def execute!( *bind_vars, &block )
+    def execute!(*bind_vars, &block)
       execute(*bind_vars)
-      block_given? ? each(&block) : to_a
+      block ? each(&block) : to_a
     end
 
     # Returns true if the statement is currently active, meaning it has an
@@ -100,7 +117,7 @@ module SQLite3
     # a (potentially) expensive operation.
     def columns
       get_metadata unless @columns
-      return @columns
+      @columns
     end
 
     def each
@@ -128,7 +145,35 @@ module SQLite3
       end
     end
 
+    # Returns a Hash containing information about the statement.
+    # The contents of the hash are implementation specific and may change in
+    # the future without notice. The hash includes information about internal
+    # statistics about the statement such as:
+    #   - +fullscan_steps+: the number of times that SQLite has stepped forward
+    # in a table as part of a full table scan
+    #   - +sorts+: the number of sort operations that have occurred
+    #   - +autoindexes+: the number of rows inserted into transient indices
+    # that were created automatically in order to help joins run faster
+    #   - +vm_steps+: the number of virtual machine operations executed by the
+    # prepared statement
+    #   - +reprepares+: the number of times that the prepare statement has been
+    # automatically regenerated due to schema changes or changes to bound
+    # parameters that might affect the query plan
+    #   - +runs+: the number of times that the prepared statement has been run
+    #   - +filter_misses+: the number of times that the Bloom filter returned
+    # a find, and thus the join step had to be processed as normal
+    #   - +filter_hits+: the number of times that a join step was bypassed
+    # because a Bloom filter returned not-found
+    def stat key = nil
+      if key
+        stat_for(key)
+      else
+        stats_as_hash
+      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.
@@ -138,7 +183,7 @@ module SQLite3
       end
       @types = Array.new(column_count) do |column|
         val = column_decltype(column)
-        val.nil? ? nil : val.downcase
+        val&.downcase
       end
     end
   end

data/lib/sqlite3/value.rb

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

data/lib/sqlite3/version.rb

@@ -1,23 +1,4 @@
 module SQLite3
-
-  VERSION = "1.7.3"
-
-  module VersionProxy
-    MAJOR = 1
-    MINOR = 7
-    TINY  = 3
-    BUILD = nil
-
-    STRING = [ MAJOR, MINOR, TINY, BUILD ].compact.join( "." )
-
-    VERSION = ::SQLite3::VERSION
-  end
-
-  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
-    eowarn
-    VersionProxy
-  end
+  # (String) the version of the sqlite3 gem, e.g. "2.1.1"
+  VERSION = "2.5.0"
 end

data/lib/sqlite3/version_info.rb

@@ -0,0 +1,17 @@
+module SQLite3
+  # a hash of descriptive metadata about the current version of the sqlite3 gem
+  VERSION_INFO = {
+    ruby: RUBY_DESCRIPTION,
+    gem: {
+      version: SQLite3::VERSION
+    },
+    sqlite: {
+      compiled: SQLite3::SQLITE_VERSION,
+      loaded: SQLite3::SQLITE_LOADED_VERSION,
+      packaged: SQLite3::SQLITE_PACKAGED_LIBRARIES,
+      precompiled: SQLite3::SQLITE_PRECOMPILED_LIBRARIES,
+      sqlcipher: SQLite3.sqlcipher?,
+      threadsafe: SQLite3.threadsafe?
+    }
+  }
+end

data/lib/sqlite3.rb

@@ -3,13 +3,17 @@ begin
   RUBY_VERSION =~ /(\d+\.\d+)/
   require "sqlite3/#{$1}/sqlite3_native"
 rescue LoadError
-  require 'sqlite3/sqlite3_native'
+  require "sqlite3/sqlite3_native"
 end
 
-require 'sqlite3/database'
-require 'sqlite3/version'
+require "sqlite3/database"
+require "sqlite3/version"
 
 module SQLite3
   # Was sqlite3 compiled with thread safety on?
-  def self.threadsafe?; threadsafe > 0; end
+  def self.threadsafe?
+    threadsafe > 0
+  end
 end
+
+require "sqlite3/version_info"

metadata

@@ -1,17 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: sqlite3
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Jamis Buck
 - Luis Lavena
 - Aaron Patterson
 - Mike Dalessio
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mini_portile2
@@ -27,16 +26,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.8.0
-  force_ruby_platform: false
 description: |
   Ruby library to interface with the SQLite3 database engine (http://www.sqlite.org). Precompiled
   binaries are available for common platforms for recent versions of Ruby.
-email:
 executables: []
 extensions:
 - ext/sqlite3/extconf.rb
 extra_rdoc_files:
-- API_CHANGES.md
 - CHANGELOG.md
 - README.md
 - ext/sqlite3/aggregator.c
@@ -47,15 +43,11 @@ extra_rdoc_files:
 - ext/sqlite3/statement.c
 files:
 - ".gemtest"
-- API_CHANGES.md
 - CHANGELOG.md
 - CONTRIBUTING.md
-- ChangeLog.cvs
 - FAQ.md
-- Gemfile
 - INSTALLATION.md
 - LICENSE
-- LICENSE-DEPENDENCIES
 - README.md
 - dependencies.yml
 - ext/sqlite3/aggregator.c
@@ -71,49 +63,30 @@ files:
 - ext/sqlite3/sqlite3_ruby.h
 - ext/sqlite3/statement.c
 - ext/sqlite3/statement.h
+- ext/sqlite3/timespec.h
 - lib/sqlite3.rb
 - lib/sqlite3/constants.rb
 - lib/sqlite3/database.rb
 - lib/sqlite3/errors.rb
+- lib/sqlite3/fork_safety.rb
 - lib/sqlite3/pragmas.rb
 - lib/sqlite3/resultset.rb
 - lib/sqlite3/statement.rb
-- lib/sqlite3/translator.rb
 - lib/sqlite3/value.rb
 - lib/sqlite3/version.rb
-- ports/archives/sqlite-autoconf-3450200.tar.gz
-- test/helper.rb
-- test/test_backup.rb
-- test/test_collation.rb
-- test/test_database.rb
-- test/test_database_flags.rb
-- test/test_database_readonly.rb
-- test/test_database_readwrite.rb
-- test/test_deprecated.rb
-- test/test_encoding.rb
-- test/test_integration.rb
-- test/test_integration_aggregate.rb
-- test/test_integration_open_close.rb
-- test/test_integration_pending.rb
-- test/test_integration_resultset.rb
-- test/test_integration_statement.rb
-- test/test_pragmas.rb
-- test/test_result_set.rb
-- test/test_sqlite3.rb
-- test/test_statement.rb
-- test/test_statement_execute.rb
+- lib/sqlite3/version_info.rb
+- ports/archives/sqlite-autoconf-3470200.tar.gz
 homepage: https://github.com/sparklemotion/sqlite3-ruby
 licenses:
 - BSD-3-Clause
 metadata:
   homepage_uri: https://github.com/sparklemotion/sqlite3-ruby
   bug_tracker_uri: https://github.com/sparklemotion/sqlite3-ruby/issues
-  documentation_uri: https://www.rubydoc.info/gems/sqlite3
+  documentation_uri: https://sparklemotion.github.io/sqlite3-ruby/
   changelog_uri: https://github.com/sparklemotion/sqlite3-ruby/blob/master/CHANGELOG.md
   source_code_uri: https://github.com/sparklemotion/sqlite3-ruby
   msys2_mingw_dependencies: sqlite3
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options:
 - "--main"
 - README.md
@@ -123,15 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby library to interface with the SQLite3 database engine (http://www.sqlite.org).
 test_files: []

data/API_CHANGES.md

@@ -1,49 +0,0 @@
-# API Changes
-
-* SQLite3::Database#execute only accepts an array for bind parameters.
-
-* SQLite3::ResultSet used to query the database for the first row, regardless
-  of whether the user asked for it or not.  I have removed that so that rows
-  will not be returned until the user asks for them.  This is a subtle but
-  sometimes important change in behavior.
-
-  83882d2208ed189361617d5ab8532a325aaf729d
-
-* SQLite3::Database#trace now takes either a block or an object that responds
-  to "call".  The previous implementation passed around a VALUE that was cast
-  to a void *.  This is dangerous because the value could get garbage collected
-  before the proc was called.  If the user wants data passed around with the
-  block, they should use variables available to the closure or create an
-  object.
-
-* SQLite3::Statement#step automatically converts to ruby types, where before
-  all values were automatically yielded as strings.  This will only be a
-  problem for people who were accessing information about the database that
-  wasn't previously passed through the pure ruby conversion code.
-
-* SQLite3::Database#errmsg no longer takes a parameter to return error
-  messages as UTF-16.  Do people even use that?  I opt for staying UTF-8 when
-  possible.  See test_integration.rb test_errmsg_utf16
-
-* SQLite3::Database#authorize same changes as trace
-
-* test/test_tc_database.rb was removed because we no longer use the Driver
-  design pattern.
-
-# Garbage Collection Strategy
-
-All statements keep pointers back to their respective database connections.
-The @connection instance variable on the Statement handle keeps the database
-connection alive.  Memory allocated for a statement handler will be freed in
-two cases:
-
-* close is called on the statement
-* The SQLite3::Database object gets garbage collected
-
-We can't free the memory for the statement in the garbage collection function
-for the statement handler.  The reason is because there exists a race
-condition.  We cannot guarantee the order in which objects will be garbage
-collected.  So, it is possible that a connection and a statement are up for
-garbage collection.  If the database connection were to be free'd before the
-statement, then boom.  Instead we'll be conservative and free unclosed
-statements when the connection is terminated.