pg 0.17.1-x86-mingw32 → 0.18.0.pre20141017160319-x86-mingw32

data/spec/pg/result_spec.rb

@@ -1,59 +1,29 @@
 #!/usr/bin/env rspec
 # encoding: utf-8
 
-BEGIN {
-	require 'pathname'
+require_relative '../helpers'
 
-	basedir = Pathname( __FILE__ ).dirname.parent.parent
-	libdir = basedir + 'lib'
-
-	$LOAD_PATH.unshift( basedir.to_s ) unless $LOAD_PATH.include?( basedir.to_s )
-	$LOAD_PATH.unshift( libdir.to_s ) unless $LOAD_PATH.include?( libdir.to_s )
-}
-
-require 'rspec'
-require 'spec/lib/helpers'
 require 'pg'
 
-describe PG::Result do
-
-	before( :all ) do
-		@conn = setup_testing_db( "PG_Result" )
-	end
-
-	before( :each ) do
-		@conn.exec( 'BEGIN' )
-	end
-
-	after( :each ) do
-		@conn.exec( 'ROLLBACK' )
-	end
-
-	after( :all ) do
-		teardown_testing_db( @conn )
-	end
-
 
-	#
-	# Examples
-	#
+describe PG::Result do
 
-	it "should act as an array of hashes" do
+	it "acts as an array of hashes" do
 		res = @conn.exec("SELECT 1 AS a, 2 AS b")
-		res[0]['a'].should== '1'
-		res[0]['b'].should== '2'
+		expect( res[0]['a'] ).to eq( '1' )
+		expect( res[0]['b'] ).to eq( '2' )
 	end
 
-	it "should yield a row as an array" do
+	it "yields a row as an array" do
 		res = @conn.exec("SELECT 1 AS a, 2 AS b")
 		list = []
 		res.each_row { |r| list << r }
-		list.should eq [['1', '2']]
+		expect( list ).to eq [['1', '2']]
 	end
 
-	it "should insert nil AS NULL and return NULL as nil" do
+	it "inserts nil AS NULL and return NULL as nil" do
 		res = @conn.exec("SELECT $1::int AS n", [nil])
-		res[0]['n'].should be_nil()
+		expect( res[0]['n'] ).to be_nil()
 	end
 
 	it "encapsulates errors in a PGError object" do
@@ -66,20 +36,25 @@ describe PG::Result do
 
 		result = exception.result
 
-		result.should be_a( described_class() )
-		result.error_field( PG::PG_DIAG_SEVERITY ).should == 'ERROR'
-		result.error_field( PG::PG_DIAG_SQLSTATE ).should == '42P01'
-		result.error_field( PG::PG_DIAG_MESSAGE_PRIMARY ).
-			should == 'relation "nonexistant_table" does not exist'
-		result.error_field( PG::PG_DIAG_MESSAGE_DETAIL ).should be_nil()
-		result.error_field( PG::PG_DIAG_MESSAGE_HINT ).should be_nil()
-		result.error_field( PG::PG_DIAG_STATEMENT_POSITION ).should == '15'
-		result.error_field( PG::PG_DIAG_INTERNAL_POSITION ).should be_nil()
-		result.error_field( PG::PG_DIAG_INTERNAL_QUERY ).should be_nil()
-		result.error_field( PG::PG_DIAG_CONTEXT ).should be_nil()
-		result.error_field( PG::PG_DIAG_SOURCE_FILE ).should =~ /parse_relation\.c$|namespace\.c$/
-		result.error_field( PG::PG_DIAG_SOURCE_LINE ).should =~ /^\d+$/
-		result.error_field( PG::PG_DIAG_SOURCE_FUNCTION ).should =~ /^parserOpenTable$|^RangeVarGetRelid$/
+		expect( result ).to be_a( described_class() )
+		expect( result.error_field(PG::PG_DIAG_SEVERITY) ).to eq( 'ERROR' )
+		expect( result.error_field(PG::PG_DIAG_SQLSTATE) ).to eq( '42P01' )
+		expect(
+			result.error_field(PG::PG_DIAG_MESSAGE_PRIMARY)
+		).to eq( 'relation "nonexistant_table" does not exist' )
+		expect( result.error_field(PG::PG_DIAG_MESSAGE_DETAIL) ).to be_nil()
+		expect( result.error_field(PG::PG_DIAG_MESSAGE_HINT) ).to be_nil()
+		expect( result.error_field(PG::PG_DIAG_STATEMENT_POSITION) ).to eq( '15' )
+		expect( result.error_field(PG::PG_DIAG_INTERNAL_POSITION) ).to be_nil()
+		expect( result.error_field(PG::PG_DIAG_INTERNAL_QUERY) ).to be_nil()
+		expect( result.error_field(PG::PG_DIAG_CONTEXT) ).to be_nil()
+		expect(
+			result.error_field(PG::PG_DIAG_SOURCE_FILE)
+		).to match( /parse_relation\.c$|namespace\.c$/ )
+		expect( result.error_field(PG::PG_DIAG_SOURCE_LINE) ).to match( /^\d+$/ )
+		expect(
+			result.error_field(PG::PG_DIAG_SOURCE_FUNCTION)
+		).to match( /^parserOpenTable$|^RangeVarGetRelid$/ )
 	end
 
 	it "encapsulates database object names for integrity constraint violations", :postgresql_93 do
