spanner-translator 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 54175adb11828290cc2c5f7993973130dd9b870b66fcf90748af2de11a3a3ea1
-  data.tar.gz: 5e2a822a94c976fa76f20e86122cbd95961a5616e008e2cfba53510d38e2594c
+  metadata.gz: 926b9a0a9e9c07d185627a742e55d5b46361e060de681317fc9af9a78342fdcd
+  data.tar.gz: c9a93b243c46c5238fbbad3c479ab346c1204138a679730a5afc322a085d5063
 SHA512:
-  metadata.gz: c8169d285df624c76f63ad577d588b19b85606cd393abdd5f0ebbad229de8c5409e4c2ed0d3fa461df8d18db9b75dc97dabf6169ddea0bc61c43376c1b751551
-  data.tar.gz: 6013cd95da080222aca143982461624971c1c3a22ab71c3deddc791bc85a22f1b00b947fa402aa66a3c66ffa1de139b5f79fec7568431fe2aa654d46e96d5012
+  metadata.gz: 4dbc32f2c941211c6f6c57f85737319dec4d0926a7c145cc23ad700f966d72241792360c1dd4a3b51478127012859f1bc6babb9952f3e92d6774ca4587de9e72
+  data.tar.gz: 24002f577195c9f02e2de88c94261be22807d7201774a0f2268097e304715d8c1b9ac85df4c6378ec15b02662945c0ce9a6e3ac85a6cb52f0fa8c566ef418bfe

data/.rubocop.yml

@@ -1,3 +1,6 @@
+require:
+  - rubocop-rspec
+
 AllCops:
   TargetRubyVersion: 3.2.2
   NewCops: enable
@@ -25,3 +28,12 @@ Metrics/BlockLength:
   Max: 120
   Exclude:
     - 'spec/**/*'
+
+RSpec/ExampleLength:
+  Max: 120
+
+RSpec/ContextWording:
+  Enabled: false
+
+RSpec/MultipleMemoizedHelpers:
+  Enabled: false

data/Gemfile

@@ -10,3 +10,4 @@ gem "debug", ">= 1.0.0"
 gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.59.0"
+gem "rubocop-rspec"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spanner-translator (0.3.0)
+    spanner-translator (0.3.3)
       rubocop-ast (~> 1.30.0)
 
 GEM
@@ -59,6 +59,14 @@ GEM
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.30.0)
       parser (>= 3.2.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.26.1)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
     ruby-progressbar (1.13.0)
     stringio (3.0.8)
     unicode-display_width (2.5.0)
@@ -73,6 +81,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.59.0)
+  rubocop-rspec
   spanner-translator!
 
 BUNDLED WITH

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].each do |t_method_name|
+      %i[index column bigint datetime timestamp timestamps].each do |t_method_name|
         define_method(:"t_#{t_method_name}?") do
           sending_t? && method_name == t_method_name
         end

data/lib/spanner/translator/cli.rb

@@ -10,17 +10,17 @@ module Spanner
       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: Rules::Check::ORDERED_CHECK_RULES,
+                          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:)
+          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: {})
+        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
@@ -48,13 +48,15 @@ module Spanner
         private
 
         # dumb create_table block code formatting
-        def formatted_create_table(code)
+        def formatted_create_table(code) # rubocop:disable Metrics/MethodLength
           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

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

@@ -6,6 +6,8 @@ module Spanner
   module Translator
     module Rules
       module Check # rubocop:disable Style/Documentation
+        ORDERED_CHECK_RULES = [].freeze
+
         autoload :HasAnyIndex, "spanner/translator/rules/check/has_any_index"
       end
     end

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

@@ -4,18 +4,25 @@ 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
-        #
+        # 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 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'
 
-            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
+          def on_block(node)
+            # only pay attention to create_table blocks
+            return unless node.send_node.method_name == :create_table
+
+            # try all body children to see if any are t.index, if so, insert before
+            node.body.children.each do |child|
+              next unless child.is_a?(RuboCop::AST::SendNode) && child.t_index?
+
+              return @rewriter.insert_before(child.loc.expression, "#{COMMITTED_AT_COLUMN}\n  ")
+            end
+
+            # otherwise, insert at end of block
+            @rewriter.insert_before(node.loc.end, "  #{COMMITTED_AT_COLUMN}\n")
           end
         end
       end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+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 AddTimestamps < BaseRule
+          COLUMN_DEF = "t.timestamps"
+
+          def on_send(node)
+            return unless node.t_datetime? && %w[created_at updated_at].include?(node.first_argument.value)
+
+            full_line = Parser::Source::Range.new(@rewriter.source_buffer,
+                                                  node.loc.expression.begin_pos,
+                                                  node.loc.expression.end_pos)
+            @rewriter.remove(full_line)
+          end
+
+          def on_block(node) # rubocop:disable Metrics/AbcSize
+            # only pay attention to create_table blocks
+            return unless node.send_node.method_name == :create_table
+
+            # check all  already has `t.timestamps` bail out
+            return if timestamp_child?(node.body.children)
+
+            # try all body children to see if any are t.index, if so, insert before
+            t_index = node.body.children.find { |child| child.is_a?(RuboCop::AST::SendNode) && child.t_index? }
+            return @rewriter.insert_before(t_index.loc.expression, "#{COLUMN_DEF}\n  ") if t_index
+
+            # otherwise, insert at end of block
+            @rewriter.insert_before(node.loc.end, "  #{COLUMN_DEF}\n")
+          end
+
+          private
+
+          def timestamp_child?(children)
+            children.any? do |child|
+              child.is_a?(RuboCop::AST::SendNode) && child.t_timestamps?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -10,7 +10,9 @@ module Spanner
             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
+            primary_keys = translation_options
+                           .fetch(:primary_keys, Spanner::Translator.configuration.default_primary_keys)
+                           .inspect
             @rewriter.replace(node.arguments[1].source_range, "primary_key: #{primary_keys}, force: :cascade")
           end
         end

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

@@ -10,6 +10,7 @@ module Spanner
         ORDERED_SCHEMA_RULES = %w[
           AddExplicitPrimaryKey
           AddCommittedAtTimestamp
+          AddTimestamps
           AddIndexOptions
           EnumColumnToStringWithConstraint
           TimeColumnsToTime
@@ -21,6 +22,7 @@ module Spanner
         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 :AddTimestamps, "spanner/translator/rules/translation/add_timestamps"
         autoload :BigintToInteger, "spanner/translator/rules/translation/bigint_to_integer"
         autoload :EnumColumnToStringWithConstraint,
                  "spanner/translator/rules/translation/enum_column_to_string_with_constraint"

data/lib/spanner/translator/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spanner-translator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Adam Bachman
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-10 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop-ast
@@ -57,6 +57,7 @@ files:
 - 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/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/enum_column_to_string_with_constraint.rb