pg_typecast 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Stateless Systems
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,68 @@
+= pg_typecast
+
+* http://github.com/deepfryed/pg_typecast
+
+== Description
+
+Provides typecasting support for the pg gem. The code is extracted from the swift gem as
+a drop-in enhancement for users of the pg gem.
+
+== Dependencies
+
+* ruby   >= 1.9.1
+* pg     >= 0.9.0
+
+== Alternatives
+
+Swift (http://github.com/shanna/swift) is as fast as the pg gem with typecasting support
+and drivers for mysql, postgresql and db2.
+
+== Caveats
+
+* This gem overrides the PGresult#each method.
+* The rows are returned as hashes with field names as symbols and values typecast from
+  postgres types to ruby types.
+* Timestamp conversion is done to localtime. The server and client are assumed to be in
+  same timezone unless you use the 'timestamp with time zone' data type in postgresql.
+
+== Compiling
+
+If pg_config is not on your PATH, then just set POSTGRES_INCLUDE and POSTGRES_LIB environment variables
+to the include and lib directories.
+
+== Synopsis
+
+    require 'pg'
+    require 'pg_typecast'
+
+    adapter = PGconn.connect 'host=127.0.0.1 dbname=test'
+    result  = adapter.exec('select * from users')
+    result.each do |row|
+      p row
+    end
+
+== Typecasting
+
+The following table illustrates the typecasting done from postgresql types to native ruby types.
+
+    +--------------------+---------------------------+
+    | postgresql type    |   ruby type               |
+    +--------------------+---------------------------+
+    | bool               |   TrueClass or FalseClass |
+    | bytea              |   StringIO                |
+    | date               |   Date                    |
+    | float              |   Float                   |
+    | integer            |   Fixnum or Bignum        |
+    | numeric            |   BigDecimal              |
+    | timestamp          |   Time                    |
+    | timestampz         |   Time                    |
+    +--------------------+---------------------------+
+
+
+== TODO
+
+* tests.
+
+== License
+
+See LICENSE.

data/Rakefile

@@ -0,0 +1,20 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name        = 'pg_typecast'
+    gem.summary     = %q{Extensions to pg gem supporting typecasting.}
+    gem.description = %q{Extensions to pg gem supporting typecasting.}
+    gem.email       = %w{deepfryed@gmail.com}
+    gem.homepage    = 'http://github.com/deepfryed/pg_typecast'
+    gem.authors     = ['Bharanee Rathna']
+    gem.extensions  = FileList['ext/extconf.rb']
+    gem.files.reject!{|f| f =~ %r{\.gitignore}}
+
+    gem.add_dependency 'pg', '>= 0.9.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/ext/extconf.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby
+
+require 'mkmf'
+
+incdir = `pg_config --includedir`.chomp rescue ENV.fetch('POSTGRES_INCLUDE', '/usr/include/postgresql')
+libdir = `pg_config --libdir`.chomp     rescue ENV.fetch('POSTGRES_LIB',     '/usr/lib')
+
+$CFLAGS  = "-I#{incdir} -Os"
+$LDFLAGS = "-L#{libdir} -lpq"
+
+create_makefile 'pg_typecast'

data/ext/pg_typecast.c

@@ -0,0 +1,146 @@
+#include <ruby/ruby.h>
+#include <ruby/io.h>
+#include <stdint.h>
+#include <time.h>
+#include <libpq-fe.h>
+#include <libpq/libpq-fs.h>
+
+#define CONST_GET(scope, constant) rb_funcall(scope, rb_intern("const_get"), 1, rb_str_new2(constant))
+
+/*
+    Extracted from swift gem.
+
+    1. This speeds up pg when you need typecasting and the ability to whip through results quickly.
+    2. Adds PGresult#each and mixes in enumerable.
+
+*/
+
+ID fnew;
+VALUE cStringIO, cBigDecimal;
+
+int64_t client_tzoffset(int64_t local, int isdst) {
+  struct tm tm;
+  gmtime_r((const time_t*)&local, &tm);
+  return (int64_t)(local + (isdst ? 3600 : 0) - mktime(&tm));
+}
+
+VALUE typecast_timestamp(const char *data, uint64_t len) {
+  struct tm tm;
+  int64_t epoch, adjust, offset;
+
+  char tzsign = 0;
+  int tzhour  = 0, tzmin = 0;
+  long double sec_fraction = 0;
+
+  memset(&tm, 0, sizeof(struct tm));
+  if (strchr(data, '.')) {
+    sscanf(data, "%04d-%02d-%02d %02d:%02d:%02d%Lf%c%02d:%02d",
+      &tm.tm_year, &tm.tm_mon, &tm.tm_mday, &tm.tm_hour, &tm.tm_min, &tm.tm_sec, &sec_fraction,
+      &tzsign, &tzhour, &tzmin);
+  }
+  else {
+    sscanf(data, "%04d-%02d-%02d %02d:%02d:%02d%c%02d:%02d",
+      &tm.tm_year, &tm.tm_mon, &tm.tm_mday, &tm.tm_hour, &tm.tm_min, &tm.tm_sec,
+      &tzsign, &tzhour, &tzmin);
+  }
+
+  tm.tm_year  -= 1900;
+  tm.tm_mon   -= 1;
+  tm.tm_isdst = -1;
+  if (tm.tm_mday > 0) {
+    epoch  = mktime(&tm);
+    adjust = client_tzoffset(epoch, tm.tm_isdst);
+    offset = adjust;
+
+    if (tzsign) {
+      offset = tzsign == '+'
+        ? (time_t)tzhour *  3600 + (time_t)tzmin *  60
+        : (time_t)tzhour * -3600 + (time_t)tzmin * -60;
+    }
+
+    return rb_time_new(epoch+adjust-offset, (uint64_t)(sec_fraction*1000000L));
+  }
+
+  return rb_str_new(data, len);
+}
+
+VALUE typecast_date(const char *data, uint64_t len) {
+  return rb_funcall(typecast_timestamp(data, len), rb_intern("to_date"), 0);
+}
+
+inline VALUE typecast(const char* data, uint64_t len, int pgtype) {
+  size_t bytea_len;
+  unsigned char* bytea;
+  VALUE rv;
+
+  switch(pgtype) {
+    case 16:
+      return *data == 't' ? Qtrue : Qfalse;
+    case 17:
+      bytea = PQunescapeBytea(data, &bytea_len);
+      rv = rb_funcall(cStringIO, fnew, 1, rb_str_new(bytea, bytea_len));
+      PQfreemem(bytea);
+      return rv;
+    case 20:
+    case 21:
+    case 22:
+    case 23:
+    case 26:
+      return rb_cstr2inum(data, 10);
+    case 700:
+    case 701:
+    case 790:
+      return rb_float_new(atof(data));
+    case 1700:
+      return rb_funcall(cBigDecimal, fnew, 1, rb_str_new(data, len));
+    case 1082:
+      return typecast_date(data, len);
+    case 1114:
+    case 1184:
+      return typecast_timestamp(data, len);
+    default:
+      return rb_str_new(data, len);
+  }
+}
+
+VALUE result_each(VALUE self) {
+    int r, c, rows, cols, *types;
+    PGresult *res;
+    Data_Get_Struct(self, PGresult, res);
+
+    VALUE fields = rb_ary_new();
+    rows  = PQntuples(res);
+    cols  = PQnfields(res);
+    types = (int*)malloc(sizeof(int)*cols);
+    for (c = 0; c < cols; c++) {
+        rb_ary_push(fields, ID2SYM(rb_intern(PQfname(res, c))));
+        types[c] = PQftype(res, c);
+    }
+
+    for (r = 0; r < rows; r++) {
+        VALUE tuple = rb_hash_new();
+        for (c = 0; c < cols; c++) {
+            rb_hash_aset(tuple, rb_ary_entry(fields, c),
+                PQgetisnull(res, r, c) ? Qnil : typecast(PQgetvalue(res, r, c), PQgetlength(res, r, c), types[c]));
+        }
+        rb_yield(tuple);
+    }
+
+    free(types);
+    return Qnil;
+}
+
+void Init_pg_typecast() {
+  rb_require("pg");
+  rb_require("date");
+  rb_require("stringio");
+  rb_require("bigdecimal");
+
+  fnew        = rb_intern("new");
+  cStringIO   = CONST_GET(rb_mKernel, "StringIO");
+  cBigDecimal = CONST_GET(rb_mKernel, "BigDecimal");
+
+  VALUE cPGresult = rb_define_class("PGresult", rb_cObject);
+  rb_include_module(cPGresult, CONST_GET(rb_mKernel, "Enumerable"));
+  rb_define_method(cPGresult, "each", RUBY_METHOD_FUNC(result_each), 0);
+}

data/pg_typecast.gemspec

@@ -0,0 +1,48 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{pg_typecast}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Bharanee Rathna"]
+  s.date = %q{2010-09-16}
+  s.description = %q{Extensions to pg gem supporting typecasting.}
+  s.email = ["deepfryed@gmail.com"]
+  s.extensions = ["ext/extconf.rb"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "ext/extconf.rb",
+     "ext/pg_typecast.c",
+     "pg_typecast.gemspec"
+  ]
+  s.homepage = %q{http://github.com/deepfryed/pg_typecast}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Extensions to pg gem supporting typecasting.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<pg>, [">= 0.9.0"])
+    else
+      s.add_dependency(%q<pg>, [">= 0.9.0"])
+    end
+  else
+    s.add_dependency(%q<pg>, [">= 0.9.0"])
+  end
+end
+

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: pg_typecast
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Bharanee Rathna
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-16 00:00:00 +10:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pg
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.0
+    version: 
+description: Extensions to pg gem supporting typecasting.
+email: 
+- deepfryed@gmail.com
+executables: []
+
+extensions: 
+- ext/extconf.rb
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- ext/extconf.rb
+- ext/pg_typecast.c
+- pg_typecast.gemspec
+has_rdoc: true
+homepage: http://github.com/deepfryed/pg_typecast
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Extensions to pg gem supporting typecasting.
+test_files: []
+