simplycop 1.6.4 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92bb33b36ef3075fabd5fb751db5db4ee51600adbdc590b8087ee3caa7096067
-  data.tar.gz: 9ef66e1eee9f894ca08f5842e057d499c3a876ba4771df484034fc47ef33b886
+  metadata.gz: 37f961bf25d8a75b4c034f73b033878fda1f93de9aac8eb0f7d973a70cb6208f
+  data.tar.gz: db170cb142883c29d430f3c0963c8cd5aa8e000ce1c4b5f4651efef7c5945c04
 SHA512:
-  metadata.gz: e85123bfa60e0fde3362574a9340ac24a1a47deda3285604946f0719b169f286c7076a6097388caea6ea1e8eb0c3e8cd140019d17e3c2440ebae6566b9165987
-  data.tar.gz: 2da2ab60e881de80ae5e4b94c440ad5b794ae4be62307a0b6f8064707f310ce91ec3006ae767bc7db8cf70706d863ac16adae0c624ea2999b4a347076399358f
+  metadata.gz: fd9db437e6ba9d1b47e5c2a5ff2ff3d63657c274b5898dabc0b7bbb87802221dbf4dc4c883d7c03498ed28ce1c6b89c985ccff6b89d9e4a4155d5d9959f53ba5
+  data.tar.gz: 312b26a63c636df40d7508102ae82181951f0024f70006c71a92615ef5ac349b53779a69459c2f426bec3a537955e53494cac690e4e64d1b0ac48e7ab274b30b

data/.github/workflows/dobby-actions.yml

@@ -9,7 +9,7 @@ jobs:
 
     steps:
       - name: 'bump version'
-        uses: simplybusiness/dobby@v2.0.0
+        uses: simplybusiness/dobby@v2.1.0
         env:
           DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
           DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}

data/.simplycop.yml

@@ -22,6 +22,9 @@ AllCops:
   ExtraDetails: true
 # Adapted from: https://github.com/simplybusiness/how-we-roll/blob/master/development/RUBYSTYLEGUIDE.markdown
 
+Gemspec/DateAssignment:
+  Enabled: true
+
 Layout/EmptyLineAfterMultilineCondition:
   Enabled: true
 
@@ -95,28 +98,14 @@ Lint/UnexpectedBlockArity:
 Lint/UnmodifiedReduceAccumulator:
   Enabled: true
 
-###### COPS REVIEWED ABOVE THIS LINE ######
-
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
-    -
+
 Metrics/ClassLength:
   Max: 512
-  Enabled: true
-
-Metrics/ModuleLength:
-  Enabled: true
 
-Naming/FileName:
-  Enabled: true
-
-Naming/VariableName:
-  Enabled: true
-  EnforcedStyle: snake_case
-  SupportedStyles:
-    - snake_case
-    - camelCase
+###### COPS REVIEWED ABOVE THIS LINE ######
 
 Style/AccessorGrouping:
   Enabled: true
@@ -185,6 +174,9 @@ Style/GuardClause:
 Style/HashAsLastArrayItem:
   Enabled: true
 
+Style/HashConversion:
+  Enabled: true
+
 Style/HashEachMethods:
   Enabled: false
 
@@ -301,6 +293,9 @@ Style/SpecialGlobalVars:
   Enabled: true
   Severity: warning
 
+Style/StringChars:
+  Enabled: true
+
 Style/StringConcatenation:
   Enabled: true
 

data/README.md

