activerecord 1.0.0 → 3.0.0

data/lib/active_record/connection_adapters/sqlite3_adapter.rb

@@ -0,0 +1,53 @@
+require 'active_record/connection_adapters/sqlite_adapter'
+
+module ActiveRecord
+  class Base
+    # sqlite3 adapter reuses sqlite_connection.
+    def self.sqlite3_connection(config) # :nodoc:
+      # Require database.
+      unless config[:database]
+        raise ArgumentError, "No database file specified. Missing argument: database"
+      end
+
+      # Allow database path relative to Rails.root, but only if
+      # the database path is not the special path that tells
+      # Sqlite to build a database only in memory.
+      if defined?(Rails.root) && ':memory:' != config[:database]
+        config[:database] = File.expand_path(config[:database], Rails.root)
+      end
+
+      unless 'sqlite3' == config[:adapter]
+        raise ArgumentError, 'adapter name should be "sqlite3"'
+      end
+
+      unless self.class.const_defined?(:SQLite3)
+        require_library_or_gem(config[:adapter])
+      end
+
+      db = SQLite3::Database.new(
+        config[:database],
+        :results_as_hash => true
+      )
+
+      db.busy_timeout(config[:timeout]) unless config[:timeout].nil?
+
+      ConnectionAdapters::SQLite3Adapter.new(db, logger, config)
+    end
+  end
+
+  module ConnectionAdapters #:nodoc:
+    class SQLite3Adapter < SQLiteAdapter # :nodoc:
+
+      # Returns the current database encoding format as a string, eg: 'UTF-8'
+      def encoding
+        if @connection.respond_to?(:encoding)
+          @connection.encoding.to_s
+        else
+          encoding = @connection.execute('PRAGMA encoding')
+          encoding[0]['encoding']
+        end
+      end
+
+    end
+  end
+end

data/lib/active_record/connection_adapters/sqlite_adapter.rb

@@ -1,107 +1,401 @@
-# sqlite_adapter.rb
-# author:   Luke Holden <lholden@cablelan.net>
-
 require 'active_record/connection_adapters/abstract_adapter'
+require 'active_support/core_ext/kernel/requires'
+
+module ActiveRecord
+  module ConnectionAdapters #:nodoc:
+    class SQLiteColumn < Column #:nodoc:
+      class <<  self
+        def string_to_binary(value)
+          value.gsub(/\0|\%/n) do |b|
+            case b
+              when "\0" then "%00"
+              when "%"  then "%25"
+            end
+          end
+        end
 
-begin
-  require 'sqlite' unless self.class.const_defined?(:SQLite)
+        def binary_to_string(value)
+          if value.respond_to?(:force_encoding) && value.encoding != Encoding::ASCII_8BIT
+            value = value.force_encoding(Encoding::ASCII_8BIT)
+          end
 
-  module ActiveRecord
-    class Base
-      # Establishes a connection to the database that's used by all Active Record objects
-      def self.sqlite_connection(config) # :nodoc:
-        symbolize_strings_in_hash(config)
-        unless config.has_key?(:dbfile)
-          raise ArgumentError, "No database file specified. Missing argument: dbfile"
+          value.gsub(/%00|%25/n) do |b|
+            case b
+              when "%00" then "\0"
+              when "%25" then "%"
+            end
+          end
         end
+      end
+    end
 
-        db = SQLite::Database.new(config[:dbfile], 0)
+    # The SQLite adapter works with both the 2.x and 3.x series of SQLite with the sqlite-ruby
+    # drivers (available both as gems and from http://rubyforge.org/projects/sqlite-ruby/).
+    #
+    # Options:
+    #
+    # * <tt>:database</tt> - Path to the database file.
+    class SQLiteAdapter < AbstractAdapter
+      class Version
+        include Comparable
+
+        def initialize(version_string)
+          @version = version_string.split('.').map { |v| v.to_i }
+        end
 
-        db.show_datatypes   = "ON" if !defined? SQLite::Version
-        db.results_as_hash  = true if defined? SQLite::Version
-        db.type_translation = false
+        def <=>(version_string)
+          @version <=> version_string.split('.').map { |v| v.to_i }
+        end
+      end
 
