sqlite3 1.7.3 → 2.0.0

data/lib/sqlite3/pragmas.rb

@@ -1,59 +1,55 @@
-require 'sqlite3/errors'
+require "sqlite3/errors"
 
 module SQLite3
-
   # This module is intended for inclusion solely by the Database class. It
   # defines convenience methods for the various pragmas supported by SQLite3.
   #
   # For a detailed description of these pragmas, see the SQLite3 documentation
   # at http://sqlite.org/pragma.html.
   module Pragmas
-
     # Returns +true+ or +false+ depending on the value of the named pragma.
-    def get_boolean_pragma( name )
-      get_first_value( "PRAGMA #{name}" ) != 0
+    def get_boolean_pragma(name)
+      get_first_value("PRAGMA #{name}") != 0
     end
 
     # Sets the given pragma to the given boolean value. The value itself
     # may be +true+ or +false+, or any other commonly used string or
     # integer that represents truth.
-    def set_boolean_pragma( name, mode )
+    def set_boolean_pragma(name, mode)
       case mode
       when String
-          case mode.downcase
-          when "on", "yes", "true", "y", "t"; mode = "'ON'"
-          when "off", "no", "false", "n", "f"; mode = "'OFF'"
-          else
-              raise Exception,
-                "unrecognized pragma parameter #{mode.inspect}"
-          end
+        case mode.downcase
+        when "on", "yes", "true", "y", "t" then mode = "'ON'"
+        when "off", "no", "false", "n", "f" then mode = "'OFF'"
+        else
+          raise SQLite3::Exception, "unrecognized pragma parameter #{mode.inspect}"
+        end
       when true, 1
-          mode = "ON"
+        mode = "ON"
       when false, 0, nil
-          mode = "OFF"
+        mode = "OFF"
       else
-          raise Exception,
-            "unrecognized pragma parameter #{mode.inspect}"
+        raise SQLite3::Exception, "unrecognized pragma parameter #{mode.inspect}"
       end
 
-      execute( "PRAGMA #{name}=#{mode}" )
+      execute("PRAGMA #{name}=#{mode}")
     end
 
     # 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, *params, &block ) # :yields: row
+    def get_query_pragma(name, *params, &block) # :yields: row
       if params.empty?
-        execute( "PRAGMA #{name}", &block )
+        execute("PRAGMA #{name}", &block)
       else
         args = "'" + params.join("','") + "'"
-        execute( "PRAGMA #{name}( #{args} )", &block )
+        execute("PRAGMA #{name}( #{args} )", &block)
       end
     end
 
     # Return the value of the given pragma.
-    def get_enum_pragma( name )
-      get_first_value( "PRAGMA #{name}" )
+    def get_enum_pragma(name)
+      get_first_value("PRAGMA #{name}")
     end
 
     # Set the value of the given pragma to +mode+. The +mode+ parameter must
@@ -61,51 +57,52 @@ module SQLite3
     # the array is another array comprised of elements in the enumeration that
     # have duplicate values. See #synchronous, #default_synchronous,
     # #temp_store, and #default_temp_store for usage examples.
-    def set_enum_pragma( name, mode, enums )
+    def set_enum_pragma(name, mode, enums)
       match = enums.find { |p| p.find { |i| i.to_s.downcase == mode.to_s.downcase } }
-      raise Exception,
-        "unrecognized #{name} #{mode.inspect}" unless match
-      execute( "PRAGMA #{name}='#{match.first.upcase}'" )
+      unless match
+        raise SQLite3::Exception, "unrecognized #{name} #{mode.inspect}"
+      end
+      execute("PRAGMA #{name}='#{match.first.upcase}'")
     end
 
     # Returns the value of the given pragma as an integer.
-    def get_int_pragma( name )
-      get_first_value( "PRAGMA #{name}" ).to_i
+    def get_int_pragma(name)
+      get_first_value("PRAGMA #{name}").to_i
     end
 
     # Set the value of the given pragma to the integer value of the +value+
     # parameter.
-    def set_int_pragma( name, value )
-      execute( "PRAGMA #{name}=#{value.to_i}" )
+    def set_int_pragma(name, value)
+      execute("PRAGMA #{name}=#{value.to_i}")
     end
 
     # The enumeration of valid synchronous modes.
-    SYNCHRONOUS_MODES = [ [ 'full', 2 ], [ 'normal', 1 ], [ 'off', 0 ] ]
+    SYNCHRONOUS_MODES = [["full", 2], ["normal", 1], ["off", 0]]
 
     # The enumeration of valid temp store modes.
