pg 1.1.0 → 1.2.3

data/spec/pg/result_spec.rb

@@ -4,16 +4,65 @@
 require_relative '../helpers'
 
 require 'pg'
+require 'objspace'
 
 
 describe PG::Result do
 
+	describe :field_name_type do
+		let!(:res) { @conn.exec('SELECT 1 AS a, 2 AS "B"') }
+
+		it "uses string field names per default" do
+			expect(res.field_name_type).to eq(:string)
+		end
+
+		it "can set string field names" do
+			res.field_name_type = :string
+			expect(res.field_name_type).to eq(:string)
+		end
+
+		it "can set symbol field names" do
+			res.field_name_type = :symbol
+			expect(res.field_name_type).to eq(:symbol)
+		end
+
+		it "can set static_symbol field names" do
+			res.field_name_type = :static_symbol
+			expect(res.field_name_type).to eq(:static_symbol)
+		end
+
+		it "can't set symbol field names after #fields" do
+			res.fields
+			expect{ res.field_name_type = :symbol }.to raise_error(ArgumentError, /already materialized/)
+			expect(res.field_name_type).to eq(:string)
+		end
+
+		it "can't set invalid values" do
+			expect{ res.field_name_type = :sym }.to raise_error(ArgumentError, /invalid argument :sym/)
+			expect{ res.field_name_type = "symbol" }.to raise_error(ArgumentError, /invalid argument "symbol"/)
+		end
+	end
+
 	it "acts as an array of hashes" do
 		res = @conn.exec("SELECT 1 AS a, 2 AS b")
 		expect( res[0]['a'] ).to eq( '1' )
 		expect( res[0]['b'] ).to eq( '2' )
 	end
 
+	it "acts as an array of hashes with symbols" do
+		res = @conn.exec("SELECT 1 AS a, 2 AS b")
+		res.field_name_type = :symbol
+		expect( res[0][:a] ).to eq( '1' )
+		expect( res[0][:b] ).to eq( '2' )
+	end
+
+	it "acts as an array of hashes with static_symbols" do
+		res = @conn.exec("SELECT 1 AS a, 2 AS b")
+		res.field_name_type = :static_symbol
+		expect( res[0][:a] ).to eq( '1' )
+		expect( res[0][:b] ).to eq( '2' )
+	end
+
 	it "yields a row as an array" do
 		res = @conn.exec("SELECT 1 AS a, 2 AS b")
 		list = []
@@ -25,7 +74,6 @@ describe PG::Result do
 		res = @conn.exec("SELECT 1 AS a, 2 AS b")
 		e = res.each_row
 		expect( e ).to be_a_kind_of(Enumerator)
-		pending "Rubinius doesn't define RETURN_SIZED_ENUMERATOR()" if RUBY_ENGINE=='rbx'
 		expect( e.size ).to eq( 1 )
 		expect( e.to_a ).to eq [['1', '2']]
 	end
@@ -34,12 +82,19 @@ describe PG::Result do
 		res = @conn.exec("SELECT 1 AS a, 2 AS b")
 		e = res.each
 		expect( e ).to be_a_kind_of(Enumerator)
-		pending "Rubinius doesn't define RETURN_SIZED_ENUMERATOR()" if RUBY_ENGINE=='rbx'
 		expect( e.size ).to eq( 1 )
 		expect( e.to_a ).to eq [{'a'=>'1', 'b'=>'2'}]
 	end
 
+	it "yields a row as an Enumerator of hashs with symbols" do
+		res = @conn.exec("SELECT 1 AS a, 2 AS b")
+		res.field_name_type = :symbol
+		expect( res.each.to_a ).to eq [{:a=>'1', :b=>'2'}]
+	end
+
 	context "result streaming in single row mode" do
+		let!(:textdec_int){ PG::TextDecoder::Integer.new name: 'INT4', oid: 23 }
+
 		it "can iterate over all rows as Hash" do
 			@conn.send_query( "SELECT generate_series(2,4) AS a; SELECT 1 AS b, generate_series(5,6) AS c" )
 			@conn.set_single_row_mode
@@ -56,6 +111,31 @@ describe PG::Result do
 			expect( @conn.get_result ).to be_nil
 		end
 
