activerecord-spanner-adapter 1.2.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5796cf16ff55f858459e9d87da1cdd362b8b8a097161e3e7bda6283b56f6036a
-  data.tar.gz: 9e2b8b7f9f4a72b7fe70d139281b82468d019cc46065368bd9fc0dc9e687a722
+  metadata.gz: 499376d85989274623aa1cda4cb9197e14636b42cd5cf5d5bda4b3fbdb2a6494
+  data.tar.gz: 4e0f7e384b4450b28581523a79540416567aa44745e44377a1f7744e11ff95e7
 SHA512:
-  metadata.gz: 4899a089f30648b42a68386da0c43553c560c620178ff5609153cc67c42a08ada041b2dba565870c1b63cc067d3bbcd2208f97f290db93cda4dc2ba8c0dccb6a
-  data.tar.gz: f3f3fca35b1e83a02fbd073cf5a8d969d411ac93588cb41c828e5a596d74cb8485f8bc23956e205ea1737a30bada65f65812ca0b24c8f02bb1287ed2106c6134
+  metadata.gz: a3d5ff8b79e774c6eb6c74431162366543d2476a8f2e7eb3f3f2d81dac249b0493a773b09cd787cdf5a8dd5b287d85170021b2e7c47c2aba9d06f76a77c2b9d6
+  data.tar.gz: 28bebd4c40535b80239992f66aed5030744623c21c00f875b548fac2c0318280871e83c294e8b87681a2376d34446050cee60283da469ff4fe175b2ad78685a6

data/.github/CODEOWNERS

@@ -4,4 +4,4 @@
 # For syntax help see:
 # https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-code-owners#codeowners-syntax
 
-*     @googleapis/ruby-team @skuruppu @hengfengli @olavloite @xiangshen-dk
+*     @googleapis/ruby-team @olavloite @rahul2393 @ansh0l

data/.github/blunderbuss.yml

@@ -1,2 +1,2 @@
 assign_issues:
-  - hengfengli
+  - olavloite

data/.github/workflows/acceptance-tests-on-emulator.yaml

@@ -18,16 +18,16 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        ruby: [2.6, 2.7, 3.0]
-        ar: [6.0.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1]
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4"]
         # Exclude combinations that are not supported.
         exclude:
-          - ruby: 3.0
-            ar: 6.0.5.1
-          - ruby: 2.6
-            ar: 7.0.2.4
-          - ruby: 2.6
-            ar: 7.0.3.1
+          - ruby: "3.0"
+            ar: "~> 6.0.6"
+          - ruby: "3.1"
+            ar: "~> 6.0.6"
+          - ruby: "2.6"
+            ar: "~> 7.0.4"
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:

data/.github/workflows/ci.yaml

@@ -10,14 +10,16 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        ruby: ["2.6", "2.7", "3.0"]
-        ar: ["6.0.4", "6.1.4", "7.0.2.4"]
+        ruby: ["2.6", "2.7", "3.0", "3.1"]
+        ar: ["~> 6.0.6", "~> 6.1.7", "~> 7.0.4"]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: "3.0"
-            ar: "6.0.4"
+            ar: "~> 6.0.6"
+          - ruby: "3.1"
+            ar: "~> 6.0.6"
           - ruby: "2.6"
-            ar: "7.0.2.4"
+            ar: "~> 7.0.4"
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:

data/.github/workflows/nightly-acceptance-tests-on-emulator.yaml

@@ -19,8 +19,8 @@ jobs:
       max-parallel: 4
       matrix:
         # Run acceptance tests all supported combinations of Ruby and ActiveRecord.
-        ruby: [2.5, 2.6, 2.7, 3.0]
-        ar: [6.0.0, 6.0.1, 6.0.2.2, 6.0.3.7, 6.0.4, 6.1.3.2, 6.1.4.7, 6.1.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1]
+        ruby: [2.6, 2.7, 3.0, 3.1]
+        ar: [6.0.0, 6.0.1, 6.0.2.2, 6.0.3.7, 6.0.4, 6.1.3.2, 6.1.4.7, 6.1.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1, 7.0.4]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: 3.0
@@ -33,14 +33,22 @@ jobs:
             ar: 6.0.3.7
           - ruby: 3.0
             ar: 6.0.4