-    TEMP_STORE_MODES  = [ [ 'default', 0 ], [ 'file', 1 ], [ 'memory', 2 ] ]
+    TEMP_STORE_MODES = [["default", 0], ["file", 1], ["memory", 2]]
 
     # The enumeration of valid auto vacuum modes.
-    AUTO_VACUUM_MODES  = [ [ 'none', 0 ], [ 'full', 1 ], [ 'incremental', 2 ] ]
+    AUTO_VACUUM_MODES = [["none", 0], ["full", 1], ["incremental", 2]]
 
     # The list of valid journaling modes.
-    JOURNAL_MODES  = [ [ 'delete' ], [ 'truncate' ], [ 'persist' ], [ 'memory' ],
-                       [ 'wal' ], [ 'off' ] ]
+    JOURNAL_MODES = [["delete"], ["truncate"], ["persist"], ["memory"],
+      ["wal"], ["off"]]
 
     # The list of valid locking modes.
-    LOCKING_MODES  = [ [ 'normal' ], [ 'exclusive' ] ]
+    LOCKING_MODES = [["normal"], ["exclusive"]]
 
     # The list of valid encodings.
-    ENCODINGS = [ [ 'utf-8' ], [ 'utf-16' ], [ 'utf-16le' ], [ 'utf-16be ' ] ]
+    ENCODINGS = [["utf-8"], ["utf-16"], ["utf-16le"], ["utf-16be "]]
 
     # The list of valid WAL checkpoints.
-    WAL_CHECKPOINTS = [ [ 'passive' ], [ 'full' ], [ 'restart' ], [ 'truncate' ] ]
+    WAL_CHECKPOINTS = [["passive"], ["full"], ["restart"], ["truncate"]]
 
     def application_id
       get_int_pragma "application_id"
     end
 
-    def application_id=( integer )
+    def application_id=(integer)
       set_int_pragma "application_id", integer
     end
 
@@ -113,7 +110,7 @@ module SQLite3
       get_enum_pragma "auto_vacuum"
     end
 
-    def auto_vacuum=( mode )
+    def auto_vacuum=(mode)
       set_enum_pragma "auto_vacuum", mode, AUTO_VACUUM_MODES
     end
 
@@ -121,7 +118,7 @@ module SQLite3
       get_boolean_pragma "automatic_index"
     end
 
-    def automatic_index=( mode )
+    def automatic_index=(mode)
       set_boolean_pragma "automatic_index", mode
     end
 
@@ -129,7 +126,7 @@ module SQLite3
       get_int_pragma "busy_timeout"
     end
 
-    def busy_timeout=( milliseconds )
+    def busy_timeout=(milliseconds)
       set_int_pragma "busy_timeout", milliseconds
     end
 
@@ -137,7 +134,7 @@ module SQLite3
       get_int_pragma "cache_size"
     end
 
-    def cache_size=( size )
+    def cache_size=(size)
       set_int_pragma "cache_size", size
     end
 
@@ -145,11 +142,11 @@ module SQLite3
       get_boolean_pragma "cache_spill"
     end
 
-    def cache_spill=( mode )
+    def cache_spill=(mode)
       set_boolean_pragma "cache_spill", mode
     end
 
-    def case_sensitive_like=( mode )
+    def case_sensitive_like=(mode)
       set_boolean_pragma "case_sensitive_like", mode
     end
 
@@ -157,7 +154,7 @@ module SQLite3
       get_boolean_pragma "cell_size_check"
     end
 
-    def cell_size_check=( mode )
+    def cell_size_check=(mode)
       set_boolean_pragma "cell_size_check", mode
     end
 
@@ -165,15 +162,15 @@ module SQLite3
       get_boolean_pragma "checkpoint_fullfsync"
     end
 
-    def checkpoint_fullfsync=( mode )
+    def checkpoint_fullfsync=(mode)
       set_boolean_pragma "checkpoint_fullfsync", mode
     end
 
-    def collation_list( &block ) # :yields: row
+    def collation_list(&block) # :yields: row
       get_query_pragma "collation_list", &block
     end
 
-    def compile_options( &block ) # :yields: row
+    def compile_options(&block) # :yields: row
       get_query_pragma "compile_options", &block
     end
 
@@ -181,7 +178,7 @@ module SQLite3
       get_boolean_pragma "count_changes"
     end
 
-    def count_changes=( mode )
+    def count_changes=(mode)
       set_boolean_pragma "count_changes", mode
     end
 
@@ -189,7 +186,7 @@ module SQLite3
       get_int_pragma "data_version"
     end
 
-    def database_list( &block ) # :yields: row
+    def database_list(&block) # :yields: row
       get_query_pragma "database_list", &block
     end
 