-        ConnectionAdapters::SQLiteAdapter.new(db, logger)
+      def initialize(connection, logger, config)
+        super(connection, logger)
+        @config = config
+      end
+
+      def adapter_name #:nodoc:
+        'SQLite'
+      end
+
+      def supports_ddl_transactions?
+        sqlite_version >= '2.0.0'
+      end
+
+      def supports_migrations? #:nodoc:
+        true
+      end
+
+      def supports_primary_key? #:nodoc:
+        true
+      end
+
+      def requires_reloading?
+        true
+      end
+
+      def supports_add_column?
+        sqlite_version >= '3.1.6'
+      end
+
+      def disconnect!
+        super
+        @connection.close rescue nil
+      end
+
+      def supports_count_distinct? #:nodoc:
+        sqlite_version >= '3.2.6'
       end
-    end
 
-    module ConnectionAdapters
-      class SQLiteAdapter < AbstractAdapter # :nodoc:
-        def select_all(sql, name = nil)
-          select(sql, name)
+      def supports_autoincrement? #:nodoc:
+        sqlite_version >= '3.1.0'
+      end
+
+      def native_database_types #:nodoc:
+        {
+          :primary_key => default_primary_key_type,
+          :string      => { :name => "varchar", :limit => 255 },
+          :text        => { :name => "text" },
+          :integer     => { :name => "integer" },
+          :float       => { :name => "float" },
+          :decimal     => { :name => "decimal" },
+          :datetime    => { :name => "datetime" },
+          :timestamp   => { :name => "datetime" },
+          :time        => { :name => "time" },
+          :date        => { :name => "date" },
+          :binary      => { :name => "blob" },
+          :boolean     => { :name => "boolean" }
+        }
+      end
+
+
+      # QUOTING ==================================================
+
+      def quote_string(s) #:nodoc:
+        @connection.class.quote(s)
+      end
+
+      def quote_column_name(name) #:nodoc:
+        %Q("#{name}")
+      end
+
+      # Quote date/time values for use in SQL input. Includes microseconds
+      # if the value is a Time responding to usec.
+      def quoted_date(value) #:nodoc:
+        if value.acts_like?(:time) && value.respond_to?(:usec)
+          "#{super}.#{sprintf("%06d", value.usec)}"
+        else
+          super
         end
+      end
+
+
+      # DATABASE STATEMENTS ======================================
+
+      def execute(sql, name = nil) #:nodoc:
+        log(sql, name) { @connection.execute(sql) }
+      end
 
-        def select_one(sql, name = nil)
-          result = select(sql, name)
-          result.nil? ? nil : result.first
+      def update_sql(sql, name = nil) #:nodoc:
+        super
+        @connection.changes
+      end
+
+      def delete_sql(sql, name = nil) #:nodoc:
+        sql += " WHERE 1=1" unless sql =~ /WHERE/i
+        super sql, name
+      end
+
+      def insert_sql(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil) #:nodoc:
+        super || @connection.last_insert_row_id
+      end
+      alias :create :insert_sql
+
+      def select_rows(sql, name = nil)
+        execute(sql, name).map do |row|
+          (0...(row.size / 2)).map { |i| row[i] }
         end
+      end
+
+      def begin_db_transaction #:nodoc:
+        @connection.transaction
+      end
+
+      def commit_db_transaction #:nodoc:
+        @connection.commit
+      end
+
+      def rollback_db_transaction #:nodoc:
+        @connection.rollback
+      end
+
+      # SCHEMA STATEMENTS ========================================
+
+      def tables(name = nil) #:nodoc:
+        sql = <<-SQL
+          SELECT name
+          FROM sqlite_master
+          WHERE type = 'table' AND NOT name = 'sqlite_sequence'
+        SQL
 