@@ -92,54 +67,54 @@ describe PG::Result do
 		end
 		result = exception.result
 
-		result.error_field( PG::PG_DIAG_SCHEMA_NAME ).should == 'public'
-		result.error_field( PG::PG_DIAG_TABLE_NAME ).should == 'integrity'
-		result.error_field( PG::PG_DIAG_COLUMN_NAME ).should == 'id'
-		result.error_field( PG::PG_DIAG_DATATYPE_NAME ).should be_nil
-		result.error_field( PG::PG_DIAG_CONSTRAINT_NAME ).should be_nil
+		expect( result.error_field(PG::PG_DIAG_SCHEMA_NAME) ).to eq( 'public' )
+		expect( result.error_field(PG::PG_DIAG_TABLE_NAME) ).to eq( 'integrity' )
+		expect( result.error_field(PG::PG_DIAG_COLUMN_NAME) ).to eq( 'id' )
+		expect( result.error_field(PG::PG_DIAG_DATATYPE_NAME) ).to be_nil
+		expect( result.error_field(PG::PG_DIAG_CONSTRAINT_NAME) ).to be_nil
 	end
 
-	it "should detect division by zero as SQLSTATE 22012" do
+	it "detects division by zero as SQLSTATE 22012" do
 		sqlstate = nil
 		begin
 			res = @conn.exec("SELECT 1/0")
 		rescue PGError => e
 			sqlstate = e.result.result_error_field( PG::PG_DIAG_SQLSTATE ).to_i
 		end
-		sqlstate.should == 22012
+		expect( sqlstate ).to eq( 22012 )
 	end
 
-	it "should return the same bytes in binary format that are sent in binary format" do
+	it "returns the same bytes in binary format that are sent in binary format" do
 		binary_file = File.join(Dir.pwd, 'spec/data', 'random_binary_data')
 		bytes = File.open(binary_file, 'rb').read
 		res = @conn.exec('VALUES ($1::bytea)',
 			[ { :value => bytes, :format => 1 } ], 1)
-		res[0]['column1'].should== bytes
-		res.getvalue(0,0).should == bytes
-		res.values[0][0].should == bytes
-		res.column_values(0)[0].should == bytes
+		expect( res[0]['column1'] ).to eq( bytes )
+		expect( res.getvalue(0,0) ).to eq( bytes )
+		expect( res.values[0][0] ).to eq( bytes )
+		expect( res.column_values(0)[0] ).to eq( bytes )
 	end
 
-	it "should return the same bytes in binary format that are sent as inline text" do
+	it "returns the same bytes in binary format that are sent as inline text" do
 		binary_file = File.join(Dir.pwd, 'spec/data', 'random_binary_data')
 		bytes = File.open(binary_file, 'rb').read
 		@conn.exec("SET standard_conforming_strings=on")
 		res = @conn.exec("VALUES ('#{PG::Connection.escape_bytea(bytes)}'::bytea)", [], 1)