@@ -197,7 +194,7 @@ module SQLite3
       get_int_pragma "default_cache_size"
     end
 
-    def default_cache_size=( size )
+    def default_cache_size=(size)
       set_int_pragma "default_cache_size", size
     end
 
@@ -205,7 +202,7 @@ module SQLite3
       get_enum_pragma "default_synchronous"
     end
 
-    def default_synchronous=( mode )
+    def default_synchronous=(mode)
       set_enum_pragma "default_synchronous", mode, SYNCHRONOUS_MODES
     end
 
@@ -213,7 +210,7 @@ module SQLite3
       get_enum_pragma "default_temp_store"
     end
 
-    def default_temp_store=( mode )
+    def default_temp_store=(mode)
       set_enum_pragma "default_temp_store", mode, TEMP_STORE_MODES
     end
 
@@ -221,7 +218,7 @@ module SQLite3
       get_boolean_pragma "defer_foreign_keys"
     end
 
-    def defer_foreign_keys=( mode )
+    def defer_foreign_keys=(mode)
       set_boolean_pragma "defer_foreign_keys", mode
     end
 
@@ -229,15 +226,15 @@ module SQLite3
       get_enum_pragma "encoding"
     end
 
-    def encoding=( mode )
+    def encoding=(mode)
       set_enum_pragma "encoding", mode, ENCODINGS
     end
 
-    def foreign_key_check( *table, &block ) # :yields: row
+    def foreign_key_check(*table, &block) # :yields: row
       get_query_pragma "foreign_key_check", *table, &block
     end
 
-    def foreign_key_list( table, &block ) # :yields: row
+    def foreign_key_list(table, &block) # :yields: row
       get_query_pragma "foreign_key_list", table, &block
     end
 
@@ -245,7 +242,7 @@ module SQLite3
       get_boolean_pragma "foreign_keys"
     end
 
-    def foreign_keys=( mode )
+    def foreign_keys=(mode)
       set_boolean_pragma "foreign_keys", mode
     end
 
@@ -257,7 +254,7 @@ module SQLite3
       get_boolean_pragma "full_column_names"
     end
 
-    def full_column_names=( mode )
+    def full_column_names=(mode)
       set_boolean_pragma "full_column_names", mode
     end
 
@@ -265,31 +262,31 @@ module SQLite3
       get_boolean_pragma "fullfsync"
     end
 
-    def fullfsync=( mode )
+    def fullfsync=(mode)
       set_boolean_pragma "fullfsync", mode
     end
 
-    def ignore_check_constraints=( mode )
+    def ignore_check_constraints=(mode)
       set_boolean_pragma "ignore_check_constraints", mode
     end
 
-    def incremental_vacuum( pages, &block ) # :yields: row
+    def incremental_vacuum(pages, &block) # :yields: row
       get_query_pragma "incremental_vacuum", pages, &block
     end
 
-    def index_info( index, &block ) # :yields: row
+    def index_info(index, &block) # :yields: row
       get_query_pragma "index_info", index, &block
     end
 
-    def index_list( table, &block ) # :yields: row
+    def index_list(table, &block) # :yields: row
       get_query_pragma "index_list", table, &block
     end
 
-    def index_xinfo( index, &block ) # :yields: row
+    def index_xinfo(index, &block) # :yields: row
       get_query_pragma "index_xinfo", index, &block
     end
 
-    def integrity_check( *num_errors, &block ) # :yields: row
+    def integrity_check(*num_errors, &block) # :yields: row
       get_query_pragma "integrity_check", *num_errors, &block
     end
 
@@ -297,7 +294,7 @@ module SQLite3
       get_enum_pragma "journal_mode"
     end
 
-    def journal_mode=( mode )
+    def journal_mode=(mode)
       set_enum_pragma "journal_mode", mode, JOURNAL_MODES
     end
 
@@ -305,7 +302,7 @@ module SQLite3
       get_int_pragma "journal_size_limit"
     end
 
-    def journal_size_limit=( size )
+    def journal_size_limit=(size)
       set_int_pragma "journal_size_limit", size
     end
 
@@ -313,7 +310,7 @@ module SQLite3
       get_boolean_pragma "legacy_file_format"
     end
 
-    def legacy_file_format=( mode )
+    def legacy_file_format=(mode)
       set_boolean_pragma "legacy_file_format", mode
     end
 
@@ -321,7 +318,7 @@ module SQLite3
       get_enum_pragma "locking_mode"
     end
 
-    def locking_mode=( mode )
+    def locking_mode=(mode)
       set_enum_pragma "locking_mode", mode, LOCKING_MODES
     end
 