+		it "can iterate over all rows as Hash with symbols and typemap" do
+			@conn.send_query( "SELECT generate_series(2,4) AS a" )
+			@conn.set_single_row_mode
+			res = @conn.get_result.field_names_as(:symbol)
+			res.type_map = PG::TypeMapByColumn.new [textdec_int]
+			expect(
+				res.stream_each.to_a
+			).to eq(
+				[{:a=>2}, {:a=>3}, {:a=>4}]
+			)
+			expect( @conn.get_result ).to be_nil
+		end
+
+		it "keeps last result on error while iterating stream_each" do
+			@conn.send_query( "SELECT generate_series(2,4) AS a" )
+			@conn.set_single_row_mode
+			res = @conn.get_result
+			expect do
+				res.stream_each_row do
+					raise ZeroDivisionError
+				end
+			end.to raise_error(ZeroDivisionError)
+			expect( res.values ).to eq([["2"]])
+		end
+
 		it "can iterate over all rows as Array" do
 			@conn.send_query( "SELECT generate_series(2,4) AS a; SELECT 1 AS b, generate_series(5,6) AS c" )
 			@conn.set_single_row_mode
@@ -72,6 +152,18 @@ describe PG::Result do
 			expect( @conn.get_result ).to be_nil
 		end
 
+		it "keeps last result on error while iterating stream_each_row" do
+			@conn.send_query( "SELECT generate_series(2,4) AS a" )
+			@conn.set_single_row_mode
+			res = @conn.get_result
+			expect do
+				res.stream_each_row do
+					raise ZeroDivisionError
+				end
+			end.to raise_error(ZeroDivisionError)
+			expect( res.values ).to eq([["2"]])
+		end
+
 		it "can iterate over all rows as PG::Tuple" do
 			@conn.send_query( "SELECT generate_series(2,4) AS a; SELECT 1 AS b, generate_series(5,6) AS c" )
 			@conn.set_single_row_mode
@@ -88,6 +180,36 @@ describe PG::Result do
 			expect( @conn.get_result ).to be_nil
 		end
 
+		it "clears result on error while iterating stream_each_tuple" do
+			@conn.send_query( "SELECT generate_series(2,4) AS a" )
+			@conn.set_single_row_mode
+			res = @conn.get_result
+			expect do
+				res.stream_each_tuple do
+					raise ZeroDivisionError
+				end
+			end.to raise_error(ZeroDivisionError)
+			expect( res.cleared? ).to eq(true)
+		end
+
+		it "should reuse field names in stream_each_tuple" do
+			@conn.send_query( "SELECT generate_series(2,3) AS a" )
+			@conn.set_single_row_mode
+			tuple1, tuple2 = *@conn.get_result.stream_each_tuple.to_a
+			expect( tuple1.keys[0].object_id ).to eq(tuple2.keys[0].object_id)
+		end
+
+		it "can iterate over all rows as PG::Tuple with symbols and typemap" do
+			@conn.send_query( "SELECT generate_series(2,4) AS a" )
+			@conn.set_single_row_mode
+			res = @conn.get_result.field_names_as(:symbol)
+			res.type_map = PG::TypeMapByColumn.new [textdec_int]
+			tuples = res.stream_each_tuple.to_a
+			expect( tuples[0][0] ).to eq( 2 )
+			expect( tuples[1][:a] ).to eq( 3 )
+			expect( @conn.get_result ).to be_nil
+		end
+
 		it "complains when not in single row mode" do
 			@conn.send_query( "SELECT generate_series(2,4)" )
 			expect{
@@ -147,6 +269,17 @@ describe PG::Result do
 		).to match( /^parserOpenTable$|^RangeVarGetRelid$/ )
 	end
 
+	it "encapsulates PG_DIAG_SEVERITY_NONLOCALIZED error in a PG::Error object", :postgresql_96 do
+		result = nil
+		begin
+			@conn.exec( "SELECT * FROM nonexistant_table" )
+		rescue PG::Error => err
+			result = err.result
+		end
+
+		expect( result.error_field(PG::PG_DIAG_SEVERITY_NONLOCALIZED) ).to eq( 'ERROR' )
+	end
+
 	it "encapsulates database object names for integrity constraint violations", :postgresql_93 do
 		@conn.exec( "CREATE TABLE integrity (id SERIAL PRIMARY KEY)" )
 		exception = nil
@@ -167,13 +300,35 @@ describe PG::Result do
 	it "detects division by zero as SQLSTATE 22012" do
 		sqlstate = nil
 		begin