-		res[0]['column1'].should == bytes
-		res.getvalue(0,0).should == bytes
-		res.values[0][0].should == bytes
-		res.column_values(0)[0].should == bytes
+		expect( res[0]['column1'] ).to eq( bytes )
+		expect( res.getvalue(0,0) ).to eq( bytes )
+		expect( res.values[0][0] ).to eq( bytes )
+		expect( res.column_values(0)[0] ).to eq( bytes )
 	end
 
-	it "should return the same bytes in text format that are sent in binary format" do
+	it "returns the same bytes in text format that are sent in binary format" do
 		binary_file = File.join(Dir.pwd, 'spec/data', 'random_binary_data')
 		bytes = File.open(binary_file, 'rb').read
 		res = @conn.exec('VALUES ($1::bytea)',
 			[ { :value => bytes, :format => 1 } ])
-		PG::Connection.unescape_bytea(res[0]['column1']).should== bytes
+		expect( PG::Connection.unescape_bytea(res[0]['column1']) ).to eq( bytes )
 	end
 
-	it "should return the same bytes in text format that are sent as inline text" do
+	it "returns the same bytes in text format that are sent as inline text" do
 		binary_file = File.join(Dir.pwd, 'spec/data', 'random_binary_data')
 		in_bytes = File.open(binary_file, 'rb').read
 
@@ -147,73 +122,76 @@ describe PG::Result do
 		@conn.exec("SET standard_conforming_strings=on")
 		res = @conn.exec("VALUES ('#{PG::Connection.escape_bytea(in_bytes)}'::bytea)", [], 0)
 		out_bytes = PG::Connection.unescape_bytea(res[0]['column1'])
-		out_bytes.should == in_bytes
+		expect( out_bytes ).to eq( in_bytes )
 	end
 
-	it "should return the parameter type of the specified prepared statement parameter", :postgresql_92 do
+	it "returns the parameter type of the specified prepared statement parameter", :postgresql_92 do
 		query = 'SELECT * FROM pg_stat_activity WHERE user = $1::name AND query = $2::text'
 		@conn.prepare( 'queryfinder', query )
 		res = @conn.describe_prepared( 'queryfinder' )
 
-		@conn.exec( 'SELECT format_type($1, -1)', [res.paramtype(0)] ).getvalue( 0, 0 ).
-			should == 'name'
-		@conn.exec( 'SELECT format_type($1, -1)', [res.paramtype(1)] ).getvalue( 0, 0 ).
-			should == 'text'
+		expect(
+			@conn.exec( 'SELECT format_type($1, -1)', [res.paramtype(0)] ).getvalue( 0, 0 )
+		).to eq( 'name' )
+		expect(
+			@conn.exec( 'SELECT format_type($1, -1)', [res.paramtype(1)] ).getvalue( 0, 0 )
+		).to eq( 'text' )
 	end
 
-	it "should raise an exception when a negative index is given to #fformat" do
+	it "raises an exception when a negative index is given to #fformat" do
 		res = @conn.exec('SELECT * FROM pg_stat_activity')
 		expect {
 			res.fformat( -1 )
 		}.to raise_error( ArgumentError, /column number/i )
 	end
 
-	it "should raise an exception when a negative index is given to #fmod" do
+	it "raises an exception when a negative index is given to #fmod" do
 		res = @conn.exec('SELECT * FROM pg_stat_activity')
 		expect {
 			res.fmod( -1 )
 		}.to raise_error( ArgumentError, /column number/i )
 	end
 
-	it "should raise an exception when a negative index is given to #[]" do
+	it "raises an exception when a negative index is given to #[]" do
 		res = @conn.exec('SELECT * FROM pg_stat_activity')
 		expect {
 			res[ -1 ]
 		}.to raise_error( IndexError, /-1 is out of range/i )
 	end
 
-	it "should raise allow for conversion to an array of arrays" do
+	it "raises allow for conversion to an array of arrays" do
 		@conn.exec( 'CREATE TABLE valuestest ( foo varchar(33) )' )
 		@conn.exec( 'INSERT INTO valuestest ("foo") values (\'bar\')' )
 		@conn.exec( 'INSERT INTO valuestest ("foo") values (\'bar2\')' )
 
 		res = @conn.exec( 'SELECT * FROM valuestest' )
