activerecord-native_db_types_override 0.1.2 → 0.2.0

data/README.md

@@ -25,13 +25,15 @@ In your config/environment.rb or an environment specific configuration, you may
 
 Some gems may require the adapter prior to this point, so it may not need to be required, but we do not load the Rails adapters in the NativeDbTypesOverride gem because all are most likely not needed.
 
+Note: I left the Ruby 1.8 hashrocket notation to show it shouldn't matter. Feel free to use 1.9+ hash syntax.
+
 #### PostgreSQL
 
 For example, if you want Rails to use the timestamptz type for all datetimes and timestamps created by migrations, you could use:
 
     require 'active_record/connection_adapters/postgresql_adapter'
     NativeDbTypesOverride.configure({
-      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter => {
+      :postgres => {
         :datetime => { :name => "timestamptz" },
         :timestamp => { :name => "timestamptz" }
       }
@@ -43,9 +45,8 @@ See [PostgreSQLAdapter][postgres_adapter] for the default types.
 
 For the MySQL/MySQL2 adapters, maybe you could change boolean to a string type:
 
-    require 'active_record/connection_adapters/abstract_mysql_adapter'
     NativeDbTypesOverride.configure({
-      ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter => {
+      :mysql => {
         :boolean => { :name => "varchar", :limit => 1 }
       }
     })
@@ -56,9 +57,8 @@ See [AbstractMysqlAdapter][mysql_adapter] for the default types.
 
 Maybe you need to extend the default string limit from 255 to 4096:
 
-    require 'active_record/connection_adapters/sqlite3_adapter'
     NativeDbTypesOverride.configure({
-      ActiveRecord::ConnectionAdapters::SQLite3Adapter => {
+      :sqlite => {
         :string => { :name => "varchar", :limit => 4096 }
       }
     })
@@ -75,9 +75,8 @@ In addition, it's native_database_types method can define boolean as VARCHAR2 (1
 
 However, if you need to make another change like making datetime and timestamp store timezones *and* you want to emulate_booleans_from_strings, just ensure that you define the boolean shown in the following example rather than using OracleEnhancedAdapter's emulate_booleans_from_strings option:
 
-    require 'active_record/connection_adapters/oracle_enhanced_adapter'
     NativeDbTypesOverride.configure({
-      ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter => {
+      :oracle => {
         :datetime => { :name => "TIMESTAMP WITH TIMEZONE" },
         :timestamp => { :name => "TIMESTAMP WITH TIMEZONE" },
         :boolean => { :name => "VARCHAR2", :limit => 1 }
@@ -92,13 +91,21 @@ See [OracleEnhancedAdapter][oracle_adapter] for the default types.
 
 Look for the adapter class that contains the `native_database_types` method and specify the fully-qualified name (e.g. ActiveRecord::ConnectionAdapters::MyDbAdapter) as the key in the options hash.
 
-Be sure to add a require for the adapter, if it has not been loaded already prior to configuration.
+Be sure to add a require for the adapter, if it has not been loaded already prior to configuration, e.g.:
+
+    require 'active_record/connection_adapters/postgresql_adapter'
+    NativeDbTypesOverride.configure({
+      ActiveRecord::ConnectionAdapters::PostgreSQLAdapter => {
+        :datetime => { :name => "timestamptz" },
+        :timestamp => { :name => "timestamptz" }
+      }
+    })
 
-Let us know if we can list a new or revised adapter here. Pull requests are welcome!
+Let us know if we can add support for an adapter, so it can be referenced by a symbol instead. Pull requests welcome!
 
 ### Troubleshooting
 
-Make sure that you either add a require for the adapter before the configuration or you may get an `uninitialized constant (adapter class)` error, depending on whether something else loaded the adapter prior to configuration.
+If not using one of the supported symbols you may need to add a require for the adapter before the configuration or you may get an `uninitialized constant (adapter class)` error, depending on whether something else loaded the adapter prior.
 
 Test out a migration and include all the types defined in your adapter's NATIVE_DATABASE_TYPES if you're unsure whether it is defining things correctly, e.g. in a test project for PostgreSQL in Rails 3.1/3.2 you could do this and then look at the my_models table in your database:
 

data/lib/activerecord-native_db_types_override/options.rb

@@ -8,17 +8,43 @@ module NativeDbTypesOverride
     
     def configure(hash)
       puts "ActiveRecord - Native Database Types Override #{NativeDbTypesOverride::VERSION}" if NativeDbTypesOverride.debug?
-      hash.keys.each do |clazz|
+      hash.keys.each do |key|
+        begin
+          clazz = convert_symbol_to_class(key)
+        rescue => e
+          puts "Unable to get adapter class for #{key.inspect}. Try specifying the adapter class itself as the key in the hash in NativeDbTypesOverride.configure(). Error: #{e.message}\n#{e.backtrace.join("\n")}"
+        end
         new_types = {}
         begin
           new_types = clazz.const_get('NATIVE_DATABASE_TYPES')
         rescue
-          puts "No NATIVE_DATABASE_TYPES constant on #{clazz} so expecting the whole types hash to be specified in the NativeDbTypesOverride::Options.configure" if NativeDbTypesOverride.debug?
+          puts "No NATIVE_DATABASE_TYPES constant on #{clazz} so expecting the whole types hash to be specified via NativeDbTypesOverride.configure()" if NativeDbTypesOverride.debug?
         end
-        new_types = new_types.merge(hash[clazz])
+        new_types = new_types.merge(hash[key])
         puts "Defining #{clazz}.native_database_types as #{new_types.inspect}" if NativeDbTypesOverride.debug?
         clazz.class_eval "def native_database_types; #{new_types.inspect}; end"
       end
     end
+
+    private
+
+    def convert_symbol_to_class(clazz)
+      case clazz
+      when :postgres
+        require 'active_record/connection_adapters/postgresql_adapter'
+        'ActiveRecord::ConnectionAdapters::PostgreSQLAdapter'.constantize
+      when :mysql
+        require 'active_record/connection_adapters/abstract_mysql_adapter'
+        'ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter'.constantize
+      when :sqlite
+        require 'active_record/connection_adapters/sqlite3_adapter'
+        'ActiveRecord::ConnectionAdapters::SQLite3Adapter'.constantize
+      when :oracle
+        require 'active_record/connection_adapters/oracle_enhanced_adapter'
+        'ActiveRecord::ConnectionAdapters::OracleEnhancedAdapter'.constantize
+      else
+        clazz
+      end
+    end
   end
 end

data/lib/activerecord-native_db_types_override/version.rb

@@ -1,3 +1,3 @@
 module NativeDbTypesOverride
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-native_db_types_override
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors: