rubocop-powerhome 0.5.5 → 0.6.0

data/lib/rubocop/cop/migration/acknowledge_ignored_column.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    # rubocop:disable Lint/RedundantCopDisableDirective
+    module Migration
+      # Do not remove columns until they are first ignored in production.
+      # Verify you have deleted the 'ignored_columns' from the Model and
+      # then disable this cop to acknowledge.
+
+      # @example
+      #   # good BEFORE
+      #   # This code is deployed to production
+      #   class User < ApplicationRecord
+      #     self.ignored_columns += %w[some_column]
+      #   end
+      #
+      #   # good AFTER
+      #   # Your changeset deletes the ignored_column
+      #   class User < ApplicationRecord
+      #   end
+
+      #   class RemoveUsersSomeColumn < ActiveRecord::Migration[7.0]
+      #     def change
+      #       remove_column :users, :some_column # rubocop:disable Migration/AcknowledgeIgnoredColumn
+      #     end
+      #   end
+      class AcknowledgeIgnoredColumn < RuboCop::Cop::Base
+        MSG = "Do not remove a column until it is already ignored in production and " \
+              "all references to it are removed. Once done, remove the 'ignored_columns' " \
+              "from the Model and disable this cop to acknowledge this is safe."
+
+        def on_send(node)
+          return unless remove_column?(node)
+
+          add_offense(node)
+        end
+        alias on_csend on_send
+
+        def on_block(node)
+          return unless change_table_block?(node)
+
+          block_arg = node.arguments.first
+          return unless block_arg
+
+          remove_calls(node, block_arg.name) do |rename_node|
+            add_offense(rename_node)
+          end
+        end
+
+        def_node_matcher :change_table_block?, <<~PATTERN
+          (block
+            (send nil? :change_table ...)
+            (args (arg _))
+            _
+          )
+        PATTERN
+
+        def_node_search :remove_calls, <<~PATTERN
+          (send
+            (lvar %1)
+            :remove
+            ...
+          )
+        PATTERN
+
+        def_node_matcher :remove_column?, <<~PATTERN
+          (send
+            nil?
+            :remove_column
+            ...
+          )
+        PATTERN
+      end
+    end
+    # rubocop:enable Lint/RedundantCopDisableDirective
+  end
+end

data/lib/rubocop/cop/migration/rename_column.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Do not rename columns that are in use. It will cause down time in your application
+      # and is unsafe for pt-online-schema-change.
+      # Instead:
+      #
+      # 1. Create a new column
+      # 2. Backfill and write to the new column
+      # 3. Add old column to `ignored_columns` in model
+      # 4. Drop the old column
+      #
+      # This is meaningful if the table has records in it.
+      # But even if the column is not in use, one can not rename it.
+      # ActiveRecord accesses old columns unless all queries explicitly SELECT other columns.
+      #
+      # @example
+      #   # bad
+      #   class RenameUsersSettingsToProperties < ActiveRecord::Migration[7.0]
+      #     def change
+      #       rename_column :users, :settings, :properties
+      #     end
+      #   end
+      #
+      #   # good
+      #   class AddUsersProperties < ActiveRecord::Migration[7.0]
+      #     def change
+      #       add_column :users, :properties, :jsonb
+      #     end
+      #   end
+      #
+      #   class User < ApplicationRecord
+      #     self.ignored_columns += %w[settings]
+      #   end
+      #
+      #   class RemoveUsersSettings < ActiveRecord::Migration[7.0]
+      #     def change
+      #       remove_column :users, :settings
+      #     end
+      #   end
+      class RenameColumn < RuboCop::Cop::Base
+        MSG = "Do not rename columns that are in use. It will cause down time in your application " \
+              "and is unsafe for pt-online-schema-change."
+
+        def on_send(node)
+          return unless rename_column?(node)
+
+          add_offense(node)
+        end
+        alias on_csend on_send
+
+        def on_block(node)
+          return unless change_table_block?(node)
+
+          block_arg = node.arguments.first
+          return unless block_arg
+
+          rename_calls(node, block_arg.name) do |rename_node|
+            add_offense(rename_node)
+          end
+        end
+
+        def_node_matcher :change_table_block?, <<~PATTERN
+          (block
+            (send nil? :change_table ...)
+            (args (arg _))
+            _
+          )
+        PATTERN
+
+        def_node_search :rename_calls, <<~PATTERN
+          (send
+            (lvar %1)
+            :rename
+            ...
+          )
+        PATTERN
+
+        def_node_matcher :rename_column?, <<~PATTERN
+          (send
+            nil?
+            :rename_column
+            ...
+          )
+        PATTERN
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration/rename_table.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      # Do not rename tables. It will cause down time in your application and is unsafe for pt-online-schema-change.
+      # Instead:
+      #
+      # 1. Create a new table
+      # 2. Backfill and write to the new table
+      # 3. Drop the old table
+      #
+      # @example
+      #   # bad
+      #   class RenameUsersToAccouts < ActiveRecord::Migration[7.0]
+      #     def change
+      #       rename_table :users, :accounts
+      #     end
+      #   end
+      #
+      #   # good
+      #   class AddAccounts < ActiveRecord::Migration[7.0]
+      #     def change
+      #       create_table :accounts do |t|
+      #         t.string :name, null: false
+      #       end
+      #     end
+      #   end
+      #
+      #   class RemoveUsers < ActiveRecord::Migration[7.0]
+      #     def change
+      #       remove_table :users, if_exists: true
+      #     end
+      #   end
+      class RenameTable < RuboCop::Cop::Base
+        MSG = "Do not rename tables. It will cause down time in your application " \
+              "and is unsafe for pt-online-schema-change."
+
+        def on_send(node)
+          return unless rename_table?(node)
+
+          add_offense(node)
+        end
+        alias on_csend on_send
+
+        def_node_matcher :rename_table?, <<~PATTERN
+          (send
+            nil?
+            :rename_table
+            ...
+          )
+        PATTERN
+      end
+    end
+  end
+end

data/lib/rubocop/cop/migration_cops.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Migration
+      require_relative "migration/acknowledge_ignored_column"
+      require_relative "migration/rename_column"
+      require_relative "migration/rename_table"
+    end
+  end
+end

data/lib/rubocop/cop/style/no_helpers.rb

@@ -15,7 +15,7 @@ module RuboCop
           return if processed_source.blank?
           return unless helper_path?
 
-          add_offense(processed_source.ast, message: format(MSG))
+          add_offense(processed_source.ast)
         end
 
       private

data/lib/rubocop/powerhome/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Powerhome
-    VERSION = "0.5.5"
+    VERSION = "0.6.0"
   end
 end

data/lib/rubocop/powerhome.rb

@@ -3,7 +3,7 @@
 module RuboCop
   module Powerhome
     class Error < StandardError; end
-    # Your code goes here...
+
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
     CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze

data/lib/rubocop-powerhome.rb

@@ -3,6 +3,7 @@
 require "rubocop"
 
 require_relative "rubocop/powerhome"
+require_relative "rubocop/cop/migration_cops"
 require_relative "rubocop/cop/naming_cops"
 require_relative "rubocop/cop/style_cops"
 

data/rubocop-powerhome.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
 
-  spec.add_dependency "rubocop", "1.74.0"
+  spec.add_dependency "rubocop", "1.82.1"
   spec.add_dependency "rubocop-performance"
   spec.add_dependency "rubocop-rails"
   spec.add_dependency "rubocop-rake"
@@ -46,7 +46,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "license_finder", "~> 7.0"
   spec.add_development_dependency "pry", ">= 0.14.2"
   spec.add_development_dependency "pry-byebug", "3.10.1"
-  spec.add_development_dependency "rails", ">= 6.0.6.1", "< 7.1"
+  spec.add_development_dependency "rails", ">= 6.0.6.1", "< 8"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-powerhome
 version: !ruby/object:Gem::Version
-  version: 0.5.5
+  version: 0.6.0
 platform: ruby
 authors:
 - Carlos Palhares
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.74.0
+        version: 1.82.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.74.0
+        version: 1.82.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -145,7 +145,7 @@ dependencies:
         version: 6.0.6.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -155,7 +155,7 @@ dependencies:
         version: 6.0.6.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -208,7 +208,15 @@ files:
 - gemfiles/rails_6_1.gemfile.lock
 - gemfiles/rails_7_0.gemfile
 - gemfiles/rails_7_0.gemfile.lock
+- gemfiles/rails_7_1.gemfile
+- gemfiles/rails_7_1.gemfile.lock
+- gemfiles/rails_7_2.gemfile
+- gemfiles/rails_7_2.gemfile.lock
 - lib/rubocop-powerhome.rb
+- lib/rubocop/cop/migration/acknowledge_ignored_column.rb
+- lib/rubocop/cop/migration/rename_column.rb
+- lib/rubocop/cop/migration/rename_table.rb
+- lib/rubocop/cop/migration_cops.rb
 - lib/rubocop/cop/naming/view_component.rb
 - lib/rubocop/cop/naming_cops.rb
 - lib/rubocop/cop/style/no_helpers.rb
@@ -241,7 +249,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.7
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Powerhome Rubocop standard rules
 test_files: []