simplycop 2.15.0 → 2.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9533e9be57ea5b5426ae2281a38a07107b8d08df130b3ce3602dc2087643cb8b
-  data.tar.gz: 5aac1a1ab8f0e60b6999bc5276af34b943e4e6a582385b0e12b2c88effa92e55
+  metadata.gz: 001daed63b2564e1470bfc3d10a710e539d27be6ebd1525736f715c84b15ccc2
+  data.tar.gz: 4ec0826610ae5b39b596ef2a420eac1812e79004b730edae051091c9e57bc80c
 SHA512:
-  metadata.gz: 5ec594e0ce8c5d6e8466efff142a68685b618af4f1bc9cd35f71ae4414d3e6d3c2e280860d22b847a7a0824e09dc33710fdadcce08acec6c96222484c3a8481d
-  data.tar.gz: b4c9331d7eb41aed654ad015f12c6ebddd651105c02edb2ae9f730a7c0f05cafe74f84f4307ce432c4d7bedca6709f0efb9fd8e315769362b83b4e0c9be06625
+  metadata.gz: 6d9ae17467b5944a0772b6f083c6b4f07e42e5cd792f77f60bc5aa5665ae064edb19e4c9cbaf5d9afda5968dbdaf71c71f23157fdc4a8c502b5a72f345b8db7e
+  data.tar.gz: 2417bd12bfdd7735997817cc82a33b0b3a9f3cc133c99e2526e614aeac288d4cb0795193218c64eeba2939788911b4580cc8d3a61cf5d6fc86a3db1a4b01e37d

data/catalog-info.yaml

@@ -10,7 +10,7 @@ metadata:
     simplybusiness.com/bnw-app-name: simplycop
     simplybusiness.com/sast-scanning: enabled
     rubygems.org/name: simplycop
-    rubygems.org/current-version: 2.15.0
+    rubygems.org/current-version: 2.15.1
 spec:
   type: library
   lifecycle: production

data/docs/index.md

@@ -101,3 +101,39 @@ class BooksController < ApplicationController
 end
 ```
 Vulnerability Details: https://nvd.nist.gov/vuln/detail/CVE-2020-8159
+
+## Development
+
+To change a setting for simplycop, simply edit the relevant .yml file with the configuration changes you wish to make. The aim is to choose a sensible configuration for all new cops as they are added in package updates. 
+
+Rubocop is well established enough that most new cops are for niche cases. The default assumption is therefore that they will provide a small code quality benefit without major disruption to the codebase and can safely be enabled.
+
+However, this is not always the case. Always check the notes on the cop to understand the reasoning behind it, paying particular attention to any warnings and exceptions listed.
+
+- [Base Rubocop](https://docs.rubocop.org/rubocop/cops.html)
+- [Rubocop Capybara](https://docs.rubocop.org/rubocop-capybara/cops.html)
+- [Rubocop Factory Bot](https://docs.rubocop.org/rubocop-factory_bot/cops.html)
+- [Rubocop Performance](https://docs.rubocop.org/rubocop-performance/cops.html)
+- [Rubocop Rails](https://docs.rubocop.org/rubocop-rails/cops.html)
+- [Rubocop Rspec](https://docs.rubocop.org/rubocop-rspec/cops.html)
+- [Rubocop RSpec Rails](https://docs.rubocop.org/rubocop-rspec_rails/cops.html)
+
+Consider keeping the cop disabled (or selecting a sensible config option) if any of the following apply:
+- The cop is disabled by default in rubocop (NB: All new cops are set to pending until the next major rubocop version)
+- The cop is listed as not safe in rubocop. Read the notes to find out why.
+- It is known that a large part of the SB codebase will systematically break a rule. Use smaller, newer repos as your benchmark for this. Chopin and Rater will have violations for most new rules, so do not disable a rule on that basis alone if it will bring benefit across the wider codebase.
+
+Other things to bear in mind:
+- Lean towards enabling rules if there are clear performance and/or clarity benefits.
+- Avoid setting config or enablement based on personal stylistic preference. If a team has a particularly strong stylistic preference on, say [explicit return of nil](https://docs.rubocop.org/rubocop/cops_style.html#stylereturnnil) this can be overridden at a repo level.
+- Default maximums for metrics cops are hard to meet and regularly violated. For that reason, they are mostly overridden or set as 'to-dos' within individual repos. There will be value in reducing violation of these over time, but centralised maximums have not yet been discussed or set.
+
+If in doubt, discuss in #technical-excellence-community or #tech for guidance and a wider range of opinion.
+
+### Versioning
+
+When updating simplycop, you can use [dobby](https://github.com/simplybusiness/dobby) in your PR comments to increment the version number. Try to stick to the following versioning principles
+
+- MAJOR: For breaking changes (e.g in [v2.0](https://github.com/simplybusiness/simplycop/releases/tag/2.0.0) several rubocop departments were split out into separate packages)
+- MINOR: For rule enablements, disablements and config changes (i.e. changes that may cause previously passing rubocop runs to fail)
+- PATCH: For updates that do not touch config (e.g. individual rubocop package bumps which typically fix false positives/negatives or other bugs, doc changes)

data/lib/simplycop/version.rb

@@ -7,5 +7,5 @@
 #
 
 module Simplycop
-  VERSION = '2.15.0'
+  VERSION = '2.15.1'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: simplycop
 version: !ruby/object:Gem::Version
-  version: 2.15.0
+  version: 2.15.1
 platform: ruby
 authors:
 - Simply Business
 bindir: bin
 cert_chain: []
-date: 2025-03-26 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop