spanner-translator 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 926b9a0a9e9c07d185627a742e55d5b46361e060de681317fc9af9a78342fdcd
-  data.tar.gz: c9a93b243c46c5238fbbad3c479ab346c1204138a679730a5afc322a085d5063
+  metadata.gz: 5245a782dcce416f03a31c38710e8e5a3acb18a64d0082c44ebb004a1e8121ec
+  data.tar.gz: 264532835fce24060de4579d46cf95a09b777fb05b7d0c9e6f3c16aa02360ce1
 SHA512:
-  metadata.gz: 4dbc32f2c941211c6f6c57f85737319dec4d0926a7c145cc23ad700f966d72241792360c1dd4a3b51478127012859f1bc6babb9952f3e92d6774ca4587de9e72
-  data.tar.gz: 24002f577195c9f02e2de88c94261be22807d7201774a0f2268097e304715d8c1b9ac85df4c6378ec15b02662945c0ce9a6e3ac85a6cb52f0fa8c566ef418bfe
+  metadata.gz: 06645ad45c11413b73284d32b5fed8dc6dbb9ba1f2c2d67b78c29dae3f188dac3bace1220fbe7342990777c2c608f6f8849deabc66ef92146e5187a81594cdf9
+  data.tar.gz: 846b937be1eb9b5e829216567b0070790d99cef0f1c2b1b889364de6c5bc93717970c023a1658002c6c7a3f36f44cb0cee4705b3cb7dcc2a7167eb815e7e3aa7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spanner-translator (0.3.3)
+    spanner-translator (0.3.4)
       rubocop-ast (~> 1.30.0)
 
 GEM

data/lib/rubocop/ast/send_node.rb

@@ -4,7 +4,7 @@ module RuboCop
   module AST
     # Spanner-specific extensions for RuboCop::AST::SendNode objects
     class SendNode
-      %i[index column bigint datetime timestamp timestamps].each do |t_method_name|
+      %i[index column bigint integer datetime timestamp timestamps].each do |t_method_name|
         define_method(:"t_#{t_method_name}?") do
           sending_t? && method_name == t_method_name
         end
@@ -31,7 +31,7 @@ module RuboCop
         find_hash_option(option_name.to_sym)&.source
       end
 
-      %i[null name unique limit default].each do |option_name|
+      %i[null name unique limit default primary_key].each do |option_name|
         define_method(:"#{option_name}_option") do
           find_hash_option(option_name)
         end

data/lib/spanner/translator/cli.rb

@@ -48,18 +48,11 @@ module Spanner
         private
 
         # dumb create_table block code formatting
-        def formatted_create_table(code) # rubocop:disable Metrics/MethodLength
+        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
-            when /^\s*$/
-              nil # remove blank lines
-            else
-              "  #{l.strip}"
-            end
+            next if /^\s*$/ =~ l
+
+            /(create_table|end)/ =~ l ? l.strip : "  #{l.strip}"
           end.compact.join("\n")
         end
       end

data/lib/spanner/translator/configuration.rb

@@ -4,7 +4,7 @@ module Spanner
   module Translator
     # Configuration
     class Configuration
-      attr_accessor :rules, :checks, :db_schema, :skip_indexes
+      attr_accessor :rules, :checks, :db_schema, :skip_indexes, :primary_key_type
       attr_reader :default_primary_keys
 
       def initialize
@@ -17,6 +17,7 @@ module Spanner
         @db_schema = "db/schema.rb"
         @default_primary_keys = ["id"]
         @skip_indexes = false
+        @primary_key_type = :integer
       end
 
       # Set primary key column(s), make sure it is an array of symbols

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

@@ -6,8 +6,9 @@ module Spanner
   module Translator
     module Rules
       module Translation
-        # Based on the `create_table` statement, add an explicit column
-        # creation for the default primary key.
+        # Based on the `create_table` statement, add an explicit column creation
+        # for the default primary key when the default is "id" and not already
+        # defined.
         #
         # Scenarios:
         #   create_table "users" do |t|
@@ -25,7 +26,8 @@ module Spanner
 
             primary_key_name = "id"
 
-            @rewriter.insert_before(node.loc.expression, "t.integer \"#{primary_key_name}\", limit: 8, null: false\n  ")
+            @rewriter.insert_before(node.loc.expression,
+                                    "t.integer \"#{primary_key_name}\", null: false # generated\n  ")
             @seen["primary_key"] = true
           end
         end

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

@@ -14,6 +14,7 @@ module Spanner
           def on_send(node)
             capture_column_nullity(node)
             return unless node.t_index?
+            return @rewriter.remove(node.loc.expression) if Spanner::Translator.configuration.skip_indexes
 
             @rewriter.replace(node.loc.expression, "t.index #{new_arguments_for_column_definition(node)}")
           end

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

