activerecord-native_db_types_override 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09286096663b0d7e97e7bb99b064d0772db91534
+  data.tar.gz: 1f208e3fd9b7f020f3105e1d60525fb53cd4c1f4
+SHA512:
+  metadata.gz: 1d7dc24d2ff96d672f561150a8523dd43dab3c4abd6d7317e513f846bf1fae2e385a4248a65c34d9e68c89c7b03a9411f7149a9d49081e2a35c5449e510d49f6
+  data.tar.gz: 93e37eadb0e9ff0529767afa9e57162bf4bc90998b3f9a5ac9522bfca813a824f6bd97c0a95923368fa38af5d22980f4d98675bc7dadfc41525842a5ec435cad

data/README.md

@@ -1,17 +1,10 @@
-ActiveRecord 3.1+/4.0 Native Database Types Override
-=====
+## ActiveRecord 4.x Native Database Types Override
 
-Define native database types that Rails migrations and ActiveRecord should use. Theoretically this should work for any ActiveRecord adapter written to support the access defined in the "How it works" section.
-
-Does not work in Rails/ActiveRecord 3.0 or earlier versions, and even though it should work in Rails/ActiveRecord 3.1+/4.0.
-
-### How it works
-
-All adapter classes in Rails 3.1-4.0 should have a NATIVE_DATABASE_TYPES constant and a native_database_types method that can be redefined, so we get the NATIVE_DATABASE_TYPES if it exists, if not we start with an empty hash. Then we merge in your settings, and redefine the native_database_types instance method (defined at class level so using class_eval) to return the value of inspect from the merged hash.
+Define native database types and change default migration behavior in ActiveRecord/Rails.
 
 ### Setup
 
-In your ActiveRecord/Rails 3.1+ project, add this to your Gemfile:
+In your ActiveRecord/Rails 4.x project, add this to your Gemfile:
 
     gem 'activerecord-native_db_types_override'
 
@@ -21,46 +14,85 @@ Then run:
 
 ### Usage
 
