[postgres] hstore values should be returned as Hash instances (fixes #454)

Author: kares

src/java/arjdbc/postgresql/PostgreSQLRubyJdbcConnection.java

@@ -36,13 +36,15 @@
 import java.sql.Timestamp;
 import java.sql.Types;
 import java.util.List;
+import java.util.Map;
 import java.util.UUID;
 
 import org.jruby.Ruby;
 import org.jruby.RubyArray;
 import org.jruby.RubyBoolean;
 import org.jruby.RubyClass;
 import org.jruby.RubyFloat;
+import org.jruby.RubyHash;
 import org.jruby.RubyIO;
 import org.jruby.RubyString;
 import org.jruby.anno.JRubyMethod;
@@ -388,13 +390,23 @@ protected String resolveArrayBaseTypeName(final ThreadContext context,
         return sqlType;
     }
 
+    private static final int HSTORE_TYPE = 100000 + 1111;
+
     @Override
     protected int jdbcTypeFor(final ThreadContext context, final Ruby runtime,
         final IRubyObject column, final Object value) throws SQLException {
         // NOTE: likely wrong but native adapters handles this thus we should
         // too - used from #table_exists? `binds << [ nil, schema ] if schema`
         if ( column == null || column.isNil() ) return Types.VARCHAR; // assume type == :string
-        return super.jdbcTypeFor(context, runtime, column, value);
+        final int type = super.jdbcTypeFor(context, runtime, column, value);
+        /*
+        if ( type == Types.OTHER ) {
+            final IRubyObject columnType = column.callMethod(context, "type");
+            if ( "hstore" == (Object) columnType.asJavaString() ) {
+                return HSTORE_TYPE;
+            }
+        } */
+        return type;
     }
 
     /**
@@ -467,6 +479,7 @@ protected IRubyObject arrayToRuby(final ThreadContext context,
     protected IRubyObject objectToRuby(final ThreadContext context,
         final Ruby runtime, final ResultSet resultSet, final int column)
         throws SQLException {
+
         final Object object = resultSet.getObject(column);
 
         if ( object == null && resultSet.wasNull() ) return runtime.getNil();
@@ -485,6 +498,16 @@ protected IRubyObject objectToRuby(final ThreadContext context,
             return runtime.newString( object.toString() );
         }
 
+        if ( object instanceof Map ) { // hstore
+            if ( rawHstoreType ) {
+                return runtime.newString( resultSet.getString(column) );
+            }
+            // by default we avoid double parsing by driver and than column :
+            final RubyHash rubyObject = RubyHash.newHash(runtime);
+            rubyObject.putAll((Map) object); // converts keys/values to ruby
+            return rubyObject;
+        }
+
         return JavaUtil.convertJavaToRuby(runtime, object);
     }
 
@@ -529,6 +552,24 @@ private String formatInterval(final Object object) {
         return str.toString();
     }
 
+    protected static boolean rawHstoreType = Boolean.getBoolean("arjdbc.postgresql.hstore.raw");
+
+    @JRubyMethod(name = "raw_hstore_type?")
+    public static IRubyObject useRawHstoreType(final ThreadContext context, final IRubyObject self) {
+        return context.getRuntime().newBoolean(rawHstoreType);
+    }
+
+    @JRubyMethod(name = "raw_hstore_type=")
+    public static IRubyObject setRawHstoreType(final IRubyObject self, final IRubyObject value) {
+        if ( value instanceof RubyBoolean ) {
+            rawHstoreType = ((RubyBoolean) value).isTrue();
+        }
+        else {
+            rawHstoreType = ! value.isNil();
+        }
+        return value;
+    }
+
     // whether to use "raw" interval values off by default - due native adapter compatibilty :
     // RAW values :
     // - 2 years 0 mons 0 days 0 hours 3 mins 0.00 secs
@@ -549,7 +590,7 @@ public static IRubyObject setRawIntervalType(final IRubyObject self, final IRuby
             rawIntervalType = ((RubyBoolean) value).isTrue();
         }
         else {
-            rawIntervalType = value.isNil();
+            rawIntervalType = ! value.isNil();
         }
         return value;
     }

test/db/postgresql/hstore_test.rb

@@ -3,7 +3,7 @@
 require 'db/postgres'
 
 class PostgresqlHstoreTest < Test::Unit::TestCase
-  
+
   class Hstore < ActiveRecord::Base
     self.table_name = 'hstores'
   end
@@ -133,17 +133,31 @@ def test_rewrite
     assert x.save!
   end
 
-
   def test_select
     @connection.execute "insert into hstores (tags) VALUES ('1=>2')"
     x = Hstore.first
     assert_equal({'1' => '2'}, x.tags)
+    assert_instance_of Hash, x.tags
   end
 
   def test_select_multikey
     @connection.execute "insert into hstores (tags) VALUES ('1=>2,2=>3')"
     x = Hstore.first
     assert_equal({'1' => '2', '2' => '3'}, x.tags)
+    assert_instance_of Hash, x.tags
+  end
+
+  class Hstore2 < ActiveRecord::Base
+    self.table_name = 'hstores'
+    store :tags, :accessors => [ :name ]
+  end
+
+  def test_store_select
+    @connection.execute "insert into hstores (tags) VALUES ('name=>ferko,type=>suska')"
+    x = Hstore2.first
+    assert_equal 'ferko', x.name
+    assert_equal 'suska', x.tags[:type]
+    assert_instance_of ActiveSupport::HashWithIndifferentAccess, x.tags
   end
 
   def test_create
@@ -196,5 +210,5 @@ def assert_cycle hash
     x.reload
     assert_equal(hash, x.tags)
   end
-  
+
 end if Test::Unit::TestCase.ar_version('4.0')