activerecord-sqlserver-adapter 7.1.0.rc2 → 7.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ddd1e2bb81c9a6675d4a8f561c585869b0fafb6ecfe3c513e7e69d8bc3646d9f
-  data.tar.gz: 0d669eaaa14be843acc19cc887c47a3f8eecfb3552e8477a062df688d9ef1172
+  metadata.gz: 670622c4f84954789b5050d84bbe47ce3235a614bcd12a083716d9c2c8b775c7
+  data.tar.gz: 07720ea291eabf91fbb2def06c493a423795533a08394a2837faff4825ef660a
 SHA512:
-  metadata.gz: 879aeb90caaef5bb0218651407ec5a978d4a62d51682e92d55fbda2d3eed2fd37e8348e72aa8c4c92cab856c8eebc2fa4bf1c2166ad13d99c983f1310d3b66ab
-  data.tar.gz: 15030862f3ae2044dd780a62f4a8868dc383cd6e9775fcedff214b1429bdbf2881be503e670cf2cbcfcbe92c0583c2a89d53f30ddd988a5425649ff29ef2c971
+  metadata.gz: 0144e10d2f2670cf7ab24fc9e5ca50351474b09e82a8d2322a4a402ce5d3365e697f487db5741b9b8199afbe68319093d7c14cd3fbfecce49f041d8b3ee295d7
+  data.tar.gz: c4d3666c0f01d14e7985651cbd7fd40da9e5bfb03e509e53a5709fe0fcd956efff3d01bdb7a97c12037c80a1588c8afa34e1eaad11623341ba748cff9195e112

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## v7.1.1
+
+#### Fixed
+
+- [#1145](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1145) Ensure correct order of COLLATE and NOT NULL in CREATE TABLE statements
+- [#1144](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1144) Fix precision handling in time migration
+- [#1143](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1143) Fix precision handling for datetimeoffset migration
+
+## v7.1.0
+
+#### Added
+
+- [#1141](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1141) Added support for check constraints.
+
 ## v7.1.0.rc2
 
 #### Added

data/README.md

@@ -11,16 +11,16 @@ 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 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        | Branch                                                                                          |
-|-----------------|---------------|----------------|-------------------------------------------------------------------------------------------------|
-| `7.1.0.rc2`    | `7.1.x`       | In development | [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) |
-| `5.2.1`         | `5.2.x`       | Ended          | [5-2-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/5-2-stable) |
-| `5.1.6`         | `5.1.x`       | Ended          | [5-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/5-1-stable) |
-| `4.2.18`        | `4.2.x`       | Ended          | [4-2-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/4-2-stable) |
-| `4.1.8`         | `4.1.x`       | Ended          | [4-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/4-1-stable) |
+| 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.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)  |
+| `5.2.1`         | `5.2.x`       | Ended   | [5-2-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/5-2-stable)  |
+| `5.1.6`         | `5.1.x`       | Ended   | [5-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/5-1-stable)  |
+| `4.2.18`        | `4.2.x`       | Ended   | [4-2-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/4-2-stable)  |
+| `4.1.8`         | `4.1.x`       | Ended   | [4-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/4-1-stable)  |
 
 For older versions, please check their stable branches.
 
@@ -100,7 +100,7 @@ module ActiveRecord
     class SQLServerAdapter < AbstractAdapter
       def configure_connection
         super
-        raw_connection_do "SET TEXTSIZE #{64.megabytes}"
+        @raw_connection.execute("SET TEXTSIZE #{64.megabytes}").do
       end
     end
   end

data/VERSION

@@ -1 +1 @@
-7.1.0.rc2
+7.1.1

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

@@ -51,12 +51,12 @@ module ActiveRecord
 
         def add_column_options!(sql, options)
           sql << " DEFAULT #{quote_default_expression(options[:default], options[:column])}" if options_include_default?(options)
-          if options[:null] == false
-            sql << " NOT NULL"
-          end
           if options[:collation].present?
             sql << " COLLATE #{options[:collation]}"
           end
+          if options[:null] == false
+            sql << " NOT NULL"
+          end
           if options[:is_identity] == true
             sql << " IDENTITY(1,1)"
           end

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

@@ -267,6 +267,29 @@ module ActiveRecord
           end
         end
 
+        def check_constraints(table_name)
+          sql = <<~SQL
+            select chk.name AS 'name',
+                   chk.definition AS 'expression'
+            from sys.check_constraints chk
+            inner join sys.tables st on chk.parent_object_id = st.object_id
+            where
+            st.name = '#{table_name}'
+          SQL
+
+          chk_info = internal_exec_query(sql, "SCHEMA")
+
+          chk_info.map do |row|
+            options = {
+              name: row["name"]
+            }
+            expression = row["expression"]
+            expression = expression[1..-2] if expression.start_with?("(") && expression.end_with?(")")
+
+            CheckConstraintDefinition.new(table_name, expression, options)
+          end
+        end
+
         def type_to_sql(type, limit: nil, precision: nil, scale: nil, **)
           type_limitable = %w(string integer float char nchar varchar nvarchar).include?(type.to_s)
           limit = nil unless type_limitable
@@ -280,6 +303,16 @@ module ActiveRecord
             when 5..8       then  "bigint"
             else raise(ActiveRecordError, "No integer type has byte size #{limit}. Use a numeric with precision 0 instead.")
             end
+          when "time" # https://learn.microsoft.com/en-us/sql/t-sql/data-types/time-transact-sql
+            column_type_sql = type.to_s
+            if precision
+              if (0..7) === precision
+                column_type_sql << "(#{precision})"
+              else
+                raise(ActiveRecordError, "The time type has precision of #{precision}. The allowed range of precision is from 0 to 7")
+              end
+            end
+            column_type_sql
           when "datetime2"
             column_type_sql = super
             if precision
@@ -290,6 +323,16 @@ module ActiveRecord
               end
             end
             column_type_sql
+          when "datetimeoffset"
+            column_type_sql = super
+            if precision
+              if (0..7) === precision
+                column_type_sql << "(#{precision})"
+              else
+                raise(ActiveRecordError, "The datetimeoffset type has precision of #{precision}. The allowed range of precision is from 0 to 7")
+              end
+            end
+            column_type_sql
           else
             super
           end

data/lib/active_record/connection_adapters/sqlserver_adapter.rb

@@ -171,6 +171,10 @@ module ActiveRecord
         true
       end
 
+      def supports_check_constraints?
+        true
+      end
+
       def supports_json?
         version_year >= 2016
       end

data/test/cases/active_schema_test_sqlserver.rb

@@ -3,43 +3,43 @@
 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
+  describe "indexes" do
+    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
-  end
 
-  after do
-    connection.drop_table :schema_test_table rescue nil
-  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"
+    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
-  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
+    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
-  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'"
+    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
-  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
+    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
-  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
@@ -52,4 +52,76 @@ class ActiveSchemaTestSQLServer < ActiveRecord::TestCase
       end
     end
   end
+
+  describe 'collation' do
+    it "create column with NOT NULL and COLLATE" do
+      assert_nothing_raised do
+        connection.create_table :not_null_with_collation_table, force: true, id: false do |t|
+          t.text :not_null_text_with_collation, null: false, collation: "Latin1_General_CS_AS"
+        end
+      end
+    ensure
+      connection.drop_table :not_null_with_collation_table rescue nil
+    end
+  end
+
+  describe 'datetimeoffset precision' do
+    it 'valid precisions are correct' do
+      assert_nothing_raised do
+        connection.create_table :datetimeoffset_precisions do |t|
+          t.datetimeoffset :precision_default
+          t.datetimeoffset :precision_5, precision: 5
+          t.datetimeoffset :precision_7, precision: 7
+        end
+      end
+
+      columns = connection.columns("datetimeoffset_precisions")
+
+      assert_equal columns.find { |column| column.name == "precision_default" }.precision, 7
+      assert_equal columns.find { |column| column.name == "precision_5" }.precision, 5
+      assert_equal columns.find { |column| column.name == "precision_7" }.precision, 7
+    ensure
+      connection.drop_table :datetimeoffset_precisions rescue nil
+    end
+
+    it 'invalid precision raises exception' do
+      assert_raise(ActiveRecord::ActiveRecordError) do
+        connection.create_table :datetimeoffset_precisions do |t|
+          t.datetimeoffset :precision_8, precision: 8
+        end
+      end
+    ensure
+      connection.drop_table :datetimeoffset_precisions rescue nil
+    end
+  end
+
+  describe 'time precision' do
+    it 'valid precisions are correct' do
+      assert_nothing_raised do
+        connection.create_table :time_precisions do |t|
+          t.time :precision_default
+          t.time :precision_5, precision: 5
+          t.time :precision_7, precision: 7
+        end
+      end
+
+      columns = connection.columns("time_precisions")
+
+      assert_equal columns.find { |column| column.name == "precision_default" }.precision, 7
+      assert_equal columns.find { |column| column.name == "precision_5" }.precision, 5
+      assert_equal columns.find { |column| column.name == "precision_7" }.precision, 7
+    ensure
+      connection.drop_table :time_precisions rescue nil
+    end
+
+    it 'invalid precision raises exception' do
+      assert_raise(ActiveRecord::ActiveRecordError) do
+        connection.create_table :time_precisions do |t|
+          t.time :precision_8, precision: 8
+        end
+      end
+    ensure
+      connection.drop_table :time_precisions rescue nil
+    end
+  end
 end

data/test/cases/coerced_tests.rb

@@ -1580,6 +1580,13 @@ class SchemaDumperTest < ActiveRecord::TestCase
 
   # Tests are not about a specific adapter.
   coerce_tests! :test_do_not_dump_foreign_keys_when_bypassed_by_config
+
+  # SQL Server formats the check constraint expression differently.
+  coerce_tests! :test_schema_dumps_check_constraints
+  def test_schema_dumps_check_constraints_coerced
+    constraint_definition = dump_table_schema("products").split(/\n/).grep(/t.check_constraint.*products_price_check/).first.strip
+    assert_equal 't.check_constraint "[price]>[discounted_price]", name: "products_price_check"', constraint_definition
+  end
 end
 
 class SchemaDumperDefaultsTest < ActiveRecord::TestCase
@@ -1825,6 +1832,9 @@ class TimePrecisionTest < ActiveRecord::TestCase
 
   # SQL Server uses default precision for time.
   coerce_tests! :test_no_time_precision_isnt_truncated_on_assignment
+
+  # SQL Server accepts precision of 7 for time.
+  coerce_tests! :test_invalid_time_precision_raises_error
 end
 
 class DefaultNumbersTest < ActiveRecord::TestCase
@@ -2585,3 +2595,54 @@ module ActiveRecord
     end
   end
 end
+
+module ActiveRecord
+  class Migration
+    class CheckConstraintTest < ActiveRecord::TestCase
+      # SQL Server formats the check constraint expression differently.
+      coerce_tests! :test_check_constraints
+      def test_check_constraints_coerced
+        check_constraints = @connection.check_constraints("products")
+        assert_equal 1, check_constraints.size
+
+        constraint = check_constraints.first
+        assert_equal "products", constraint.table_name
+        assert_equal "products_price_check", constraint.name
+        assert_equal "[price]>[discounted_price]", constraint.expression
+      end
+
+      # SQL Server formats the check constraint expression differently.
+      coerce_tests! :test_add_check_constraint
+      def test_add_check_constraint_coerced
+        @connection.add_check_constraint :trades, "quantity > 0"
+
+        check_constraints = @connection.check_constraints("trades")
+        assert_equal 1, check_constraints.size
+
+        constraint = check_constraints.first
+        assert_equal "trades", constraint.table_name
+        assert_equal "chk_rails_2189e9f96c", constraint.name
+        assert_equal "[quantity]>(0)", constraint.expression
+      end
+
+      # SQL Server formats the check constraint expression differently.
+      coerce_tests! :test_remove_check_constraint
+      def test_remove_check_constraint_coerced
+        @connection.add_check_constraint :trades, "price > 0", name: "price_check"
+        @connection.add_check_constraint :trades, "quantity > 0", name: "quantity_check"
+
+        assert_equal 2, @connection.check_constraints("trades").size
+        @connection.remove_check_constraint :trades, name: "quantity_check"
+        assert_equal 1, @connection.check_constraints("trades").size
+
+        constraint = @connection.check_constraints("trades").first
+        assert_equal "trades", constraint.table_name
+        assert_equal "price_check", constraint.name
+        assert_equal "[price]>(0)", constraint.expression
+
+        @connection.remove_check_constraint :trades, name: :price_check # name as a symbol
+        assert_empty @connection.check_constraints("trades")
+      end
+    end
+  end
+end

data/test/cases/column_test_sqlserver.rb

@@ -435,13 +435,15 @@ class ColumnTestSQLServer < ActiveRecord::TestCase
       _(type.limit).must_be_nil
       _(type.precision).must_equal 7
       _(type.scale).must_be_nil
-      # Can save 100 nanosecond precisoins and return again.
+
+      # Can save 100 nanosecond precisions and return again.
       obj.datetimeoffset_7 = Time.new(2010, 4, 1, 12, 34, 56, +18000).change(nsec: 123456755)
       _(obj.datetimeoffset_7).must_equal Time.new(2010, 4, 1, 12, 34, 56, +18000).change(nsec: 123456800), "Nanoseconds were <#{obj.datetimeoffset_7.nsec}> vs <123456800>"
       obj.save!
       _(obj.datetimeoffset_7).must_equal Time.new(2010, 4, 1, 12, 34, 56, +18000).change(nsec: 123456800), "Nanoseconds were <#{obj.datetimeoffset_7.nsec}> vs <123456800>"
       obj.reload
       _(obj.datetimeoffset_7).must_equal Time.new(2010, 4, 1, 12, 34, 56, +18000).change(nsec: 123456800), "Nanoseconds were <#{obj.datetimeoffset_7.nsec}> vs <123456800>"
+
       # Maintains the timezone
       time = ActiveSupport::TimeZone["America/Los_Angeles"].local 2010, 12, 31, 23, 59, 59, Rational(123456800, 1000)
       obj.datetimeoffset_7 = time
@@ -449,6 +451,7 @@ class ColumnTestSQLServer < ActiveRecord::TestCase
       obj.save!
       _(obj.datetimeoffset_7).must_equal time
       _(obj.reload.datetimeoffset_7).must_equal time
+
       # With other precisions.
       time = ActiveSupport::TimeZone["America/Los_Angeles"].local 2010, 12, 31, 23, 59, 59, Rational(123456755, 1000)
       col = column("datetimeoffset_3")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-sqlserver-adapter
 version: !ruby/object:Gem::Version
-  version: 7.1.0.rc2
+  version: 7.1.1
 platform: ruby
 authors:
 - Ken Collins
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-14 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -235,8 +235,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.0.rc2/CHANGELOG.md
-  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v7.1.0.rc2
+  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
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -248,9 +248,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.4.7
 signing_key: