activerecord-sqlserver-adapter 6.1.2.1 → 6.1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cbe90476efcde83329c5afc117491b77898865135cca90e25f44eed91b54e87
-  data.tar.gz: fd41bbb523fdf9281e18120788dd0ff49653a31ff189dceb55ab49aba816d197
+  metadata.gz: 746931d24bb3806cafe400f5e4fed544e36dc7b06c6635a2ed4da4aacbf28590
+  data.tar.gz: dc87a51ccca60af1256b55f511f919c0ce6e5e9c7bb85a1a6865c52ed1e272f4
 SHA512:
-  metadata.gz: b6555a063590ffe22617da22910c8f131935582dd366e76bb9f1b953670ef462416ca8cd28f290277d799449cd7e298e3abb5159578b074e59c66b18fd30cedb
-  data.tar.gz: 8c5a255f1d37d1961c1dd5957535513370510316ace2266c1f91359a2c85700b9c94bf30aa47bb482d9e928c5399fa54fbb2415c8e52b65ebbec16c7fd38abad
+  metadata.gz: c33ad8a4f68a70fb8b15ae9b010d47043c412a17494a1248197651cdfebe3e8960fec51648c81bef28ccc9d4fae6dff08b9732a1f7dec9fe9f5cfcb66b8ccbbf
+  data.tar.gz: 3f40b13dd7c1d69af465467b5f00a60514c02d4d7f2051c6a78c365374a0ae42d475233b9b08646bb94d8ce4899b8627b836098217efee44fc785814b1cd8bf1

data/.github/workflows/ci.yml

@@ -13,7 +13,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby: [2.5.9, 2.6.7, 2.7.3, 3.0.1]
+        ruby:
+          - 2.7.5
+          - 3.0.3
+          - 3.1.0
 
     steps:
       - name: Checkout code

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v6.1.3.0
+
+[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)

data/Gemfile

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

data/README.md

@@ -12,8 +12,8 @@ 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.
 
 | Adapter Version | Rails Version | Support                                                                                     |
-| --------------- | ------------- | ------------------------------------------------------------------------------------------- |
-| `6.1.2.1`       | `6.1.x`       | [active](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main)       |
+|-----------------| ------------- |---------------------------------------------------------------------------------------------|
+| `6.1.3.0`       | `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)  |
@@ -84,7 +84,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 override 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 implement the `configure_connection` method in an initializer like so. In this case below we are setting the `TEXTSIZE` to 64 megabytes.
 
 ```ruby
 module ActiveRecord
@@ -107,7 +107,7 @@ Below shows how you might use the database.yml file to use the process ID in you
 ```yaml
 development:
   adapter: sqlserver
-  appname: <%= myapp_#{Process.pid} %>
+  appname: <%= "myapp_#{Process.pid}" %>
 ```
 
 #### Executing Stored Procedures