-			res = @conn.exec("SELECT 1/0")
+			@conn.exec("SELECT 1/0")
 		rescue PG::Error => e
 			sqlstate = e.result.result_error_field( PG::PG_DIAG_SQLSTATE ).to_i
 		end
 		expect( sqlstate ).to eq( 22012 )
 	end
 
+	it "provides the error message" do
+		@conn.send_query("SELECT xyz")
+		res = @conn.get_result; @conn.get_result
+		expect( res.error_message ).to match(/"xyz"/)
+		expect( res.result_error_message ).to match(/"xyz"/)
+	end
+
+	it "provides a verbose error message", :postgresql_96 do
+		@conn.send_query("SELECT xyz")
+		res = @conn.get_result; @conn.get_result
+		# PQERRORS_TERSE should give a single line result
+		expect( res.verbose_error_message(PG::PQERRORS_TERSE, PG::PQSHOW_CONTEXT_ALWAYS) ).to match(/\A.*\n\z/)
+		# PQERRORS_VERBOSE should give a multi line result
+		expect( res.result_verbose_error_message(PG::PQERRORS_VERBOSE, PG::PQSHOW_CONTEXT_NEVER) ).to match(/\n.*\n/)
+	end
+
+	it "provides a verbose error message with SQLSTATE", :postgresql_12 do
+		@conn.send_query("SELECT xyz")
+		res = @conn.get_result; @conn.get_result
+		expect( res.verbose_error_message(PG::PQERRORS_SQLSTATE, PG::PQSHOW_CONTEXT_NEVER) ).to match(/42703/)
+	end
+
 	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
@@ -258,6 +413,32 @@ describe PG::Result do
 		expect( res.values ).to eq( [ ["bar"], ["bar2"] ] )
 	end
 
+	it "can retrieve field names" do
+		res = @conn.exec('SELECT 1 AS a, 2 AS "B"')
+		expect(res.fields).to eq(["a", "B"])
+	end
+
+	it "can retrieve field names as symbols" do
+		res = @conn.exec('SELECT 1 AS a, 2 AS "B"')
+		res.field_name_type = :symbol
+		expect(res.fields).to eq([:a, :B])
+	end
+
+	it "can retrieve single field names" do
+		res = @conn.exec('SELECT 1 AS a, 2 AS "B"')
+		expect(res.fname(0)).to eq("a")
+		expect(res.fname(1)).to eq("B")
+		expect{res.fname(2)}.to raise_error(ArgumentError)
+	end
+
+	it "can retrieve single field names as symbol" do
+		res = @conn.exec('SELECT 1 AS a, 2 AS "B"')
+		res.field_name_type = :symbol
+		expect(res.fname(0)).to eq(:a)
+		expect(res.fname(1)).to eq(:B)
+		expect{res.fname(2)}.to raise_error(ArgumentError)
+	end
+
 	# PQfmod
 	it "can return the type modifier for a result column" do
 		@conn.exec( 'CREATE TABLE fmodtest ( foo varchar(33) )' )
@@ -355,8 +536,9 @@ describe PG::Result do
 		res = @conn.exec( "SELECT 1 AS x, 'a' AS y UNION ALL SELECT 2, 'b'" )
 		expect( res.field_values('x') ).to eq( ['1', '2'] )
 		expect( res.field_values('y') ).to eq( ['a', 'b'] )
+		expect( res.field_values(:x) ).to eq( ['1', '2'] )
 		expect{ res.field_values('') }.to raise_error(IndexError)
-		expect{ res.field_values(:x) }.to raise_error(TypeError)
+		expect{ res.field_values(0) }.to raise_error(TypeError)
 	end
 
 	it "can return the values of a single tuple" do
@@ -444,6 +626,13 @@ describe PG::Result do
 		expect( r.inspect ).to match(/cleared/)
 	end
 
+	it "should give account about memory usage" do
+		r = @conn.exec "select 1"
+		expect( ObjectSpace.memsize_of(r) ).to be > 1000
+		r.clear
+		expect( ObjectSpace.memsize_of(r) ).to be < 100
+	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 }
@@ -470,6 +659,7 @@ describe PG::Result do
 			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] )
+			expect( res.field_values(:f) ).to eq( [123] )
 			expect( res.tuple_values(0) ).to eq( [123] )
 		end
 

data/spec/pg/tuple_spec.rb