@@ -8,7 +8,7 @@ module Spanner
         # allow_commit_timestamp: true before the first t.index or at the end of
         # the block if no t.index is found.
         class AddTimestamps < BaseRule
-          COLUMN_DEF = "t.timestamps"
+          COLUMN_DEF = "t.timestamps # generated"
 
           def on_send(node)
             return unless node.t_datetime? && %w[created_at updated_at].include?(node.first_argument.value)

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

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Spanner
+  module Translator
+    module Rules
+      module Translation
+        # In the create_table block, add t.time :committed_at with
+        # allow_commit_timestamp: true before the first t.index or at the end of
+        # the block if no t.index is found.
+        class EnsurePrimaryKeyColumnsExist < BaseRule
+          ID_COLUMN_TEMPLATE = %(t.%<type>s "%<colname>s", null: false # generated\n  )
+
+          def on_block(node)
+            # only pay attention to create_table blocks
+            return unless node.send_node.method_name == :create_table
+
+            # get primary_key hash argument value
+            specified_primary_keys = value_of(node.send_node.primary_key_option.value)
+            return unless specified_primary_keys
+
+            # get primary_key column name[s]
+            undefined_columns = undefined_primary_key_columns node.body.children, specified_primary_keys
+
+            # otherwise, insert at beginning of block
+            undefined_columns.each do |colname|
+              @rewriter.insert_before(node.body.loc.expression, id_column_source(colname))
+            end
+          end
+
+          private
+
+          def value_of(node)
+            case node
+            when RuboCop::AST::ArrayNode
+              node.children.map { |c| value_of(c) }
+            when RuboCop::AST::StrNode, RuboCop::AST::SymbolNode
+              node.value.to_s
+            else
+              raise "Unexpected node type in argument slot: #{node.class}"
+            end
+          end
+
+          def undefined_primary_key_columns(children, columns)
+            columns = Array(columns)
+
+            children.each do |child|
+              next unless string_argument_haver?(child)
+
+              colname = child.arguments.first.value.to_s
+              columns.delete(colname)
+            end
+
+            columns
+          end
+
+          def string_argument_haver?(child)
+            child.is_a?(RuboCop::AST::SendNode) &&
+              child.sending_t? &&
+              child.arguments.first.is_a?(RuboCop::AST::StrNode)
+          end
+
+          def id_column_source(colname)
+            format(ID_COLUMN_TEMPLATE, colname: colname, type: Spanner::Translator.configuration.primary_key_type)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -14,10 +14,11 @@ module Spanner
 
             constraint_name = generate_constraint_name(node)
             unless_seen(constraint_name) do
-              @rewriter.replace(node.loc.expression, "t.string #{new_arguments_for_column_definition(node)}")
+              @rewriter.replace(node.loc.expression,
+                                "t.string #{new_arguments_for_column_definition(node)} # generated")
               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}\"")
+                                     "\n  t.check_constraint #{constraint}, name: \"#{constraint_name}\" # generated")
             end
           end
 

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

@@ -13,7 +13,7 @@ module Spanner
             conditionally_propagate_argument new_arguments, node, "null"
             conditionally_propagate_argument new_arguments, node, "default"
 
-            @rewriter.replace(node.loc.expression, "t.time #{new_arguments.join(", ")}")
+            @rewriter.replace(node.loc.expression, "t.time #{new_arguments.join(", ")} # generated")
           end
         end
       end

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

@@ -16,6 +16,7 @@ module Spanner
           TimeColumnsToTime
           BigintToInteger
           ReplaceCreateTableArgs
+          EnsurePrimaryKeyColumnsExist
         ].freeze
 
         autoload :AddExplicitPrimaryKey, "spanner/translator/rules/translation/add_explicit_primary_key"
@@ -26,6 +27,7 @@ module Spanner
         autoload :BigintToInteger, "spanner/translator/rules/translation/bigint_to_integer"
         autoload :EnumColumnToStringWithConstraint,
                  "spanner/translator/rules/translation/enum_column_to_string_with_constraint"
+        autoload :EnsurePrimaryKeyColumnsExist, "spanner/translator/rules/translation/ensure_primary_key_columns_exist"
         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"

data/lib/spanner/translator/version.rb

@@ -2,6 +2,6 @@
 
 module Spanner
   module Translator
-    VERSION = "0.3.3"
+    VERSION = "0.3.4"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spanner-translator
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.3.4
 platform: ruby
 authors:
 - Adam Bachman
@@ -60,6 +60,7 @@ files:
 - lib/spanner/translator/rules/translation/add_timestamps.rb
 - lib/spanner/translator/rules/translation/base_rule.rb
 - lib/spanner/translator/rules/translation/bigint_to_integer.rb
+- lib/spanner/translator/rules/translation/ensure_primary_key_columns_exist.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