activerecord-sqlserver-adapter 7.1.1 → 7.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 670622c4f84954789b5050d84bbe47ce3235a614bcd12a083716d9c2c8b775c7
-  data.tar.gz: 07720ea291eabf91fbb2def06c493a423795533a08394a2837faff4825ef660a
+  metadata.gz: b304aee82f2ca78fe1db797b127b31a73b95df1dfb670a7232a68d57b6d9846e
+  data.tar.gz: bb52aecdc34253336fdeafb2fad5d26a3cb48ea7dfd2a453c3b87f07a423c0a6
 SHA512:
-  metadata.gz: 0144e10d2f2670cf7ab24fc9e5ca50351474b09e82a8d2322a4a402ce5d3365e697f487db5741b9b8199afbe68319093d7c14cd3fbfecce49f041d8b3ee295d7
-  data.tar.gz: c4d3666c0f01d14e7985651cbd7fd40da9e5bfb03e509e53a5709fe0fcd956efff3d01bdb7a97c12037c80a1588c8afa34e1eaad11623341ba748cff9195e112
+  metadata.gz: 34a017ac93ad7e077f41e4897185ccf20820774e1b5ee3c49988fc58d3b0febf422e6989155100b06eab3b2bcfcd79fab35ec83a31d4c9b0a266fc54f06da652
+  data.tar.gz: e9fa8fc3869bc0cc20eac834eef6737421d0ff4cfc27a1064843c89a3fd4447f02c5b35338661740c55cbd7caf687151aa469fc2092c01a048ac4967612c88ad

data/.devcontainer/Dockerfile

@@ -0,0 +1,30 @@
+# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.191.1/containers/ruby/.devcontainer/base.Dockerfile
+
+# [Choice] Ruby version: 3, 3.0, 2, 2.7, 2.6
+ARG VARIANT="3"
+FROM mcr.microsoft.com/devcontainers/ruby:${VARIANT}
+
+# TinyTDS
+RUN apt-get -y install libc6-dev \
+    && wget http://www.freetds.org/files/stable/freetds-1.1.32.tar.gz \
+    && tar -xzf freetds-1.1.32.tar.gz \
+    && cd freetds-1.1.32 \
+    && ./configure --prefix=/usr/local --with-tdsver=7.3 \
+    && make \
+    && make install
+
+# Install the SQL Server command-line tools
+RUN curl https://packages.microsoft.com/keys/microsoft.asc | sudo tee /etc/apt/trusted.gpg.d/microsoft.asc \
+    && curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list | sudo tee /etc/apt/sources.list.d/mssql-release.list \
+    && apt-get update \
+    && ACCEPT_EULA=Y apt-get install -y mssql-tools18 unixodbc-dev \
+    && echo 'export PATH="$PATH:/opt/mssql-tools18/bin"' >> ~/.bashrc \
+    && echo 'export PATH="$PATH:/opt/mssql-tools18/bin"' >> /root/.bashrc
+
+# Add the SQL Server main Gemfile and install the gems.
+RUN mkdir -p /tmp/activerecord-sqlserver-adapter
+COPY Gemfile VERSION activerecord-sqlserver-adapter.gemspec /tmp/activerecord-sqlserver-adapter/
+RUN cd /tmp/activerecord-sqlserver-adapter \
+    && bundle install \
+    && rm -rf /tmp/activerecord-sqlserver-adapter
+RUN chown -R vscode:vscode /usr/local/rvm

data/.devcontainer/boot.sh

@@ -0,0 +1,22 @@
+sudo chown -R vscode:vscode /usr/local/bundle
+
+# Wait for 10 seconds to make sure SQL Server came up.
+sleep 10
+
+# Setup test databases and users.
+/opt/mssql-tools18/bin/sqlcmd -C -S sqlserver -U sa -P "MSSQLadmin!" <<SQL
+CREATE DATABASE [activerecord_unittest];
+CREATE DATABASE [activerecord_unittest2];
+GO
+CREATE LOGIN [rails] WITH PASSWORD = '', CHECK_POLICY = OFF, DEFAULT_DATABASE = [activerecord_unittest];
+GO
+USE [activerecord_unittest];
+CREATE USER [rails] FOR LOGIN [rails];
+GO
+EXEC sp_addrolemember N'db_owner', N'rails';
+EXEC master..sp_addsrvrolemember @loginame = N'rails', @rolename = N'sysadmin';
+GO
+SQL
+
+# Mark directory as safe in Git so that commands run without warnings.
+git config --global --add safe.directory /workspaces/activerecord-sqlserver-adapter

