simplycop 1.7.0 → 1.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44b5f9419a9d452d32f7d123d2556a8aa54fa929d4cf1ad15ba8d050141dca2b
-  data.tar.gz: c5a7282f831692081d6318e8da1bc44db00ae5b2c4e5e89ede7f2ee7c4c92010
+  metadata.gz: 51da31df3951047a568a81ec7504c1930411afcf0e857b2e65ace63d1f488ac0
+  data.tar.gz: 85d46a288f0d262dda7ba5d45499af3f7e8091ca74a66631eafae6cb1f140a00
 SHA512:
-  metadata.gz: 14a434723f2626c1c2032ebf6ced1ad2289e4ef519832f4c6c2c557a5ead996f449cab005f35d94924e13c001576c38a163c478ed6b946a520b64bef644cc891
-  data.tar.gz: d8aba41e196a647ddc612d526c5894a87419000ad581edebf5d1333dca93fe8604bd6550d78e3239d2ea071671bda226d3ea4c5223e8c4906cf65e5cbe84f4b9
+  metadata.gz: 5557171cf6f61cfb26ea0cefcb6a3cc8d50bd6310fbdd061bae01e3ff50232a0bc2c8c0316737408baec401ac3e6426b4c82f72e07dd2a5804d56a8a50a67253
+  data.tar.gz: 6c4f41690117b681f990ed6dc631a5def48e4881b0040ec2f9446b1931e35f61a426a3d0a7205dc63e2f08eb86a699f56a55b140232e5f071a1e75d6b68459b7

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

@@ -1,4 +1,5 @@
-name: "dobby actions"
+
+name: "Dobby action"
 on:
   issue_comment:
     types: [created]
@@ -6,10 +7,20 @@ jobs:
   pr_commented:
     runs-on: ubuntu-20.04
     if: startsWith(github.event.comment.body, '/dobby')
-
+    env:
+      BUNDLE_WITHOUT: "development:test"
     steps:
-      - name: 'bump version'
-        uses: simplybusiness/dobby@v2.0.0
+      - name: Chekcout action
+        uses: actions/checkout@v2
+        with:
+          repository: 'simplybusiness/dobby'
+          ref: 'v3.0.0'
+      - name: Set up ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Bump version
+        uses: simplybusiness/dobby@v3.0.0
         env:
           DOBBY_APP_ID: ${{ secrets.DOBBY_APP_ID }}
           DOBBY_PRIVATE_KEY: ${{ secrets.DOBBY_PRIVATE_KEY }}

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.7.0'
+  VERSION = '1.7.4'
 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.0
+  version: 1.7.4
 platform: ruby
 authors:
 - Simply Business
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-07 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -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.