activerecord-sqlserver-adapter 6.1.3.0 → 7.0.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 746931d24bb3806cafe400f5e4fed544e36dc7b06c6635a2ed4da4aacbf28590
-  data.tar.gz: dc87a51ccca60af1256b55f511f919c0ce6e5e9c7bb85a1a6865c52ed1e272f4
+  metadata.gz: 9983757834cfcc185a0a292ec422cc8e090a5cdff995be814738bb82b0620373
+  data.tar.gz: 527f419f372081cd743fcd0898c16183136ac36eaf36dd14a521bb455a5147cc
 SHA512:
-  metadata.gz: c33ad8a4f68a70fb8b15ae9b010d47043c412a17494a1248197651cdfebe3e8960fec51648c81bef28ccc9d4fae6dff08b9732a1f7dec9fe9f5cfcb66b8ccbbf
-  data.tar.gz: 3f40b13dd7c1d69af465467b5f00a60514c02d4d7f2051c6a78c365374a0ae42d475233b9b08646bb94d8ce4899b8627b836098217efee44fc785814b1cd8bf1
+  metadata.gz: 4e64604834556a9bf9bd9be39e3aff2cc267729c6d32f28c697d293a6b9be5f5a44c924bbe6fae48f528b88a6c24c2c2d6337a5658aa295284764cb9a66a46c4
+  data.tar.gz: c09d354e4af8a5dbb9eb4ef4ab3fdf3b3a527f3ed779895995aac6d60c6335e0698d57cae2509b43e5e3e2825a724bcc41ed2424822b6f067ae6fddfd26ea9bb

data/CHANGELOG.md

@@ -1,76 +1,18 @@
-## v6.1.3.0
+## v7.0.0.0.rc1
 