-        def columns(table_name, name = nil)
-          table_structure(table_name).inject([]) do |columns, field| 
-            columns << Column.new(field['name'], field['dflt_value'], field['type'])
-            columns
+        execute(sql, name).map do |row|
+          row['name']
+        end
+      end
+
+      def columns(table_name, name = nil) #:nodoc:
+        table_structure(table_name).map do |field|
+          SQLiteColumn.new(field['name'], field['dflt_value'], field['type'], field['notnull'].to_i == 0)
+        end
+      end
+
+      def indexes(table_name, name = nil) #:nodoc:
+        execute("PRAGMA index_list(#{quote_table_name(table_name)})", name).map do |row|
+          IndexDefinition.new(
+            table_name,
+            row['name'],
+            row['unique'].to_i != 0,
+            execute("PRAGMA index_info('#{row['name']}')").map { |col|
+              col['name']
+            })
+        end
+      end
+
+      def primary_key(table_name) #:nodoc:
+        column = table_structure(table_name).find { |field|
+          field['pk'].to_i == 1
+        }
+        column && column['name']
+      end
+
+      def remove_index!(table_name, index_name) #:nodoc:
+        execute "DROP INDEX #{quote_column_name(index_name)}"
+      end
+
+      def rename_table(name, new_name)
+        execute "ALTER TABLE #{quote_table_name(name)} RENAME TO #{quote_table_name(new_name)}"
+      end
+
+      # See: http://www.sqlite.org/lang_altertable.html
+      # SQLite has an additional restriction on the ALTER TABLE statement
+      def valid_alter_table_options( type, options)
+        type.to_sym != :primary_key
+      end
+
+      def add_column(table_name, column_name, type, options = {}) #:nodoc:
+        if supports_add_column? && valid_alter_table_options( type, options )
+          super(table_name, column_name, type, options)
+        else
+          alter_table(table_name) do |definition|
+            definition.column(column_name, type, options)
+          end
+        end
+      end
+
+      def remove_column(table_name, *column_names) #:nodoc:
+        raise ArgumentError.new("You must specify at least one column name.  Example: remove_column(:people, :first_name)") if column_names.empty?
+        column_names.flatten.each do |column_name|
+          alter_table(table_name) do |definition|
+            definition.columns.delete(definition[column_name])
+          end
+        end
+      end
+      alias :remove_columns :remove_column
+
+      def change_column_default(table_name, column_name, default) #:nodoc:
+        alter_table(table_name) do |definition|
+          definition[column_name].default = default
+        end
+      end
+
+      def change_column_null(table_name, column_name, null, default = nil)
+        unless null || default.nil?
+          execute("UPDATE #{quote_table_name(table_name)} SET #{quote_column_name(column_name)}=#{quote(default)} WHERE #{quote_column_name(column_name)} IS NULL")
+        end
+        alter_table(table_name) do |definition|
+          definition[column_name].null = null
+        end
+      end
+
+      def change_column(table_name, column_name, type, options = {}) #:nodoc:
+        alter_table(table_name) do |definition|
+          include_default = options_include_default?(options)
+          definition[column_name].instance_eval do
+            self.type    = type
+            self.limit   = options[:limit] if options.include?(:limit)
+            self.default = options[:default] if include_default
+            self.null    = options[:null] if options.include?(:null)
           end
         end
+      end
 
-        def insert(sql, name = nil, pk = nil, id_value = nil)
-          execute(sql, name = nil)
-          id_value || @connection.send( defined?( SQLite::Version ) ? :last_insert_row_id : :last_insert_rowid )
+      def rename_column(table_name, column_name, new_column_name) #:nodoc:
+        unless columns(table_name).detect{|c| c.name == column_name.to_s }
+          raise ActiveRecord::ActiveRecordError, "Missing column #{table_name}.#{column_name}"
         end
+        alter_table(table_name, :rename => {column_name.to_s => new_column_name.to_s})
+      end
 
-        def execute(sql, name = nil)
-          log(sql, name, @connection) do |connection|
-            if defined?( SQLite::Version )
-              case sql
-                when "BEGIN" then connection.transaction
-                when "COMMIT" then connection.commit
-                when "ROLLBACK" then connection.rollback
-                else connection.execute(sql)
-              end
-            else
-              connection.execute( sql )
+      def empty_insert_statement_value
+        "VALUES(NULL)"
+      end
+
+      protected
+        def select(sql, name = nil) #:nodoc:
+          execute(sql, name).map do |row|
+            record = {}
+            row.each do |key, value|
+              record[key.sub(/^"?\w+"?\./, '')] = value if key.is_a?(String)
             end
+            record
           end
         end
 
-        alias_method :update, :execute
-        alias_method :delete, :execute
+        def table_structure(table_name)
+          structure = @connection.table_info(quote_table_name(table_name))
+          raise(ActiveRecord::StatementInvalid, "Could not find table '#{table_name}'") if structure.empty?
+          structure
+        end
+
+        def alter_table(table_name, options = {}) #:nodoc:
+          altered_table_name = "altered_#{table_name}"
+          caller = lambda {|definition| yield definition if block_given?}
 