-		res.values.should == [ ["bar"], ["bar2"] ]
+		expect( res.values ).to eq( [ ["bar"], ["bar2"] ] )
 	end
 
 	# PQfmod
 	it "can return the type modifier for a result column" do
 		@conn.exec( 'CREATE TABLE fmodtest ( foo varchar(33) )' )
 		res = @conn.exec( 'SELECT * FROM fmodtest' )
-		res.fmod( 0 ).should == 33 + 4 # Column length + varlena size (4)
+		expect( res.fmod(0) ).to eq( 33 + 4 ) # Column length + varlena size (4)
 	end
 
-	it "should raise an exception when an invalid index is passed to PG::Result#fmod" do
+	it "raises an exception when an invalid index is passed to PG::Result#fmod" do
 		@conn.exec( 'CREATE TABLE fmodtest ( foo varchar(33) )' )
 		res = @conn.exec( 'SELECT * FROM fmodtest' )
 		expect { res.fmod(1) }.to raise_error( ArgumentError )
 	end
 
-	it "should raise an exception when an invalid (negative) index is passed to PG::Result#fmod" do
+	it "raises an exception when an invalid (negative) index is passed to PG::Result#fmod" do
 		@conn.exec( 'CREATE TABLE fmodtest ( foo varchar(33) )' )
 		res = @conn.exec( 'SELECT * FROM fmodtest' )
 		expect { res.fmod(-11) }.to raise_error( ArgumentError )
 	end
 
-	it "shouldn't raise an exception when a valid index is passed to PG::Result#fmod for a column with no typemod" do
+	it "doesn't raise an exception when a valid index is passed to PG::Result#fmod for a" +
+	   " column with no typemod" do
 		@conn.exec( 'CREATE TABLE fmodtest ( foo text )' )
 		res = @conn.exec( 'SELECT * FROM fmodtest' )
-		res.fmod( 0 ).should == -1 # and it shouldn't raise an exception, either
+		expect( res.fmod(0) ).to eq( -1 )
 	end
 
 	# PQftable
@@ -221,28 +199,28 @@ describe PG::Result do
 		@conn.exec( 'CREATE TABLE ftabletest ( foo text )' )
 		res = @conn.exec( 'SELECT * FROM ftabletest' )
 
-		res.ftable( 0 ).should == be_nonzero()
+		expect( res.ftable(0) ).to be_nonzero()
 	end
 
-	it "should raise an exception when an invalid index is passed to PG::Result#ftable" do
+	it "raises an exception when an invalid index is passed to PG::Result#ftable" do
 		@conn.exec( 'CREATE TABLE ftabletest ( foo text )' )
 		res = @conn.exec( 'SELECT * FROM ftabletest' )
 
 		expect { res.ftable(18) }.to raise_error( ArgumentError )
 	end
 
-	it "should raise an exception when an invalid (negative) index is passed to PG::Result#ftable" do
+	it "raises an exception when an invalid (negative) index is passed to PG::Result#ftable" do
 		@conn.exec( 'CREATE TABLE ftabletest ( foo text )' )
 		res = @conn.exec( 'SELECT * FROM ftabletest' )
 
 		expect { res.ftable(-2) }.to raise_error( ArgumentError )
 	end
 
-	it "shouldn't raise an exception when a valid index is passed to PG::Result#ftable for a " +
+	it "doesn't raise an exception when a valid index is passed to PG::Result#ftable for a " +
 	   "column with no corresponding table" do
 		@conn.exec( 'CREATE TABLE ftabletest ( foo text )' )
 		res = @conn.exec( 'SELECT foo, LENGTH(foo) as length FROM ftabletest' )
-		res.ftable( 1 ).should == PG::INVALID_OID # and it shouldn't raise an exception, either
+		expect( res.ftable(1) ).to eq( PG::INVALID_OID )
 	end
 
 	# PQftablecol