data/.devcontainer/devcontainer.json

@@ -0,0 +1,38 @@
+// For format details, see https://aka.ms/devcontainer.json.
+{
+	"name": "ActiveRecord SQL Server Adapter project development",
+	"dockerComposeFile": "docker-compose.yml",
+	"service": "activerecord-sqlserver-adapter",
+	"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
+
+	// Features to add to the dev container. More info: https://containers.dev/features.
+	"features": {
+		"ghcr.io/devcontainers/features/github-cli:1": {
+			"version": "latest"
+		}
+	},
+
+	"containerEnv": {
+    "ACTIVERECORD_UNITTEST_HOST": "sqlserver"
+	},
+
+	// Use 'forwardPorts' to make a list of ports inside the container available locally.
+	// This can be used to network with other containers or the host.
+	// "forwardPorts": [3000, 5432],
+
+	// Use 'postCreateCommand' to run commands after the container is created.
+	"postCreateCommand": ".devcontainer/boot.sh",
+
+	// Configure tool-specific properties.
+	"customizations": {
+		"vscode": {
+			// Add the IDs of extensions you want installed when the container is created.
+			"extensions": [
+				"Shopify.ruby-lsp"
+			]
+		}
+	},
+
+	// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
+	// "remoteUser": "root"
+}

data/.devcontainer/docker-compose.yml