-        def begin_db_transaction()    execute "BEGIN" end
-        def commit_db_transaction()   execute "COMMIT" end
-        def rollback_db_transaction() execute "ROLLBACK" end
+          transaction do
+            move_table(table_name, altered_table_name,
+              options.merge(:temporary => true))
+            move_table(altered_table_name, table_name, &caller)
+          end
+        end
+
+        def move_table(from, to, options = {}, &block) #:nodoc:
+          copy_table(from, to, options, &block)
+          drop_table(from)
+        end
+
+        def copy_table(from, to, options = {}) #:nodoc:
+          options = options.merge(:id => (!columns(from).detect{|c| c.name == 'id'}.nil? && 'id' == primary_key(from).to_s))
+          create_table(to, options) do |definition|
+            @definition = definition
+            columns(from).each do |column|
+              column_name = options[:rename] ?
+                (options[:rename][column.name] ||
+                 options[:rename][column.name.to_sym] ||
+                 column.name) : column.name
+
+              @definition.column(column_name, column.type,
+                :limit => column.limit, :default => column.default,
+                :null => column.null)
+            end
+            @definition.primary_key(primary_key(from)) if primary_key(from)
+            yield @definition if block_given?
+          end
 
-        def quote_column_name(name)
-          return "'#{name}'"
+          copy_table_indexes(from, to, options[:rename] || {})
+          copy_table_contents(from, to,
+            @definition.columns.map {|column| column.name},
+            options[:rename] || {})
         end
 
-        private
-          def select(sql, name = nil)
-            results = nil
-            log(sql, name, @connection) { |connection| results = connection.execute(sql) }
+        def copy_table_indexes(from, to, rename = {}) #:nodoc:
+          indexes(from).each do |index|
+            name = index.name
+            if to == "altered_#{from}"
+              name = "temp_#{name}"
+            elsif from == "altered_#{to}"
+              name = name[5..-1]
+            end
 
-            rows = []
+            to_column_names = columns(to).map { |c| c.name }
+            columns = index.columns.map {|c| rename[c] || c }.select do |column|
+              to_column_names.include?(column)
+            end
 
