simplycop 1.7.2 → 1.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 50a0298e4fe2fea10475eb542f24df49cc548add3299ce646df95daca8ac8194
-  data.tar.gz: f7bc5d42576f976f5be0b7d28920861d38553dcc907a41a8d7044df941771661
+  metadata.gz: 37f961bf25d8a75b4c034f73b033878fda1f93de9aac8eb0f7d973a70cb6208f
+  data.tar.gz: db170cb142883c29d430f3c0963c8cd5aa8e000ce1c4b5f4651efef7c5945c04
 SHA512:
-  metadata.gz: 88236123a372bef498fc28c6b897b5017fdd4492b05c9fb575720721d9174a6b74828a4ae06be57a4dc3082be26eb15f60d3f850ac581a3beb0c55b40a55c883
-  data.tar.gz: 94ad143b7fa0971802e735be97f98ba6ee2826c2c846bdad91a646f50277a070201a756a5ed70b0a57530c6c9d4ce807bf61c6c8c979e089b00d984bf85ab0bd
+  metadata.gz: fd9db437e6ba9d1b47e5c2a5ff2ff3d63657c274b5898dabc0b7bbb87802221dbf4dc4c883d7c03498ed28ce1c6b89c985ccff6b89d9e4a4155d5d9959f53ba5
+  data.tar.gz: 312b26a63c636df40d7508102ae82181951f0024f70006c71a92615ef5ac349b53779a69459c2f426bec3a537955e53494cac690e4e64d1b0ac48e7ab274b30b

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

@@ -6,7 +6,6 @@ metadata:
   annotations:
     github.com/project-slug: "simplybusiness/simplycop"
     backstage.io/source-location: url:https://github.com/simplybusiness/simplycop/
-    backstage.io/techdocs-ref: url:https://github.com/simplybusiness/simplycop/
 spec:
   type: library
   lifecycle: production

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.7.2'
+  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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simplycop
 version: !ruby/object:Gem::Version
-  version: 1.7.2
+  version: 1.7.3
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-09 00:00:00.000000000 Z
+date: 2021-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -124,6 +124,7 @@ files:
 - 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
@@ -135,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
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Provides a single point of reference for common rubocop rules.