nedap / do_postgres

Port of data mapper/do_postgres with small changes to get C extension building working on ruby 3

Rationale for fork

The changes added to have this gem working with Ruby 3.x.x could have been made by vendorizing the gem, however:

As this gem actually requires the building of a C extension, creating a fork seems like the only possible solution.

do_postgres

• http://dataobjects.info

Description

A PostgreSQL driver for DataObjects.

Features/Problems

This driver implements the DataObjects API for the PostgreSQL relational database.

Synopsis

An example of usage:

# default user (postgres, postgres), default port (5432)
DataObjects::Connection.new("postgres://host/database")
# specified user, specified port
DataObjects::Connection.new("postgres://user:pass@host:8888/database")

@connection = DataObjects::Connection.new("postgres://localhost/employees")
@reader = @connection.create_command('SELECT * FROM users').execute_reader
@reader.next!

Requirements

This driver is provided for the following platforms:

• Ruby MRI (1.8.6/7), 1.9: tested on Linux, Mac OS X and Windows platforms.
• JRuby 1.3.1 + (1.4+ recommended).
• Rubinius (experimental).

Additionally you should have the following prerequisites:

• data_objects gem
• do_jdbc gem (shared library), if running on JRuby.

Install

To install the gem:

gem install do_postgres

To compile and install from source:

• Install rake-compiler: gem install rake-compiler.

• For MRI/Rubinius extensions:

  • Install the gcc compiler. On OS X, you should install XCode tools. On Ubuntu, run apt-get install build-essential.
  • Install Ruby and PostgreSQL client.
  • Install the Ruby and PostgreSQL development headers.
    • On Debian-Linux distributions, you can install the following packages with apt: ruby-dev libpostgresql-dev.
  • If you want to cross-compile for Windows:
    • Install MinGW:
      • On Debian-Linux distributions, you can install the following package with apt: mingw32.
      • On OS X, this can install the following package with MacPorts: i386-mingw32-gcc.
    • Run rake-compiler cross-ruby.
    • Run rake-compiler update-config.

• For JRuby extensions:

  • Install the Java Development Kit (provided if you are on a recent version of Mac OS X) from http://java.sun.com.
  • Install a recent version of JRuby. Ensure jruby is in your PATH and/or you have configured the JRUBY_HOME environment variable to point to your JRuby installation.
  • Install data_objects and do_jdbc with jruby -S rake install.

• Then, install this driver with (jruby -S) rake install.

For more information, see the PostgreSQL driver wiki page: http://wiki.github.com/datamapper/do/postgresql.

Developers

Follow the above installation instructions. Additionally, you'll need:

• rspec gem for running specs.
• YARD gem for generating documentation.

See the DataObjects wiki for more comprehensive information on installing and contributing to the JRuby-variant of this driver: http://wiki.github.com/datamapper/do/jruby.

To run specs:

rake spec

To run specs without compiling extensions first:

rake spec_no_compile

To run individual specs:

rake spec SPEC=spec/connection_spec.rb

License

This code is licensed under an MIT (X11) License. Please see the accompanying LICENSE file.