pg 0.11.0pre229 → 0.11.0

data/ChangeLog

@@ -1,4 +1,7 @@
-229[master,tip]:228,222   b477174160c8   2011-03-30 06:13 -0700   ged
+230[tip]   24aa7899c696   2011-04-18 16:51 -0700   ged
+  Move connection-parameter parsing into Ruby, and make option-handling more
+
+229:228,222   b477174160c8   2011-03-30 06:13 -0700   ged
   Automated merge with ssh://bitbucket.org/larskanis/ruby-pg
 
 228   cc3a7476465c   2011-03-15 13:21 +0100   kanis
@@ -31,7 +34,7 @@
 219   1c3a1ca9f0cd   2011-01-22 04:41 +0800   ghazel
   for windows support, duplicate the sockets from libpq and create temporary CRT fds
 
-218[github/master]:214   c3f163bf1ecd   2011-01-22 22:11 -0800   ged
+218:214   c3f163bf1ecd   2011-01-22 22:11 -0800   ged
   Pulling fixes for Windows from ghazel on Github
 
 217   18f413081e0c   2011-02-10 16:19 -0800   ged

data/ext/pg.c

@@ -9,7 +9,7 @@
   modified at: Wed Jan 20 16:41:51 1999
 
   $Author: ged $
-  $Date: 2011/03/30 13:13:47 $
+  $Date: 2011/04/18 23:51:05 $
 ************************************************/
 
 #include "pg.h"
@@ -77,34 +77,6 @@ static PQnoticeReceiver default_notice_receiver = NULL;
 static PQnoticeProcessor default_notice_processor = NULL;
 
 
-/*
- * Used to quote the values passed in a Hash to PGconn.init
- * when building the connection string.
- */
-static VALUE
-pgconn_s_quote_connstr(VALUE string)
-{
-	char *str,*ptr;
-	int i,j=0,len;
-	VALUE result;
-
-	Check_Type(string, T_STRING);
-
-	ptr = RSTRING_PTR(string);
-	len = RSTRING_LEN(string);
-	str = ALLOC_N(char, len * 2 + 2 + 1);
-	str[j++] = '\'';
-	for(i = 0; i < len; i++) {
-		if(ptr[i] == '\'' || ptr[i] == '\\')
-			str[j++] = '\\';
-		str[j++] = ptr[i];	
-	}
-	str[j++] = '\'';
-	result = rb_str_new(str, j);
-	xfree(str);
-	return result;
-}
-
 static void
 free_pgconn(PGconn *conn)
 {
@@ -223,87 +195,6 @@ notice_processor_proxy(void *arg, const char *message)
 	return;
 }
 
