activerecord-spanner-adapter 1.6.1 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931e6b17bf3e6d6b068c57ca879bc0dbb06933790101aa05415514c6448fd004
-  data.tar.gz: c4981e814899be433830e0380f69060dfa589ec39dfa7e831aad616e224030ec
+  metadata.gz: 2c2a9a0a36a471ac93bdb0d59e50cc9b8e5c6647655487dc55a1d9e398abcf46
+  data.tar.gz: de680bcac6cf0f491bd0007d80d48496cf5e74b5eddf17d13b58353f06b818da
 SHA512:
-  metadata.gz: a989bdd8195d98206802a05294b09a53fe76c0684fba781d22dc15aaa5a38106ee3f193555cbe83e5f65254e3b39d95ed1cfb6445ded245ad80683d9752fdfd2
-  data.tar.gz: 0dbe1209ccad8da313fafb110bbb4fb2c1ef9ff9209230e88673f031ad02c0c372a13422fd2a5756fb0bc97a2318c003433350e071f64bcef37ba5a7754e868e
+  metadata.gz: '0658d456b4d6377bf5f95f44296869404ac9ac1c65aaa25360080bab1df7c122c4b7aba28992f5030e6465e51fefa1b6630a4e79547c65446edd29c40954ca61'
+  data.tar.gz: 470e026052a753f08d59f2824044894afe84d5601735270250c09368c7541ef98d5356a6ca6810c10755033a81601afb40826656967bdf8cda132563a2e9b267

data/.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "1.6.1"
+  ".": "1.6.3"
 }

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+### 1.6.3 (2024-08-31)
+
+#### Bug Fixes
+
+* a few Ruby DSL schema dump bug fixes ([#308](https://github.com/googleapis/ruby-spanner-activerecord/issues/308)) 
+#### Documentation
+
+* update bit-reversed sequence sample ([#303](https://github.com/googleapis/ruby-spanner-activerecord/issues/303)) 
+
+### 1.6.2 (2024-02-19)
+
+#### Bug Fixes
+
+* failed to convert active model type to spanner type under certain condition ([#299](https://github.com/googleapis/ruby-spanner-activerecord/issues/299)) 
+
 ### 1.6.1 (2024-02-05)
 
 #### Bug Fixes

data/Gemfile

@@ -4,12 +4,12 @@ source "https://rubygems.org"
 gemspec
 
 gem "activerecord", ENV.fetch("AR_VERSION", "~> 6.1.6.1")
-gem "minitest", "~> 5.20.0"
+gem "minitest", "~> 5.25.0"
 gem "minitest-rg", "~> 5.3.0"
 gem "pry", "~> 0.13.0"
 gem "pry-byebug", "~> 3.9.0"
 # Add sqlite3 for testing for compatibility with other adapters.
-gem "sqlite3"
+gem 'sqlite3', '~> 1.4'
 
 # Required for samples and testing.
 install_if -> { ENV.fetch("AR_VERSION", "~> 6.1.6.1").dup.to_s.sub("~>", "").strip < "7.1.0" && !ENV["SKIP_COMPOSITE_PK"] } do

data/README.md

@@ -77,6 +77,7 @@ __NOTE__: You do need to have [Docker](https://docs.docker.com/get-docker/) inst
 Some noteworthy examples in the snippets directory:
 - [quickstart](examples/snippets/quickstart): A simple application that shows how to create and query a simple database containing two tables.
 - [migrations](examples/snippets/migrations): Shows a best-practice for executing migrations on Cloud Spanner.
+- [bit-reversed-sequences](examples/snippets/bit-reversed-sequence): Shows how to use bit-reversed sequences for primary keys.
 - [read-write-transactions](examples/snippets/read-write-transactions): Shows how to execute transactions on Cloud Spanner.
 - [read-only-transactions](examples/snippets/read-only-transactions): Shows how to execute read-only transactions on Cloud Spanner.
 - [bulk-insert](examples/snippets/bulk-insert): Shows the best way to insert a large number of new records.

data/acceptance/cases/migration/schema_dumper_test.rb

@@ -73,6 +73,20 @@ module ActiveRecord
         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
+
+      def test_dump_schema_contains_string_array
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("t.string \"col_array_string\", array: true"), schema.string
+      end
+
+      def test_dump_schema_index_storing
+        connection = ActiveRecord::Base.connection
+        schema = StringIO.new
+        ActiveRecord::SchemaDumper.dump connection, schema
+        assert schema.string.include?("t.index [\"last_name\"], name: \"index_singers_on_last_name\", order: { last_name: :asc }, storing: [\"first_name\", \"tracks_count\"]"), schema.string
+      end
     end
   end
 end

data/acceptance/cases/tasks/database_tasks_test.rb

@@ -226,6 +226,7 @@ CREATE TABLE singers (
   lock_version INT64,
   full_name STRING(MAX) AS (COALESCE(first_name || ' ', '') || last_name) STORED,
 ) PRIMARY KEY(singerid);
+CREATE INDEX index_singers_on_last_name ON singers(last_name) STORING (tracks_count, first_name);
 CREATE TABLE albums (
   albumid INT64 NOT NULL,
   singerid INT64 NOT NULL,
@@ -383,6 +384,7 @@ CREATE TABLE singers (
   lock_version INT64,
   full_name STRING(MAX) AS (COALESCE(first_name || ' ', '') || last_name) STORED,
 ) PRIMARY KEY(singerid);
+CREATE INDEX index_singers_on_last_name ON singers(last_name) STORING (tracks_count, first_name);
 CREATE TABLE albums (
   singerid INT64 NOT NULL,
   albumid INT64 NOT NULL,
@@ -547,6 +549,7 @@ CREATE TABLE singers (
   lock_version INT64,
   full_name STRING(MAX) AS (COALESCE(first_name || ' ', '') || last_name) STORED,
 ) PRIMARY KEY(singerid);
+CREATE INDEX index_singers_on_last_name ON singers(last_name) STORING (tracks_count, first_name);
 CREATE TABLE albums (
   albumid INT64 NOT NULL,
   singerid INT64 NOT NULL,
@@ -707,6 +710,7 @@ CREATE TABLE singers (
   lock_version INT64,
   full_name STRING(MAX) AS (COALESCE(first_name || ' ', '') || last_name) STORED,
 ) PRIMARY KEY(singerid);
+CREATE INDEX index_singers_on_last_name ON singers(last_name) STORING (tracks_count, first_name);
 CREATE TABLE albums (
   singerid INT64 NOT NULL,
   albumid INT64 NOT NULL,

data/acceptance/schema/schema.rb

@@ -126,6 +126,7 @@ def create_tables_in_test_schema
         t.integer :lock_version
         t.virtual :full_name, type: :string, as: "COALESCE(first_name || ' ', '') || last_name", stored: true
       end
+      add_index :singers, :last_name, storing: %i[tracks_count first_name]
 
       if is_7_1_or_higher?
         create_table :albums, primary_key: [:singerid, :albumid] do |t|

data/activerecord-spanner-adapter.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.add_dependency "google-cloud-spanner", "~> 2.18"
+  # Pin gRPC to 1.64.3, as 1.65 and 1.66 cause test runs to hang randomly.
+  spec.add_dependency "grpc", "1.64.3"
   spec.add_runtime_dependency "activerecord", [">= 6.0.0", "< 7.2"]
 
   spec.add_development_dependency "autotest-suffix", "~> 1.1"

data/examples/snippets/bit-reversed-sequence/README.md

@@ -5,6 +5,12 @@ This example shows how to use a bit-reversed sequence to generate the primary ke
 See https://cloud.google.com/spanner/docs/primary-key-default-value#bit-reversed-sequence for more information
 about bit-reversed sequences in Cloud Spanner.
 
+## Requirements
+Using bit-reversed sequences for generating primary key values in ActiveRecord has the following requirements:
+1. You must use __ActiveRecord version 7.1 or higher__.
+2. Your models must include a sequence name like this: `self.sequence_name = :singer_sequence`
+3. You must create the bit-reversed sequence using a SQL statement in your migrations.
+
 ## Creating Tables with Bit-Reversed Sequences in ActiveRecord
 You can create bit-reversed sequences using migrations in ActiveRecord by executing a SQL statement using the underlying
 connection.

data/examples/snippets/bit-reversed-sequence/db/migrate/01_create_tables.rb

@@ -8,15 +8,12 @@ class CreateTables < ActiveRecord::Migration[7.1]
   def change
     # Execute the entire migration as one DDL batch.
     connection.ddl_batch do
-      # TODO: Uncomment when bit-reversed sequences are supported in the emulator.
-      # connection.execute "create sequence singer_sequence OPTIONS (sequence_kind = 'bit_reversed_positive')"
+      connection.execute "create sequence singer_sequence OPTIONS (sequence_kind = 'bit_reversed_positive')"
 
       # Explicitly define the primary key.
       create_table :singers, id: false, primary_key: :singerid do |t|
-        # TODO: Uncomment when bit-reversed sequences are supported in the emulator.
-        # t.integer :singerid, primary_key: true, null: false,
-        #           default: -> { "GET_NEXT_SEQUENCE_VALUE(SEQUENCE singer_sequence)" }
-        t.integer :singerid, primary_key: true, null: false, default: -> { "FARM_FINGERPRINT(GENERATE_UUID())" }
+        t.integer :singerid, primary_key: true, null: false,
+                  default: -> { "GET_NEXT_SEQUENCE_VALUE(SEQUENCE singer_sequence)" }
         t.string :first_name
         t.string :last_name
       end

data/examples/snippets/bit-reversed-sequence/db/schema.rb

@@ -19,7 +19,7 @@ ActiveRecord::Schema[7.1].define(version: 1) do
     t.string "title"
   end
 
-  create_table "singers", primary_key: "singerid", default: -> { "FARM_FINGERPRINT(GENERATE_UUID())" }, force: :cascade do |t|
+  create_table "singers", primary_key: "singerid", default: -> { "GET_NEXT_SEQUENCE_VALUE(SEQUENCE singer_sequence)" }, force: :cascade do |t|
     t.string "first_name"
     t.string "last_name"
   end

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

@@ -27,6 +27,8 @@ module ActiveRecord
             spec = { type: schema_type(column).inspect }.merge! spec
           end
 
+          spec[:array] = true if column.sql_type.start_with? "ARRAY<"
+
           spec
         end
 
@@ -54,7 +56,7 @@ module ActiveRecord
           index_parts = super
           index_parts << "null_filtered: #{index.null_filtered.inspect}" if index.null_filtered
           index_parts << "interleave_in: #{index.interleave_in.inspect}" if index.interleave_in
-          index_parts << "storing: #{format_index_parts index.storing}" if index.storing.present?
+          index_parts << "storing: #{format_index_parts index.storing.sort}" if index.storing.present?
           index_parts
         end
 

data/lib/active_record/type/spanner/spanner_active_record_converter.rb

@@ -23,6 +23,9 @@ module ActiveRecord
         ##
         # Converts an ActiveModel::Type to a Spanner type code.
         def self.convert_active_model_type_to_spanner type # rubocop:disable Metrics/CyclomaticComplexity
+          # Unwrap the underlying object if the type is a DelegateClass.
+          type = type.__getobj__ if type.respond_to? :__getobj__
+
           case type
           when NilClass then nil
           when ActiveModel::Type::Integer, ActiveModel::Type::BigInteger then :INT64

data/lib/activerecord_spanner_adapter/version.rb

@@ -5,5 +5,5 @@
 # https://opensource.org/licenses/MIT.
 
 module ActiveRecordSpannerAdapter
-  VERSION = "1.6.1".freeze
+  VERSION = "1.6.3".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activerecord-spanner-adapter
 version: !ruby/object:Gem::Version
-  version: 1.6.1
+  version: 1.6.3
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-06 00:00:00.000000000 Z
+date: 2024-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-spanner
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.18'
+- !ruby/object:Gem::Dependency
+  name: grpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.64.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.64.3
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -230,8 +244,6 @@ files:
 - ".github/workflows/nightly-acceptance-tests-on-emulator.yaml"
 - ".github/workflows/nightly-acceptance-tests-on-production.yaml"
 - ".github/workflows/nightly-unit-tests.yaml"
-- ".github/workflows/release-please-label.yml"
-- ".github/workflows/release-please.yml"
 - ".github/workflows/rubocop.yaml"
 - ".gitignore"
 - ".kokoro/populate-secrets.sh"
@@ -577,7 +589,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.6
 signing_key: 
 specification_version: 4
 summary: Rails ActiveRecord connector for Google Spanner Database

data/.github/workflows/release-please-label.yml

@@ -1,25 +0,0 @@
-name: release-please-label
-on:
-  pull_request_target:
-    branches:
-      - main
-    types:
-      - opened
-jobs:
-  release-please-label:
-    if: "${{ github.event.sender.login == 'yoshi-code-bot' && startsWith(github.event.pull_request.title, 'chore(main): release ') }}"
-    runs-on: ubuntu-latest
-    steps:
-      - name: ReleaseLabel
-        uses: actions/github-script@v7
-        with:
-          github-token: ${{secrets.YOSHI_APPROVER_TOKEN}}
-          script: |
-            core.info('Labeling release');
-            await github.rest.issues.addLabels({
-              owner: context.repo.owner,
-              repo: context.repo.repo,
-              issue_number: context.payload.pull_request.number,
-              labels: ['autorelease: pending']
-            });
-            core.info('Labeled');

data/.github/workflows/release-please.yml

@@ -1,38 +0,0 @@
-name: Release-Please
-on:
-  workflow_dispatch:
-    inputs:
-      gem:
-        description: "Name of single gem to release. Leave blank to check all gems."
-        required: false
-      args:
-        description: "Extra command line arguments."
-        required: false
-
-jobs:
-  release-please:
-    if: ${{ github.repository == 'googleapis/ruby-spanner-activerecord' }}
-    runs-on: ubuntu-latest
-    env:
-      GITHUB_TOKEN: ${{ secrets.YOSHI_CODE_BOT_TOKEN }}
-      RELEASE_PLEASE_DISABLE: ${{ secrets.RELEASE_PLEASE_DISABLE }}
-    steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-      - name: Install Ruby 3.0
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: "3.0"
-      - name: Install NodeJS 16.x
-        uses: actions/setup-node@v4
-        with:
-          node-version: "16.x"
-      - name: Install tools
-        run: "gem install --no-document toys"
-      - name: execute
-        run: |
-          toys release manifest -v \
-            --fork --skip-labeling \
-            --github-event-name=${{ github.event_name }} \
-            ${{ github.event.inputs.args }} \
-            -- ${{ github.event.inputs.gem }}