@@ -2,72 +2,4 @@
 
 Provides standard shared rubocop configuration for Simply Business applications. No more copying `.rubocop.yml`, no more out-of-sync configuration files. Yay!
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'simplycop', git: 'git@github.com:simplybusiness/simplycop.git'
-
-```
-
-Then install gems by executing:
-
-    $ bundle install
-
-Put following lines at the beginning of your `rubocop.yml` file:
-
-```yaml
-inherit_gem:
-  simplycop: .simplycop.yml
-
-AllCops:
-  Exclude:
-    - 'vendor/**/*'
-```
-
-* If you are implementing this in rails project and have rspec , you probably want the standard rails and rspec cops. you can include this by adding:
-
-```yaml
-inherit_gem:
-  simplycop:
-    - .simplycop.yml
-    - .simplycop_rails.yml
-    - .simplycop_rspec.yml
-```
-
-## Usage
-
-Run Rubocop as you would usually do, i.e.
-
-    $ bundle exec rubocop
-
-or from your continuous integration tool.
-
-## Guidances
-
-* If you are implementing this in a non-rails project, you probably don't want or need the rails cops. In case they cause problems, you can exclude them using:
-```yaml
-Rails:
-  Enabled: false
-```
-* When adding rubocop and simplycop to a legacy project, you might want to initially disable some of the rules.
-
-## Security Cops
-- CheckForVulnerableCode
-
-This cop was built to identify possible Rails vulnerable code.
-Its purpose is to raise an awareness of the finding.
-When an offence was raised, please seek for help and guidance from application security team.
-
-IMPORTANT:
-This cop must be enabled at all times, if you need to disable it please check with AppSec team first.
-
-Example of vulnerable code:
-
-```ruby
-class BooksController < ApplicationController
-  caches_page :show
-end
-```
-Vulnerability Details: https://nvd.nist.gov/vuln/detail/CVE-2020-8159
+See [Full docs](docs/index.md)

data/catalog-info.yaml

@@ -0,0 +1,16 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: simplycop
+  description: Simply Business Rubocop rules
+  annotations:
+    github.com/project-slug: "simplybusiness/simplycop"
+    backstage.io/source-location: url:https://github.com/simplybusiness/simplycop/
+spec:
+  type: library
+  lifecycle: production
+  owner: silversmiths
+  dependsOn:
+    - "Component:rake"
+    - "Component:rspec"
+    - "Component:rubocop"

data/docs/index.md

@@ -0,0 +1,73 @@
+# Simplycop
+
+Provides standard shared rubocop configuration for Simply Business applications. No more copying `.rubocop.yml`, no more out-of-sync configuration files. Yay!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'simplycop'
+
+```
+
+Then install gems by executing:
+
+    $ bundle install
+
+Put following lines at the beginning of your `rubocop.yml` file:
+
+```yaml
+inherit_gem:
+  simplycop: .simplycop.yml
+
+AllCops:
+  Exclude:
+    - 'vendor/**/*'
+```
+
+* If you are implementing this in rails project and have rspec , you probably want the standard rails and rspec cops. you can include this by adding:
+
+```yaml
+inherit_gem:
+  simplycop:
+    - .simplycop.yml
+    - .simplycop_rails.yml
+    - .simplycop_rspec.yml
+```
+
+## Usage
+
+Run Rubocop as you would usually do, i.e.
+
+    $ bundle exec rubocop
+
+or from your continuous integration tool.
+
+## Guidances
+
+* If you are implementing this in a non-rails project, you probably don't want or need the rails cops. In case they cause problems, you can exclude them using:
+```yaml
+Rails:
+  Enabled: false
+```
+* When adding rubocop and simplycop to a legacy project, you might want to initially disable some of the rules.
+
+## Security Cops
+- CheckForVulnerableCode
+
+This cop was built to identify possible Rails vulnerable code.
+Its purpose is to raise an awareness of the finding.
+When an offence was raised, please seek for help and guidance from application security team.
+
+IMPORTANT:
+This cop must be enabled at all times, if you need to disable it please check with AppSec team first.
+
+Example of vulnerable code:
+
+```ruby
+class BooksController < ApplicationController
+  caches_page :show
+end
+```
+Vulnerability Details: https://nvd.nist.gov/vuln/detail/CVE-2020-8159

data/lib/simplycop/version.rb

@@ -7,5 +7,5 @@
 #
 
 module Simplycop
-  VERSION = '1.6.4'
+  VERSION = '1.7.3'
 end

data/mkdocs.yml

@@ -0,0 +1,7 @@
+site_name: 'Simplycop Docs'
+docs_dir: 'doc'
+nav:
+  - Home: index.md
+
+plugins:
+  - techdocs-core

data/simplycop.gemspec

@@ -17,9 +17,9 @@ Gem::Specification.new do |spec|
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rubocop', '~> 1.9.1'
+  spec.add_dependency 'rubocop', '~> 1.12.1'
   spec.add_dependency 'rubocop-rails', '~> 2.9.0'
-  spec.add_dependency 'rubocop-rspec', '~> 2.1.0'
+  spec.add_dependency 'rubocop-rspec', '~> 2.2.0'
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplycop
 version: !ruby/object:Gem::Version
-  version: 1.6.4
+  version: 1.7.3
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-25 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.12.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.9.1
+        version: 1.12.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rails
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.1.0
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +123,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- catalog-info.yaml
+- docs/index.md
 - lib/simplycop.rb
 - lib/simplycop/custom_cops/constantize.rb
 - lib/simplycop/custom_cops/define_method.rb
@@ -134,6 +136,7 @@ files:
 - lib/simplycop/security/csrf_token_validation.rb
 - lib/simplycop/security/reject_all_requests_local.rb
 - lib/simplycop/version.rb
+- mkdocs.yml
 - simplycop.gemspec
 - vuln_db.json
 homepage: https://github.com/simplybusiness/simplycop
@@ -155,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provides a single point of reference for common rubocop rules.