-/*
- * Appends key='val' to conninfo_rstr
- */
-static void
-build_key_value_string(VALUE conninfo_rstr, char *key, VALUE val)
-{
-	if(val != Qnil) {
-		if(RSTRING_LEN(conninfo_rstr) > 0)
-			rb_str_cat2(conninfo_rstr, " ");
-		rb_str_cat2(conninfo_rstr, key);
-		rb_str_cat2(conninfo_rstr, "=");
-		rb_str_concat(conninfo_rstr, 
-			pgconn_s_quote_connstr(rb_obj_as_string(val)));
-	}
-	return;
-}
-
-static VALUE
-parse_connect_args(int argc, VALUE *argv, VALUE self)
-{
-	VALUE args,arg;
-	VALUE conninfo_rstr = rb_str_new("",0);
-	char *host, *port, *opt, *tty, *dbname, *login, *pwd;
-	host = port = opt = tty = dbname = login = pwd = NULL;
-
-	rb_scan_args(argc, argv, "0*", &args); 
-	if (RARRAY_LEN(args) == 1) { 
-		arg = rb_ary_entry(args,0);
-		if(TYPE(arg) == T_HASH) {
-			build_key_value_string(conninfo_rstr, "host", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("host"))));
-			build_key_value_string(conninfo_rstr, "hostaddr", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("hostaddr"))));
-			build_key_value_string(conninfo_rstr, "port", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("port"))));
-			build_key_value_string(conninfo_rstr, "dbname", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("dbname"))));
-			build_key_value_string(conninfo_rstr, "user", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("user"))));
-			build_key_value_string(conninfo_rstr, "password", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("password"))));
-			build_key_value_string(conninfo_rstr, "connect_timeout", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("connect_timeout"))));
-			build_key_value_string(conninfo_rstr, "options", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("options"))));
-			build_key_value_string(conninfo_rstr, "tty", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("tty"))));
-			build_key_value_string(conninfo_rstr, "sslmode", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("sslmode"))));
-			build_key_value_string(conninfo_rstr, "krbsrvname", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("krbsrvname"))));
-			build_key_value_string(conninfo_rstr, "gsslib", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("gsslib"))));
-			build_key_value_string(conninfo_rstr, "service", 
-				rb_hash_aref(arg, ID2SYM(rb_intern("service"))));
-		}
-		else if(TYPE(arg) == T_STRING) {
-			conninfo_rstr = arg;
-		}
-		else {
-			rb_raise(rb_eArgError, 
-				"Expecting String or Hash as single argument");
-		}
-	}
-	else if (RARRAY_LEN(args) == 7) {
-		build_key_value_string(conninfo_rstr, "host", rb_ary_entry(args,0));
-		build_key_value_string(conninfo_rstr, "port", rb_ary_entry(args,1));
-		build_key_value_string(conninfo_rstr, "options", rb_ary_entry(args,2));
-		build_key_value_string(conninfo_rstr, "tty", rb_ary_entry(args,3));
-		build_key_value_string(conninfo_rstr, "dbname", rb_ary_entry(args,4));
-		build_key_value_string(conninfo_rstr, "user", rb_ary_entry(args,5));
-		build_key_value_string(conninfo_rstr, "password", rb_ary_entry(args,6));
-	}
-	else {
-		rb_raise( rb_eArgError, 
-				  "Expected connection info string, hash, or 7 separate arguments, got a %s.",
-				  RSTRING_PTR(rb_obj_classname( args )) );
-	}
-
-	return conninfo_rstr;
-}
 
 /********************************************************************
  *
@@ -351,9 +242,10 @@ pgconn_alloc(VALUE klass)
  * Document-method: new
  *
  * call-seq:
+ *    PGconn.new -> PGconn
  *    PGconn.new(connection_hash) -> PGconn
  *    PGconn.new(connection_string) -> PGconn
- *    PGconn.new(host, port, options, tty, dbname, login, password) ->  PGconn
+ *    PGconn.new(host, port, options, tty, dbname, user, password) ->  PGconn
  * 
  * Create a connection to the specified server.
  * 
@@ -386,6 +278,9 @@ pgconn_alloc(VALUE klass)
  * 
  * Examples:
  * 
+ *   # Connect using all defaults
+ *   PGconn.connect
+ *
  *   # As a Hash
  *   PGconn.connect( :dbname => 'test', :port => 5432 )
  *   
@@ -411,7 +306,7 @@ pgconn_init(int argc, VALUE *argv, VALUE self)
 	const char *encname;
 #endif
 
-	conninfo = parse_connect_args(argc, argv, self);
+	conninfo = rb_funcall2( rb_cPGconn, rb_intern("parse_connect_args"), argc, argv );
 	conn = PQconnectdb(StringValuePtr(conninfo));
 
 	if(conn == NULL)
@@ -473,7 +368,7 @@ pgconn_s_connect_start(int argc, VALUE *argv, VALUE self)
 	 */
 	rb_conn = pgconn_alloc(rb_cPGconn);
 
-	conninfo = parse_connect_args(argc, argv, self);
+	conninfo = rb_funcall2( rb_cPGconn, rb_intern("parse_connect_args"), argc, argv );
 	conn = PQconnectStart(StringValuePtr(conninfo));
 
 	if(conn == NULL)
