og 0.31.0 → 0.40.0

data/lib/og/adapter/mysql/override.rb

@@ -0,0 +1,34 @@
+#--
+# Customize the standard MySQL driver objects to make
+# more compatible with Og.
+#++
+
+class Mysql # :nodoc: all
+
+class Result # :nodoc: all
+  def blank?
+    0 == num_rows
+  end
+
+  alias_method :next, :fetch_row  
+
+  def each_row
+    each do |row|
+      yield(row, 0)
+    end
+  end
+
+  def first_value
+    val = fetch_row[0]
+    free
+    return val
+  end
+
+  alias close free
+
+  def fields
+    fetch_fields.collect { |f| f.name }
+  end
+end
+
+end

data/lib/og/adapter/mysql/script.rb

@@ -0,0 +1,15 @@
+# Helper for mysql scripts.
+#
+# === Example
+#
+# mysql '-u root -p', %{
+#   drop database if exists weblog_development;
+#   create database weblog_development;
+#   grant all on weblog_development.* to #{`id -un`.strip}@localhost;
+# }
+
+def mysql(opts, stream)
+  IO.popen("mysql #{opts}", 'w') do |io| 
+    io.puts stream
+  end
+end

data/lib/og/adapter/mysql/utils.rb

@@ -0,0 +1,40 @@
+require 'og/store/sql/utils'
+
+module Og
+
+module MysqlUtils
+  include SqlUtils
+  
+  def escape(str)
+    return nil unless str
+    return Mysql.quote(str)
+  end
+
+  # Escape the various Ruby types.
+
+  def quote(vals)
+    vals = [vals] unless vals.is_a?(Array)
+    quoted = vals.inject('') do |s, val|
+      s += case val
+        when Fixnum, Integer, Float
+          val ? val.to_s : 'NULL'
+        when String
+          val ? "'#{escape(val)}'" : 'NULL'
+        when Time
+          val ? "'#{timestamp(val)}'" : 'NULL'
+        when Date
+          val ? "'#{date(val)}'" : 'NULL'
+        when TrueClass, FalseClass
+          val ? "'1'" : 'NULL'
+        else
+          # gmosx: keep the '' for nil symbols.
+          val ? escape(val.to_yaml) : ''
+      end + ','
+    end
+    quoted.chop!
+    vals.size > 1 ? "(#{quoted})" : quoted
+  end
+
+end
+
+end

data/lib/og/adapter/postgresql.rb