@@ -8,10 +8,22 @@ require 'objspace'
 describe PG::Tuple do
 	let!(:typemap) { PG::BasicTypeMapForResults.new(@conn) }
 	let!(:result2x2) { @conn.exec( "VALUES(1, 'a'), (2, 'b')" ) }
-	let!(:result2x3cast) { @conn.exec( "SELECT * FROM (VALUES(1, TRUE, '3'), (2, FALSE, '4')) AS m (a, b, b)" ).map_types!(typemap) }
+	let!(:result2x2sym) { @conn.exec( "VALUES(1, 'a'), (2, 'b')" ).field_names_as(:symbol) }
+	let!(:result2x3cast) do
+		@conn.exec( "SELECT * FROM (VALUES(1, TRUE, '3'), (2, FALSE, '4')) AS m (a, b, b)" )
+			.map_types!(typemap)
+	end
+	let!(:result2x3symcast) do
+		@conn.exec( "SELECT * FROM (VALUES(1, TRUE, '3'), (2, FALSE, '4')) AS m (a, b, b)" )
+			.map_types!(typemap)
+			.field_names_as(:symbol)
+	end
 	let!(:tuple0) { result2x2.tuple(0) }
+	let!(:tuple0sym) { result2x2sym.tuple(0) }
 	let!(:tuple1) { result2x2.tuple(1) }
+	let!(:tuple1sym) { result2x2sym.tuple(1) }
 	let!(:tuple2) { result2x3cast.tuple(0) }
+	let!(:tuple2sym) { result2x3symcast.tuple(0) }
 	let!(:tuple3) { str = Marshal.dump(result2x3cast.tuple(1)); Marshal.load(str) }
 	let!(:tuple_empty) { PG::Tuple.new }
 
@@ -51,9 +63,19 @@ describe PG::Tuple do
 			expect( tuple0["column2"] ).to eq( "a" )
 			expect( tuple2["a"] ).to eq( 1 )
 			expect( tuple2["b"] ).to eq( "3" )
+			expect( tuple0[:b] ).to be_nil
 			expect( tuple0["x"] ).to be_nil
 		end
 
+		it "supports hash like access with symbols" do
+			expect( tuple0sym[:column1] ).to eq( "1" )
+			expect( tuple0sym[:column2] ).to eq( "a" )
+			expect( tuple2sym[:a] ).to eq( 1 )
+			expect( tuple2sym[:b] ).to eq( "3" )
+			expect( tuple2sym["b"] ).to be_nil
+			expect( tuple0sym[:x] ).to be_nil
+		end
+
 		it "casts lazy and caches result" do
 			a = []
 			deco = Class.new(PG::SimpleDecoder) do
@@ -138,6 +160,12 @@ describe PG::Tuple do
 			expect{ tuple_empty.each }.to raise_error(TypeError)
 		end
 
+		it "can be used as an enumerator with symbols" do
+			expect( tuple0sym.each ).to be_kind_of(Enumerator)
+			expect( tuple0sym.each.to_a ).to eq( [[:column1, "1"], [:column2, "a"]] )
+			expect( tuple2sym.each.to_a ).to eq( [[:a, 1], [:b, true], [:b, "3"]] )
+		end
+
 		it "can be used with block" do
 			a = []
 			tuple0.each do |*v|
@@ -174,16 +202,30 @@ describe PG::Tuple do
 
 	it "responds to key?" do
 		expect( tuple1.key?("column1") ).to eq( true )
+		expect( tuple1.key?(:column1) ).to eq( false )
 		expect( tuple1.key?("other") ).to eq( false )
 		expect( tuple1.has_key?("column1") ).to eq( true )
 		expect( tuple1.has_key?("other") ).to eq( false )
 	end
 
+	it "responds to key? as symbol" do
+		expect( tuple1sym.key?(:column1) ).to eq( true )
+		expect( tuple1sym.key?("column1") ).to eq( false )
+		expect( tuple1sym.key?(:other) ).to eq( false )
+		expect( tuple1sym.has_key?(:column1) ).to eq( true )
+		expect( tuple1sym.has_key?(:other) ).to eq( false )
+	end
+
 	it "responds to keys" do
 		expect( tuple0.keys ).to eq( ["column1", "column2"] )
 		expect( tuple2.keys ).to eq( ["a", "b", "b"] )
 	end
 