-[Full changelog](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/compare/v6.1.2.1...v6.1.3.0)
-
-#### Fixed
-
-- [#1006](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1006) Fix support for index types
-- [#1041](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1041) Fix hook method that allows custom connection configuration.
-
-#### Changed
-
-- [#1014](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1014) Better handle SQL queries with invalid encoding
-
-## v6.1.2.1
-
-[Full changelog](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/compare/v6.1.2.0...v6.1.2.1)
-
-#### Fixed
-
-- [#943](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/943) Fix appname resolution when outside Rails context
-
-## v6.1.2.0
-
-[Full changelog](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/compare/v6.1.1.0...v6.1.2.0)
-
-#### Fixed
-
-- [#940](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/940) Primary key violation should result in RecordNotUnique error
+[Full changelog](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/compare/6-1-stable...v7.0.0.0.rc1)
 
 #### Changed
 
-- [#941](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/941) No longer support configuring the application name by overriding the 'configure_application_name' method.
-
-## v6.1.1.0
-
-[Full changelog](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/compare/v6.1.0.0...v6.1.1.0)
-
-#### Fixed
-
-- [#933](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/933) Conditionally apply SQL Server monkey patches to ActiveRecord so that it is safe to use this gem alongside other database adapters (e.g. PostgreSQL) in a multi-database Rails app
-- [#935](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/935) Fix schema cache generation
-  (**breaking change**)
-- [#936](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/936) Fix deteministic fetch when table has a composite primary key
-- [#938](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/938) Fix date columns serialization for range values
-
-## v6.1.0.0
+- [#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***)
 
-- No changes
-
-## v6.1.0.0.rc1
-
-[Full changelog](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/compare/6-0-stable...v6.1.0.0.rc1)
-
-#### Fixed
-
-- [#872](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/872) Use native String#start_with
-- [#876](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/876) Use native String#end_with
-- [#873](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/873) Various fixes to get the tests running for Rails 6.1
-- [#874](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/874) Deduplicate schema cache structures
-- [#875](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/875) Handle default boolean column values when deduplicating
-- [#879](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/879) Added visit method for HomogeneousIn
-- [#880](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/880) Handle any default column class when deduplicating
-- [#861](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/861) Fix Rails 6.1 database config
-- [#890](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/890) Fix removal of invalid ordering from select statements
-- [#881](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/881) Dump column collation to schema.rb and allow collation changes using column_change
-- [#891](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/891) Add support for if_not_exists to indexes
-- [#892](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/892) Add support for if_exists on remove_column
-- [#883](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/885) Fix quoting of ActiveRecord::Relation::QueryAttribute and ActiveModel::Attributes
-- [#893](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/893) Add Active Record Marshal forward compatibility tests
-- [#903](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/903) Raise ActiveRecord::ConnectionNotEstablished on calls to execute with a disconnected connection
-
-#### Changed
+#### Added
 
-- [#917](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/917) Refactored to use new_client connection pattern
+- [#972](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/972) Support `ActiveRecord::QueryLogs`
+- [#981](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/981) Support `find_by` an encrypted attribute
+- [#985](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/985) Support string returning clause for `ActiveRecord#insert_all`
 
-Please check [6-0-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/6-0-stable/CHANGELOG.md) for previous changes.
+Please check [6-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/6-1-stable/CHANGELOG.md) for previous changes.

data/Gemfile

@@ -7,12 +7,10 @@ git_source(:github) { |repo| "https://github.com/#{repo}.git" }
 gemspec
 
 gem "bcrypt"
-
-gem "pg", "~> 1.3"
-
+gem "pg",      ">= 0.18.0"
 gem "sqlite3", "~> 1.4"
 gem "tzinfo-data", platforms: [:mingw, :mswin, :x64_mingw, :jruby]
-gem "minitest", ">= 5.15.0", "< 5.16"
+gem "benchmark-ips"
 
 if ENV["RAILS_SOURCE"]
   gemspec path: ENV["RAILS_SOURCE"]

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2008-2015
+Copyright (c) 2008-2022
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -9,11 +9,12 @@
 
 The SQL Server adapter for ActiveRecord using SQL Server 2012 or higher.
 
-Interested in older versions? We follow a rational versioning policy that tracks Rails. That means that our 6.x version of the adapter is only for the latest 6.x version of Rails. If you need the adapter for SQL Server 2008 or 2005, you are still in the right spot. Just install the latest 3.2.x to 4.1.x version of the adapter that matches your Rails version. We also have stable branches for each major/minor release of ActiveRecord.
+Interested in older versions? We follow a rational versioning policy that tracks Rails. That means that our 7.x version of the adapter is only for the latest 7.x version of Rails. If you need the adapter for SQL Server 2008 or 2005, you are still in the right spot. Just install the latest 3.2.x to 4.1.x version of the adapter that matches your Rails version. We also have stable branches for each major/minor release of ActiveRecord.
 
 | Adapter Version | Rails Version | Support                                                                                     |
-|-----------------| ------------- |---------------------------------------------------------------------------------------------|
-| `6.1.3.0`       | `6.1.x`       | [active](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/6-1-stable) |
+| --------------- | ------------- | ------------------------------------------------------------------------------------------- |
+| `7.0.0.0.rc1`   | `7.0.x`       | [unreleased](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main)   |
+| `6.1.2.1`       | `6.1.x`       | [active](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/6-1-stable) |
 | `6.0.2`         | `6.0.x`       | [active](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/6-0-stable) |
 | `5.2.1`         | `5.2.x`       | [active](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/5-2-stable) |
 | `5.1.6`         | `5.1.x`       | [ended](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/5-1-stable)  |
@@ -66,7 +67,7 @@ ActiveRecord::Base.table_name_prefix = 'dbo.'
 It's also possible to create/change/drop a schema in the migration file as in the example below:
 
 ```ruby
-class CreateFooSchema < ActiveRecord::Migration[6.0]
+class CreateFooSchema < ActiveRecord::Migration[7.0]
   def up
     create_schema('foo')
 
@@ -84,7 +85,7 @@ end
 
 #### Configure Connection
 
-We currently conform to an unpublished and non-standard AbstractAdapter interface to configure connections made to the database. To do so, just implement the `configure_connection` method in an initializer like so. In this case below we are setting the `TEXTSIZE` to 64 megabytes.
+We currently conform to an unpublished and non-standard AbstractAdapter interface to configure connections made to the database. To do so, just override the `configure_connection` method in an initializer like so. In this case below we are setting the `TEXTSIZE` to 64 megabytes.
 
 ```ruby
 module ActiveRecord
@@ -187,5 +188,4 @@ You can see an up-to-date list of contributors here: http://github.com/rails-sql
 
 ## License
 
-Copyright © 2008-2020. It is free software, and may be redistributed under the terms specified in the [MIT-LICENSE](MIT-LICENSE) file.
-
+Copyright © 2008-2022. It is free software, and may be redistributed under the terms specified in the [MIT-LICENSE](MIT-LICENSE) file.

data/VERSION

@@ -1 +1 @@
-6.1.3.0
+7.0.0.0.rc1

data/activerecord-sqlserver-adapter.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.platform      = Gem::Platform::RUBY
   spec.version       = version
 
-  spec.required_ruby_version = ">= 2.5.0"
+  spec.required_ruby_version = ">= 2.7.0"
 
   spec.license       = "MIT"
   spec.authors       = ["Ken Collins", "Anna Carey", "Will Bond", "Murray Steele", "Shawn Balestracci", "Joe Rafaniello", "Tom Ward"]
@@ -27,6 +27,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activerecord", "~> 6.1.0"
+  spec.add_dependency "activerecord", "~> 7.0.0"
   spec.add_dependency "tiny_tds"
 end

data/lib/active_record/connection_adapters/sqlserver/core_ext/preloader.rb

@@ -6,20 +6,12 @@ module ActiveRecord
   module ConnectionAdapters
     module SQLServer
       module CoreExt
-        module Preloader
-          private
+        module LoaderQuery
+          def load_records_for_keys(keys, &block)
+            return super unless scope.connection.adapter_name == "SQLServer"
 
-          def records_for(ids)
-            return super unless klass.connection.adapter_name == "SQLServer"
-
-            ids.each_slice(in_clause_length).flat_map do |slice|
-              scope.where(association_key_name => slice).load do |record|
-                # Processing only the first owner
-                # because the record is modified but not an owner
-                owner = owners_by_key[convert_key(record[association_key_name])].first
-                association = owner.association(reflection.name)
-                association.set_inverse_instance(record)
-              end.records
+            keys.each_slice(in_clause_length).flat_map do |slice|
+              scope.where(association_key_name => slice).load(&block).records
             end
           end
 
@@ -33,6 +25,6 @@ module ActiveRecord
 end
 
 ActiveSupport.on_load(:active_record) do
-  mod = ActiveRecord::ConnectionAdapters::SQLServer::CoreExt::Preloader
-  ActiveRecord::Associations::Preloader::Association.prepend(mod)
+  mod = ActiveRecord::ConnectionAdapters::SQLServer::CoreExt::LoaderQuery
+  ActiveRecord::Associations::Preloader::Association::LoaderQuery.prepend(mod)
 end

data/lib/active_record/connection_adapters/sqlserver/database_statements.rb

@@ -14,6 +14,7 @@ module ActiveRecord
         end
 
         def execute(sql, name = nil)
+          sql = transform_query(sql)
           if preventing_writes? && write_query?(sql)
             raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
           end
@@ -28,7 +29,8 @@ module ActiveRecord
           end
         end
 
-        def exec_query(sql, name = "SQL", binds = [], prepare: false)
+        def exec_query(sql, name = "SQL", binds = [], prepare: false, async: false)
+          sql = transform_query(sql)
           if preventing_writes? && write_query?(sql)
             raise ActiveRecord::ReadOnlyError, "Write query attempted while in readonly mode: #{sql}"
           end
@@ -36,7 +38,7 @@ module ActiveRecord
           materialize_transactions
           mark_transaction_written_if_write(sql)
 
-          sp_executesql(sql, name, binds, prepare: prepare)
+          sp_executesql(sql, name, binds, prepare: prepare, async: async)
         end
 
         def exec_insert(sql, name = nil, binds = [], pk = nil, _sequence_name = nil)
@@ -147,7 +149,12 @@ module ActiveRecord
           sql = +"INSERT #{insert.into}"
 
           if returning = insert.send(:insert_all).returning
-            sql << " OUTPUT " << returning.map { |column| "INSERTED.#{quote_column_name(column)}" }.join(", ")
+            returning_sql = if returning.is_a?(String)
+              returning
+            else
+              returning.map { |column| "INSERTED.#{quote_column_name(column)}" }.join(", ")
+            end
+            sql << " OUTPUT #{returning_sql}"
           end
 
           sql << " #{insert.values_list}"
@@ -170,7 +177,7 @@ module ActiveRecord
             case @connection_options[:mode]
             when :dblib
               result = ensure_established_connection! { dblib_execute(sql) }
-              options = { as: :hash, cache_rows: true, timezone: ActiveRecord::Base.default_timezone || :utc }
+              options = { as: :hash, cache_rows: true, timezone: ActiveRecord.default_timezone || :utc }
               result.each(options) do |row|
                 r = row.with_indifferent_access
                 yield(r) if block_given?
@@ -411,7 +418,7 @@ module ActiveRecord
         # === SQLServer Specific (Selecting) ============================ #
 
         def raw_select(sql, name = "SQL", binds = [], options = {})
-          log(sql, name, binds) { _raw_select(sql, options) }
+          log(sql, name, binds, async: options[:async]) { _raw_select(sql, options) }
         end
 
         def _raw_select(sql, options = {})
@@ -443,7 +450,7 @@ module ActiveRecord
 
         def handle_to_names_and_values_dblib(handle, options = {})
           query_options = {}.tap do |qo|
-            qo[:timezone] = ActiveRecord::Base.default_timezone || :utc
+            qo[:timezone] = ActiveRecord.default_timezone || :utc
             qo[:as] = (options[:ar_result] || options[:fetch] == :rows) ? :array : :hash
           end
           results = handle.each(query_options)

data/lib/active_record/connection_adapters/sqlserver/quoting.rb

@@ -109,9 +109,7 @@ module ActiveRecord
 
         private_constant :COLUMN_NAME, :COLUMN_NAME_WITH_ORDER
 
-        private
-
-        def _quote(value)
+        def quote(value)
           case value
           when Type::Binary::Data
             "0x#{value.hex}"
@@ -124,7 +122,7 @@ module ActiveRecord
           end
         end
 
-        def _type_cast(value)
+        def type_cast(value)
           case value
           when ActiveRecord::Type::SQLServer::Data
             value.to_s

data/lib/active_record/connection_adapters/sqlserver/schema_creation.rb

@@ -34,19 +34,17 @@ module ActiveRecord
         end
 
         def visit_CreateIndexDefinition(o)
-          index = o.index
+          if_not_exists = o.if_not_exists
+
+          o.if_not_exists = false
+
+          sql = super
 
-          sql = []
-          sql << "IF NOT EXISTS (SELECT name FROM sysindexes WHERE name = '#{o.index.name}')" if o.if_not_exists
-          sql << "CREATE"
-          sql << "UNIQUE" if index.unique
-          sql << index.type.upcase if index.type
-          sql << "INDEX"
-          sql << "#{quote_column_name(index.name)} ON #{quote_table_name(index.table)}"
-          sql << "(#{quoted_columns(index)})"
-          sql << "WHERE #{index.where}" if index.where
+          if if_not_exists
+            sql = "IF NOT EXISTS (SELECT name FROM sysindexes WHERE name = '#{o.index.name}') #{sql}"
+          end
 
-          sql.join(" ")
+          sql
         end
 
         def add_column_options!(sql, options)

data/lib/active_record/connection_adapters/sqlserver/schema_statements.rb

@@ -378,7 +378,7 @@ module ActiveRecord
           binds << Relation::QueryAttribute.new("TABLE_NAME", identifier.object, nv128)
           binds << Relation::QueryAttribute.new("TABLE_SCHEMA", identifier.schema, nv128) unless identifier.schema.blank?
           results = sp_executesql(sql, "SCHEMA", binds)
-          results.map do |ci|
+          columns = results.map do |ci|
             ci = ci.symbolize_keys
             ci[:_type] = ci[:type]
             ci[:table_name] = view_tblnm || table_name
@@ -437,6 +437,13 @@ module ActiveRecord
             ci[:is_identity] = ci[:is_identity].to_i == 1 unless [TrueClass, FalseClass].include?(ci[:is_identity].class)
             ci
           end
+
+          # Since Rails 7, it's expected that all adapter raise error when table doesn't exists.
+          # I'm not aware of the possibility of tables without columns on SQL Server (postgres have those).
+          # Raise error if the method return an empty array
+          columns.tap do |result|
+            raise ActiveRecord::StatementInvalid, "Table '#{table_name}' doesn't exist" if result.empty?
+          end
         end
 
         def column_definitions_sql(database, identifier)
@@ -507,6 +514,13 @@ module ActiveRecord
           }.gsub(/[ \t\r\n]+/, " ").strip
         end
 
+        def remove_columns_for_alter(table_name, *column_names, **options)
+          first, *rest = column_names
+
+          # return an array like this [DROP COLUMN col_1, col_2, col_3]. Abstract adapter joins fragments with ", "
+          [remove_column_for_alter(table_name, first)] + rest.map { |column_name| quote_column_name(column_name) }
+        end
+
         def remove_check_constraints(table_name, column_name)
           constraints = select_values "SELECT CONSTRAINT_NAME FROM INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE where TABLE_NAME = '#{quote_string(table_name)}' and COLUMN_NAME = '#{quote_string(column_name)}'", "SCHEMA"
           constraints.each do |constraint|

data/lib/active_record/connection_adapters/sqlserver/type/data.rb

@@ -7,6 +7,8 @@ module ActiveRecord
         class Data
           attr_reader :value, :type
 
+          delegate :sub, to: :value
+
           def initialize(value, type)
             @value, @type = value, type
           end
@@ -25,7 +27,7 @@ module ActiveRecord
           end
 
           def eql?(other)
-            self.class == other.class && self.value == other.value
+            self.class == other.class && value == other.value
           end
           alias :== :eql?
         end

data/lib/active_record/connection_adapters/sqlserver/type/date.rb

@@ -13,7 +13,7 @@ module ActiveRecord
             value = super
             return value unless value.acts_like?(:date)
 
-            date = super(value).to_s(:_sqlserver_dateformat)
+            date = super(value).to_formatted_s(:_sqlserver_dateformat)
             Data.new date, self
           end
 

data/lib/active_record/connection_adapters/sqlserver/type/datetime.rb

@@ -15,7 +15,7 @@ module ActiveRecord
             value = super
             return value unless value.acts_like?(:time)
 
-            datetime = "#{value.to_s(:_sqlserver_datetime)}.#{quote_fractional(value)}"
+            datetime = "#{value.to_formatted_s(:_sqlserver_datetime)}.#{quote_fractional(value)}"
 
             Data.new datetime, self
           end

data/lib/active_record/connection_adapters/sqlserver/type/time.rb

@@ -11,7 +11,7 @@ module ActiveRecord
             value = super
             return value unless value.acts_like?(:time)
 
-            time = "#{value.to_s(:_sqlserver_time)}.#{quote_fractional(value)}"
+            time = "#{value.to_formatted_s(:_sqlserver_time)}.#{quote_fractional(value)}"
 
             Data.new time, self
           end