@@ -0,0 +1,231 @@
+begin
+  require 'postgres'
+rescue Object => ex
+  Logger.error 'Ruby-PostgreSQL bindings are not installed!'
+  Logger.error ex
+end
+
+require 'og/store/sql'
+require 'og/adapter/postgresql/override'
+require 'og/adapter/postgresql/utils'
+
+module Og
+
+# A Store that persists objects into a PostgreSQL database.
+# To read documentation about the methods, consult the 
+# documentation for SqlStore and Store.
+#
+# This is the reference Og store.
+
+class PostgresqlAdapter < SqlStore
+  extend PostgresqlUtils; include PostgresqlUtils
+
+  def initialize(options)
+    super
+  
+    @typemap.update(Og::Blob => 'bytea')
+
+    @conn = PGconn.connect(
+      options[:address] || options[:host], 
+      options[:port], nil, nil, 
+      options[:name], 
+      options[:user].to_s, 
+      options[:password].to_s
+    )
+    schema_order = options[:schema_order]
+    encoding = options[:encoding]
+    min_messages = options[:min_messages]
+    
+    @conn.exec("SET search_path TO #{schema_order}") if schema_order
+    @conn.exec("SET client_encoding TO '#{encoding}'") if encoding
+    @conn.exec("SET client_min_messages TO '#{min_messages}'") if min_messages
+  rescue PGError => ex
+    if database_does_not_exist_exception? ex
+      Logger.info "Database '#{options[:name]}' not found!"
+      create_db(options)
+      retry
+    end
+    raise
+  end
+
+  def close
+    @conn.close
+    super
+  end
+
+  def create_db(options)
+    # gmosx: system is used to avoid shell expansion.
+    system 'createdb', options[:name], '-U', options[:user]
+    super
+  end
+
+  def destroy_db(options)
+    system 'dropdb', options[:name], '-U', options[:user]
+    super
+  end
+
+  # The type used for default primary keys.
+  
+  def primary_key_type
+    'serial PRIMARY KEY'
+  end
+  
+  def enchant(klass, manager)
+    pk = klass.primary_key
+    
+    seq = if klass.schema_inheritance_child?
+      "#{table(klass.schema_inheritance_root_class)}_#{pk}_seq"
+    else
+      "#{table(klass)}_#{pk}_seq"
+    end
+    
+    pkann = klass.ann[pk]
+    
+    pkann[:sequence] = (pkann[:sql] =~ /SERIAL/i) ? seq : false
+    
+    super
+  end
+
+  def query_statement(sql)
+    return @conn.exec(sql)
+  end
+
+  def exec_statement(sql)
+    @conn.exec(sql).clear
+  end
+
+  def sql_update(sql)
+    Logger.debug sql if $DBG  
+    res = @conn.exec(sql)
+    changed = res.cmdtuples
+    res.clear
+    return changed
+  end
+
+  # Return the last inserted row id.
+  
+  def last_insert_id(klass)
+    seq = klass.ann[klass.primary_key][:sequence]
+    
+    res = query("SELECT nextval('#{seq}')")
+    lid = Integer(res.first_value)
+    
+    return lid
+  end
+  
+  # The insert sql statements.
+  
+  def insert_sql(sql, klass)
+    str = ''
+    
+    if klass.ann[klass.primary_key][:sequence]
+      str << "@#{klass.primary_key} = store.last_insert_id(#{klass})\n"
+    end
+    
+    str << "store.exec \"#{sql}\""
+    
+    return str
+  end
+  
+  # :section: Transaction methods.
+
+  # Start a new transaction.
+
+  def start  
+    # neumann: works with earlier PSQL databases too.
+    exec('BEGIN TRANSACTION') if @transaction_nesting < 1
+    
+    if @transaction_nesting >= 1 && @conn.server_version > 80000
+      exec("SAVEPOINT SP#{@transaction_nesting}")
+    end
+    
+    @transaction_nesting += 1
+  end
+  
+  # Commit a transaction.
+
+  def commit
+    @transaction_nesting -= 1
+    exec('COMMIT') if @transaction_nesting < 1
+    
+    if @transaction_nesting >= 1 && @conn.server_version > 80000
+      exec("RELEASE SAVEPOINT SP#{@transaction_nesting}")
+    end
+  end
+
+  # Rollback a transaction.
+
+  def rollback
+    @transaction_nesting -= 1
+    exec('ROLLBACK') if @transaction_nesting < 1
+    
+    if @transaction_nesting >= 1 && @conn.server_version > 80000
+      exec("ROLLBACK TO SAVEPOINT SP#{@transaction_nesting}")
+    end
+  end
+  
+  def read_attr(s, a, col)
+    store = self.class
+    {
+      String    => nil,
+      Integer   => :parse_int,
+      Float     => :parse_float,
+      Time      => :parse_timestamp,
+      Date      => :parse_date,
+      TrueClass => :parse_boolean,
+      Og::Blob  => :parse_blob
+    }.each do |klass, meth|
+      if a.class.ancestor? klass
+        return meth ? 
+          "#{store}.#{meth}(res[#{col} + offset])" : "res[#{col} + offset]"
+      end
+    end
+
+    # else try to load it via YAML
+    "YAML::load(res[#{col} + offset])"
+  end
+
+  def eval_og_allocate(klass)  
+    if klass.schema_inheritance?
+      klass.module_eval %{
+        def self.og_allocate(res, row = 0)
+          Object.constant(res[0]).allocate
+        end
+      }
+    else
+      klass.module_eval %{
+        def self.og_allocate(res, row = 0)
+          self.allocate
+        end
+      }
+    end
+  end
+
+  def read_row(obj, res, res_row, row)
+    res.fields.each_with_index do |field, idx|
+      obj.instance_variable_set "@#{field}", res.getvalue(row, idx)
+    end
+  end
+
+  # Returns the PostgreSQL information of a table within the database or
+  # nil if it doesn't exist. Mostly for internal usage.
+
+  def table_info(table)
+    r = query_statement("SELECT c.* FROM pg_catalog.pg_class c LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace WHERE c.relkind = 'r' AND n.nspname NOT IN ('pg_catalog', 'pg_toast') AND pg_catalog.pg_table_is_visible(c.oid) AND c.relname = '#{self.class.escape(table.to_s)}'")
+    return r && r.blank? ? nil : r.next
+  end
+
+private
+
+  def database_does_not_exist_exception?(ex)
+    ex.message =~ /database .* does not exist/i
+  end
+  
+  def table_already_exists_exception?(ex)
+    ex.message =~ /already exists/
+  end    
+  
+end
+
+end
+