@@ -4109,6 +4004,7 @@ Init_pg_ext()
 	rb_define_singleton_method(rb_cPGconn, "quote_ident", pgconn_s_quote_ident, 1);
 	rb_define_singleton_method(rb_cPGconn, "connect_start", pgconn_s_connect_start, -1);
 	rb_define_singleton_method(rb_cPGconn, "conndefaults", pgconn_s_conndefaults, 0);
+	
 
 	/******     PGconn CLASS CONSTANTS: Connection Status     ******/
 

data/lib/pg.rb

@@ -14,3 +14,58 @@ rescue LoadError => err
 
 end
 
+### The PG connection class.
+class PGconn
+
+	# The order the options are passed to the ::connect method.
+	CONNECT_ARGUMENT_ORDER = %w[host port options tty dbname user password]
+
+
+	### Quote the given +value+ for use in a connection-parameter string.
+	### @param [String] value  the option value to be quoted.
+	### @return [String]
+	def self::quote_connstr( value )
+		return "'" + value.to_s.gsub( /[\\']/ ) {|m| '\\' + m } + "'"
+	end
+
+
+	### Parse the connection +args+ into a connection-parameter string
+	### @param [Array<String>] args  the connection parameters
+	### @return [String]  a connection parameters string
+	def self::parse_connect_args( *args )
+		return '' if args.empty?
+
+		# This will be swapped soon for code that makes options like those required for
+		# PQconnectdbParams()/PQconnectStartParams(). For now, stick to an options string for
+		# PQconnectdb()/PQconnectStart().
+		connopts = []
+
+		# Handle an options hash first
+		if args.last.is_a?( Hash )
+			opthash = args.pop 
+			opthash.each do |key, val|
+				connopts.push( "%s=%s" % [key, PGconn.quote_connstr(val)] )
+			end
+		end
+
+		# Option string style
+		if args.length == 1 && args.first.to_s.index( '=' )
+			connopts.unshift( args.first )
+
+		# Append positional parameters
+		else
+			args.each_with_index do |val, i|
+				next unless val # Skip nil placeholders
+
+				key = CONNECT_ARGUMENT_ORDER[ i ] or
+					raise ArgumentError, "Extra positional parameter %d: %p" % [ i+1, val ]
+				connopts.push( "%s=%s" % [key, PGconn.quote_connstr(val.to_s)] )
+			end
+		end
+
+		return connopts.join(' ')
+	end
+
+end # class PGconn
+
+

data/spec/pgconn_spec.rb

@@ -30,20 +30,64 @@ describe PGconn do
 		@conn.exec( 'BEGIN' )
 	end
 
+	it "can create a connection option string from a Hash of options" do
+		optstring = PGconn.parse_connect_args( 
+			:host => 'pgsql.example.com',
+			:dbname => 'db01',
+			'sslmode' => 'require'
+		  )
+
+		optstring.should be_a( String )
+		optstring.should =~ /(^|\s)host='pgsql.example.com'/
+		optstring.should =~ /(^|\s)dbname='db01'/
+		optstring.should =~ /(^|\s)sslmode='require'/
+	end
+
+	it "can create a connection option string from positional parameters" do
+		optstring = PGconn.parse_connect_args( 'pgsql.example.com', nil, '-c geqo=off', nil, 
+		                                       'sales' )
+
+		optstring.should be_a( String )
+		optstring.should =~ /(^|\s)host='pgsql.example.com'/
+		optstring.should =~ /(^|\s)dbname='sales'/
+		optstring.should =~ /(^|\s)options='-c geqo=off'/
+		
+		optstring.should_not =~ /port=/
+		optstring.should_not =~ /tty=/
+	end
+
+	it "can create a connection option string from a mix of positional and hash parameters" do
+		optstring = PGconn.parse_connect_args( 'pgsql.example.com',
+		                                       :dbname => 'licensing', :user => 'jrandom' )
+
+		optstring.should be_a( String )
+		optstring.should =~ /(^|\s)host='pgsql.example.com'/
+		optstring.should =~ /(^|\s)dbname='licensing'/
+		optstring.should =~ /(^|\s)user='jrandom'/
+	end
+
+	it "escapes single quotes and backslashes in connection parameters" do
+		PGconn.parse_connect_args( "DB 'browser' \\" ).should == "host='DB \\'browser\\' \\\\'"
+
+	end
+
+	it "connects with defaults if no connection parameters are given" do
+		PGconn.parse_connect_args.should == ''
+	end
 
-	it "should connect successfully with connection string" do
+	it "connects successfully with connection string" do
 		tmpconn = PGconn.connect(@conninfo)
 		tmpconn.status.should== PGconn::CONNECTION_OK
 		tmpconn.finish
 	end
 
-	it "should connect using 7 arguments converted to strings" do
+	it "connects using 7 arguments converted to strings" do
 		tmpconn = PGconn.connect('localhost', @port, nil, nil, :test, nil, nil)
 		tmpconn.status.should== PGconn::CONNECTION_OK
 		tmpconn.finish
 	end
 
-	it "should connect using hash" do
+	it "connects using a hash of connection parameters" do
 		tmpconn = PGconn.connect(
 			:host => 'localhost',
 			:port => @port,
@@ -52,7 +96,14 @@ describe PGconn do
 		tmpconn.finish
 	end
 
-	it "should connect asynchronously" do
+	it "raises an exception when connecting with an invalid number of arguments" do
+		expect {
+			PGconn.connect( 1, 2, 3, 4, 5, 6, 7, 'extra' )
+		}.to raise_error( ArgumentError, /extra positional parameter/i )
+	end
+
+
+	it "can connect asynchronously" do
 		tmpconn = PGconn.connect_start(@conninfo)
 		socket = IO.for_fd(tmpconn.socket)
 		status = tmpconn.connect_poll
@@ -72,7 +123,7 @@ describe PGconn do
 		tmpconn.finish
 	end
 
-	it "should not leave stale server connections after finish" do
+	it "doesn't leave stale server connections after finish" do
 		PGconn.connect(@conninfo).finish
 		sleep 0.5
 		res = @conn.exec(%[SELECT COUNT(*) AS n FROM pg_stat_activity
@@ -112,7 +163,7 @@ describe PGconn do
 		}.gsub( /^\t{2}/, '' ).lstrip
 
 	unless RUBY_PLATFORM =~ /mswin|mingw/
-		it "should trace and untrace client-server communication" do
+		it "trace and untrace client-server communication" do
 			# be careful to explicitly close files so that the
 			# directory can be removed and we don't have to wait for
 			# the GC to run.
@@ -173,7 +224,7 @@ describe PGconn do
 		res.ntuples.should == 0
 	end
 
-	it "should not read past the end of a large object" do
+	it "not read past the end of a large object" do
 		@conn.transaction do
 			oid = @conn.lo_create( 0 )
 			fd = @conn.lo_open( oid, PGconn::INV_READ|PGconn::INV_WRITE )

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: pg
 version: !ruby/object:Gem::Version 
-  hash: 1923832275
+  hash: 51
   prerelease: 
   segments: 
   - 0
   - 11
   - 0
-  - pre
-  - 229
-  version: 0.11.0pre229
+  version: 0.11.0
 platform: ruby
 authors: 
 - Jeff Davis
@@ -38,8 +36,7 @@ cert_chain:
   cmlhXe46pZNJgWKbxZah85jIjx95hR8vOI+NAM5iH9kOqK13DrxacTKPhqj5PjwF
   -----END CERTIFICATE-----
 
-date: 2011-03-31 00:00:00 -07:00
-default_executable: 
+date: 2011-04-19 00:00:00 Z
 dependencies: []
 
 description: |-
@@ -98,7 +95,6 @@ files:
 - Rakefile.local
 - spec/data/expected_trace.out
 - spec/data/random_binary_data
-has_rdoc: true
 homepage: http://bitbucket.org/ged/ruby-pg/
 licenses: 
 - Ruby
@@ -138,7 +134,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: 
 - PostgreSQL >=7.4
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: A Ruby interface to the PostgreSQL RDBMS