-In your config/environment.rb or an environment specific configuration, you may specify one or more options in the config hash that will be merged into the default types. The act of configuring does the hash merge/activation of changes.
+Define configuration to be run prior to migration execution, such as in a Rails initializer or environment file.
+
+#### Configure Adapters
+
+The following symbols can be used can be used with the NativeDbTypesOverride.configure_adapters method to automatically require and load the right adapter class prior to configuring it:
+
+Adapters included in ActiveRecord:
+* [:postgres](https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb)
+* [:mysql](https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb)
+* [:sqlite](https://github.com/rails/rails/blob/4-2-stable/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb)
 
-If using Ruby 1.8.x, use hashrocket notation instead for the following examples.
+Adapters that require other gems:
+* [:oracle_enhanced](https://github.com/rsim/oracle-enhanced/blob/release16/lib/active_record/connection_adapters/oracle_enhanced_adapter.rb)
+* [:sqlserver](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/4-2-stable/lib/active_record/connection_adapters/sqlserver_adapter.rb)
+
+You can also specify a custom adapter class that uses a native_database_types method to map types. See 'Other Adapters' for more information.
 
 #### PostgreSQL
 
-For example, if you want Rails to use the timestamptz type for all datetimes and timestamps created by migrations, you could use:
+The following would:
+* use primary key type 'bigserial primary key' for in migrations
+* change add_reference behavior in migrations to use bigint type by default
+* use timestamptz for all datetimes and timestamps created by migrations* 
 
-    NativeDbTypesOverride.configure({
+    NativeDbTypesOverride.configure_adapters({
       postgres: {
         datetime: { name: "timestamptz" },
-        timestamp: { name: "timestamptz" }
+        timestamp: { name: "timestamptz" },
+        primary_key: { name: "bigserial primary key"}
       }
     })
 
-See [PostgreSQLAdapter][postgres_adapter] for the default types.
+    NativeDbTypesOverride.configure_migrations({
+      add_reference: {type: :bigint}
+    })
+
+See PostgreSQLAdapter source for the default types.
 
 #### MySQL
 
 For the MySQL/MySQL2 adapters, maybe you could change boolean to a string type:
 
-    NativeDbTypesOverride.configure({
+    NativeDbTypesOverride.configure_adapters({
       mysql: {
         boolean: { name: "varchar", limit: 1 }
       }
     })
 
-See [AbstractMysqlAdapter][mysql_adapter] for the default types.
+Alternatively, you could use the this Gem to override [primary_key](https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb#L43)  to overcome errors that occur when trying to run `rake db:migrate` that are caused by MySQL updates (i.e. MySQL 5.7) that no longer support DEFAULT NULL values for PRIMARY KEY. Simply create the following:
+
+*config/initializers/abstract_mysql2_adapter.rb*
+
+	require 'active_record/connection_adapters/mysql2_adapter'
+	NativeDbTypesOverride.configure_adapters({
+	  ActiveRecord::ConnectionAdapters::Mysql2Adapter => {
+	    primary_key: "int(11) auto_increment PRIMARY KEY"
+	  }
+	})
+
+*config/environment.rb*
+
+	# Load monkey patches to prevent migration errors after importing legacy sql dumpfile
+	require File.expand_path('../initializers/abstract_mysql2_adapter.rb', __FILE__)
+
+*config/database.yml* check contains 'adapter: mysql2' for db connection to be used
+
+See [AbstractMysqlAdapter][mysql_adapter] for the default types. (Change code branch as needed.)
 
 #### SQLite3
 
 Maybe you need to extend the default string limit from 255 to 4096:
 
-    NativeDbTypesOverride.configure({
+    NativeDbTypesOverride.configure_adapters({
       sqlite: {
         string: { :name: "varchar", limit: 4096 }
       }
     })
 
-See [SQLite3Adapter][sqlite_adapter] for the default types.
+See [SQLite3Adapter][sqlite_adapter] for the default types. (Change code branch as needed.)
 
 #### Oracle
 
@@ -72,7 +104,7 @@ 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:
 
-    NativeDbTypesOverride.configure({
+    NativeDbTypesOverride.configure_adapters({
       oracle: {
         datetime: { name: "TIMESTAMP WITH TIMEZONE" },
         timestamp: { name: "TIMESTAMP WITH TIMEZONE" },
@@ -82,33 +114,40 @@ However, if you need to make another change like making datetime and timestamp s
 
 The reason for this is that Native Database Types Override gem tries to use the constant NATIVE_DATABASE_TYPES available on most adapters to get the existing hash before doing the overrides, but OracleEnhancedAdapter's emulate_booleans_from_strings option changes what is returned by the native_database_types method to NATIVE_DATABASE_TYPES but with :boolean changed to the value {:name => "VARCHAR2", :limit => 1}.
 
-See [OracleEnhancedAdapter][oracle_adapter] for the default types.
+See oracle_enhanced_adapter link below for the default types.
 
-#### Others
+#### Other Adapters
 
-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.
+ActiveRecord adapter class that uses a `native_database_types` method to define the type mappings (as most do) should work. Just 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, e.g.:
 
     require 'active_record/connection_adapters/postgresql_adapter'
-    NativeDbTypesOverride.configure({
+    NativeDbTypesOverride.configure_adapters({
       ActiveRecord::ConnectionAdapters::PostgreSQLAdapter => {
         datetime: { name: "timestamptz" },
         timestamp: { name: "timestamptz" }
       }
     })
 
-Let us know if we can add support for an adapter, so it can be referenced by a symbol instead. Pull requests welcome!
 
 ### Troubleshooting
 
+Turn on debug output:
+
+    NativeDbTypesOverride.debug = true
+
 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:
+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.:
 
     rails g model MyModel a_string:string a_text:text an_integer:integer a_float:float a_decimal:decimal a_datetime:datetime a_timestamp:timestamp a_time:time a_date:date a_binary:binary a_boolean:boolean a_xml:xml a_tsvector:tsvector
     rake db:migrate
 
+With Rails you can output the schema to see if the types were set correctly:
+
+    rake db:structure:dump
+
 Then just to ensure it really is working, go into rails console:
 
     rails c
@@ -131,16 +170,12 @@ And try to play with data (this is postgres-specific):
     m.a_tsvector = nil
     m.save!
 
-Turn on debug output by adding this prior to NativeDbTypesOverride.configure:
+### Contributors
 
-    NativeDbTypesOverride.debug = true
+* Gary Weaver (https://github.com/garysweaver)
 
 ### License
 
-Copyright (c) 2012 Gary S. Weaver, released under the [MIT license][lic].
+(c) 2012-2014 FineLine Prototyping, Inc., (c) 2016-2017 Proto Labs, Inc., released under the [MIT license][lic].
 
-[postgres_adapter]: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_adapters/postgresql_adapter.rb
-[mysql_adapter]: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_adapters/abstract_mysql_adapter.rb
-[sqlite_adapter]: https://github.com/rails/rails/blob/master/activerecord/lib/active_record/connection_adapters/sqlite3_adapter.rb
-[oracle_adapter]: https://github.com/rsim/oracle-enhanced/blob/master/lib/active_record/connection_adapters/oracle_enhanced_adapter.rb
-[lic]: http://github.com/garysweaver/activerecord-native_db_types_override/blob/master/LICENSE
+[lic]: LICENSE

data/lib/activerecord-native_db_types_override.rb

@@ -1,2 +1,5 @@
 require 'activerecord-native_db_types_override/version'
+require 'activerecord-native_db_types_override/configuration_error'
+require 'activerecord-native_db_types_override/adapter_overrider'
+require 'activerecord-native_db_types_override/patches'
 require 'activerecord-native_db_types_override/options'

data/lib/activerecord-native_db_types_override/adapter_overrider.rb

@@ -0,0 +1,40 @@
+module NativeDbTypesOverride
+  class AdapterOverrider
+
+    def self.override_native_database_types(adapter_class, hash)
+      puts "ActiveRecord - Native Database Types Override #{NativeDbTypesOverride::VERSION}" if NativeDbTypesOverride.debug?
+      new_types = {}
+      begin
+        new_types = adapter_class.const_get('NATIVE_DATABASE_TYPES')
+      rescue
+        puts "No NATIVE_DATABASE_TYPES constant on #{adapter_class} so expecting the whole types hash to be specified via NativeDbTypesOverride.configure()" if NativeDbTypesOverride.debug?
+      end
+      new_types = new_types.merge(hash)
+      puts "Defining #{adapter_class}.native_database_types as #{new_types.inspect}" if NativeDbTypesOverride.debug?
+
+      adapter_class.class_eval "def native_database_types; #{new_types.inspect}; end"
+    end
+
+    def self.convert_symbol_to_class(adapter_class_or_sym)
+      case adapter_class_or_sym
+      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
+      when :sqlserver
+        require 'active_record/connection_adapters/sqlserver_adapter'
+        '::ActiveRecord::ConnectionAdapters::SQLServer'.constantize
+      else
+        adapter_class_or_sym
+      end
+    end
+  end
+end

data/lib/activerecord-native_db_types_override/configuration_error.rb

@@ -0,0 +1,4 @@
+module NativeDbTypesOverride
+  class ConfigurationError < ::StandardError
+  end
+end

data/lib/activerecord-native_db_types_override/options.rb

@@ -1,50 +1,32 @@
 module NativeDbTypesOverride
   class << self
-    attr_accessor :debug
+    attr_accessor :debug, :adapters_options, :migrations_options
 
     def debug?
       !!send(:debug)
     end
-    
+
     def configure(hash)
-      puts "ActiveRecord - Native Database Types Override #{NativeDbTypesOverride::VERSION}" if NativeDbTypesOverride.debug?
+      warn 'NativeDbTypesOverride.configure is deprecated! Call NativeDbTypesOverride.adapters instead of NativeDbTypesOverride.configure.'
+      configure_adapters(hash)
+    end
+
+    def configure_adapters(hash)
+      puts "ActiveRecord - Native Database Types Override #{NativeDbTypesOverride::VERSION} - configure_adapters called" if NativeDbTypesOverride.debug?
       hash.keys.each do |key|
         begin
-          clazz = convert_symbol_to_class(key)
+          clazz = ::NativeDbTypesOverride::AdapterOverrider.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 via NativeDbTypesOverride.configure()" if NativeDbTypesOverride.debug?
+          raise ::NativeDbTypesOverride::ConfigurationError.new "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 = 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"
+
+        ::NativeDbTypesOverride::AdapterOverrider.override_native_database_types(clazz, hash[key])
       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
+    def configure_migrations(hash)
+      puts "ActiveRecord - Native Database Types Override #{NativeDbTypesOverride::VERSION} - configure_adapters called" if NativeDbTypesOverride.debug?
+      self.migrations_options = hash
     end
   end
 end

data/lib/activerecord-native_db_types_override/patches.rb

@@ -0,0 +1,16 @@
+module ActiveRecord
+  module ConnectionAdapters
+    module SchemaStatements
+      alias_method :add_reference_without_native_db_types_override, :add_reference
+
+      def add_reference(table_name, ref_name, options = {})
+        if ::NativeDbTypesOverride.migrations_options
+          add_ref_opts = ::NativeDbTypesOverride.migrations_options[:add_reference]
+          options = Marshal.load(Marshal.dump(add_ref_opts)).merge(options) if add_ref_opts
+        end
+
+        add_reference_without_native_db_types_override(table_name, ref_name, options)
+      end
+    end
+  end
+end

data/lib/activerecord-native_db_types_override/version.rb

@@ -1,3 +1,3 @@
 module NativeDbTypesOverride
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,52 +1,53 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-native_db_types_override
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Gary S. Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2017-10-11 00:00:00.000000000 Z
 dependencies: []
-description: Overrides native database types for any database adapter with a native_database_types
-  method. Compatible with ActiveRecord 3.1+/4.0.
+description: Define native database types and change default migration behavior in
+  ActiveRecord/Rails.
 email:
 - garysweaver@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
+- Rakefile
+- lib/activerecord-native_db_types_override.rb
+- lib/activerecord-native_db_types_override/adapter_overrider.rb
+- lib/activerecord-native_db_types_override/configuration_error.rb
 - lib/activerecord-native_db_types_override/options.rb
+- lib/activerecord-native_db_types_override/patches.rb
 - lib/activerecord-native_db_types_override/version.rb
-- lib/activerecord-native_db_types_override.rb
-- Rakefile
-- README.md
 homepage: https://github.com/garysweaver/activerecord-native_db_types_override
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.6.8
 signing_key: 
-specification_version: 3
-summary: Overrides native database types in ActiveRecord DB adapters.
+specification_version: 4
+summary: Define native database types and change default migration behavior.
 test_files: []