activerecord 3.0.0 → 4.0.0

data/lib/active_record/connection_adapters/postgresql/oid.rb

@@ -0,0 +1,366 @@
+require 'active_record/connection_adapters/abstract_adapter'
+
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+      module OID
+        class Type
+          def type; end
+
+          def type_cast_for_write(value)
+            value
+          end
+        end
+
+        class Identity < Type
+          def type_cast(value)
+            value
+          end
+        end
+
+        class Bit < Type
+          def type_cast(value)
+            if String === value
+              ConnectionAdapters::PostgreSQLColumn.string_to_bit value
+            else
+              value
+            end
+          end
+        end
+
+        class Bytea < Type
+          def type_cast(value)
+            return if value.nil?
+            PGconn.unescape_bytea value
+          end
+        end
+
+        class Money < Type
+          def type_cast(value)
+            return if value.nil?
+
+            # Because money output is formatted according to the locale, there are two
+            # cases to consider (note the decimal separators):
+            #  (1) $12,345,678.12
+            #  (2) $12.345.678,12
+
+            case value
+            when /^-?\D+[\d,]+\.\d{2}$/  # (1)
+              value.gsub!(/[^-\d.]/, '')
+            when /^-?\D+[\d.]+,\d{2}$/  # (2)
+              value.gsub!(/[^-\d,]/, '').sub!(/,/, '.')
+            end
+
+            ConnectionAdapters::Column.value_to_decimal value
+          end
+        end
+
+        class Vector < Type
+          attr_reader :delim, :subtype
+
+          # +delim+ corresponds to the `typdelim` column in the pg_types
+          # table.  +subtype+ is derived from the `typelem` column in the
+          # pg_types table.
+          def initialize(delim, subtype)
+            @delim   = delim
+            @subtype = subtype
+          end
+
+          # FIXME: this should probably split on +delim+ and use +subtype+
+          # to cast the values.  Unfortunately, the current Rails behavior
+          # is to just return the string.
+          def type_cast(value)
+            value
+          end
+        end
+
+        class Point < Type
+          def type_cast(value)
+            if String === value
+              ConnectionAdapters::PostgreSQLColumn.string_to_point value
+            else
+              value
+            end
+          end
+        end
+
+        class Array < Type
+          attr_reader :subtype
+          def initialize(subtype)
+            @subtype = subtype
+          end
+
+          def type_cast(value)
+            if String === value
+              ConnectionAdapters::PostgreSQLColumn.string_to_array value, @subtype
+            else
+              value
+            end
+          end
+        end
+
+        class Range < Type
+          attr_reader :subtype
+          def initialize(subtype)
+            @subtype = subtype
+          end
+
+          def extract_bounds(value)
+            from, to = value[1..-2].split(',')
+            {
+              from:          (value[1] == ',' || from == '-infinity') ? infinity(:negative => true) : from,
+              to:            (value[-2] == ',' || to == 'infinity') ? infinity : to,
+              exclude_start: (value[0] == '('),
+              exclude_end:   (value[-1] == ')')
+            }
+          end
+
+          def infinity(options = {})
+            ::Float::INFINITY * (options[:negative] ? -1 : 1)
+          end
+
+          def infinity?(value)
+            value.respond_to?(:infinite?) && value.infinite?
+          end
+
+          def to_integer(value)
+            infinity?(value) ? value : value.to_i
+          end
+
+          def type_cast(value)
+            return if value.nil? || value == 'empty'
+            return value if value.is_a?(::Range)
+
+            extracted = extract_bounds(value)
+
+            case @subtype
+            when :date
+              from  = ConnectionAdapters::Column.value_to_date(extracted[:from])
+              from -= 1.day if extracted[:exclude_start]
+              to    = ConnectionAdapters::Column.value_to_date(extracted[:to])
+            when :decimal
+              from  = BigDecimal.new(extracted[:from].to_s)
+              # FIXME: add exclude start for ::Range, same for timestamp ranges
+              to    = BigDecimal.new(extracted[:to].to_s)
+            when :time
+              from = ConnectionAdapters::Column.string_to_time(extracted[:from])
+              to   = ConnectionAdapters::Column.string_to_time(extracted[:to])
+            when :integer
+              from = to_integer(extracted[:from]) rescue value ? 1 : 0
+              from -= 1 if extracted[:exclude_start]
+              to   = to_integer(extracted[:to]) rescue value ? 1 : 0
+            else
+              return value
+            end
+
+            ::Range.new(from, to, extracted[:exclude_end])
+          end
+        end
+
+        class Integer < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::Column.value_to_integer value
+          end
+        end
+
+        class Boolean < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::Column.value_to_boolean value
+          end
+        end
+
+        class Timestamp < Type
+          def type; :timestamp; end
+
+          def type_cast(value)
+            return if value.nil?
+
+            # FIXME: probably we can improve this since we know it is PG
+            # specific
+            ConnectionAdapters::PostgreSQLColumn.string_to_time value
+          end
+        end
+
+        class Date < Type
+          def type; :datetime; end
+
+          def type_cast(value)
+            return if value.nil?
+
+            # FIXME: probably we can improve this since we know it is PG
+            # specific
+            ConnectionAdapters::Column.value_to_date value
+          end
+        end
+
+        class Time < Type
+          def type_cast(value)
+            return if value.nil?
+
+            # FIXME: probably we can improve this since we know it is PG
+            # specific
+            ConnectionAdapters::Column.string_to_dummy_time value
+          end
+        end
+
+        class Float < Type
+          def type_cast(value)
+            return if value.nil?
+
+            value.to_f
+          end
+        end
+
+        class Decimal < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::Column.value_to_decimal value
+          end
+        end
+
+        class Hstore < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::PostgreSQLColumn.string_to_hstore value
+          end
+        end
+
+        class Cidr < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::PostgreSQLColumn.string_to_cidr value
+          end
+        end
+
+        class Json < Type
+          def type_cast(value)
+            return if value.nil?
+
+            ConnectionAdapters::PostgreSQLColumn.string_to_json value
+          end
+        end
+
+        class TypeMap
+          def initialize
+            @mapping = {}
+          end
+
+          def []=(oid, type)
+            @mapping[oid] = type
+          end
+
+          def [](oid)
+            @mapping[oid]
+          end
+
+          def clear
+            @mapping.clear
+          end
+
+          def key?(oid)
+            @mapping.key? oid
+          end
+
+          def fetch(ftype, fmod)
+            # The type for the numeric depends on the width of the field,
+            # so we'll do something special here.
+            #
+            # When dealing with decimal columns:
+            #
+            # places after decimal  = fmod - 4 & 0xffff
+            # places before decimal = (fmod - 4) >> 16 & 0xffff
+            if ftype == 1700 && (fmod - 4 & 0xffff).zero?
+              ftype = 23
+            end
+
+            @mapping.fetch(ftype) { |oid| yield oid, fmod }
+          end
+        end
+
+        TYPE_MAP = TypeMap.new # :nodoc:
+
+        # When the PG adapter connects, the pg_type table is queried.  The
+        # key of this hash maps to the `typname` column from the table.
+        # TYPE_MAP is then dynamically built with oids as the key and type
+        # objects as values.
+        NAMES = Hash.new { |h,k| # :nodoc:
+          h[k] = OID::Identity.new
+        }
+
+        # Register an OID type named +name+ with a typcasting object in
+        # +type+.  +name+ should correspond to the `typname` column in
+        # the `pg_type` table.
+        def self.register_type(name, type)
+          NAMES[name] = type
+        end
+
+        # Alias the +old+ type to the +new+ type.
+        def self.alias_type(new, old)
+          NAMES[new] = NAMES[old]
+        end
+
+        # Is +name+ a registered type?
+        def self.registered_type?(name)
+          NAMES.key? name
+        end
+
+        register_type 'int2', OID::Integer.new
+        alias_type    'int4', 'int2'
+        alias_type    'int8', 'int2'
+        alias_type    'oid',  'int2'
+
+        register_type 'daterange', OID::Range.new(:date)
+        register_type 'numrange', OID::Range.new(:decimal)
+        register_type 'tsrange', OID::Range.new(:time)
+        register_type 'int4range', OID::Range.new(:integer)
+        alias_type    'tstzrange', 'tsrange'
+        alias_type    'int8range', 'int4range'
+
+        register_type 'numeric', OID::Decimal.new
+        register_type 'text', OID::Identity.new
+        alias_type 'varchar', 'text'
+        alias_type 'char', 'text'
+        alias_type 'bpchar', 'text'
+        alias_type 'xml', 'text'
+
+        # FIXME: why are we keeping these types as strings?
+        alias_type 'tsvector', 'text'
+        alias_type 'interval', 'text'
+        alias_type 'macaddr',  'text'
+        alias_type 'uuid',     'text'
+
+        register_type 'money', OID::Money.new
+        register_type 'bytea', OID::Bytea.new
+        register_type 'bool', OID::Boolean.new
+        register_type 'bit', OID::Bit.new
+        register_type 'varbit', OID::Bit.new
+
+        register_type 'float4', OID::Float.new
+        alias_type 'float8', 'float4'
+
+        register_type 'timestamp', OID::Timestamp.new
+        register_type 'timestamptz', OID::Timestamp.new
+        register_type 'date', OID::Date.new
+        register_type 'time', OID::Time.new
+
+        register_type 'path', OID::Identity.new
+        register_type 'point', OID::Point.new
+        register_type 'polygon', OID::Identity.new
+        register_type 'circle', OID::Identity.new
+        register_type 'hstore', OID::Hstore.new
+        register_type 'json', OID::Json.new
+        register_type 'ltree', OID::Identity.new
+
+        register_type 'cidr', OID::Cidr.new
+        alias_type 'inet', 'cidr'
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/postgresql/quoting.rb

@@ -0,0 +1,171 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+      module Quoting
+        # Escapes binary strings for bytea input to the database.
+        def escape_bytea(value)
+          PGconn.escape_bytea(value) if value
+        end
+
+        # Unescapes bytea output from a database to the binary string it represents.
+        # NOTE: This is NOT an inverse of escape_bytea! This is only to be used
+        # on escaped binary output from database drive.
+        def unescape_bytea(value)
+          PGconn.unescape_bytea(value) if value
+        end
+
+        # Quotes PostgreSQL-specific data types for SQL input.
+        def quote(value, column = nil) #:nodoc:
+          return super unless column
+
+          sql_type = type_to_sql(column.type, column.limit, column.precision, column.scale)
+
+          case value
+          when Range
+            if /range$/ =~ sql_type
+              "'#{PostgreSQLColumn.range_to_string(value)}'::#{sql_type}"
+            else
+              super
+            end
+          when Array
+            case sql_type
+            when 'point' then super(PostgreSQLColumn.point_to_string(value))
+            else
+              if column.array
+                "'#{PostgreSQLColumn.array_to_string(value, column, self).gsub(/'/, "''")}'"
+              else
+                super
+              end
+            end
+          when Hash
+            case sql_type
+            when 'hstore' then super(PostgreSQLColumn.hstore_to_string(value), column)
+            when 'json' then super(PostgreSQLColumn.json_to_string(value), column)
+            else super
+            end
+          when IPAddr
+            case sql_type
+            when 'inet', 'cidr' then super(PostgreSQLColumn.cidr_to_string(value), column)
+            else super
+            end
+          when Float
+            if value.infinite? && column.type == :datetime
+              "'#{value.to_s.downcase}'"
+            elsif value.infinite? || value.nan?
+              "'#{value.to_s}'"
+            else
+              super
+            end
+          when Numeric
+            if sql_type == 'money' || [:string, :text].include?(column.type)
+              # Not truly string input, so doesn't require (or allow) escape string syntax.
+              "'#{value}'"
+            else
+              super
+            end
+          when String
+            case sql_type
+            when 'bytea' then "'#{escape_bytea(value)}'"
+            when 'xml'   then "xml '#{quote_string(value)}'"
+            when /^bit/
+              case value
+              when /^[01]*$/      then "B'#{value}'" # Bit-string notation
+              when /^[0-9A-F]*$/i then "X'#{value}'" # Hexadecimal notation
+              end
+            else
+              super
+            end
+          else
+            super
+          end
+        end
+
+        def type_cast(value, column, array_member = false)
+          return super(value, column) unless column
+
+          case value
+          when Range
+            return super(value, column) unless /range$/ =~ column.sql_type
+            PostgreSQLColumn.range_to_string(value)
+          when NilClass
+            if column.array && array_member
+              'NULL'
+            elsif column.array
+              value
+            else
+              super(value, column)
+            end
+          when Array
+            case column.sql_type
+            when 'point' then PostgreSQLColumn.point_to_string(value)
+            else
+              return super(value, column) unless column.array
+              PostgreSQLColumn.array_to_string(value, column, self)
+            end
+          when String
+            return super(value, column) unless 'bytea' == column.sql_type
+            { :value => value, :format => 1 }
+          when Hash
+            case column.sql_type
+            when 'hstore' then PostgreSQLColumn.hstore_to_string(value)
+            when 'json' then PostgreSQLColumn.json_to_string(value)
+            else super(value, column)
+            end
+          when IPAddr
+            return super(value, column) unless ['inet','cidr'].include? column.sql_type
+            PostgreSQLColumn.cidr_to_string(value)
+          else
+            super(value, column)
+          end
+        end
+
+        # Quotes strings for use in SQL input.
+        def quote_string(s) #:nodoc:
+          @connection.escape(s)
+        end
+
+        # Checks the following cases:
+        #
+        # - table_name
+        # - "table.name"
+        # - schema_name.table_name
+        # - schema_name."table.name"
+        # - "schema.name".table_name
+        # - "schema.name"."table.name"
+        def quote_table_name(name)
+          schema, name_part = extract_pg_identifier_from_name(name.to_s)
+
+          unless name_part
+            quote_column_name(schema)
+          else
+            table_name, name_part = extract_pg_identifier_from_name(name_part)
+            "#{quote_column_name(schema)}.#{quote_column_name(table_name)}"
+          end
+        end
+
+        def quote_table_name_for_assignment(table, attr)
+          quote_column_name(attr)
+        end
+
+        # Quotes column names for use in SQL queries.
+        def quote_column_name(name) #:nodoc:
+          PGconn.quote_ident(name.to_s)
+        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:
+          result = super
+          if value.acts_like?(:time) && value.respond_to?(:usec)
+            result = "#{result}.#{sprintf("%06d", value.usec)}"
+          end
+
+          if value.year < 0
+            result = result.sub(/^-/, "") + " BC"
+          end
+          result
+        end
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/postgresql/referential_integrity.rb

@@ -0,0 +1,30 @@
+module ActiveRecord
+  module ConnectionAdapters
+    class PostgreSQLAdapter < AbstractAdapter
+      module ReferentialIntegrity
+        def supports_disable_referential_integrity? #:nodoc:
+          true
+        end
+
+        def disable_referential_integrity #:nodoc:
+          if supports_disable_referential_integrity?
+            begin
+              execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER ALL" }.join(";"))
+            rescue
+              execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} DISABLE TRIGGER USER" }.join(";"))
+            end
+          end
+          yield
+        ensure
+          if supports_disable_referential_integrity?
+            begin
+              execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER ALL" }.join(";"))
+            rescue
+              execute(tables.collect { |name| "ALTER TABLE #{quote_table_name(name)} ENABLE TRIGGER USER" }.join(";"))
+            end
+          end
+        end
+      end
+    end
+  end
+end