data/lib/og/adapter/postgresql/override.rb

@@ -0,0 +1,117 @@
+#--
+# Customize the standard Postgresql driver objects to make them
+# more compatible with Og.
+#++
+
+class PGconn # :nodoc: all
+  
+  # Redirect notices from backend to the logger instead of stderr
+  
+  alias_method :initialize_pre_on_notice, :initialize
+  def initialize(*args)
+    initialize_pre_on_notice(*args)
+    
+    on_notice { |message| Logger.info message }
+  end
+
+# Check for older versions of ruby-postgres and postgres-pr
+
+unless PGconn.instance_methods.include?('server_version')
+  
+  # call-seq:
+  #   conn.server_version -> Integer
+  # 
+  # The number is formed by converting the major, minor, and revision numbers
+  # into two-decimal-digit numbers and appending them together. For example,
+  # version 7.4.2 will be returned as 70402, and version 8.1 will be returned
+  # as 80100 (leading zeroes are not shown). Zero is returned if the
+  # connection is bad.
+  # See also parse_version.
+  
+  def server_version
+    @server_version ||= parse_version(exec('SHOW server_version').first_value)
+  rescue PGError => e
+    return 0
+  end
+  
+  def parse_version(version)
+    version.split('.').map{|v| v.rjust(2,'0') }.join.to_i
+  end
+  private :parse_version
+  
+end
+
+end
+
+
+class PGresult # :nodoc: all
+  def blank?
+    0 == num_tuples
+  end
+  
+  def next
+    @row_idx ||= -1
+    result[@row_idx += 1]
+  end
+
+  def each_row
+    result.each_with_index do |row, idx|
+      yield(row, idx)
+    end
+  end
+  
+  def first_value
+    val = getvalue(0, 0)
+    clear
+    return val
+  end
+  
+  alias_method :close, :clear
+
+end
+
+class PGError # :nodoc: all
+  attr_accessor :og_info
+end
+
+
+# Compatibility layer for postgres-pr
+
+if defined?(PostgresPR)
+
+class PGconn # :nodoc: all
+  alias_method :query_pre_resque, :query
+  alias_method :exec_old, :exec
+  
+  def query(*args)
+    exec_old(*args)
+  # postgres-pr raises NoMethodError when querying if no conn is available
+  rescue RuntimeError, NoMethodError => e
+    raise PGError, e.message
+  end
+  
+  alias_method :exec, :query
+  
+  class << self
+    alias_method :new_pre_resque, :new
+    
+    def new(*args)
+      new_pre_resque(*args)
+    rescue RuntimeError => e
+      raise PGError, e.message
+    end
+    
+    alias_method :connect, :new
+  end
+  
+  def on_notice(&block)
+    @notice_processor = block
+  end
+  
+end
+
+class PGError # :nodoc: all
+  alias error message
+end
+
+end

data/lib/og/adapter/postgresql/script.rb

@@ -0,0 +1,15 @@
+# Helper for mysql scripts.
+#
+# === Example
+#
+# mysql '-u root -p', %{
+#   drop database if exists weblog_development;
+#   create database weblog_development;
+#   grant all on weblog_development.* to #{`id -un`.strip}@localhost;
+# }
+
+def psql(opts, stream)
+  IO.popen("psql #{opts}", 'w') do |io| 
+    io.puts stream
+  end
+end