-            results.each do |row|
-              hash_only_row = {}
-              row.each_key do |key|
-                hash_only_row[key.gsub(/\w\./, "")] = row[key] unless key.class == Fixnum
-              end
-              rows << hash_only_row
+            unless columns.empty?
+              # index name can't be the same
+              opts = { :name => name.gsub(/_(#{from})_/, "_#{to}_") }
+              opts[:unique] = true if index.unique
+              add_index(to, columns, opts)
             end
+          end
+        end
+
+        def copy_table_contents(from, to, columns, rename = {}) #:nodoc:
+          column_mappings = Hash[*columns.map {|name| [name, name]}.flatten]
+          rename.inject(column_mappings) {|map, a| map[a.last] = a.first; map}
+          from_columns = columns(from).collect {|col| col.name}
+          columns = columns.find_all{|col| from_columns.include?(column_mappings[col])}
+          quoted_columns = columns.map { |col| quote_column_name(col) } * ','
 
-            return rows
+          quoted_to = quote_table_name(to)
+          @connection.execute "SELECT * FROM #{quote_table_name(from)}" do |row|
+            sql = "INSERT INTO #{quoted_to} (#{quoted_columns}) VALUES ("
+            sql << columns.map {|col| quote row[column_mappings[col]]} * ', '
+            sql << ')'
+            @connection.execute sql
           end
+        end
 
-          def table_structure(table_name)
-            sql = "PRAGMA table_info(#{table_name});"
-            results = nil
-            log(sql, nil, @connection) { |connection| results = connection.execute(sql) }
-            return results
+        def sqlite_version
+          @sqlite_version ||= SQLiteAdapter::Version.new(select_value('select sqlite_version(*)'))
+        end
+
+        def default_primary_key_type
+          if supports_autoincrement?
+            'INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL'
+          else
+            'INTEGER PRIMARY KEY NOT NULL'
           end
-      end
+        end
+
+        def translate_exception(exception, message)
+          case exception.message
+          when /column(s)? .* (is|are) not unique/
+            RecordNotUnique.new(message, exception)
+          else
+            super
+          end
+        end
+
     end
   end
-rescue LoadError
-  retry if require('rubygems') rescue LoadError
-  # SQLite driver is not availible
 end

data/lib/active_record/counter_cache.rb

@@ -0,0 +1,115 @@
+module ActiveRecord
+  # = Active Record Counter Cache
+  module CounterCache
+    # Resets one or more counter caches to their correct value using an SQL
+    # count query.  This is useful when adding new counter caches, or if the
+    # counter has been corrupted or modified directly by SQL.
+    #
+    # ==== Parameters
+    #
+    # * +id+ - The id of the object you wish to reset a counter on.
+    # * +counters+ - One or more counter names to reset
+    #
+    # ==== Examples
+    #
+    #   # For Post with id #1 records reset the comments_count
+    #   Post.reset_counters(1, :comments)
+    def reset_counters(id, *counters)
+      object = find(id)
+      counters.each do |association|
+        has_many_association = reflect_on_association(association.to_sym)
+
+        expected_name = if has_many_association.options[:as]
+          has_many_association.options[:as].to_s.classify
+        else
+          self.name
+        end
+
+        child_class  = has_many_association.klass
+        belongs_to   = child_class.reflect_on_all_associations(:belongs_to)
+        reflection   = belongs_to.find { |e| e.class_name == expected_name }
+        counter_name = reflection.counter_cache_column
+
+        self.unscoped.where(arel_table[self.primary_key].eq(object.id)).arel.update({
+          arel_table[counter_name] => object.send(association).count
+        })
+      end
+      return true
+    end
+
+    # A generic "counter updater" implementation, intended primarily to be
+    # used by increment_counter and decrement_counter, but which may also
+    # be useful on its own. It simply does a direct SQL update for the record
+    # with the given ID, altering the given hash of counters by the amount
+    # given by the corresponding value:
+    #
+    # ==== Parameters
+    #
+    # * +id+ - The id of the object you wish to update a counter on or an Array of ids.
+    # * +counters+ - An Array of Hashes containing the names of the fields
+    #   to update as keys and the amount to update the field by as values.
+    #
+    # ==== Examples
+    #
+    #   # For the Post with id of 5, decrement the comment_count by 1, and
+    #   # increment the action_count by 1
+    #   Post.update_counters 5, :comment_count => -1, :action_count => 1
+    #   # Executes the following SQL:
+    #   # UPDATE posts
+    #   #    SET comment_count = comment_count - 1,
+    #   #        action_count = action_count + 1
+    #   #  WHERE id = 5
+    #
+    #   # For the Posts with id of 10 and 15, increment the comment_count by 1
+    #   Post.update_counters [10, 15], :comment_count => 1
+    #   # Executes the following SQL:
+    #   # UPDATE posts
+    #   #    SET comment_count = comment_count + 1,
+    #   #  WHERE id IN (10, 15)
+    def update_counters(id, counters)
+      updates = counters.map do |counter_name, value|
+        operator = value < 0 ? '-' : '+'
+        quoted_column = connection.quote_column_name(counter_name)
+        "#{quoted_column} = COALESCE(#{quoted_column}, 0) #{operator} #{value.abs}"
+      end
+
+      update_all(updates.join(', '), primary_key => id )
+    end
+
+    # Increment a number field by one, usually representing a count.
+    #
+    # This is used for caching aggregate values, so that they don't need to be computed every time.
+    # For example, a DiscussionBoard may cache post_count and comment_count otherwise every time the board is
+    # shown it would have to run an SQL query to find how many posts and comments there are.
+    #
+    # ==== Parameters
+    #
+    # * +counter_name+ - The name of the field that should be incremented.
+    # * +id+ - The id of the object that should be incremented.
+    #
+    # ==== Examples
+    #
+    #   # Increment the post_count column for the record with an id of 5
+    #   DiscussionBoard.increment_counter(:post_count, 5)
+    def increment_counter(counter_name, id)
+      update_counters(id, counter_name => 1)
+    end
+
+    # Decrement a number field by one, usually representing a count.
+    #
+    # This works the same as increment_counter but reduces the column value by 1 instead of increasing it.
+    #
+    # ==== Parameters
+    #
+    # * +counter_name+ - The name of the field that should be decremented.
+    # * +id+ - The id of the object that should be decremented.
+    #
+    # ==== Examples
+    #
+    #   # Decrement the post_count column for the record with an id of 5
+    #   DiscussionBoard.decrement_counter(:post_count, 5)
+    def decrement_counter(counter_name, id)
+      update_counters(id, counter_name => -1)
+    end
+  end
+end