-          - ruby: 2.5
-            ar: 7.0.2.4
+          - ruby: 3.1
+            ar: 6.0.0
+          - ruby: 3.1
+            ar: 6.0.1
+          - ruby: 3.1
+            ar: 6.0.2.2
+          - ruby: 3.1
+            ar: 6.0.3.7
+          - ruby: 3.1
+            ar: 6.0.4
           - ruby: 2.6
             ar: 7.0.2.4
-          - ruby: 2.5
-            ar: 7.0.3.1
           - ruby: 2.6
             ar: 7.0.3.1
+          - ruby: 2.6
+            ar: 7.0.4
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:

data/.github/workflows/nightly-unit-tests.yaml

@@ -11,8 +11,8 @@ jobs:
       max-parallel: 4
       matrix:
         # Run unit tests all supported combinations of Ruby and ActiveRecord.
-        ruby: [2.5, 2.6, 2.7, 3.0]
-        ar: [6.0.0, 6.0.1, 6.0.2.2, 6.0.3.7, 6.0.4, 6.1.3.2, 6.1.4.7, 6.1.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1]
+        ruby: [2.6, 2.7, 3.0, 3.1]
+        ar: [6.0.0, 6.0.1, 6.0.2.2, 6.0.3.7, 6.0.4, 6.1.3.2, 6.1.4.7, 6.1.5.1, 6.1.6.1, 7.0.2.4, 7.0.3.1, 7.0.4]
         # Exclude combinations that are not supported.
         exclude:
           - ruby: 3.0
@@ -25,14 +25,22 @@ jobs:
             ar: 6.0.3.7
           - ruby: 3.0
             ar: 6.0.4
-          - ruby: 2.5
-            ar: 7.0.2.4
+          - ruby: 3.1
+            ar: 6.0.0
+          - ruby: 3.1
+            ar: 6.0.1
+          - ruby: 3.1
+            ar: 6.0.2.2
+          - ruby: 3.1
+            ar: 6.0.3.7
+          - ruby: 3.1
+            ar: 6.0.4
           - ruby: 2.6
             ar: 7.0.2.4
-          - ruby: 2.5
-            ar: 7.0.3.1
           - ruby: 2.6
             ar: 7.0.3.1
+          - ruby: 2.6
+            ar: 7.0.4
     env:
       AR_VERSION: ${{ matrix.ar }}
     steps:

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.2.2"
+  ".": "1.4.0"
 }