@@ -250,29 +228,29 @@ describe PG::Result do
 		@conn.exec( 'CREATE TABLE ftablecoltest ( foo text, bar numeric )' )
 		res = @conn.exec( 'SELECT * FROM ftablecoltest' )
 
-		res.ftablecol( 0 ).should == 1
-		res.ftablecol( 1 ).should == 2
+		expect( res.ftablecol(0) ).to eq( 1 )
+		expect( res.ftablecol(1) ).to eq( 2 )
 	end
 
-	it "should raise an exception when an invalid index is passed to PG::Result#ftablecol" do
+	it "raises an exception when an invalid index is passed to PG::Result#ftablecol" do
 		@conn.exec( 'CREATE TABLE ftablecoltest ( foo text, bar numeric )' )
 		res = @conn.exec( 'SELECT * FROM ftablecoltest' )
 
 		expect { res.ftablecol(32) }.to raise_error( ArgumentError )
 	end
 
-	it "should raise an exception when an invalid (negative) index is passed to PG::Result#ftablecol" do
+	it "raises an exception when an invalid (negative) index is passed to PG::Result#ftablecol" do
 		@conn.exec( 'CREATE TABLE ftablecoltest ( foo text, bar numeric )' )
 		res = @conn.exec( 'SELECT * FROM ftablecoltest' )
 
 		expect { res.ftablecol(-1) }.to raise_error( ArgumentError )
 	end
 
-	it "shouldn't raise an exception when a valid index is passed to PG::Result#ftablecol for a " +
+	it "doesnn't raise an exception when a valid index is passed to PG::Result#ftablecol for a " +
 	   "column with no corresponding table" do
 		@conn.exec( 'CREATE TABLE ftablecoltest ( foo text )' )
 		res = @conn.exec( 'SELECT foo, LENGTH(foo) as length FROM ftablecoltest' )
-		res.ftablecol(1).should == 0 # and it shouldn't raise an exception, either
+		expect( res.ftablecol(1) ).to eq( 0 )
 	end
 
 	it "can be manually checked for failed result status (async API)" do
@@ -285,41 +263,41 @@ describe PG::Result do
 
 	it "can return the values of a single field" do
 		res = @conn.exec( "SELECT 1 AS x, 'a' AS y UNION ALL SELECT 2, 'b'" )
-		res.field_values( 'x' ).should == ['1', '2']
-		res.field_values( 'y' ).should == ['a', 'b']
-		expect{ res.field_values( '' ) }.to raise_error(IndexError)
-		expect{ res.field_values( :x ) }.to raise_error(TypeError)
+		expect( res.field_values('x') ).to eq( ['1', '2'] )
+		expect( res.field_values('y') ).to eq( ['a', 'b'] )
+		expect{ res.field_values('') }.to raise_error(IndexError)
+		expect{ res.field_values(:x) }.to raise_error(TypeError)
 	end
 
-	it "should raise a proper exception for a nonexistant table" do
+	it "raises a proper exception for a nonexistant table" do
 		expect {
 			@conn.exec( "SELECT * FROM nonexistant_table" )
 		}.to raise_error( PG::UndefinedTable, /relation "nonexistant_table" does not exist/ )
 	end
 
-	it "should raise a more generic exception for an unknown SQLSTATE" do
+	it "raises a more generic exception for an unknown SQLSTATE" do
 		old_error = PG::ERROR_CLASSES.delete('42P01')
 		begin
 			expect {
 				@conn.exec( "SELECT * FROM nonexistant_table" )
 			}.to raise_error{|error|
-				error.should be_an_instance_of(PG::SyntaxErrorOrAccessRuleViolation)
-				error.to_s.should match(/relation "nonexistant_table" does not exist/)
+				expect( error ).to be_an_instance_of(PG::SyntaxErrorOrAccessRuleViolation)
+				expect( error.to_s ).to match(/relation "nonexistant_table" does not exist/)
 			}
 		ensure
 			PG::ERROR_CLASSES['42P01'] = old_error
 		end
 	end
 
-	it "should raise a ServerError for an unknown SQLSTATE class" do
+	it "raises a ServerError for an unknown SQLSTATE class" do
 		old_error1 = PG::ERROR_CLASSES.delete('42P01')
 		old_error2 = PG::ERROR_CLASSES.delete('42')
 		begin
 			expect {
 				@conn.exec( "SELECT * FROM nonexistant_table" )
 			}.to raise_error{|error|
-				error.should be_an_instance_of(PG::ServerError)
-				error.to_s.should match(/relation "nonexistant_table" does not exist/)
+				expect( error ).to be_an_instance_of(PG::ServerError)
+				expect( error.to_s ).to match(/relation "nonexistant_table" does not exist/)
 			}
 		ensure
 			PG::ERROR_CLASSES['42P01'] = old_error1
@@ -327,19 +305,71 @@ describe PG::Result do
 		end
 	end
 
-	it "should raise a proper exception for a nonexistant schema" do
+	it "raises a proper exception for a nonexistant schema" do
 		expect {
 			@conn.exec( "DROP SCHEMA nonexistant_schema" )
 		}.to raise_error( PG::InvalidSchemaName, /schema "nonexistant_schema" does not exist/ )
 	end
 
-	it "the raised result should be nil in case of a connection error" do
+	it "the raised result is nil in case of a connection error" do
 		c = PGconn.connect_start( '127.0.0.1', 54320, "", "", "me", "xxxx", "somedb" )
 		expect {
 			c.exec "select 1"
-		}.to raise_error{|error|
-			error.should be_an_instance_of(PG::UnableToSend)
-			error.result.should == nil
+		}.to raise_error {|error|
+			expect( error ).to be_an_instance_of(PG::UnableToSend)
+			expect( error.result ).to eq( nil )
 		}
 	end
+
+	it "does not clear the result itself" do
+		r = @conn.exec "select 1"
+		expect( r.autoclear? ).to eq(false)
+		expect( r.cleared? ).to eq(false)
+		r.clear
+		expect( r.cleared? ).to eq(true)
+	end
+
+	context 'result value conversions with TypeMapByColumn' do
+		let!(:textdec_int){ PG::TextDecoder::Integer.new name: 'INT4', oid: 23 }
+		let!(:textdec_float){ PG::TextDecoder::Float.new name: 'FLOAT4', oid: 700 }
+
+		it "should allow reading, assigning and diabling type conversions" do
+			res = @conn.exec( "SELECT 123" )
+			expect( res.type_map ).to be_nil
+			res.type_map = PG::TypeMapByColumn.new [textdec_int]
+			expect( res.type_map ).to be_an_instance_of(PG::TypeMapByColumn)
+			expect( res.type_map.coders ).to eq( [textdec_int] )
+			res.type_map = PG::TypeMapByColumn.new [textdec_float]
+			expect( res.type_map.coders ).to eq( [textdec_float] )
+			res.type_map = nil
+			expect( res.type_map ).to be_nil
+		end
+
+		it "should be applied to all value retrieving methods" do
+			res = @conn.exec( "SELECT 123 as f" )
+			res.type_map = PG::TypeMapByColumn.new [textdec_int]
+			expect( res.values ).to eq( [[123]] )
+			expect( res.getvalue(0,0) ).to eq( 123 )
+			expect( res[0] ).to eq( {'f' => 123 } )
+			expect( res.enum_for(:each_row).to_a ).to eq( [[123]] )
+			expect( res.enum_for(:each).to_a ).to eq( [{'f' => 123}] )
+			expect( res.column_values(0) ).to eq( [123] )
+			expect( res.field_values('f') ).to eq( [123] )
+		end
+
+		it "should be usable for several querys" do
+			colmap = PG::TypeMapByColumn.new [textdec_int]
+			res = @conn.exec( "SELECT 123" )
+			res.type_map = colmap
+			expect( res.values ).to eq( [[123]] )
+			res = @conn.exec( "SELECT 456" )
+			res.type_map = colmap
+			expect( res.values ).to eq( [[456]] )
+		end
+
+		it "shouldn't allow invalid type maps" do
+			res = @conn.exec( "SELECT 1" )
+			expect{ res.type_map = 1 }.to raise_error(TypeError)
+		end
+	end
 end