@@ -329,7 +326,7 @@ module SQLite3
       get_int_pragma "max_page_count"
     end
 
-    def max_page_count=( size )
+    def max_page_count=(size)
       set_int_pragma "max_page_count", size
     end
 
@@ -337,7 +334,7 @@ module SQLite3
       get_int_pragma "mmap_size"
     end
 
-    def mmap_size=( size )
+    def mmap_size=(size)
       set_int_pragma "mmap_size", size
     end
 
@@ -349,11 +346,11 @@ module SQLite3
       get_int_pragma "page_size"
     end
 
-    def page_size=( size )
+    def page_size=(size)
       set_int_pragma "page_size", size
     end
 
-    def parser_trace=( mode )
+    def parser_trace=(mode)
       set_boolean_pragma "parser_trace", mode
     end
 
@@ -361,11 +358,11 @@ module SQLite3
       get_boolean_pragma "query_only"
     end
 
-    def query_only=( mode )
+    def query_only=(mode)
       set_boolean_pragma "query_only", mode
     end
 
-    def quick_check( *num_errors, &block ) # :yields: row
+    def quick_check(*num_errors, &block) # :yields: row
       get_query_pragma "quick_check", *num_errors, &block
     end
 
@@ -373,7 +370,7 @@ module SQLite3
       get_boolean_pragma "read_uncommitted"
     end
 
-    def read_uncommitted=( mode )
+    def read_uncommitted=(mode)
       set_boolean_pragma "read_uncommitted", mode
     end
 
@@ -381,7 +378,7 @@ module SQLite3
       get_boolean_pragma "recursive_triggers"
     end
 
-    def recursive_triggers=( mode )
+    def recursive_triggers=(mode)
       set_boolean_pragma "recursive_triggers", mode
     end
 
@@ -389,7 +386,7 @@ module SQLite3
       get_boolean_pragma "reverse_unordered_selects"
     end
 
-    def reverse_unordered_selects=( mode )
+    def reverse_unordered_selects=(mode)
       set_boolean_pragma "reverse_unordered_selects", mode
     end
 
@@ -397,7 +394,7 @@ module SQLite3
       get_int_pragma "schema_cookie"
     end
 
-    def schema_cookie=( cookie )
+    def schema_cookie=(cookie)
       set_int_pragma "schema_cookie", cookie
     end
 
@@ -405,7 +402,7 @@ module SQLite3
       get_int_pragma "schema_version"
     end
 
-    def schema_version=( version )
+    def schema_version=(version)
       set_int_pragma "schema_version", version
     end
 
@@ -413,7 +410,7 @@ module SQLite3
       get_boolean_pragma "secure_delete"
     end
 
-    def secure_delete=( mode )
+    def secure_delete=(mode)
       set_boolean_pragma "secure_delete", mode
     end
 
@@ -421,23 +418,23 @@ module SQLite3
       get_boolean_pragma "short_column_names"
     end
 
-    def short_column_names=( mode )
+    def short_column_names=(mode)
       set_boolean_pragma "short_column_names", mode
     end
 
     def shrink_memory
-      execute( "PRAGMA shrink_memory" )
+      execute("PRAGMA shrink_memory")
     end
 
     def soft_heap_limit
       get_int_pragma "soft_heap_limit"
     end
 
-    def soft_heap_limit=( mode )
+    def soft_heap_limit=(mode)
       set_int_pragma "soft_heap_limit", mode
     end
 
-    def stats( &block ) # :yields: row
+    def stats(&block) # :yields: row
       get_query_pragma "stats", &block
     end
 
@@ -445,7 +442,7 @@ module SQLite3
       get_enum_pragma "synchronous"
     end
 
-    def synchronous=( mode )
+    def synchronous=(mode)
       set_enum_pragma "synchronous", mode, SYNCHRONOUS_MODES
     end
 
@@ -453,7 +450,7 @@ module SQLite3
       get_enum_pragma "temp_store"
     end
 
-    def temp_store=( mode )
+    def temp_store=(mode)
       set_enum_pragma "temp_store", mode, TEMP_STORE_MODES
     end
 
@@ -461,7 +458,7 @@ module SQLite3
       get_int_pragma "threads"
     end
 
-    def threads=( count )
+    def threads=(count)
       set_int_pragma "threads", count
     end
 
@@ -469,7 +466,7 @@ module SQLite3
       get_int_pragma "user_cookie"
     end
 
-    def user_cookie=( cookie )
+    def user_cookie=(cookie)
       set_int_pragma "user_cookie", cookie
     end
 
