ezcater_rubocop 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 323c025da922f1cda50aabdabe7bf0869962acab4a539d31ab46e0f53e9cb7ae
-  data.tar.gz: 9fefcf330dd581976919e2350c7c21394752d9b5ee22487e164d8b216e54fbab
+  metadata.gz: 5c15a00ae9ee7d51e47aaf97b9fb70308b94992ce89ea2f2240a9405021b90b1
+  data.tar.gz: 80c042251192d29ff9e3fda486fbd18cdd02e9231b3ba381650488dd86a0a14e
 SHA512:
-  metadata.gz: 4cfb5f29b315f4b275f9b664864a289651395093a8f3aefd010bb233744b93d00639a24fefa5e7ba4600ad3fea76206c53c946932e3b0f6303919257dd605933
-  data.tar.gz: 620ededc1b8d3c301bfb79d31de02953a5172167741e52b19475e747a4d24847e5a4a75e62fc8540d4eb75ae135e7e2a5cd74d4771ac6a67bb60a128db4859b7
+  metadata.gz: c0c6d395b37d422cbf0d63bd221dd1cc971da352b1af23d9b5c871e922731f8492095d2ceceea4cdb33a630b72bb7799acf69ddb4d9a1bf8046b8e587d1436d2
+  data.tar.gz: f6573e38d0e0b75df186f03941a72552854cb5f22c4fe8f488f2f013ae3d633e6b317b2d4212e22a3d706da795cd78a61ee5dd44e6632006b50fc303787f5780

data/CHANGELOG.md

@@ -10,6 +10,10 @@ Prior to v1.0.0 this gem was versioned based on the `MAJOR`.`MINOR` version of R
 
 - ...
 
+## v1.2.0
+
+- Add `Ezcater/RailsTopLevelSqlExecute` to replace `ActiveRecord::Base.connection.execute` with `execute` in `db/migrate/`.
+
 ## v1.1.1
 
 - Exclude `lib/tasks/` for `Ezcater/RailsEnv` and `Ezcater/DirectEnvCheck`.

data/conf/rubocop_rails.yml

@@ -47,6 +47,12 @@ Rails/UnknownEnv:
     - staging
     - production
 
+Ezcater/RailsTopLevelSqlExecute:
+  Description: 'Use `execute` instead of `ActiveRecord::Base.connection.execute` in migrations.'
+  Enabled: true
+  Include:
+    - "db/migrate/**/*"
+
 Ezcater/RailsEnv:
   Description: 'Enforce the use of `Rails.configuration.x.<foo>` instead of checking `Rails.env`.'
   Enabled: true

data/lib/ezcater_rubocop.rb

@@ -17,6 +17,7 @@ RuboCop::ConfigLoader.instance_variable_set(:@default_configuration, config)
 require "rubocop/cop/ezcater/direct_env_check"
 require "rubocop/cop/ezcater/rails_configuration"
 require "rubocop/cop/ezcater/rails_env"
+require "rubocop/cop/ezcater/rails_top_level_sql_execute"
 require "rubocop/cop/ezcater/require_gql_error_helpers"
 require "rubocop/cop/ezcater/rspec_match_ordered_array"
 require "rubocop/cop/ezcater/rspec_require_browser_mock"

data/lib/ezcater_rubocop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EzcaterRubocop
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/rubocop/cop/ezcater/rails_top_level_sql_execute.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Ezcater
+      # Use `execute` instead of `ActiveRecord::Base.connection.execute` in migrations. The latter is redundant and
+      # can bypass migration safety checks.
+      #
+      # @example
+      #
+      #   # good
+      #   execute("...")
+      #
+      #   # bad
+      #   ActiveRecord::Base.connection.execute("...")
+      #
+      class RailsTopLevelSqlExecute < Cop
+        MSG = <<~END_MESSAGE.split("\n").join(" ")
+          Use `execute` instead of `ActiveRecord::Base.connection.execute` in migrations. The latter is
+          redundant and can bypass safety checks.
+        END_MESSAGE
+
+        def_node_matcher "ar_connection_execute", <<-PATTERN
+          (send (send (const (const _ :ActiveRecord) :Base) :connection) :execute _)
+        PATTERN
+
+        def on_send(node)
+          ar_connection_execute(node) do
+            add_offense(node, location: :expression, message: MSG)
+          end
+        end
+
+        def autocorrect(node)
+          lambda do |corrector|
+            range = Parser::Source::Range.new(
+              node.source_range.source_buffer,
+              node.source_range.begin_pos,
+              node.source_range.end_pos
+            )
+
+            corrector.replace(range, "execute(#{node.last_argument.source})")
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ezcater_rubocop
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-02 00:00:00.000000000 Z
+date: 2019-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -161,6 +161,7 @@ files:
 - lib/rubocop/cop/ezcater/direct_env_check.rb
 - lib/rubocop/cop/ezcater/rails_configuration.rb
 - lib/rubocop/cop/ezcater/rails_env.rb
+- lib/rubocop/cop/ezcater/rails_top_level_sql_execute.rb
 - lib/rubocop/cop/ezcater/require_gql_error_helpers.rb
 - lib/rubocop/cop/ezcater/rspec_dot_not_self_dot.rb
 - lib/rubocop/cop/ezcater/rspec_match_ordered_array.rb