123456789_123456789_123456789_123456789_123456789_

Class: ActiveRecord::ConnectionAdapters::PostgreSQL::OID::Hstore

Do not use. This class is for internal use only.
Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::ActiveModel::Type::Value
Instance Chain:
self, ::ActiveModel::Type::Helpers::Mutable, ::ActiveModel::Type::Value, ::ActiveModel::Type::SerializeCastValue
Inherits: ActiveModel::Type::Value
Defined in: activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb

Constant Summary

Class Method Summary

::ActiveModel::Type::Value - Inherited

.new

Initializes a type with three basic configuration settings: precision, limit, and scale.

Instance Attribute Summary

::ActiveModel::Type::Helpers::Mutable - Included

#mutable?

::ActiveModel::Type::Value - Inherited

#limit, #precision, #scale,
#binary?

These predicates are not documented, as I need to look further into their use, and see if they can be removed entirely.
#mutable?, #serialized?

Instance Method Summary

::ActiveModel::Type::Helpers::Mutable - Included

#cast,
#changed_in_place?

raw_old_value will be the _before_type_cast version of the value (likely a string).

::ActiveModel::Type::Value - Inherited

#==, #as_json, #assert_valid_value,
#cast

::ActiveRecord::Type casts a value from user input (e.g. from a setter).
#changed?

Determines whether a value has changed for dirty checking.
#changed_in_place?

Determines whether the mutable value has been modified since it was read.
#deserialize

Converts a value from database input to the appropriate ruby type.
#eql?

Alias for ActiveModel::Type::Value#==.
#hash,
#serializable?

Returns true if this type can convert value to a type that is usable by the database.
#serialize

Casts a value from the ruby type to a type that the database knows how to understand.
#type

Returns the unique type name as a ::Symbol.
#cast_value

Convenience method for types which do not need separate type casting behavior for user and database inputs.
#force_equality?, #map,
#type_cast_for_schema

::ActiveRecord::Type casts a value for schema dumping.
#value_constructed_by_mass_assignment?

::ActiveModel::Type::SerializeCastValue - Included

#initialize, #itself_if_serialize_cast_value_compatible

Constructor Details

This class inherits a constructor from ActiveModel::Type::Value

Instance Method Details

#accessor

[ GitHub ] 

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb', line 81



def accessor
  ActiveRecord::Store::StringKeyedHashAccessor
end


  








  

    #changed_in_place?(raw_old_value, new_value)  ⇒ Boolean 
  



  

    

Will compare the ::Hash equivalents of raw_old_value and new_value. By comparing hashes, this avoids an edge case where the order of the keys change between the two hashes, and they would not be marked as equal.


  





  


  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb', line 89



def changed_in_place?(raw_old_value, new_value)
  deserialize(raw_old_value) != new_value
end


  








  

    #deserialize(value)  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb', line 18



def deserialize(value)
  return value unless value.is_a?(::String)

  scanner = StringScanner.new(value)
  hash = {}

  until scanner.eos?
    unless scanner.skip(/"/)
      raise(ArgumentError, ERROR % scanner.string.inspect)
    end

    unless key = scanner.scan(/^(\\[\\"]|[^\\"])*?(?=")/)
      raise(ArgumentError, ERROR % scanner.string.inspect)
    end

    unless scanner.skip(/"=>?/)
      raise(ArgumentError, ERROR % scanner.string.inspect)
    end

    if scanner.scan(/NULL/)
      value = nil
    else
      unless scanner.skip(/"/)
        raise(ArgumentError, ERROR % scanner.string.inspect)
      end

      unless value = scanner.scan(/^(\\[\\"]|[^\\"])*?(?=")/)
        raise(ArgumentError, ERROR % scanner.string.inspect)
      end

      unless scanner.skip(/"/)
        raise(ArgumentError, ERROR % scanner.string.inspect)
      end
    end

    key.gsub!('\"', '"')
    key.gsub!("\\\\", "\\")

    if value
      value.gsub!('\"', '"')
      value.gsub!("\\\\", "\\")
    end

    hash[key] = value

    unless scanner.skip(/, /) || scanner.eos?
      raise(ArgumentError, ERROR % scanner.string.inspect)
    end
  end

  hash
end


  








  

    #escape_hstore(value)   (private)
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb', line 94



def escape_hstore(value)
  if value.nil?
    "NULL"
  else
    if value == ""
      '""'
    else
      '"%s"' % value.to_s.gsub(/(["\\])/, '\\\\\1')
    end
  end
end


  








  

    #serialize(value)  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb', line 71



def serialize(value)
  if value.is_a?(::Hash)
    value.map { |k, v| "#{escape_hstore(k)}=>#{escape_hstore(v)}" }.join(", ")
  elsif value.respond_to?(:to_unsafe_h)
    serialize(value.to_unsafe_h)
  else
    value
  end
end


  








  

    #type  
  

  [ GitHub ]


  

  


# File 'activerecord/lib/active_record/connection_adapters/postgresql/oid/hstore.rb', line 14



def type
  :hstore
end