betterlint 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4be70714f121b7f33abf6c01f95ff109af80785e27d242225d3e4b0dcf3baa2a
-  data.tar.gz: 233a10f1796cd42ebdebfa2ef715d7252f9d30abc6498e4f5cb5cec57b3f28a9
+  metadata.gz: fd581451b52d71fae89c2aa596958a8bd87bbddfa13f7e8b9019dbbe34cf3c6d
+  data.tar.gz: '0198a7a5d5e9db377f8964db8a7cd3e05c0f227e3f7a047d2914d930103aec81'
 SHA512:
-  metadata.gz: 7eebfe8e66e6098b8f78a2c5e564b51500bbbb5391f7fb341558495b0a8a8e3124f11be94a0d25ea7a3648a56c7d945d8f39815bdc30d28b8aff5374a7b768f2
-  data.tar.gz: d3f7249277cc5268cd7b6182fd4a21f98cf9e8150c6544a10af4476b879bded4675a9851b8b7f9faf541cc1863de573e6c4d6ef4969e8382338fd78620b3a08b
+  metadata.gz: c9c17ae11bc30e88ea612dd5a5b77dd8c7a89d9b2c0614a2c88dc53f5fc7099055286b1289c58015d7c8fad069df93f455a34000bf6820f32cb62a4241bc8025
+  data.tar.gz: ab5077e13a6044c53fc65654a57f282c14922a5288c1d2115c491cd35c063662f06e07572c7b26de750b4e73334ea26e8754ac1e3e8820c8821f312200960cec

data/README.md

@@ -19,6 +19,10 @@ plugins:
   - betterlint
 ```
 
+## Upgrading to 1.30
+
+Migration files are included in normal lint runs. Set `AllCops/MigratedSchemaVersion` to the last existing migration version to [skip historical files](#bettermentnodownmigrations).
+
 ## Dependencies
 
 This gem depends on the following other gems:
@@ -235,6 +239,49 @@ Betterment/UnsafeJob:
 
 It may make sense to consult your application's values for `Rails.application.config.filter_parameters`; if the application is filtering specific parameters from being logged, it might be a good idea to prevent these values from being stored in plaintext in a database as well.
 
+### Betterment/NoDownMigrations
+
+This cop enforces [the rule against down migrations](https://the-book.betterment.io/rules/ruby/#do-not-write-down-migrations)
+by flagging `down` methods and `direction.down` calls in migration `reversible` blocks.
+It allows `change` and standalone `up` methods and does not autocorrect.
+
+**Bad**
+
+```ruby
+class AddNickname < ActiveRecord::Migration[8.0]
+  def up
+    add_column :users, :nickname, :string
+  end
+
+  def down
+    remove_column :users, :nickname
+  end
+end
+```
+
+**Good**
+
+```ruby
+class AddNickname < ActiveRecord::Migration[8.0]
+  def change
+    add_column :users, :nickname, :string
+  end
+end
+```
+
+The cop is disabled by default. Enable it for migrations newer than a chosen version:
+
+```yaml
+AllCops:
+  MigratedSchemaVersion: '20261030120000'
+
+Betterment/NoDownMigrations:
+  Enabled: true
+```
+
+Set `MigratedSchemaVersion` under this cop to ignore additional migrations.
+Leave `Rails/ReversibleMigrationMethodDefinition` disabled: it requires `up` and `down`.
+
 ### Betterment/NonStandardActions
 
 This cop looks at Rails route files and flags routes that go to non-standard controller actions.

data/config/default.yml

@@ -20,7 +20,7 @@ AllCops:
     - Gemfile
     - bin/**/*
     - build/**/*
-    - db/**/*
+    - db/*schema.rb
     - frontend/**/*
     - node_modules/**/*
     - tmp/**/*
@@ -62,6 +62,14 @@ Betterment/InternalsProtection:
   StyleGuide: '#bettermentinternalsprotection'
   Enabled: false
 
+Betterment/NoDownMigrations:
+  Description: Disallows explicit rollback code in database migrations.
+  Enabled: false
+  MigratedSchemaVersion:
+  StyleGuide: '#bettermentnodownmigrations'
+  Include:
+    - db/migrate/**/*.rb
+
 Betterment/NonNamespacedClass:
   Description: Detects classes that are not namespaced under a module or constant
   StyleGuide: '#bettermentnonamespacedclass'

data/lib/betterlint/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Betterlint
-  VERSION = '1.29.0'
+  VERSION = '1.30.0'
 end

data/lib/rubocop/cop/betterment/no_down_migrations.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'rubocop/cop/mixin/migrations_helper'
+
+module RuboCop
+  module Cop
+    module Betterment
+      class NoDownMigrations < Base
+        include MigrationsHelper
+
+        MSG = 'Do not write explicit rollback code. Correct deployed migrations with a new forward migration.'
+        RESTRICT_ON_SEND = %i(down).freeze
+
+        def on_def(node)
+          add_offense(node.loc.name) if node.method?(:down) && migration_to_check?(node)
+        end
+        alias on_defs on_def
+
+        def on_send(node)
+          if migration_to_check?(node) && reversible_direction?(node.receiver)
+            add_offense(node.loc.selector)
+          end
+        end
+        alias on_csend on_send
+
+        private
+
+        def migration_to_check?(node)
+          return false unless migration_class?(node.each_ancestor(:class).first)
+
+          cutoff = cop_config.fetch('MigratedSchemaVersion')
+          version = File.basename(processed_source.file_path)[/\A\d+(?=_)/]
+          !cutoff || !version || version.to_i > Integer(cutoff)
+        end
+
+        def reversible_direction?(receiver)
+          return false unless receiver&.lvar_type?
+
+          binding = receiver.each_ancestor(:any_block).find do |block|
+            block.argument_list.any? { |argument| argument.name == receiver.children.first }
+          end
+
+          binding&.method?(:reversible) && (binding.receiver.nil? || binding.receiver.self_type?)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/betterment.rb

@@ -12,6 +12,7 @@ require 'rubocop/cop/betterment/hardcoded_id'
 require 'rubocop/cop/betterment/implicit_redirect_type'
 require 'rubocop/cop/betterment/internals_protection'
 require 'rubocop/cop/betterment/memoization_with_arguments'
+require 'rubocop/cop/betterment/no_down_migrations'
 require 'rubocop/cop/betterment/non_namespaced_class'
 require 'rubocop/cop/betterment/non_standard_actions'
 require 'rubocop/cop/betterment/non_standard_controller'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: betterlint
 version: !ruby/object:Gem::Version
-  version: 1.29.0
+  version: 1.30.0
 platform: ruby
 authors:
 - Development
@@ -105,14 +105,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.34'
+        version: '2.36'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.34'
+        version: '2.36'
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -179,6 +179,7 @@ files:
 - lib/rubocop/cop/betterment/implicit_redirect_type.rb
 - lib/rubocop/cop/betterment/internals_protection.rb
 - lib/rubocop/cop/betterment/memoization_with_arguments.rb
+- lib/rubocop/cop/betterment/no_down_migrations.rb
 - lib/rubocop/cop/betterment/non_namespaced_class.rb
 - lib/rubocop/cop/betterment/non_standard_actions.rb
 - lib/rubocop/cop/betterment/non_standard_controller.rb
@@ -203,10 +204,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/Betterment/betterlint
-  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.29.0
-  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.29.0/CHANGELOG.md
+  source_code_uri: https://github.com/Betterment/betterlint/tree/v1.30.0
+  changelog_uri: https://github.com/Betterment/betterlint/blob/v1.30.0/CHANGELOG.md
   bug_tracker_uri: https://github.com/Betterment/betterlint/issues
-  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.29.0
+  documentation_uri: https://www.rubydoc.info/gems/betterlint/1.30.0
   rubygems_mfa_required: 'true'
   default_lint_roller_plugin: Betterlint::Plugin
 rdoc_options: []
@@ -223,7 +224,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.13
+rubygems_version: 4.0.21
 specification_version: 4
 summary: Betterment rubocop configuration
 test_files: []