simplycop 2.3.3 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5bf29bc90d6b4e9d037c6d5c0d1bd61f3a17937a3025499bc84e0e5f41e6dff
-  data.tar.gz: fb894cbb90402223e398e636112b3468760fb4e2d19b3347b397e38be4288aab
+  metadata.gz: fd09f4e7858d5143a39f3666e79cb20bf1f458720decf82b23149d4f7aba71e1
+  data.tar.gz: b35dc71c87ff97229dda37d0daa3e2c1c5f5003b52b4d3c6649bcde166c9bb7c
 SHA512:
-  metadata.gz: 3783811394dd7f47e822e6a6c6f6938df1689def2052b7eaeed15f68e12689e5a4fc7d78a8b8cf08288e7329848fac2c406d64d05979dc801c3cedfb546d182d
-  data.tar.gz: 9cdb3be8d6d6f9e5745732f9e3f518efb1a44919c5c623b1e3f406f7c5b3a44925c9123b8be4251f168e7d547e79b770b929aeadd22e4636351ab9ade197d323
+  metadata.gz: 006b209f8bf36036bf7a902c7377793c8b73c2d7683ff94dd5d175dd93f94ccef005f9fc40c8cc6e3401c24874f357c83dbaf221097be62f8e1cee7d1bc39d57
+  data.tar.gz: 99e00ad5963e97f95041879c72e37e34b1fb7412706d547e90652408337c62143a334dd8a6202dac9ae55c8d2f6d964f0d08ace104ec00fc7276a45183486cd7

data/.custom_simplycop.yml

@@ -1,6 +1,7 @@
 require:
   - './lib/simplycop/custom_cops/timecop_without_block.rb'
   - './lib/simplycop/custom_cops/dont_print_all_env.rb'
+  - './lib/simplycop/custom_cops/no_foreground_indices.rb'
 
 AllCops:
   ExtraDetails: true
@@ -15,3 +16,10 @@ CustomCops/DontPrintAllEnv:
   Enabled: true
   Details: >-
     This cop checks if someone accidentally print all environment variables as they may contain secrets.
+
+CustomCops/NoForegroundIndices:
+  Enabled: true
+  Details: We want to prevent adding Mongoid indices that are not in background, otherwise the collection will lock during indexing.
+
+  Include:
+    - app/models/*

data/lib/simplycop/custom_cops/no_foreground_indices.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module CustomCops
+  #  This cop checks for the presence of Mongoid indexes that have not been
+  #  flagged with the flag `background: true`.
+  #
+  # @example
+  #   #bad
+  #   index(reference: 1)
+  #
+  #   #good
+  #   index({ reference: 1 }, { background: true })
+  #
+  class NoForegroundIndices < RuboCop::Cop::Cop
+    MSG = 'Do not create indices that lack the background flag.'
+
+    def_node_matcher :model_index?, <<~PATTERN
+      (send nil? :index $...)
+    PATTERN
+
+    def_node_matcher :hash?, <<~PATTERN
+      (hash $...)
+    PATTERN
+
+    def_node_matcher :background_pair?, <<~PATTERN
+      (pair
+        (sym :background)
+        (:true)
+      )
+    PATTERN
+
+    def on_send(node)
+      model_index?(node) do |_fields, options|
+        add_offense(node, location: :selector) unless background_enabled?(options)
+      end
+    end
+
+    private
+
+    def background_enabled?(hash)
+      return false if hash.nil? || !hash?(hash)
+
+      hash.pairs.any? { |pair| background_pair?(pair) }
+    end
+  end
+end

data/lib/simplycop/version.rb

@@ -7,5 +7,5 @@
 #
 
 module Simplycop
-  VERSION = '2.3.3'
+  VERSION = '2.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplycop
 version: !ruby/object:Gem::Version
-  version: 2.3.3
+  version: 2.5.0
 platform: ruby
 authors:
 - Simply Business
@@ -218,6 +218,7 @@ files:
 - lib/simplycop/custom_cops/dont_print_all_env.rb
 - lib/simplycop/custom_cops/instance_eval.rb
 - lib/simplycop/custom_cops/method_missing.rb
+- lib/simplycop/custom_cops/no_foreground_indices.rb
 - lib/simplycop/custom_cops/timecop_without_block.rb
 - lib/simplycop/custom_cops/variable_name_shadowing_method.rb
 - lib/simplycop/security/check_for_vulnerable_code.rb