simplycop 2.3.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cd8f4d3b21badbb734986a32b7aa1283414acfe91d8f73f12131335a8b52b60
-  data.tar.gz: d8a6a4c018995bc720ddc50cd026735a26c3ed23e6eebe7b09330be30f3e804b
+  metadata.gz: fd09f4e7858d5143a39f3666e79cb20bf1f458720decf82b23149d4f7aba71e1
+  data.tar.gz: b35dc71c87ff97229dda37d0daa3e2c1c5f5003b52b4d3c6649bcde166c9bb7c
 SHA512:
-  metadata.gz: 480339d5068f0870e62c660559529f879c8eebc33f770a69942f69b2597f2c1364324bc9360e2f53eba86e06a7d80e8cb0d787d700ddd7d4fa1c5b83f7ca5716
-  data.tar.gz: 1fc5096f3e507f71e3ea1749772c5b866c291109ce10e512a010938ce9bb1f11735e291ef715edb4a843295dd32ddc4de84d9e821121603011d96682fa772db4
+  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/.simplycop_lint.yml

@@ -212,7 +212,6 @@ Lint/NextWithoutAccumulator:
 Lint/NoReturnInBeginEndBlocks:
   Enabled: true
 
-# Overridden to false in Chopin
 Lint/NonAtomicFileOperation:
   Enabled: true
 
@@ -294,7 +293,6 @@ Lint/RequireParentheses:
 Lint/RequireRangeParentheses:
   Enabled: true
 
-# Overridden to false in Chopin
 Lint/RequireRelativeSelfPath:
   Enabled: true
 

data/.simplycop_security.yml

@@ -25,7 +25,6 @@ Security/CheckForVulnerableCode:
 
 # Standard security cops
     
-# Overridden to false in Chopin
 Security/CompoundHash:
   Enabled: true
 

data/.simplycop_style.yml

@@ -16,7 +16,6 @@ Style/ArgumentsForwarding:
 Style/ArrayCoercion:
   Enabled: true
 
-# Overridden to false in Chopin
 Style/ArrayIntersect:
   Enabled: true
 
@@ -825,7 +824,6 @@ Style/WhileUntilDo:
 Style/WhileUntilModifier:
   Enabled: true
 
-# Overridden to false in Chopin
 Style/WordArray:
   EnforcedStyle: brackets
 

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.2'
+  VERSION = '2.5.0'
 end

data/simplycop.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop-ast', '1.32.3'
   spec.add_dependency 'rubocop-capybara', '2.21.0'
   spec.add_dependency 'rubocop-factory_bot', '2.26.1'
-  spec.add_dependency 'rubocop-performance', '1.21.1'
-  spec.add_dependency 'rubocop-rails', '2.26.1'
+  spec.add_dependency 'rubocop-performance', '1.22.1'
+  spec.add_dependency 'rubocop-rails', '2.26.2'
   spec.add_dependency 'rubocop-rspec', '3.0.5'
   spec.add_dependency 'rubocop-rspec_rails', '2.30.0'
   spec.add_development_dependency 'bundler', '>= 2.2.15'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplycop
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-11 00:00:00.000000000 Z
+date: 2024-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -72,28 +72,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.21.1
+        version: 1.22.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.21.1
+        version: 1.22.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.26.1
+        version: 2.26.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.26.1
+        version: 2.26.2
 - !ruby/object:Gem::Dependency
   name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -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