data/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+### 1.4.0 (2023-01-18)
+
+#### Features
+
+* dropped support for Ruby 2.5 ([#236](https://github.com/googleapis/ruby-spanner-activerecord/issues/236)) 
+
+### 1.3.1 (2022-12-15)
+
+#### Bug Fixes
+
+* build error for ruby 2.5 ([#216](https://github.com/googleapis/ruby-spanner-activerecord/issues/216)) 
+
+### 1.3.0 (2022-12-08)
+
+#### Features
+
+* add check constraint support to migrations ([#205](https://github.com/googleapis/ruby-spanner-activerecord/issues/205)) 
+* allows passing of type parameter when creating parent_key column ([#195](https://github.com/googleapis/ruby-spanner-activerecord/issues/195)) 
+* include index options in the output of SchemaDumper ([#203](https://github.com/googleapis/ruby-spanner-activerecord/issues/203)) 
+* schema_dumper should use DDL batch ([#207](https://github.com/googleapis/ruby-spanner-activerecord/issues/207)) 
+* support column DEFAULT expressions in migrations ([#196](https://github.com/googleapis/ruby-spanner-activerecord/issues/196)) 
+#### Bug Fixes
+
+* ignore no database when recreating ([#208](https://github.com/googleapis/ruby-spanner-activerecord/issues/208)) 
+#### Documentation
+
+* fix typo in example of interleaved-tables ([#209](https://github.com/googleapis/ruby-spanner-activerecord/issues/209)) 
+
 ### 1.2.2 (2022-08-29)
 
 #### Documentation

data/Gemfile

@@ -4,7 +4,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "activerecord", ENV.fetch("AR_VERSION", "~> 6.1.6.1")
-gem "minitest", "~> 5.15.0"
+gem "minitest", "~> 5.16.3"
 gem "pry", "~> 0.13.0"
 gem "pry-byebug", "~> 3.9.0"
 

data/README.md

@@ -13,6 +13,9 @@ This project provides a Cloud Spanner adapter for ActiveRecord. It supports the
 Known limitations are listed in the [Limitations](#limitations) section.
 Please report any problems that you might encounter by [creating a new issue](https://github.com/googleapis/ruby-spanner-activerecord/issues/new).
 
+This adapter only supports GoogleSQL-dialect Cloud Spanner databases. PostgreSQL-dialect
+databases are not supported.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -83,6 +86,7 @@ Table without Primary Key| Cloud Spanner support does not support tables without
 Table names CANNOT have spaces within them whether back-ticked or not|Cloud Spanner DOES NOT support tables with spaces in them for example `Entity ID`|Ensure that your table names don't contain spaces.
 Table names CANNOT have punctuation marks and MUST contain valid UTF-8|Cloud Spanner DOES NOT support punctuation marks e.g. periods ".", question marks "?" in table names|Ensure that your table names don't contain punctuation marks.
 Index with fields length [add_index](https://apidock.com/rails/v5.2.3/ActiveRecord/ConnectionAdapters/SchemaStatements/add_index)|Cloud Spanner does not support index with fields length | Ensure that your database definition does not include index definitions with field lengths.
+Only GoogleSQL-dialect databases| Cloud Spanner supports both GoogleSQL- and PostgreSQL-dialect databases. This adapter only supports GoogleSQL-dialect databases. | Ensure that your database uses the GoogleSQL dialect.
 
 ## Contributing
 

data/acceptance/cases/migration/change_table_test.rb

@@ -30,77 +30,87 @@ module ActiveRecord
 
       def test_remove_references_column_type_with_polymorphic_removes_type
         with_change_table do |t|
-          @connection.expect :remove_reference, nil, [:delete_me, :taggable, polymorphic: true]
+          @connection.expect :remove_reference, nil, [:delete_me, :taggable], polymorphic: true
           t.remove_references :taggable, polymorphic: true
         end
       end
 
       def test_references_column_type_with_polymorphic_and_options_null_is_false_adds_table_flag
         with_change_table do |t|
-          @connection.expect :add_reference, nil, [:delete_me, :taggable, polymorphic: true, null: false]
+          @connection.expect :add_reference, nil, [:delete_me, :taggable], polymorphic: true, null: false
           t.references :taggable, polymorphic: true, null: false
         end
       end
 
       def test_remove_references_column_type_with_polymorphic_and_options_null_is_false_removes_table_flag
         with_change_table do |t|
-          @connection.expect :remove_reference, nil, [:delete_me, :taggable, polymorphic: true, null: false]
+          @connection.expect :remove_reference, nil, [:delete_me, :taggable], polymorphic: true, null: false
           t.remove_references :taggable, polymorphic: true, null: false
         end
       end
 
       def test_references_column_type_with_polymorphic_and_type
         with_change_table do |t|
-          @connection.expect :add_reference, nil, [:delete_me, :taggable, polymorphic: true, type: :string]
+          @connection.expect :add_reference, nil, [:delete_me, :taggable], polymorphic: true, type: :string
           t.references :taggable, polymorphic: true, type: :string
         end
       end
 
       def test_remove_references_column_type_with_polymorphic_and_type
         with_change_table do |t|
-          @connection.expect :remove_reference, nil, [:delete_me, :taggable, polymorphic: true, type: :string]
+          @connection.expect :remove_reference, nil, [:delete_me, :taggable], polymorphic: true, type: :string
           t.remove_references :taggable, polymorphic: true, type: :string
         end
       end
 
       def test_timestamps_creates_updated_at_and_created_at
         with_change_table do |t|
-          @connection.expect :add_timestamps, nil, [:delete_me, null: true]
+          @connection.expect :add_timestamps, nil, [:delete_me], null: true
           t.timestamps null: true
         end
       end
 
       def test_remove_timestamps_creates_updated_at_and_created_at
         with_change_table do |t|
-          @connection.expect :remove_timestamps, nil, [:delete_me, { null: true }]
+          @connection.expect :remove_timestamps, nil, [:delete_me], null: true
           t.remove_timestamps(null: true)
         end
       end
 
       def test_primary_key_creates_primary_key_column
         with_change_table do |t|
-          @connection.expect :add_column, nil, [:delete_me, :id, :primary_key, primary_key: true, first: true]
+          @connection.expect :add_column, nil, [:delete_me, :id, :primary_key], primary_key: true, first: true
           t.primary_key :id, first: true
         end
       end
 
       def test_index_exists
         with_change_table do |t|
-          @connection.expect :index_exists?, nil, [:delete_me, :bar, {}]
-          t.index_exists?(:bar)
+          if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3")
+            @connection.expect :index_exists?, nil, [:delete_me, :bar, {}]
+            t.index_exists?(:bar, {})
+          else
+            @connection.expect :index_exists?, nil, [:delete_me, :bar]
+            t.index_exists?(:bar)
+          end
         end
       end
 
       def test_index_exists_with_options
         with_change_table do |t|
-          @connection.expect :index_exists?, nil, [:delete_me, :bar, { unique: true }]
-          t.index_exists?(:bar, unique: true)
+          if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3")
+            @connection.expect :index_exists?, nil, [:delete_me, :bar, {unique: true}]
+            t.index_exists?(:bar, {unique: true})
+          else
+            @connection.expect :index_exists?, nil, [:delete_me, :bar], unique: true
+            t.index_exists?(:bar, unique: true)
+          end
         end
       end
 
       def test_remove_drops_multiple_columns_when_column_options_are_given
         with_change_table do |t|
-          @connection.expect :remove_columns, nil, [:delete_me, :bar, :baz, type: :string, null: false]
+          @connection.expect :remove_columns, nil, [:delete_me, :bar, :baz], type: :string, null: false
           t.remove :bar, :baz, type: :string, null: false
         end
       end

data/acceptance/cases/migration/schema_dumper_test.rb

@@ -0,0 +1,69 @@
+# Copyright 2022 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+require "test_helper"
+
+module ActiveRecord
+  class Migration
+    class IndexTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Migration::TestHelper
+
+      def test_dump_schema_contains_start_batch_ddl
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("connection.start_batch_ddl")
+      end
+
+      def test_dump_schema_contains_run_batch
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("  connection.run_batch\n"\
+                                      "rescue\n"\
+                                      "  abort_batch\n"\
+                                      "  raise")
+      end
+
+      def test_dump_schema_contains_albums_table
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("create_table \"albums\", primary_key: \"albumid\"")
+      end
+
+      def test_dump_schema_contains_interleaved_index
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("t.index [\"singerid\", \"albumid\", \"title\"], name: \"index_tracks_on_singerid_and_albumid_and_title\", order: { singerid: :asc, albumid: :asc, title: :asc }, null_filtered: true, interleave_in: \"albums\""), schema.string
+      end
+
+      def test_dump_schema_should_not_contain_id_limit
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert !schema.string.include?("id: { limit: 8 }")
+      end
+
+      def test_dump_schema_contains_commit_timestamp
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("t.time \"last_updated\", allow_commit_timestamp: true"), schema.string
+      end
+
+      def test_dump_schema_contains_virtual_column
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("t.virtual \"full_name\", type: :string, as: \"COALESCE(first_name || ' ', '') || last_name\", stored: true"), schema.string
+      end
+    end
+  end
+end

data/acceptance/cases/models/generated_column_test.rb

@@ -76,13 +76,24 @@ module ActiveRecord
         end
       end
 
+      VERSION_7 = ActiveRecord.gem_version >= Gem::Version.create("7.0.0")
+
+      def assert_raises_below_ar_7(ex, &test)
+        if VERSION_7
+          assert_nothing_raised &test
+        else
+          assert_raises ex, &test
+        end
+      end
+
       def test_create_with_value_for_generated_column
         # Note: The statement itself will not fail for an explicit transaction that uses buffered transactions.
         # Instead, the commit will fail. That is tested in a separate test case.
         [nil, :serializable].each do |isolation|
           run_in_transaction isolation do
-            assert_raises ActiveRecord::StatementInvalid do
-              Singer.create first_name: "Pete", last_name: "Allison", full_name: "Alice Peterson"
+            assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
+              singer = Singer.create first_name: "Pete", last_name: "Allison", full_name: "Alice Peterson"
+              assert_equal "Pete Allison", singer.reload.full_name
             end
           end
         end
@@ -90,10 +101,11 @@ module ActiveRecord
 
       def test_create_with_value_for_generated_column_buffered_mutations
         # The transaction itself will raise an error, as the failure occurs during the commit.
-        assert_raises ActiveRecord::StatementInvalid do
-          Singer.transaction isolation: :buffered_mutations do
+        assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
+          singer = run_in_transaction :buffered_mutations do
             Singer.create first_name: "Pete", last_name: "Allison", full_name: "Alice Peterson"
           end
+          assert_equal "Pete Allison", singer.reload.full_name
         end
       end
 
@@ -104,10 +116,11 @@ module ActiveRecord
           singer = Singer.create first_name: "Pete", last_name: "Allison"
           singer.reload # reload to ensure the full_name attribute is populated.
           run_in_transaction isolation do
-            assert_raises ActiveRecord::StatementInvalid do
+            assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
               Singer.update full_name: "Alice Peterson"
             end
           end
+          assert_equal "Pete Allison", singer.reload.full_name
         end
       end
 
@@ -115,11 +128,12 @@ module ActiveRecord
         singer = Singer.create first_name: "Pete", last_name: "Allison"
         singer.reload # reload to ensure the full_name attribute is populated.
         # The transaction itself will raise an error, as the failure occurs during the commit.
-        assert_raises ActiveRecord::StatementInvalid do
-          Singer.transaction isolation: :buffered_mutations do
+        assert_raises_below_ar_7 ActiveRecord::StatementInvalid do
+          run_in_transaction :buffered_mutations do
             Singer.update full_name: "Alice Peterson"
           end
         end
+        assert_equal "Pete Allison", singer.reload.full_name
       end
     end
   end

data/acceptance/cases/models/interleave_test.rb

@@ -0,0 +1,36 @@
+# Copyright 2021 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+require "test_helper"
+require "models/singer"
+require "models/album_partial_disabled"
+
+module ActiveRecord
+  module Model
+    class InterleaveTest < SpannerAdapter::TestCase
+      include SpannerAdapter::Associations::TestHelper
+
+      attr_accessor :singer
+
+      def setup
+        super
+
+        @singer = Singer.create first_name: "FirstName", last_name: "LastName"
+      end
+
+      def teardown
+        Album.destroy_all
+        Singer.destroy_all
+      end
+
+      def test_with_partial_inserts_disabled
+        AlbumPartialDisabled.create! title: "Title3", singer: singer
+      end
+    end
+  end
+end

data/acceptance/cases/models/logging_test.rb

@@ -0,0 +1,57 @@
+# Copyright 2022 Google LLC
+#
+# Use of this source code is governed by an MIT-style
+# license that can be found in the LICENSE file or at
+# https://opensource.org/licenses/MIT.
+
+# frozen_string_literal: true
+
+require "active_support/log_subscriber/test_helper"
+require "test_helper"
+require "models/post"
+
+module ActiveRecord
+  module Model
+    class LoggingTest < SpannerAdapter::TestCase
+      include ActiveSupport::LogSubscriber::TestHelper
+
+      setup do
+        ActiveRecord::LogSubscriber.attach_to(:active_record)
+      end
+
+      def test_logs_without_binds
+        skip "This test sometimes fails because nothing is logged (or marked as logged by the test logger)"
+
+        published_time = Time.new(2016, 05, 11, 19, 0, 0)
+        Post.where(published_time: published_time, title: 'Title - 1').first
+
+        wait
+        assert @logger.logged(:debug).length >= 1
+        assert_no_match "[[\"published_time\", \"#{published_time.utc.iso8601(9)}\"], [\"title\", \"Title - 1\"]",
+                        @logger.logged(:debug).last
+      end
+
+      def test_logs_with_binds
+        skip "This test sometimes fails because nothing is logged (or marked as logged by the test logger)"
+
+        ActiveRecord::ConnectionAdapters::SpannerAdapter.log_statement_binds = true
+
+        published_time = Time.new(2016, 05, 11, 19, 0, 0)
+        Post.where(published_time: published_time, title: 'Title - 1').first
+
+        wait
+        assert @logger.logged(:debug).length >= 1
+        assert_match "[[\"published_time\", \"#{published_time.utc.iso8601(9)}\"], [\"title\", \"Title - 1\"]",
+                     @logger.logged(:debug).last
+      ensure
+        ActiveRecord::ConnectionAdapters::SpannerAdapter.log_statement_binds = false
+      end
+
+      private
+
+      def set_logger(logger)
+        ActiveRecord::Base.logger = logger
+      end
+    end
+  end
+end

data/acceptance/cases/models/query_test.rb

@@ -166,6 +166,11 @@ module ActiveRecord
         assert_nil post.id
         assert_equal "Title - 1", post.title
       end
+
+      def test_to_sql
+        assert_equal "SELECT `comments`.* FROM `comments` WHERE `comments`.`comment` = 'Comment - 2'",
+                     Comment.where(comment: 'Comment - 2').to_sql
+      end
     end
   end
-end
+end