@@ -477,19 +474,19 @@ module SQLite3
       get_int_pragma "user_version"
     end
 
-    def user_version=( version )
+    def user_version=(version)
       set_int_pragma "user_version", version
     end
 
-    def vdbe_addoptrace=( mode )
+    def vdbe_addoptrace=(mode)
       set_boolean_pragma "vdbe_addoptrace", mode
     end
 
-    def vdbe_debug=( mode )
+    def vdbe_debug=(mode)
       set_boolean_pragma "vdbe_debug", mode
     end
 
-    def vdbe_listing=( mode )
+    def vdbe_listing=(mode)
       set_boolean_pragma "vdbe_listing", mode
     end
 
@@ -497,7 +494,7 @@ module SQLite3
       get_boolean_pragma "vdbe_trace"
     end
 
-    def vdbe_trace=( mode )
+    def vdbe_trace=(mode)
       set_boolean_pragma "vdbe_trace", mode
     end
 
@@ -505,7 +502,7 @@ module SQLite3
       get_int_pragma "wal_autocheckpoint"
     end
 
-    def wal_autocheckpoint=( mode )
+    def wal_autocheckpoint=(mode)
       set_int_pragma "wal_autocheckpoint", mode
     end
 
@@ -513,11 +510,11 @@ module SQLite3
       get_enum_pragma "wal_checkpoint"
     end
 
-    def wal_checkpoint=( mode )
+    def wal_checkpoint=(mode)
       set_enum_pragma "wal_checkpoint", mode, WAL_CHECKPOINTS
     end
 
-    def writable_schema=( mode )
+    def writable_schema=(mode)
       set_boolean_pragma "writable_schema", mode
     end
 
@@ -525,7 +522,7 @@ module SQLite3
     # Returns information about +table+.  Yields each row of table information
     # if a block is provided.
     def table_info table
-      stmt    = prepare "PRAGMA table_info(#{table})"
+      stmt = prepare "PRAGMA table_info(#{table})"
       columns = stmt.columns
 
       needs_tweak_default =
@@ -533,21 +530,15 @@ module SQLite3
 
       result = [] unless block_given?
       stmt.each do |row|
-        new_row = Hash[columns.zip(row)]
-
-        # FIXME: This should be removed but is required for older versions
-        # of rails
-        if(Object.const_defined?(:ActiveRecord))
-          new_row['notnull'] = new_row['notnull'].to_s
-        end
+        new_row = columns.zip(row).to_h
 
         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
+        if new_row["type"]
+          new_row["type"] = new_row["type"].downcase
         end
 
         if block_given?
@@ -563,33 +554,32 @@ module SQLite3
 
     private
 
-      # Compares two version strings
-      def version_compare(v1, v2)
-        v1 = v1.split(".").map { |i| i.to_i }
-        v2 = v2.split(".").map { |i| i.to_i }
-        parts = [v1.length, v2.length].max
-        v1.push 0 while v1.length < parts
-        v2.push 0 while v2.length < parts
-        v1.zip(v2).each do |a,b|
-          return -1 if a < b
-          return  1 if a > b
-        end
-        return 0
+    # Compares two version strings
+    def version_compare(v1, v2)
+      v1 = v1.split(".").map { |i| i.to_i }
+      v2 = v2.split(".").map { |i| i.to_i }
+      parts = [v1.length, v2.length].max
+      v1.push 0 while v1.length < parts
+      v2.push 0 while v2.length < parts
+      v1.zip(v2).each do |a, b|
+        return -1 if a < b
+        return 1 if a > b
       end
-
-      # Since SQLite 3.3.8, the table_info pragma has returned the default
-      # value of the row as a quoted SQL value. This method essentially
-      # unquotes those values.
-      def tweak_default(hash)
-        case hash["dflt_value"]
-        when /^null$/i
-          hash["dflt_value"] = nil
-        when /^'(.*)'$/m
-          hash["dflt_value"] = $1.gsub(/''/, "'")
-        when /^"(.*)"$/m
-          hash["dflt_value"] = $1.gsub(/""/, '"')
-        end
+      0
+    end
+
+    # Since SQLite 3.3.8, the table_info pragma has returned the default
+    # value of the row as a quoted SQL value. This method essentially
+    # unquotes those values.
+    def tweak_default(hash)
+      case hash["dflt_value"]
+      when /^null$/i
+        hash["dflt_value"] = nil
+      when /^'(.*)'$/m
+        hash["dflt_value"] = $1.gsub("''", "'")
+      when /^"(.*)"$/m
+        hash["dflt_value"] = $1.gsub('""', '"')
       end
+    end
   end
-
 end