@@ -0,0 +1,42 @@
+version: '3'
+
+services:
+  activerecord-sqlserver-adapter:
+    build:
+      context: ..
+      dockerfile: .devcontainer/Dockerfile
+
+    volumes:
+      - ../..:/workspaces:cached
+
+    # Overrides default command so things don't shut down after the process ends.
+    command: sleep infinity
+
+    # Runs app on the same network as the database container, allows "forwardPorts" in devcontainer.json function.
+    networks:
+      - default
+
+    depends_on:
+      - sqlserver
+
+    # Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
+    # (Adding the "ports" property to this file will not forward from a Codespace.)
+
+  sqlserver:
+    image: mcr.microsoft.com/mssql/server:2022-latest
+    restart: unless-stopped
+    networks:
+      - default
+    volumes:
+      - sqlserver-data:/var/opt/mssql
+    ports:
+      - "1433:1433"
+    environment:
+      MSSQL_SA_PASSWORD: MSSQLadmin!
+      ACCEPT_EULA: Y
+
+networks:
+  default:
+
+volumes:
+  sqlserver-data:

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v7.1.3
+
+#### Fixed
+
+- [#1152](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1152) Fix Composite Key Inserts with Triggers
+
+## v7.1.2
+
+#### Fixed
+
+- [#1151](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1151) FROM subquery should work if order provided
+
 ## v7.1.1
 
 #### Fixed

data/README.md

@@ -13,7 +13,7 @@ Interested in older versions? We follow a rational versioning policy that tracks
 
 | Adapter Version | Rails Version | Support | Branch                                                                                           |
 |-----------------|---------------|---------|--------------------------------------------------------------------------------------------------|
-| `7.1.1`         | `7.1.x`       | Active  | [main](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main)              |
+| `7.1.3`         | `7.1.x`       | Active  | [main](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main)              |
 | `7.0.5.1`       | `7.0.x`       | Active  | [7-0-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/7-0-stable)  |
 | `6.1.3.0`       | `6.1.x`       | Active  | [6-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/6-1-stable)  |
 | `6.0.3`         | `6.0.x`       | Ended   | [6-0-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/6-0-stable)  |
@@ -183,11 +183,49 @@ 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.
+Please contribute to the project by submitting bug fixes and features. To make sure your fix/feature has
+a high chance of being added, please include tests in your pull request. To run the tests you will need to
+setup your development environment.
 
-* Github: http://github.com/rails-sqlserver/activerecord-sqlserver-adapter
-* Gitter: https://gitter.im/rails-sqlserver/activerecord-sqlserver-adapter
+## Setting Up Your Development Environment
 
+To run the test suite you can use any of the following methods below. See [RUNNING_UNIT_TESTS](RUNNING_UNIT_TESTS.md) for
+more detailed information on running unit tests.
+
+### Dev Container CLI
+
+With [Docker](https://www.docker.com) and [npm](https://github.com/npm/cli) installed, you can run [Dev Container CLI](https://github.com/devcontainers/cli) to
+utilize the [`.devcontainer`](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main/.devcontainer) configuration from the command line.
+
+```bash
+$ npm install -g @devcontainers/cli
+$ cd activerecord-sqlserver-adapter
+$ devcontainer up --workspace-folder .
+$ devcontainer exec --workspace-folder . bash
+```
+
+From within the container, you can run the tests using the following command:
+
+```bash
+$ bundle install
+$ bundle exec rake test
+```
+
+_Note: The setup we use is based on the [Rails Dev Container setup.](https://guides.rubyonrails.org/contributing_to_ruby_on_rails.html#using-dev-container-cli)_
+
+### VirtualBox & Vagrant
+
+The [activerecord-sqlserver-adapter-dev-box](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter-dev-box)
+is a Vagrant/VirtualBox virtual machine that has MS SQL Server installed. However, the
+activerecord-sqlserver-adapter-dev-box uses Vagrant and Virtual Box which will not work on Macs with Apple silicon.
+
+### Local Development
+
+See the [RUNNING_UNIT_TESTS](RUNNING_UNIT_TESTS.md) file for the details of how to run the unit tests locally.
+
+## Community
+
+There is a [Gitter channel](https://gitter.im/rails-sqlserver/activerecord-sqlserver-adapter) for the project where you are free to ask questions about the project.
 
 ## Credits & Contributions
 

data/RUNNING_UNIT_TESTS.md

@@ -1,9 +1,8 @@
+# How To Run The Tests Locally
 
-# How To Run The Test!
+The following is a description of how to run the tests for the SQL Server adapter on a local environment.
 
-This process is much easier than it has been before!
-
-## MS SQL SERVER
+## MS SQL Server instance
 
 If you don't have easy access to MS SQL Server, you can set up a Vagrant/VirtualBox virtual machine with MS SQL Server. [Here's how](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter-dev-box).
 

data/VERSION

@@ -1 +1 @@
-7.1.1
+7.1.3

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

@@ -10,6 +10,8 @@ module ActiveRecord
           def load_records_for_keys(keys, &block)
             return super unless scope.connection.sqlserver?
 
+            return [] if keys.empty?
+
             if association_key_name.is_a?(Array)
               query_constraints = Hash.new { |hsh, key| hsh[key] = Set.new }
 

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

@@ -278,13 +278,13 @@ module ActiveRecord
                   exclude_output_inserted = exclude_output_inserted_table_name?(table_name, sql)
 
                   if exclude_output_inserted
-                    quoted_pk = SQLServer::Utils.extract_identifiers(pk).quoted
+                    quoted_pk = Array(pk).map { |subkey| SQLServer::Utils.extract_identifiers(subkey).quoted }
 
                     id_sql_type = exclude_output_inserted.is_a?(TrueClass) ? "bigint" : exclude_output_inserted
                     <<~SQL.squish
-                      DECLARE @ssaIdInsertTable table (#{quoted_pk} #{id_sql_type});
-                      #{sql.dup.insert sql.index(/ (DEFAULT )?VALUES/i), " OUTPUT INSERTED.#{quoted_pk} INTO @ssaIdInsertTable"}
-                      SELECT CAST(#{quoted_pk} AS #{id_sql_type}) FROM @ssaIdInsertTable
+                      DECLARE @ssaIdInsertTable table (#{quoted_pk.map { |subkey| "#{subkey} #{id_sql_type}"}.join(", ") });
+                      #{sql.dup.insert sql.index(/ (DEFAULT )?VALUES/i), " OUTPUT #{ quoted_pk.map { |subkey| "INSERTED.#{subkey}" }.join(", ") } INTO @ssaIdInsertTable"}
+                      SELECT #{quoted_pk.map {|subkey| "CAST(#{subkey} AS #{id_sql_type}) #{subkey}"}.join(", ")} FROM @ssaIdInsertTable
                     SQL
                   else
                     returning_columns = returning || Array(pk)

data/lib/arel/visitors/sqlserver.rb

@@ -213,7 +213,7 @@ module Arel
 
       def visit_Orders_And_Let_Fetch_Happen(o, collector)
         make_Fetch_Possible_And_Deterministic o
-        unless o.orders.empty?
+        if o.orders.any?
           collector << " ORDER BY "
           len = o.orders.length - 1
           o.orders.each_with_index { |x, i|
@@ -261,15 +261,14 @@ module Arel
 
       def make_Fetch_Possible_And_Deterministic(o)
         return if o.limit.nil? && o.offset.nil?
+        return if o.orders.any?
 
         t = table_From_Statement o
         pk = primary_Key_From_Table t
         return unless pk
 
-        if o.orders.empty?
-          # Prefer deterministic vs a simple `(SELECT NULL)` expr.
-          o.orders = [pk.asc]
-        end
+        # Prefer deterministic vs a simple `(SELECT NULL)` expr.
+        o.orders = [pk.asc]
       end
 
       def distinct_One_As_One_Is_So_Not_Fetch(o)

data/test/cases/fetch_test_sqlserver.rb

@@ -42,6 +42,25 @@ class FetchTestSqlserver < ActiveRecord::TestCase
     end
   end
 
+  describe "FROM subquery" do
+    let(:from_sql) { "(SELECT [books].* FROM [books]) [books]" }
+
+    it "SQL generated correctly for FROM subquery if order provided" do
+      query = Book.from(from_sql).order(:id).limit(5)
+
+      assert_equal query.to_sql, "SELECT [books].* FROM (SELECT [books].* FROM [books]) [books] ORDER BY [books].[id] ASC OFFSET 0 ROWS FETCH NEXT 5 ROWS ONLY"
+      assert_equal query.to_a.count, 5
+    end
+
+    it "exception thrown if FROM subquery is provided without an order" do
+      query = Book.from(from_sql).limit(5)
+
+      assert_raise(ActiveRecord::StatementInvalid) do
+        query.to_sql
+      end
+    end
+  end
+
   protected
 
   def create_10_books

data/test/cases/trigger_test_sqlserver.rb

@@ -28,4 +28,14 @@ class SQLServerTriggerTest < ActiveRecord::TestCase
     _(obj.id).must_be :present?
     _(obj.id.to_s).must_equal SSTestTriggerHistory.first.id_source
   end
+
+  it "can insert into a table with composite pk with output inserted - with a true setting for table name" do
+    exclude_output_inserted_table_names["sst_table_with_composite_pk_trigger"] = true
+    assert SSTestTriggerHistory.all.empty?
+    obj = SSTestTriggerCompositePk.create! pk_col_one: 123, pk_col_two: 42, event_name: "test trigger"
+    _(obj.event_name).must_equal "test trigger"
+    _(obj.pk_col_one).must_equal 123
+    _(obj.pk_col_two).must_equal 42
+    _(obj.pk_col_one.to_s).must_equal SSTestTriggerHistory.first.id_source
+  end
 end

data/test/models/sqlserver/trigger.rb

@@ -7,3 +7,7 @@ end
 class SSTestTriggerUuid < ActiveRecord::Base
   self.table_name = "sst_table_with_uuid_trigger"
 end
+
+class SSTestTriggerCompositePk < ActiveRecord::Base
+  self.table_name = "sst_table_with_composite_pk_trigger"
+end

data/test/schema/sqlserver_specific_schema.rb

@@ -232,6 +232,23 @@ ActiveRecord::Schema.define do
     SELECT id AS id_source, event_name FROM INSERTED
   SQL
 
+  execute "IF EXISTS(SELECT * FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = 'sst_table_with_composite_pk_trigger') DROP TABLE sst_table_with_composite_pk_trigger"
+  execute <<-SQL
+    CREATE TABLE sst_table_with_composite_pk_trigger(
+      pk_col_one int NOT NULL,
+      pk_col_two int NOT NULL,
+      event_name nvarchar(255),
+      CONSTRAINT PK_sst_table_with_composite_pk_trigger PRIMARY KEY (pk_col_one, pk_col_two)
+    )
+  SQL
+  execute <<-SQL
+    CREATE TRIGGER sst_table_with_composite_pk_trigger_t ON sst_table_with_composite_pk_trigger
+    FOR INSERT
+    AS
+    INSERT INTO sst_table_with_trigger_history (id_source, event_name)
+    SELECT pk_col_one AS id_source, event_name FROM INSERTED
+  SQL
+
   # Another schema.
 
   create_table :sst_schema_columns, force: true do |t|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-sqlserver-adapter
 version: !ruby/object:Gem::Version
-  version: 7.1.1
+  version: 7.1.3
 platform: ruby
 authors:
 - Ken Collins
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -53,6 +53,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".devcontainer/Dockerfile"
+- ".devcontainer/boot.sh"
+- ".devcontainer/devcontainer.json"
+- ".devcontainer/docker-compose.yml"
 - ".editorconfig"
 - ".github/issue_template.md"
 - ".github/workflows/ci.yml"
@@ -235,8 +239,8 @@ 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/v7.1.1/CHANGELOG.md
-  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v7.1.1
+  changelog_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/v7.1.3/CHANGELOG.md
+  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v7.1.3
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -252,7 +256,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: ActiveRecord SQL Server Adapter.