[Rails 7] Define adapter type maps statically (#968)

Author: mgrunberg

CHANGELOG.md

@@ -6,6 +6,7 @@
 
 #### Changed
 
+- [#968](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/968) Define adapter type maps statically
 - [#983](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/983) Optimize remove_columns to use a single SQL statement
 - [#984](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/984) Better handle SQL queries with invalid encoding
 - [#988](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/988) Raise `ActiveRecord::StatementInvalid` when `columns` is called with a non-existing table (***breaking change***)

lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -377,83 +377,93 @@ def get_database_version # :nodoc:
         version_year
       end
 
-      protected
-
-      # === Abstract Adapter (Misc Support) =========================== #
-
-      def initialize_type_map(m = type_map)
-        m.register_type              %r{.*}, SQLServer::Type::UnicodeString.new
-
-        # Exact Numerics
-        register_class_with_limit m, "bigint(8)",         SQLServer::Type::BigInteger
-        m.alias_type                 "bigint",            "bigint(8)"
-        register_class_with_limit m, "int(4)",            SQLServer::Type::Integer
-        m.alias_type                 "integer",           "int(4)"
-        m.alias_type                 "int",               "int(4)"
-        register_class_with_limit m, "smallint(2)",       SQLServer::Type::SmallInteger
-        m.alias_type                 "smallint",          "smallint(2)"
-        register_class_with_limit m, "tinyint(1)",        SQLServer::Type::TinyInteger
-        m.alias_type                 "tinyint",           "tinyint(1)"
-        m.register_type              "bit",               SQLServer::Type::Boolean.new
-        m.register_type              %r{\Adecimal}i do |sql_type|
-          scale     = extract_scale(sql_type)
-          precision = extract_precision(sql_type)
-          if scale == 0
-            SQLServer::Type::DecimalWithoutScale.new(precision: precision)
-          else
-            SQLServer::Type::Decimal.new(precision: precision, scale: scale)
+      class << self
+        protected
+
+        def initialize_type_map(m)
+          m.register_type              %r{.*}, SQLServer::Type::UnicodeString.new
+
+          # Exact Numerics
+          register_class_with_limit m, "bigint(8)",         SQLServer::Type::BigInteger
+          m.alias_type                 "bigint",            "bigint(8)"
+          register_class_with_limit m, "int(4)",            SQLServer::Type::Integer
+          m.alias_type                 "integer",           "int(4)"
+          m.alias_type                 "int",               "int(4)"
+          register_class_with_limit m, "smallint(2)",       SQLServer::Type::SmallInteger
+          m.alias_type                 "smallint",          "smallint(2)"
+          register_class_with_limit m, "tinyint(1)",        SQLServer::Type::TinyInteger
+          m.alias_type                 "tinyint",           "tinyint(1)"
+          m.register_type              "bit",               SQLServer::Type::Boolean.new
+          m.register_type              %r{\Adecimal}i do |sql_type|
+            scale     = extract_scale(sql_type)
+            precision = extract_precision(sql_type)
+            if scale == 0
+              SQLServer::Type::DecimalWithoutScale.new(precision: precision)
+            else
+              SQLServer::Type::Decimal.new(precision: precision, scale: scale)
+            end
           end
-        end
-        m.alias_type                 %r{\Anumeric}i,      "decimal"
-        m.register_type              "money",             SQLServer::Type::Money.new
-        m.register_type              "smallmoney",        SQLServer::Type::SmallMoney.new
-
-        # Approximate Numerics
-        m.register_type              "float",             SQLServer::Type::Float.new
-        m.register_type              "real",              SQLServer::Type::Real.new
-
-        # Date and Time
-        m.register_type              "date",              SQLServer::Type::Date.new
-        m.register_type              %r{\Adatetime} do |sql_type|
-          precision = extract_precision(sql_type)
-          if precision
-            SQLServer::Type::DateTime2.new precision: precision
-          else
-            SQLServer::Type::DateTime.new
+          m.alias_type                 %r{\Anumeric}i,      "decimal"
+          m.register_type              "money",             SQLServer::Type::Money.new
+          m.register_type              "smallmoney",        SQLServer::Type::SmallMoney.new
+
+          # Approximate Numerics
+          m.register_type              "float",             SQLServer::Type::Float.new
+          m.register_type              "real",              SQLServer::Type::Real.new
+
+          # Date and Time
+          m.register_type              "date",              SQLServer::Type::Date.new
+          m.register_type              %r{\Adatetime} do |sql_type|
+            precision = extract_precision(sql_type)
+            if precision
+              SQLServer::Type::DateTime2.new precision: precision
+            else
+              SQLServer::Type::DateTime.new
+            end
           end
+          m.register_type %r{\Adatetimeoffset}i do |sql_type|
+            precision = extract_precision(sql_type)
+            SQLServer::Type::DateTimeOffset.new precision: precision
+          end
+          m.register_type              "smalldatetime", SQLServer::Type::SmallDateTime.new
+          m.register_type              %r{\Atime}i do |sql_type|
+            precision = extract_precision(sql_type) || DEFAULT_TIME_PRECISION
+            SQLServer::Type::Time.new precision: precision
+          end
+
+          # Character Strings
+          register_class_with_limit m, %r{\Achar}i,         SQLServer::Type::Char
+          register_class_with_limit m, %r{\Avarchar}i,      SQLServer::Type::Varchar
+          m.register_type              "varchar(max)",      SQLServer::Type::VarcharMax.new
+          m.register_type              "text",              SQLServer::Type::Text.new
+
+          # Unicode Character Strings
+          register_class_with_limit m, %r{\Anchar}i,        SQLServer::Type::UnicodeChar
+          register_class_with_limit m, %r{\Anvarchar}i,     SQLServer::Type::UnicodeVarchar
+          m.alias_type                 "string",            "nvarchar(4000)"
+          m.register_type              "nvarchar(max)",     SQLServer::Type::UnicodeVarcharMax.new
+          m.register_type              "nvarchar(max)",     SQLServer::Type::UnicodeVarcharMax.new
+          m.register_type              "ntext",             SQLServer::Type::UnicodeText.new
+
+          # Binary Strings
+          register_class_with_limit m, %r{\Abinary}i,       SQLServer::Type::Binary
+          register_class_with_limit m, %r{\Avarbinary}i,    SQLServer::Type::Varbinary
+          m.register_type              "varbinary(max)",    SQLServer::Type::VarbinaryMax.new
+
+          # Other Data Types
+          m.register_type              "uniqueidentifier",  SQLServer::Type::Uuid.new
+          m.register_type              "timestamp",         SQLServer::Type::Timestamp.new
         end
-        m.register_type %r{\Adatetimeoffset}i do |sql_type|
-          precision = extract_precision(sql_type)
-          SQLServer::Type::DateTimeOffset.new precision: precision
-        end
-        m.register_type              "smalldatetime", SQLServer::Type::SmallDateTime.new
-        m.register_type              %r{\Atime}i do |sql_type|
-          precision = extract_precision(sql_type) || DEFAULT_TIME_PRECISION
-          SQLServer::Type::Time.new precision: precision
-        end
+      end
+
+      TYPE_MAP = Type::TypeMap.new.tap { |m| initialize_type_map(m) }
+
+      protected
+
+      # === Abstract Adapter (Misc Support) =========================== #
 
-        # Character Strings
-        register_class_with_limit m, %r{\Achar}i,         SQLServer::Type::Char
-        register_class_with_limit m, %r{\Avarchar}i,      SQLServer::Type::Varchar
-        m.register_type              "varchar(max)",      SQLServer::Type::VarcharMax.new
-        m.register_type              "text",              SQLServer::Type::Text.new
-
-        # Unicode Character Strings
-        register_class_with_limit m, %r{\Anchar}i,        SQLServer::Type::UnicodeChar
-        register_class_with_limit m, %r{\Anvarchar}i,     SQLServer::Type::UnicodeVarchar
-        m.alias_type                 "string",            "nvarchar(4000)"
-        m.register_type              "nvarchar(max)",     SQLServer::Type::UnicodeVarcharMax.new
-        m.register_type              "nvarchar(max)",     SQLServer::Type::UnicodeVarcharMax.new
-        m.register_type              "ntext",             SQLServer::Type::UnicodeText.new
-
-        # Binary Strings
-        register_class_with_limit m, %r{\Abinary}i,       SQLServer::Type::Binary
-        register_class_with_limit m, %r{\Avarbinary}i,    SQLServer::Type::Varbinary
-        m.register_type              "varbinary(max)",    SQLServer::Type::VarbinaryMax.new
-
-        # Other Data Types
-        m.register_type              "uniqueidentifier",  SQLServer::Type::Uuid.new
-        m.register_type              "timestamp",         SQLServer::Type::Timestamp.new
+      def type_map
+        TYPE_MAP
       end
 
       def translate_exception(e, message:, sql:, binds:)

test/cases/coerced_tests.rb

@@ -1161,7 +1161,8 @@ def test_cache_does_not_wrap_results_in_arrays_coerced
     end
   end
 
-  # Same as original test except that we expect one query to be performed to retrieve the table's primary key.
+  # Same as original test except that we expect one query to be performed to retrieve the table's primary key
+  # and we don't call `reload_type_map` because SQL Server adapter doesn't support it.
   # When we generate the SQL for the `find` it includes ordering on the primary key. If we reset the column
   # information then the primary key needs to be retrieved from the database again to generate the SQL causing the
   # original test's `assert_no_queries` assertion to fail. Assert that the query was to get the primary key.
@@ -1171,9 +1172,6 @@ def test_query_cached_even_when_types_are_reset_coerced
       # Warm the cache
       Task.find(1)
 
-      # Preload the type cache again (so we don't have those queries issued during our assertions)
-      Task.connection.send(:reload_type_map)
-
       # Clear places where type information is cached
       Task.reset_column_information
       Task.initialize_find_by_cache