+	it "responds to keys as symbol" do
+		expect( tuple0sym.keys ).to eq( [:column1, :column2] )
+		expect( tuple2sym.keys ).to eq( [:a, :b, :b] )
+	end
+
 	describe "each_key" do
 		it "can be used as an enumerator" do
 			expect( tuple0.each_key ).to be_kind_of(Enumerator)
@@ -208,12 +250,22 @@ describe PG::Tuple do
 
 	it "responds to index" do
 		expect( tuple0.index("column1") ).to eq( 0 )
+		expect( tuple0.index(:column1) ).to eq( nil )
 		expect( tuple0.index("column2") ).to eq( 1 )
 		expect( tuple0.index("x") ).to eq( nil )
 		expect( tuple2.index("a") ).to eq( 0 )
 		expect( tuple2.index("b") ).to eq( 2 )
 	end
 
+	it "responds to index with symbol" do
+		expect( tuple0sym.index(:column1) ).to eq( 0 )
+		expect( tuple0sym.index("column1") ).to eq( nil )
+		expect( tuple0sym.index(:column2) ).to eq( 1 )
+		expect( tuple0sym.index(:x) ).to eq( nil )
+		expect( tuple2sym.index(:a) ).to eq( 0 )
+		expect( tuple2sym.index(:b) ).to eq( 2 )
+	end
+
 	it "can be used as Enumerable" do
 		expect( tuple0.to_a ).to eq( [["column1", "1"], ["column2", "a"]] )
 		expect( tuple1.to_a ).to eq( [["column1", "2"], ["column2", "b"]] )
@@ -222,7 +274,7 @@ describe PG::Tuple do
 	end
 
 	it "can be marshaled" do
-		[tuple0, tuple1, tuple2, tuple3].each do |t1|
+		[tuple0, tuple1, tuple2, tuple3, tuple0sym, tuple2sym].each do |t1|
 			str = Marshal.dump(t1)
 			t2 = Marshal.load(str)
 
@@ -253,6 +305,7 @@ describe PG::Tuple do
 	it "should override #inspect" do
 		expect( tuple1.inspect ).to eq('#<PG::Tuple column1: "2", column2: "b">')
 		expect( tuple2.inspect ).to eq('#<PG::Tuple a: 1, b: true, b: "3">')
+		expect( tuple2sym.inspect ).to eq('#<PG::Tuple a: 1, b: true, b: "3">')
 		expect{ tuple_empty.inspect }.to raise_error(TypeError)
 	end
 

data/spec/pg/type_map_by_class_spec.rb

@@ -132,7 +132,7 @@ describe PG::TypeMapByClass do
 	it "should raise error on invalid coder object" do
 		tm[TrueClass] = "dummy"
 		expect{
-			res = @conn.exec_params( "SELECT $1", [true], 0, tm )
+			@conn.exec_params( "SELECT $1", [true], 0, tm )
 		}.to raise_error(NoMethodError, /undefined method.*call/)
 	end
 end

data/spec/pg/type_map_by_column_spec.rb

@@ -38,7 +38,11 @@ describe PG::TypeMapByColumn do
 			pass_through_type,
 			nil
 		] )
-		expect( cm.inspect ).to eq( "#<PG::TypeMapByColumn INT4:0 TEXT:0 FLOAT4:0 pass_through:1 nil>" )
+	end
+
+	it "should respond to inspect" do
+		cm = PG::TypeMapByColumn.new( [textdec_int, textenc_string, textdec_float, pass_through_type, PG::TextEncoder::Float.new, nil] )
+		expect( cm.inspect ).to eq( "#<PG::TypeMapByColumn INT4:TD TEXT:TE FLOAT4:TD pass_through:BD PG::TextEncoder::Float:TE nil>" )
 	end
 
 	it "should retrieve it's oids" do

data/spec/pg/type_map_by_oid_spec.rb

@@ -54,8 +54,8 @@ describe PG::TypeMapByOid do
 	end
 
 	it "should check format when deleting coders" do
-		expect{ tm.rm_coder 2, 123 }.to raise_error(ArgumentError)
-		expect{ tm.rm_coder -1, 123 }.to raise_error(ArgumentError)
+		expect{ tm.rm_coder(2, 123) }.to raise_error(ArgumentError)
+		expect{ tm.rm_coder(-1, 123) }.to raise_error(ArgumentError)
 	end
 
 	it "should check format when adding coders" do