activerecord-sqlserver-adapter 7.1.4 → 7.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e12d59815d11d0cbecea5d206057d6251384ef3a37df229c3c20c92eb7e0312
-  data.tar.gz: 25644794411a6dd0e709216a5cc444571645f94f2faf07ede21a6680c9682b35
+  metadata.gz: eea983d328f36bfb590c26ff592292369634d60b63ff38acc43e28c87e09c7ee
+  data.tar.gz: 7e9ab05308f76eb6be6ef5745977f4c0de684c608494d45d9d49d3ac54e1a4cb
 SHA512:
-  metadata.gz: ff6fc5d218ed61de3c5b28024f72e42023ee15e710048f797e428d00487dd3be8284fadc8a23922aacb08ae22389aa0eaf7d9e86123d1a9d23ee9f2f222cc54e
-  data.tar.gz: ee6cd4a68000ec209f06f39c5029b049dd870993652a9bce9125cc118efc829bced1a921631fec7a8353e7bf96790eacdd9718a606fa82dee8ff2e74143b45c5
+  metadata.gz: 67f76bc1083712be03b8a8b3eb5a2c48b9d4efc44442b8573604aecaff23ccbd0bd1586529948497776aca6b7c18257ead5d62e239f2b69d92e2ec14e5675192
+  data.tar.gz: 845923a58bda81c5f32a81b40a61157b1d36c909352ac258bd848d2e604f95ee94e09878f3c8f475f3d770725c8492b8b58c4c87146c4965e0b29d91b64872fc

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## v7.1.5
+
+#### Added
+
+- [#1201](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1201) Support non-dbo schemas in schema dumper
+- [#1206](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/pull/1206) Support table names containing spaces
+
 ## v7.1.4
 
 #### Fixed

data/README.md

@@ -13,7 +13,8 @@ Interested in older versions? We follow a rational versioning policy that tracks
 
 | Adapter Version | Rails Version | Support | Branch                                                                                           |
 |-----------------|---------------|---------|--------------------------------------------------------------------------------------------------|
-| `7.1.4`         | `7.1.x`       | Active  | [main](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main)              |
+| Unreleased      | `7.2.x`       | In Development | [main](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/main)             |
+| `7.1.5`         | `7.1.x`       | Active         | [7-1-stable](https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/7-1-stable) |
 | `7.0.7`         | `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)  |

data/VERSION

@@ -1 +1 @@
-7.1.4
+7.1.5

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

@@ -39,6 +39,17 @@ module ActiveRecord
         def default_primary_key?(column)
           super && column.is_identity?
         end
+
+        def schemas(stream)
+          schema_names = @connection.schema_names
+
+          if schema_names.any?
+            schema_names.sort.each do |name|
+              stream.puts "  create_schema #{name.inspect}"
+            end
+            stream.puts
+          end
+        end
       end
     end
   end

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

@@ -393,19 +393,37 @@ module ActiveRecord
           execute "DROP SCHEMA [#{schema_name}]"
         end
 
+        # Returns an array of schema names.
+        def schema_names
+          sql = <<~SQL.squish
+           SELECT name
+            FROM sys.schemas
+            WHERE
+            name NOT LIKE 'db_%' AND
+            name NOT IN ('INFORMATION_SCHEMA', 'sys')
+          SQL
+
+          query_values(sql, "SCHEMA")
+        end
+
         private
 
         def data_source_sql(name = nil, type: nil)
-          scope = quoted_scope name, type: type
+          scope = quoted_scope(name, type: type)
 
-          table_name = lowercase_schema_reflection_sql 'TABLE_NAME'
-          database = scope[:database].present? ? "#{scope[:database]}." : ""
+          table_schema  = lowercase_schema_reflection_sql('TABLE_SCHEMA')
+          table_name    = lowercase_schema_reflection_sql('TABLE_NAME')
+          database      = scope[:database].present? ? "#{scope[:database]}." : ""
           table_catalog = scope[:database].present? ? quote(scope[:database]) : "DB_NAME()"
 
-          sql = "SELECT #{table_name}"
+          sql = "SELECT "
+          sql += " CASE"
+          sql += "  WHEN #{table_schema} = 'dbo' THEN #{table_name}"
+          sql += "  ELSE CONCAT(#{table_schema}, '.', #{table_name})"
+          sql += " END"
           sql += " FROM #{database}INFORMATION_SCHEMA.TABLES WITH (NOLOCK)"
           sql += " WHERE TABLE_CATALOG = #{table_catalog}"
-          sql += " AND TABLE_SCHEMA = #{quote(scope[:schema])}"
+          sql += " AND TABLE_SCHEMA = #{quote(scope[:schema])}" if scope[:schema]
           sql += " AND TABLE_NAME = #{quote(scope[:name])}" if scope[:name]
           sql += " AND TABLE_TYPE = #{quote(scope[:type])}" if scope[:type]
           sql += " ORDER BY #{table_name}"
@@ -414,9 +432,10 @@ module ActiveRecord
 
         def quoted_scope(name = nil, type: nil)
           identifier = SQLServer::Utils.extract_identifiers(name)
+
           {}.tap do |scope|
             scope[:database] = identifier.database if identifier.database
-            scope[:schema] = identifier.schema || "dbo"
+            scope[:schema] = identifier.schema || "dbo" if name.present?
             scope[:name] = identifier.object if identifier.object
             scope[:type] = type if type
           end
@@ -654,12 +673,18 @@ module ActiveRecord
 
         # 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
+          s = sql.gsub(/^\s*EXEC sp_executesql N'/i, "")
+
+          if s.match?(/^\s*INSERT INTO.*/i)
+            s.split(/INSERT INTO/i)[1]
+              .split(/OUTPUT INSERTED/i)[0]
+              .split(/(DEFAULT)?\s+VALUES/i)[0]
+              .match(/\s*([^(]*)/i)[0]
+          elsif s.match?(/^\s*UPDATE\s+.*/i)
+            s.match(/UPDATE\s+([^\(\s]+)\s*/i)[1]
+          else
+            s.match(/FROM\s+((\[[^\(\]]+\])|[^\(\s]+)\s*/i)[1]
+          end.strip
         end
 
         def default_constraint_name(table_name, column_name)

data/test/cases/adapter_test_sqlserver.rb

@@ -550,11 +550,23 @@ class AdapterTestSQLServer < ActiveRecord::TestCase
 
   describe 'table is in non-dbo schema' do
     it "records can be created successfully" do
-      Alien.create!(name: 'Trisolarans')
+      assert_difference("Alien.count", 1) do
+        Alien.create!(name: 'Trisolarans')
+      end
     end
 
     it 'records can be inserted using SQL' do
-      Alien.connection.exec_insert("insert into [test].[aliens] (id, name) VALUES(1, 'Trisolarans'), (2, 'Xenomorph')")
+      assert_difference("Alien.count", 2) do
+        Alien.connection.exec_insert("insert into [test].[aliens] (id, name) VALUES(1, 'Trisolarans'), (2, 'Xenomorph')")
+      end
+    end
+  end
+
+  describe 'table names contains spaces' do
+    it 'records can be created successfully' do
+      assert_difference("TableWithSpaces.count", 1) do
+        TableWithSpaces.create!(name: 'Bob')
+      end
     end
   end
 

data/test/cases/schema_dumper_test_sqlserver.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "cases/helper_sqlserver"
+require "stringio"
 
 class SchemaDumperTestSQLServer < ActiveRecord::TestCase
   before { all_tables }
@@ -141,7 +142,7 @@ class SchemaDumperTestSQLServer < ActiveRecord::TestCase
   it "honor nonstandard primary keys" do
     generate_schema_for_table("movies") do |output|
       match = output.match(%r{create_table "movies"(.*)do})
-      assert_not_nil(match, "nonstandardpk table not found")
+      assert_not_nil(match, "non-standard primary key table not found")
       assert_match %r(primary_key: "movieid"), match[1], "non-standard primary key not preserved"
     end
   end
@@ -159,14 +160,32 @@ class SchemaDumperTestSQLServer < ActiveRecord::TestCase
     _(output.scan('t.integer "unique_field"').length).must_equal(1)
   end
 
+  it "schemas are dumped and tables names only include non-default schema" do
+    stream = StringIO.new
+    ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+    generated_schema = stream.string
+
+    # Only generate non-default schemas. Default schema is 'dbo'.
+    assert_not_includes generated_schema, 'create_schema "dbo"'
+    assert_includes generated_schema, 'create_schema "test"'
+    assert_includes generated_schema, 'create_schema "test2"'
+
+    # Only non-default schemas should be included in table names. Default schema is 'dbo'.
+    assert_includes generated_schema, 'create_table "accounts"'
+    assert_includes generated_schema, 'create_table "test.aliens"'
+    assert_includes generated_schema, 'create_table "test2.sst_schema_test_mulitple_schema"'
+  end
+
   private
 
   def generate_schema_for_table(*table_names)
-    require "stringio"
+    previous_ignore_tables = ActiveRecord::SchemaDumper.ignore_tables
+    ActiveRecord::SchemaDumper.ignore_tables = all_tables - table_names
 
     stream = StringIO.new
     ActiveRecord::SchemaDumper.ignore_tables = all_tables - table_names
     ActiveRecord::SchemaDumper.dump(ActiveRecord::Base.connection, stream)
+
     @generated_schema = stream.string
     yield @generated_schema if block_given?
     @schema_lines = Hash.new
@@ -177,6 +196,8 @@ class SchemaDumperTestSQLServer < ActiveRecord::TestCase
       @schema_lines[Regexp.last_match[1]] = SchemaLine.new(line)
     end
     @generated_schema
+  ensure
+    ActiveRecord::SchemaDumper.ignore_tables = previous_ignore_tables
   end
 
   def line(column_name)

data/test/cases/schema_test_sqlserver.rb

@@ -39,7 +39,7 @@ class SchemaTestSQLServer < ActiveRecord::TestCase
       assert_equal 1, columns.select { |c| c.is_identity? }.size
     end
 
-    it "return correct varchar and nvarchar column limit length when table is in non dbo schema" do
+    it "return correct varchar and nvarchar column limit length when table is in non-dbo schema" do
       columns = connection.columns("test.sst_schema_columns")
 
       assert_equal 255, columns.find { |c| c.name == "name" }.limit
@@ -48,4 +48,50 @@ class SchemaTestSQLServer < ActiveRecord::TestCase
       assert_equal 1000, columns.find { |c| c.name == "n_description" }.limit
     end
   end
+
+  describe "parsing table name from raw SQL" do
+    describe 'SELECT statements' do
+      it do
+        assert_equal "[sst_schema_columns]", connection.send(:get_raw_table_name, "SELECT [sst_schema_columns].[id] FROM [sst_schema_columns]")
+      end
+
+      it do
+        assert_equal "sst_schema_columns", connection.send(:get_raw_table_name, "SELECT [sst_schema_columns].[id] FROM sst_schema_columns")
+      end
+
+      it do
+        assert_equal "[WITH - SPACES]", connection.send(:get_raw_table_name, "SELECT id FROM [WITH - SPACES]")
+      end
+
+      it do
+        assert_equal "[WITH - SPACES$DOLLAR]", connection.send(:get_raw_table_name, "SELECT id FROM [WITH - SPACES$DOLLAR]")
+      end
+    end
+
+    describe 'INSERT statements' do
+      it do
+        assert_equal "[dashboards]", connection.send(:get_raw_table_name, "INSERT INTO [dashboards] DEFAULT VALUES; SELECT CAST(SCOPE_IDENTITY() AS bigint) AS Ident")
+      end
+
+      it do
+        assert_equal "lock_without_defaults", connection.send(:get_raw_table_name, "INSERT INTO lock_without_defaults(title) VALUES('title1')")
+      end
+
+      it do
+        assert_equal "json_data_type", connection.send(:get_raw_table_name, "insert into json_data_type (payload) VALUES ('null')")
+      end
+
+      it do
+        assert_equal "[auto_increments]", connection.send(:get_raw_table_name, "INSERT INTO [auto_increments] OUTPUT INSERTED.[id] DEFAULT VALUES")
+      end
+
+      it do
+        assert_equal "[WITH - SPACES]", connection.send(:get_raw_table_name, "EXEC sp_executesql N'INSERT INTO [WITH - SPACES] ([external_id]) OUTPUT INSERTED.[id] VALUES (@0)', N'@0 bigint', @0 = 10")
+      end
+
+      it do
+        assert_equal "[test].[aliens]", connection.send(:get_raw_table_name, "EXEC sp_executesql N'INSERT INTO [test].[aliens] ([name]) OUTPUT INSERTED.[id] VALUES (@0)', N'@0 varchar(255)', @0 = 'Trisolarans'")
+      end
+    end
+  end
 end

data/test/models/sqlserver/table_with_spaces.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class TableWithSpaces < ActiveRecord::Base
+  self.table_name = "A Table With Spaces"
+end

data/test/schema/sqlserver_specific_schema.rb

@@ -151,6 +151,10 @@ ActiveRecord::Schema.define do
     SELECT GETUTCDATE() utcdate
   SQL
 
+  create_table 'A Table With Spaces', force: true do |t|
+    t.string :name
+  end
+
   # Constraints
 
   create_table(:sst_has_fks, 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.4
+  version: 7.1.5
 platform: ruby
 authors:
 - Ken Collins
@@ -15,7 +15,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-04 00:00:00.000000000 Z
+date: 2024-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -212,6 +212,7 @@ files:
 - test/models/sqlserver/string_default.rb
 - test/models/sqlserver/string_defaults_big_view.rb
 - test/models/sqlserver/string_defaults_view.rb
+- test/models/sqlserver/table_with_spaces.rb
 - test/models/sqlserver/tinyint_pk.rb
 - test/models/sqlserver/trigger.rb
 - test/models/sqlserver/trigger_history.rb
@@ -239,8 +240,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.4/CHANGELOG.md
-  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v7.1.4
+  changelog_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/blob/v7.1.5/CHANGELOG.md
+  source_code_uri: https://github.com/rails-sqlserver/activerecord-sqlserver-adapter/tree/v7.1.5
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -329,6 +330,7 @@ test_files:
 - test/models/sqlserver/string_default.rb
 - test/models/sqlserver/string_defaults_big_view.rb
 - test/models/sqlserver/string_defaults_view.rb
+- test/models/sqlserver/table_with_spaces.rb
 - test/models/sqlserver/tinyint_pk.rb
 - test/models/sqlserver/trigger.rb
 - test/models/sqlserver/trigger_history.rb