@@ -152,16 +152,25 @@ ActiveRecord::ConnectionAdapters::SQLServerAdapter.showplan_option = 'SHOWPLAN_X
 **NOTE:** The method we utilize to make SHOWPLANs work is very brittle to complex SQL. There is no getting around this as we have to deconstruct an already prepared statement for the sp_executesql method. If you find that explain breaks your app, simple disable it. Do not open a github issue unless you have a patch.  Please [consult the Rails guides](http://guides.rubyonrails.org/active_record_querying.html#running-explain) for more info.
 
 
+## New Rails Applications
+
+When creating a new Rails application you can specify that you want to use the SQL Server adapter using the `database` option:
+
+```
+rails new my_app --database=sqlserver
+```
+
+To then connect the application to your SQL Server instance edit the `config/database.yml` file with the username, password and host of your SQL Server instance.
+
+
 ## Installation
 
 The adapter has no strict gem dependencies outside of `ActiveRecord`. You will have to pick a connection mode, the default is dblib which uses the `TinyTDS` gem. Just bundle the gem and the adapter will use it.
 
 ```ruby
-gem 'tiny_tds'
 gem 'activerecord-sqlserver-adapter'
 ```
 
-
 ## Contributing
 
 If you would like to contribute a feature or bugfix, thanks! To make sure your fix/feature has a high chance of being added, please read the following guidelines. First, ask on the Gitter, or post a ticket on github issues. Second, make sure there are tests! We will not accept any patch that is not tested. Please read the [`RUNNING_UNIT_TESTS`](RUNNING_UNIT_TESTS.md) file for the details of how to run the unit tests.

data/VERSION

@@ -1 +1 @@
-6.1.2.1
+6.1.3.0

data/appveyor.yml

@@ -5,10 +5,10 @@ build: off
 matrix:
   fast_finish: true
   allow_failures:
-    - ruby_version: "25"
-    - ruby_version: "26"
     - ruby_version: "27"
     - ruby_version: "27-x64"
+    - ruby_version: "30"
+    - ruby_version: "30-x64"
 services:
   - mssql2014
 
@@ -38,9 +38,7 @@ environment:
   CI_AZURE_PASS:
     secure: cSQp8sk4urJYvq0utpsK+r7J+snJ2wpcdp8RdXJfB+w=
   matrix:
-    - ruby_version: "25-x64"
-    - ruby_version: "25"
-    - ruby_version: "26-x64"
-    - ruby_version: "26"
     - ruby_version: "27-x64"
     - ruby_version: "27"
+    - ruby_version: "30-x64"
+    - ruby_version: "30"

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

@@ -9,6 +9,8 @@ module ActiveRecord
 
         def write_query?(sql) # :nodoc:
           !READ_QUERY.match?(sql)
+        rescue ArgumentError # Invalid encoding
+          !READ_QUERY.match?(sql.b)
         end
 
         def execute(sql, name = nil)

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

@@ -34,17 +34,19 @@ module ActiveRecord
         end
 
         def visit_CreateIndexDefinition(o)
-          if_not_exists = o.if_not_exists
-
-          o.if_not_exists = false
-
-          sql = super
+          index = o.index
 
-          if if_not_exists
-            sql = "IF NOT EXISTS (SELECT name FROM sysindexes WHERE name = '#{o.index.name}') #{sql}"
-          end
+          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
 
-          sql
+          sql.join(" ")
         end
 
         def add_column_options!(sql, options)

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

@@ -531,17 +531,22 @@ module ActiveRecord
 
         # === SQLServer Specific (Misc Helpers) ========================= #
 
+        # Parses just the table name from the SQL. Table name does not include database/schema/etc.
         def get_table_name(sql)
-          tn = if sql =~ /^\s*(INSERT|EXEC sp_executesql N'INSERT)(\s+INTO)?\s+([^\(\s]+)\s*|^\s*update\s+([^\(\s]+)\s*/i
-                 Regexp.last_match[3] || Regexp.last_match[4]
-               elsif sql =~ /FROM\s+([^\(\s]+)\s*/i
-                 Regexp.last_match[1]
-               else
-                 nil
-               end
+          tn = get_raw_table_name(sql)
           SQLServer::Utils.extract_identifiers(tn).object
         end
 
+        # Parses the raw table name that is used in the SQL. Table name could include database/schema/etc.
+        def get_raw_table_name(sql)
+          case sql
+          when /^\s*(INSERT|EXEC sp_executesql N'INSERT)(\s+INTO)?\s+([^\(\s]+)\s*|^\s*update\s+([^\(\s]+)\s*/i
+            Regexp.last_match[3] || Regexp.last_match[4]
+          when /FROM\s+([^\(\s]+)\s*/i
+            Regexp.last_match[1]
+          end
+        end
+
         def default_constraint_name(table_name, column_name)
           "DF_#{table_name}_#{column_name}"
         end

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

@@ -46,7 +46,22 @@ module ActiveRecord
           end
 
           def fully_qualified?
-            parts.compact.size == 4
+            qualified_level == :fully
+          end
+
+          def qualified_level
+            case parts.compact.size
+            when 4
+              :fully
+            when 3
+              :database
+            when 2
+              :schema
+            when 1
+              :table
+            else
+              :none
+            end
           end
 
           def to_s

data/lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -140,7 +140,7 @@ module ActiveRecord
       def initialize(connection, logger, _connection_options, config)
         super(connection, logger, config)
         @connection_options = config
-        configure_connection
+        perform_connection_configuration
       end
 
       # === Abstract Adapter ========================================== #
@@ -301,14 +301,6 @@ module ActiveRecord
         do_execute "IF @@TRANCOUNT > 0 ROLLBACK TRANSACTION"
       end
 
-      def configure_connection
-        @spid = _raw_select("SELECT @@SPID", fetch: :rows).first.first
-        @version_year = version_year
-
-        initialize_dateformatter
-        use_database
-      end
-
       # === Abstract Adapter (Misc Support) =========================== #
 
       def tables_with_referential_integrity
@@ -530,7 +522,20 @@ module ActiveRecord
 
       def connect
         @connection = self.class.new_client(@connection_options)
-        configure_connection
+        perform_connection_configuration
+      end
+
+      def perform_connection_configuration
+        configure_connection_defaults
+        configure_connection if self.respond_to?(:configure_connection)
+      end
+
+      def configure_connection_defaults
+        @spid = _raw_select("SELECT @@SPID", fetch: :rows).first.first
+        @version_year = version_year
+
+        initialize_dateformatter
+        use_database
       end
     end
   end

data/test/cases/active_schema_test_sqlserver.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "cases/helper_sqlserver"
+
+class ActiveSchemaTestSQLServer < ActiveRecord::TestCase
+  before do
+    connection.create_table :schema_test_table, force: true, id: false do |t|
+      t.column :foo, :string, limit: 100
+      t.column :state, :string
+    end
+  end
+
+  after do
+    connection.drop_table :schema_test_table rescue nil
+  end
+
+  it 'default index' do
+    assert_sql('CREATE INDEX [index_schema_test_table_on_foo] ON [schema_test_table] ([foo])') do
+      connection.add_index :schema_test_table, "foo"
+    end
+  end
+
+  it 'unique index' do
+    assert_sql('CREATE UNIQUE INDEX [index_schema_test_table_on_foo] ON [schema_test_table] ([foo])') do
+      connection.add_index :schema_test_table, "foo", unique: true
+    end
+  end
+
+  it 'where condition on index' do
+    assert_sql("CREATE INDEX [index_schema_test_table_on_foo] ON [schema_test_table] ([foo]) WHERE state = 'active'") do
+      connection.add_index :schema_test_table, "foo", where: "state = 'active'"
+    end
+  end
+
+  it 'if index does not exist' do
+    assert_sql("IF NOT EXISTS (SELECT name FROM sysindexes WHERE name = 'index_schema_test_table_on_foo') " \
+               "CREATE INDEX [index_schema_test_table_on_foo] ON [schema_test_table] ([foo])") do
+      connection.add_index :schema_test_table, "foo", if_not_exists: true
+    end
+  end
+
+  describe "index types" do
+    it 'clustered index' do
+      assert_sql('CREATE CLUSTERED INDEX [index_schema_test_table_on_foo] ON [schema_test_table] ([foo])') do
+        connection.add_index :schema_test_table, "foo", type: :clustered
+      end
+    end
+
+    it 'nonclustered index' do
+      assert_sql('CREATE NONCLUSTERED INDEX [index_schema_test_table_on_foo] ON [schema_test_table] ([foo])') do
+        connection.add_index :schema_test_table, "foo", type: :nonclustered
+      end
+    end
+  end
+end

data/test/cases/coerced_tests.rb

@@ -92,6 +92,18 @@ module ActiveRecord
       Subscriber.send(:load_schema!)
       original_test_errors_when_an_insert_query_prefixed_by_a_double_dash_comment_is_called_while_preventing_writes
     end
+
+    coerce_tests! :test_doesnt_error_when_a_select_query_has_encoding_errors
+    def test_doesnt_error_when_a_select_query_has_encoding_errors_coerced
+      ActiveRecord::Base.while_preventing_writes do
+        # TinyTDS fail on encoding errors.
+        # But at least we can assert it fails in the client and not before when trying to
+        # match the query.
+        assert_raises ActiveRecord::StatementInvalid do
+          @connection.select_all("SELECT '\xC8'")
+        end
+      end
+    end
   end
 end
 
@@ -1195,7 +1207,7 @@ class RelationTest < ActiveRecord::TestCase
     sql_log = capture_sql do
       message = <<~MSG.squish
         `.reorder(nil)` with `.first` / `.first!` no longer
-        takes non-deterministic result in Rails 6.2.
+        takes non-deterministic result in Rails 7.0.
         To continue taking non-deterministic result, use `.take` / `.take!` instead.
       MSG
       assert_deprecated(message) do
@@ -1402,7 +1414,8 @@ class YamlSerializationTest < ActiveRecord::TestCase
   coerce_tests! :test_types_of_virtual_columns_are_not_changed_on_round_trip
   def test_types_of_virtual_columns_are_not_changed_on_round_trip_coerced
     author = Author.select("authors.*, 5 as posts_count").first
-    dumped = YAML.load(YAML.dump(author))
+    dumped_author = YAML.dump(author)
+    dumped = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(dumped_author) : YAML.load(dumped_author)
     assert_equal 5, author.posts_count
     assert_equal 5, dumped.posts_count
   end
@@ -1893,17 +1906,22 @@ class AnnotateTest < ActiveRecord::TestCase
   def test_annotate_is_sanitized_coerced
     quoted_posts_id, quoted_posts = regexp_escape_table_name("posts.id"), regexp_escape_table_name("posts")
 
-    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* foo \*/}i) do
+    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* \* /foo/ \* \*/}i) do
       posts = Post.select(:id).annotate("*/foo/*")
       assert posts.first
     end
 
-    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* foo \*/}i) do
+    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* \*\* //foo// \*\* \*/}i) do
       posts = Post.select(:id).annotate("**//foo//**")
       assert posts.first
     end
 
-    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* foo \*/ /\* bar \*/}i) do
+    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* \* \* //foo// \* \* \*/}i) do
+      posts = Post.select(:id).annotate("* *//foo//* *")
+      assert posts.first
+    end
+
+    assert_sql(%r{SELECT #{quoted_posts_id} FROM #{quoted_posts} /\* \* /foo/ \* \*/ /\* \* /bar \*/}i) do
       posts = Post.select(:id).annotate("*/foo/*").annotate("*/bar")
       assert posts.first
     end

data/test/cases/rake_test_sqlserver.rb

@@ -176,7 +176,8 @@ class SQLServerRakeSchemaCacheDumpLoadTest < SQLServerRakeTest
   it "dumps schema cache with SQL Server metadata" do
     quietly { db_tasks.dump_schema_cache connection, filename }
 
-    schema_cache = YAML.load(File.read(filename))
+    filedata = File.read(filename)
+    schema_cache = YAML.respond_to?(:unsafe_load) ? YAML.unsafe_load(filedata) : YAML.load(filedata)
 
     col_id, col_name = connection.schema_cache.columns("users")
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-sqlserver-adapter
 version: !ruby/object:Gem::Version
-  version: 6.1.2.1
+  version: 6.1.3.0
 platform: ruby
 authors:
 - Ken Collins
@@ -11,10 +11,10 @@ authors:
 - Shawn Balestracci
 - Joe Rafaniello
 - Tom Ward
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-08 00:00:00.000000000 Z
+date: 2023-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -142,6 +142,7 @@ files:
 - test/bin/install-freetds.sh
 - test/bin/install-openssl.sh
 - test/bin/setup.sh
+- test/cases/active_schema_test_sqlserver.rb
 - test/cases/adapter_test_sqlserver.rb
 - test/cases/change_column_collation_test_sqlserver.rb
 - test/cases/change_column_null_test_sqlserver.rb
@@ -224,9 +225,9 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/issues
-  changelog_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/v6.1.2.1/CHANGELOG.md
-  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v6.1.2.1
-post_install_message:
+  changelog_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/v6.1.3.0/CHANGELOG.md
+  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v6.1.3.0
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -241,8 +242,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.2.33
+signing_key: 
 specification_version: 4
 summary: ActiveRecord SQL Server Adapter.
 test_files:
@@ -251,6 +252,7 @@ test_files:
 - test/bin/install-freetds.sh
 - test/bin/install-openssl.sh
 - test/bin/setup.sh
+- test/cases/active_schema_test_sqlserver.rb
 - test/cases/adapter_test_sqlserver.rb
 - test/cases/change_column_collation_test_sqlserver.rb
 - test/cases/change_column_null_test_sqlserver.rb