spanner-translator 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 54175adb11828290cc2c5f7993973130dd9b870b66fcf90748af2de11a3a3ea1
+  data.tar.gz: 5e2a822a94c976fa76f20e86122cbd95961a5616e008e2cfba53510d38e2594c
+SHA512:
+  metadata.gz: c8169d285df624c76f63ad577d588b19b85606cd393abdd5f0ebbad229de8c5409e4c2ed0d3fa461df8d18db9b75dc97dabf6169ddea0bc61c43376c1b751551
+  data.tar.gz: 6013cd95da080222aca143982461624971c1c3a22ab71c3deddc791bc85a22f1b00b947fa402aa66a3c66ffa1de139b5f79fec7568431fe2aa654d46e96d5012

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+AllCops:
+  TargetRubyVersion: 3.2.2
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+# irrelevant after Ruby >=3
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedShorthandSyntax: consistent
+
+Layout/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'

data/.ruby-version

@@ -0,0 +1 @@
+3.3.0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-25
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at abachman@recurly.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in spanner-translator.gemspec
+gemspec
+
+# development dependencies
+gem "debug", ">= 1.0.0"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.59.0"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    spanner-translator (0.3.0)
+      rubocop-ast (~> 1.30.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    debug (1.8.0)
+      irb (>= 1.5.0)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    io-console (0.6.0)
+    irb (1.8.1)
+      rdoc
+      reline (>= 0.3.8)
+    json (2.7.1)
+    language_server-protocol (3.17.0.3)
+    parallel (1.24.0)
+    parser (3.3.0.2)
+      ast (~> 2.4.1)
+      racc
+    psych (5.1.0)
+      stringio
+    racc (1.7.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rdoc (6.5.0)
+      psych (>= 4.0.0)
+    regexp_parser (2.9.0)
+    reline (0.3.8)
+      io-console (~> 0.5)
+    rexml (3.2.6)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.59.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.30.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    stringio (3.0.8)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-23
+  x86_64-linux
+
+DEPENDENCIES
+  debug (>= 1.0.0)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.59.0)
+  spanner-translator!
+
+BUNDLED WITH
+   2.4.8

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Adam Bachman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/Makefile

@@ -0,0 +1,12 @@
+# based on https://github.com/recurly/platform-clients-ruby/blob/master/Makefile
+
+clean:
+	rm -f *.gem
+
+build: clean
+	gem build spanner-translator.gemspec
+
+release: build
+	gem push --key github --host https://rubygems.pkg.github.com/recurly spanner-translator-*.gem
+
+.PHONY: clean build release

data/README.md

@@ -0,0 +1,116 @@
+# Spanner::Translator
+
+A quick-and-dirty [Rubocop::AST](https://github.com/rubocop/rubocop-ast) based `create_table` Ruby source rewriting translator to facilitate migration from MySQL to Google Cloud Spanner.
+
+Not intended to be a generally-useful gem, but available for use / fork as needed.
+
+## Installation
+
+Add the gem as a `github:` dependency to your Gemfile:
+
+```ruby
+group :development do
+  gem 'spanner-translator', github: 'abachman/spanner-translator', branch: 'main', require: false
+end
+```
+
+## Usage
+
+If you're in a Rails project, configure the library and use the `spanner:translate` Rake task:
+
+
+```ruby
+# config/initializers/spanner_translator.rb
+
+if Rails.env.development?
+  require 'spanner/translator'
+
+  Spanner::Translator.configure do |config|
+    config.default_primary_keys = [:related_table_id, :id]
+    config.db_schema = Rails.root.join('db/schema.rb')
+  end
+end
+```
+
+```sh
+$ bundle exec rake spanner:translate[smalls]
+```
+
+Or in any project, call the library from a script:
+
+```ruby
+# frozen_string_literal: true
+
+require 'spanner/translator'
+
+Spanner::Translator.configure do |config|
+  config.default_primary_keys = [:id]
+end
+
+source = <<~RUBY
+  create_table "smalls", id: { type: :bigint, unsigned: true, default: nil } do |t|
+    t.string "name", null: false
+    t.index ["name"], name: "index_smalls_on_name", order: { name: :asc }
+  end
+RUBY
+
+puts Spanner::Translator::CLI.process_code!(source)
+```
+
+Or, maybe simplest, use `bundler/inline` to gem install and require the library from a one-off Ruby script that can be run from inside a Rails project directory:
+
+```ruby
+require 'bundler/inline'
+gemfile do
+  source 'https://rubygems.org'
+  gem 'spanner-translator', github: 'recurly/spanner-translator', branch: 'main'
+end
+
+require 'spanner/translator'
+Spanner::Translator.configure do |config|
+  # use a composite primary key for every converted table
+  config.default_primary_keys = [:owner_id, :id]
+  # spanner-translator assumes schema exists at ./db/schema.rb
+end
+
+tables = %w(users blog_posts comments)
+
+tables.each do |table_name|
+  # load the corresponding `create_table` statement from db/schema.rb
+  source = Spanner::Translator::Schema.extract_create_table(table_name)
+
+  # print the translated Spanner `create_table` statement
+  puts Spanner::Translator::CLI.process_code!(source)
+end
+```
+
+### Safely Rewriting a File
+
+Rewriting a source file in your project boils down to:
+
+1. Read file source
+2. Process source with rules
+3. Write file
+4. Run test
+5. Revert if test fails
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Run the test suite with `bundle exec rspec`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/abachman/spanner-translator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/abachman/spanner-translator/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Spanner::Translator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/abachman/spanner-translator/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/rubocop/ast/class_node.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # extensions for RuboCop::AST::ClassNode objects
+    class ClassNode
+      def inherits_from?(class_name)
+        return false unless child_nodes[1]&.const_type?
+
+        child_nodes[1].short_name.to_s == class_name.to_s
+      end
+
+      def superclass_loc
+        return unless child_nodes[1]&.const_type?
+
+        child_nodes[1].loc.expression
+      end
+    end
+  end
+end

data/lib/rubocop/ast/send_node.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module AST
+    # Spanner-specific extensions for RuboCop::AST::SendNode objects
+    class SendNode
+      %i[index column bigint datetime timestamp].each do |t_method_name|
+        define_method(:"t_#{t_method_name}?") do
+          sending_t? && method_name == t_method_name
+        end
+      end
+
+      def sending_t?
+        receiver && receiver.source == "t"
+      end
+
+      def create_table?
+        method_name == :create_table
+      end
+
+      def find_hash_option(option_name)
+        return unless arguments.last.hash_type?
+
+        option_name = option_name.to_sym
+        arguments.last.children.find do |c|
+          c.pair_type? && c.children[0].sym_type? && c.children[0].children[0] == option_name
+        end
+      end
+
+      def find_hash_option_source(option_name)
+        find_hash_option(option_name.to_sym)&.source
+      end
+
+      %i[null name unique limit default].each do |option_name|
+        define_method(:"#{option_name}_option") do
+          find_hash_option(option_name)
+        end
+
+        define_method(:"#{option_name}_option_value") do
+          find_hash_option(option_name)&.value&.source
+        end
+      end
+
+      def last_sibling
+        parent.children.last
+      end
+    end
+  end
+end

data/lib/spanner/translator/Rakefile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "spanner/translator"
+
+namespace :spanner do
+  desc "Translate Rails MySQL create_table statements to Cloud Spanner"
+  task :translate, [:table] => :environment do |_t, args|
+    source = Spanner::Translator::Schema.extract_create_table(args[:table])
+    puts Spanner::Translator::CLI.process_code!(source)
+  end
+end

data/lib/spanner/translator/cli.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "rubocop-ast"
+require "spanner/translator/rules"
+
+module Spanner
+  module Translator
+    # CLI methods for calling the translator
+    module CLI
+      class << self
+        # process code translation, raising errors if a CheckRule fails.
+        def process_code!(code,
+                          check_classes = Rules::Check.constants,
+                          rule_classes = Rules::Translation::ORDERED_SCHEMA_RULES, options: {})
+          check_classes.each do |rule_class|
+            process_check_rule(Spanner::Translator::Rules::Check.const_get(rule_class), code)
+          end
+
+          process_code(code, rule_classes, options:)
+        end
+
+        # process code translation for only the schema related rules
+        def process_code(code, rule_classes = Rules::Translation::ORDERED_SCHEMA_RULES, options: {})
+          rule_classes.each do |rule_class|
+            code = process_rule(Spanner::Translator::Rules::Translation.const_get(rule_class), code, options:)
+          end
+          return code unless rule_classes == Rules::Translation::ORDERED_SCHEMA_RULES
+
+          formatted_create_table(code)
+        end
+
+        def process_rule(rule_class, code, options: {})
+          source = RuboCop::AST::ProcessedSource.new(code, 2.7)
+          source_buffer = source.buffer
+          rewriter = Parser::Source::TreeRewriter.new(source_buffer)
+          rule = rule_class.new(rewriter, options:)
+          source.ast.each_node { |n| rule.process(n) }
+          rewriter.process
+        end
+
+        def process_check_rule(rule_class, code)
+          source = RuboCop::AST::ProcessedSource.new(code, 2.7)
+          rule = rule_class.new(nil)
+          source.ast.each_node { |n| rule.process(n) }
+          rule.assert!
+        end
+
+        private
+
+        # dumb create_table block code formatting
+        def formatted_create_table(code)
+          code.lines.map do |l|
+            case l
+            when /(create_table|end)/
+              l.strip
+            when /t\.index/
+              "  #{l.strip}" unless Spanner::Translator.configuration.skip_indexes
+            else
+              "  #{l.strip}"
+            end
+          end.compact.join("\n")
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/configuration.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    # Configuration
+    class Configuration
+      attr_accessor :rules, :checks, :db_schema, :skip_indexes
+      attr_reader :default_primary_keys
+
+      def initialize
+        reset!
+      end
+
+      def reset!
+        @rules = nil
+        @checks = nil
+        @db_schema = "db/schema.rb"
+        @default_primary_keys = ["id"]
+        @skip_indexes = false
+      end
+
+      # Set primary key column(s), make sure it is an array of symbols
+      def default_primary_keys=(value)
+        @default_primary_keys = value.is_a?(Array) ? value : [value]
+        @default_primary_keys.map!(&:to_sym)
+      end
+    end
+  end
+end

data/lib/spanner/translator/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "spanner/translator"
+require "rails"
+
+module Spanner
+  module Translator
+    # optional railtie to add the gem's rake tasks
+    class Railtie < Rails::Railtie
+      railtie_name :spanner_translator
+
+      rake_tasks do
+        load File.join(File.expand_path(__dir__), "Rakefile")
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/check/has_any_index.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Check
+        # Check if table has any t.index statement
+        class HasAnyIndex < BaseRule
+          def on_send(node)
+            return unless node.t_index?
+
+            @seen["index"] = true
+          end
+
+          def assert!
+            raise "table has no index" unless any_index?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/check.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "spanner/translator/rules/translation/base_rule"
+
+module Spanner
+  module Translator
+    module Rules
+      module Check # rubocop:disable Style/Documentation
+        autoload :HasAnyIndex, "spanner/translator/rules/check/has_any_index"
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/add_committed_at_timestamp.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # Add t.time :committed_at with allow_commit_timestamp: true before the first t.index
+        #
+        # FIXME (@abachman): if table has no indexes, this rule will not be applied
+        #
+        class AddCommittedAtTimestamp < BaseRule
+          def on_send(node)
+            return if @seen["committed_at"]
+            return unless node.t_index?
+
+            committed_at_column = 't.time "committed_at", null: false, allow_commit_timestamp: true'
+            @rewriter.insert_before(node.loc.expression, "#{committed_at_column}\n  ")
+            @seen["committed_at"] = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/add_explicit_primary_key.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # Based on the `create_table` statement, add an explicit column
+        # creation for the default primary key.
+        #
+        # Scenarios:
+        #   create_table "users" do |t|
+        #   create_table "users", id: { type: :bigint, unsigned: true, default: nil } do |t|
+        #
+        # Other scenarios should be ignored.
+        #
+        class AddExplicitPrimaryKey < BaseRule
+          def on_send(node)
+            capture_primary_key_argument(node)
+
+            return if @seen["primary_key"]
+            return unless node.sending_t? # we assume every create_table has at least one t. statement
+            return if @primary_key_argument&.value
+
+            primary_key_name = "id"
+
+            @rewriter.insert_before(node.loc.expression, "t.integer \"#{primary_key_name}\", limit: 8, null: false\n  ")
+            @seen["primary_key"] = true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/add_index_options.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # - set order: { column_name: :asc, datetime: :desc } for each column on every index
+        # - propagate name: if explicitly set on index
+        # - propagate unique: if explicitly set on index
+        # - add null_filtered: true if any column is nullable and index is unique: true
+        class AddIndexOptions < BaseRule
+          def on_send(node)
+            capture_column_nullity(node)
+            return unless node.t_index?
+
+            @rewriter.replace(node.loc.expression, "t.index #{new_arguments_for_column_definition(node)}")
+          end
+
+          private
+
+          def new_arguments_for_column_definition(node)
+            new_arguments = [node.arguments[0].source]
+            conditionally_propagate_argument new_arguments, node, "name"
+            conditionally_propagate_argument new_arguments, node, "unique"
+            new_arguments << order_hash_argument(node)
+            conditionally_add_null_filtered_argument new_arguments, node
+            new_arguments.join(", ")
+          end
+
+          def column_names(node)
+            JSON.parse(node.arguments[0].source)
+          end
+
+          def order_hash_argument(node)
+            order_hash = column_names(node).map do |column_name|
+              "#{column_name}: :#{column_name.match?(/[a-z_]+_at$/) ? "desc" : "asc"}"
+            end
+            "order: { #{order_hash.join(", ")} }"
+          end
+
+          # requires capture_column_nullity to be called
+          def should_null_filter?(node)
+            column_names(node).any? { |c| @column_nullity[c] } &&
+              (node.unique_option && node.unique_option.value.source == "true")
+          end
+
+          def conditionally_add_null_filtered_argument(new_arguments, node)
+            new_arguments << "null_filtered: true" if should_null_filter?(node)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/add_test_case.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # replace ApplicationRecord with the configured class during translation of models
+        class AddTestCase < BaseRule
+          def_node_matcher :main_describe?, <<~PATTERN
+            (block
+              (send (const nil? :RSpec) :describe ...)
+              ...)
+          PATTERN
+
+          def on_block(node)
+            main_describe?(node) do
+              # only rewrite the first time RSpec.describe is seen
+              unless_seen(:insert_test_case) do
+                if translation_options[:test_case]
+                  @rewriter.insert_before(node.loc.end, translation_options[:test_case])
+                else
+                  @rewriter.insert_before(node.loc.end, '  # i am here\n')
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/base_rule.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "rubocop-ast"
+require "rubocop/ast/send_node"
+require "rubocop/ast/class_node"
+
+module Spanner
+  module Translator
+    module Rules
+      class BaseRule < Parser::AST::Processor # rubocop:disable Style/Documentation
+        include RuboCop::AST::Traversal
+        extend RuboCop::AST::NodePattern::Macros
+
+        attr_reader :translation_options
+
+        # rubocop:disable Lint/MissingSuper
+        def initialize(rewriter, options: {})
+          @rewriter = rewriter
+          @seen = {}
+          @column_nullity = {}
+          @translation_options = options
+          @primary_key_argument = nil
+          @primary_key_properties = nil
+        end
+        # rubocop:enable Lint/MissingSuper
+
+        def create_range(begin_pos, end_pos)
+          Parser::Source::Range.new(@rewriter.source_buffer, begin_pos, end_pos)
+        end
+
+        def capture_table_name(node)
+          @table_name = node.arguments[0].source.tr('"', "") if node.method_name == :create_table
+        end
+
+        def capture_primary_key_argument(node)
+          return unless node.method_name == :create_table
+
+          @primary_key_argument = node.find_hash_option(:primary_key)
+          @primary_key_properties = node.find_hash_option(:id)
+        end
+
+        RAILS_COLUMN_TYPES = %i[bigint string text integer float decimal
+                                datetime timestamp time date binary boolean].freeze
+
+        # track every columns' null acceptance
+        def capture_column_nullity(node)
+          is_typed_column_node = node.receiver &&
+                                 node.receiver.source == "t" &&
+                                 RAILS_COLUMN_TYPES.include?(node.method_name)
+          return unless is_typed_column_node
+
+          column_name = node.arguments[0].source.tr('"', "")
+          null_option = node.find_hash_option(:null)
+
+          # "may be null" means this column is not defined with explicit "null: false"
+          @column_nullity[column_name] = null_option&.value&.source != "false"
+        end
+
+        def any_index?
+          @seen["index"]
+        end
+
+        def unless_seen(condition)
+          return if @seen[condition]
+
+          yield
+          @seen[condition] = true
+        end
+
+        def conditionally_propagate_argument(arguments, node, name)
+          arguments << node.find_hash_option_source(name) if node.find_hash_option(name)
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/bigint_to_integer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # t.bigint is not supported in spanner, so replace with t.integer, keeping null option if given
+        class BigintToInteger < BaseRule
+          def on_send(node)
+            return unless node.t_bigint?
+
+            new_arguments = [node.arguments[0].source, "limit: 8"]
+            conditionally_propagate_argument new_arguments, node, "null"
+
+            @rewriter.replace(node.loc.expression, "t.integer #{new_arguments.join(", ")}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/enum_column_to_string_with_constraint.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # replace t.column enums with the appropriate t.string and the correct check constraints
+        class EnumColumnToStringWithConstraint < BaseRule
+          def on_send(node)
+            capture_table_name(node)
+            return unless node.t_column?
+
+            constraint_name = generate_constraint_name(node)
+            unless_seen(constraint_name) do
+              @rewriter.replace(node.loc.expression, "t.string #{new_arguments_for_column_definition(node)}")
+              constraint = %["#{column_name(node)} IN (#{choices_for_enum_string(node)})"]
+              @rewriter.insert_after(node.last_sibling.source_range,
+                                     "\n  t.check_constraint #{constraint}, name: \"#{constraint_name}\"")
+            end
+          end
+
+          private
+
+          def column_name(node)
+            JSON.parse(node.arguments[0].source)
+          end
+
+          def generate_constraint_name(node)
+            table_name = @table_name
+            "chk_rails_enum_#{table_name}_#{column_name(node)}"
+          end
+
+          def choices_for_enum_string(node)
+            choices_for_enum(node).map { |o| "'#{o}'" }.join(", ")
+          end
+
+          def choices_for_enum(node)
+            choices = choices_from_node(node)
+
+            # add empty string to options if null is permitted
+            choices.unshift("") unless node.null_option_value == "false"
+            choices
+          end
+
+          def choices_from_node(node)
+            if node.limit_option.nil?
+              # Rails 7+ uses `enum('a','b','c')`
+              enum_choices = node.arguments[1].source
+              /\((.*)\)/.match(enum_choices)[1].split(",").map(&:strip).map { |o| o[1..-2] }
+            else
+              # Rails < 7 used `limit: ["a", "b", "c"]`
+              JSON.parse(node.limit_option.value.source)
+            end
+          end
+
+          def new_arguments_for_column_definition(node)
+            new_arguments = [%("#{column_name(node)}")]
+            conditionally_propagate_argument new_arguments, node, "null"
+            conditionally_propagate_argument new_arguments, node, "default"
+            new_arguments << "limit: #{choices_for_enum(node).map(&:length).max}"
+            new_arguments.join(", ")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/replace_application_record.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # replace ApplicationRecord with the configured class during translation of models
+        class ReplaceApplicationRecord < BaseRule
+          def on_class(node)
+            return unless node.inherits_from?(:ApplicationRecord)
+            return unless translation_options[:class]
+
+            @rewriter.replace(node.superclass_loc, translation_options[:class])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/replace_create_table_args.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # Replace create_table arguments with sensible spanner options
+        class ReplaceCreateTableArgs < BaseRule
+          def on_send(node)
+            return unless node.create_table?
+
+            # keep table name argument, replace the rest with sensible spanner options
+            primary_keys = Spanner::Translator.configuration.default_primary_keys.inspect
+            @rewriter.replace(node.arguments[1].source_range, "primary_key: #{primary_keys}, force: :cascade")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation/time_columns_to_time.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # convert t.datetime and t.timestamp to t.time, keeping null option if given
+        class TimeColumnsToTime < BaseRule
+          def on_send(node)
+            return unless node.t_datetime? || node.t_timestamp?
+
+            new_arguments = [node.arguments[0].source]
+            conditionally_propagate_argument new_arguments, node, "null"
+            conditionally_propagate_argument new_arguments, node, "default"
+
+            @rewriter.replace(node.loc.expression, "t.time #{new_arguments.join(", ")}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules/translation.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "spanner/translator/rules/translation/base_rule"
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation # rubocop:disable Style/Documentation
+        # some rules must be perormed in a specific order
+        ORDERED_SCHEMA_RULES = %w[
+          AddExplicitPrimaryKey
+          AddCommittedAtTimestamp
+          AddIndexOptions
+          EnumColumnToStringWithConstraint
+          TimeColumnsToTime
+          BigintToInteger
+          ReplaceCreateTableArgs
+        ].freeze
+
+        autoload :AddExplicitPrimaryKey, "spanner/translator/rules/translation/add_explicit_primary_key"
+        autoload :AddCommittedAtTimestamp, "spanner/translator/rules/translation/add_committed_at_timestamp"
+        autoload :AddIndexOptions, "spanner/translator/rules/translation/add_index_options"
+        autoload :AddTestCase, "spanner/translator/rules/translation/add_test_case"
+        autoload :BigintToInteger, "spanner/translator/rules/translation/bigint_to_integer"
+        autoload :EnumColumnToStringWithConstraint,
+                 "spanner/translator/rules/translation/enum_column_to_string_with_constraint"
+        autoload :ReplaceCreateTableArgs, "spanner/translator/rules/translation/replace_create_table_args"
+        autoload :ReplaceApplicationRecord, "spanner/translator/rules/translation/replace_application_record"
+        autoload :TimeColumnsToTime, "spanner/translator/rules/translation/time_columns_to_time"
+      end
+    end
+  end
+end

data/lib/spanner/translator/rules.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    # Translation rules
+    module Rules
+      autoload :Check, "spanner/translator/rules/check"
+      autoload :Translation, "spanner/translator/rules/translation"
+    end
+  end
+end

data/lib/spanner/translator/schema.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "rubocop-ast"
+
+# Utility methods for working with Rails MySQL table schemas
+module Spanner
+  module Translator
+    # Access a Rails formatted db/schema.rb file and return create_table source
+    module Schema
+      class << self
+        def legacy_schema_path
+          Spanner::Translator.configuration.db_schema
+        end
+
+        def legacy_schema
+          raise Spanner::Translator::Error, "db/schema.rb not found" unless File.exist?(legacy_schema_path)
+
+          @legacy_schema ||= File.read(legacy_schema_path)
+        end
+
+        # extract the Ruby `create_table` statement for the given table name
+        def extract_create_table(table_name)
+          legacy_schema.match(/create_table "#{table_name}".*?end$/m)[0]
+        end
+
+        # extract the Parser::AST for the given table name,
+        # see https://github.com/whitequark/parser/blob/master/doc/AST_FORMAT.md
+        def extract_create_table_ast(table_name)
+          source = extract_create_table(table_name)
+          RuboCop::AST::ProcessedSource.new(source, RUBY_VERSION.to_f).ast
+        end
+      end
+    end
+  end
+end

data/lib/spanner/translator/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Spanner
+  module Translator
+    VERSION = "0.3.0"
+  end
+end

data/lib/spanner/translator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "spanner/translator/railtie" if defined?(Rails::Railtie)
+
+module Spanner
+  # MySQL to Google Cloud Spanner Rails create_table statement translator
+  module Translator
+    class Error < StandardError; end
+
+    autoload :CLI, "spanner/translator/cli"
+    autoload :Configuration, "spanner/translator/configuration"
+    autoload :Rules, "spanner/translator/rules"
+    autoload :Schema, "spanner/translator/schema"
+    autoload :VERSION, "spanner/translator/version"
+
+    class << self
+      def configure
+        yield(configuration)
+      end
+
+      def configuration
+        @configuration ||= Configuration.new
+      end
+    end
+  end
+end

data/sig/spanner/translator.rbs

@@ -0,0 +1,6 @@
+module Spanner
+  module Translator
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

data/spanner-translator.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/spanner/translator/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "spanner-translator"
+  spec.version = Spanner::Translator::VERSION
+  spec.authors = ["Adam Bachman"]
+  spec.email = ["abachman@recurly.com"]
+
+  spec.summary = "Translate pieces of a Rails app from MySQL to Google Cloud Spanner."
+  spec.description = "Translate pieces of a Rails app from MySQL to Google Cloud Spanner."
+  spec.homepage = "https://github.com/recurly/spanner-tranlator"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/recurly/spanner-tranlator"
+  spec.metadata["changelog_uri"] = "https://github.com/recurly/spanner-tranlator#changelog"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rubocop-ast", "~> 1.30.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata["rubygems_mfa_required"] = "true"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: spanner-translator
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Adam Bachman
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.30.0
+description: Translate pieces of a Rails app from MySQL to Google Cloud Spanner.
+email:
+- abachman@recurly.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Makefile
+- README.md
+- Rakefile
+- lib/rubocop/ast/class_node.rb
+- lib/rubocop/ast/send_node.rb
+- lib/spanner/translator.rb
+- lib/spanner/translator/Rakefile
+- lib/spanner/translator/cli.rb
+- lib/spanner/translator/configuration.rb
+- lib/spanner/translator/railtie.rb
+- lib/spanner/translator/rules.rb
+- lib/spanner/translator/rules/check.rb
+- lib/spanner/translator/rules/check/has_any_index.rb
+- lib/spanner/translator/rules/translation.rb
+- lib/spanner/translator/rules/translation/add_committed_at_timestamp.rb
+- lib/spanner/translator/rules/translation/add_explicit_primary_key.rb
+- lib/spanner/translator/rules/translation/add_index_options.rb
+- lib/spanner/translator/rules/translation/add_test_case.rb
+- lib/spanner/translator/rules/translation/base_rule.rb
+- lib/spanner/translator/rules/translation/bigint_to_integer.rb
+- lib/spanner/translator/rules/translation/enum_column_to_string_with_constraint.rb
+- lib/spanner/translator/rules/translation/replace_application_record.rb
+- lib/spanner/translator/rules/translation/replace_create_table_args.rb
+- lib/spanner/translator/rules/translation/time_columns_to_time.rb
+- lib/spanner/translator/schema.rb
+- lib/spanner/translator/version.rb
+- sig/spanner/translator.rbs
+- spanner-translator.gemspec
+homepage: https://github.com/recurly/spanner-tranlator
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/recurly/spanner-tranlator
+  source_code_uri: https://github.com/recurly/spanner-tranlator
+  changelog_uri: https://github.com/recurly/spanner-tranlator#changelog
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Translate pieces of a Rails app from MySQL to Google Cloud Spanner.
+test_files: []