simplycop 1.7.2 → 1.7.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +1 -69
- data/catalog-info.yaml +0 -1
- data/docs/index.md +73 -0
- data/lib/simplycop/version.rb +1 -1
- data/mkdocs.yml +7 -0
- metadata +5 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 37f961bf25d8a75b4c034f73b033878fda1f93de9aac8eb0f7d973a70cb6208f
|
|
4
|
+
data.tar.gz: db170cb142883c29d430f3c0963c8cd5aa8e000ce1c4b5f4651efef7c5945c04
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: fd9db437e6ba9d1b47e5c2a5ff2ff3d63657c274b5898dabc0b7bbb87802221dbf4dc4c883d7c03498ed28ce1c6b89c985ccff6b89d9e4a4155d5d9959f53ba5
|
|
7
|
+
data.tar.gz: 312b26a63c636df40d7508102ae82181951f0024f70006c71a92615ef5ac349b53779a69459c2f426bec3a537955e53494cac690e4e64d1b0ac48e7ab274b30b
|
data/README.md
CHANGED
|
@@ -2,72 +2,4 @@
|
|
|
2
2
|
|
|
3
3
|
Provides standard shared rubocop configuration for Simply Business applications. No more copying `.rubocop.yml`, no more out-of-sync configuration files. Yay!
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
Add this line to your application's Gemfile:
|
|
8
|
-
|
|
9
|
-
```ruby
|
|
10
|
-
gem 'simplycop', git: 'git@github.com:simplybusiness/simplycop.git'
|
|
11
|
-
|
|
12
|
-
```
|
|
13
|
-
|
|
14
|
-
Then install gems by executing:
|
|
15
|
-
|
|
16
|
-
$ bundle install
|
|
17
|
-
|
|
18
|
-
Put following lines at the beginning of your `rubocop.yml` file:
|
|
19
|
-
|
|
20
|
-
```yaml
|
|
21
|
-
inherit_gem:
|
|
22
|
-
simplycop: .simplycop.yml
|
|
23
|
-
|
|
24
|
-
AllCops:
|
|
25
|
-
Exclude:
|
|
26
|
-
- 'vendor/**/*'
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
* 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:
|
|
30
|
-
|
|
31
|
-
```yaml
|
|
32
|
-
inherit_gem:
|
|
33
|
-
simplycop:
|
|
34
|
-
- .simplycop.yml
|
|
35
|
-
- .simplycop_rails.yml
|
|
36
|
-
- .simplycop_rspec.yml
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
## Usage
|
|
40
|
-
|
|
41
|
-
Run Rubocop as you would usually do, i.e.
|
|
42
|
-
|
|
43
|
-
$ bundle exec rubocop
|
|
44
|
-
|
|
45
|
-
or from your continuous integration tool.
|
|
46
|
-
|
|
47
|
-
## Guidances
|
|
48
|
-
|
|
49
|
-
* 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:
|
|
50
|
-
```yaml
|
|
51
|
-
Rails:
|
|
52
|
-
Enabled: false
|
|
53
|
-
```
|
|
54
|
-
* When adding rubocop and simplycop to a legacy project, you might want to initially disable some of the rules.
|
|
55
|
-
|
|
56
|
-
## Security Cops
|
|
57
|
-
- CheckForVulnerableCode
|
|
58
|
-
|
|
59
|
-
This cop was built to identify possible Rails vulnerable code.
|
|
60
|
-
Its purpose is to raise an awareness of the finding.
|
|
61
|
-
When an offence was raised, please seek for help and guidance from application security team.
|
|
62
|
-
|
|
63
|
-
IMPORTANT:
|
|
64
|
-
This cop must be enabled at all times, if you need to disable it please check with AppSec team first.
|
|
65
|
-
|
|
66
|
-
Example of vulnerable code:
|
|
67
|
-
|
|
68
|
-
```ruby
|
|
69
|
-
class BooksController < ApplicationController
|
|
70
|
-
caches_page :show
|
|
71
|
-
end
|
|
72
|
-
```
|
|
73
|
-
Vulnerability Details: https://nvd.nist.gov/vuln/detail/CVE-2020-8159
|
|
5
|
+
See [Full docs](docs/index.md)
|
data/catalog-info.yaml
CHANGED
|
@@ -6,7 +6,6 @@ metadata:
|
|
|
6
6
|
annotations:
|
|
7
7
|
github.com/project-slug: "simplybusiness/simplycop"
|
|
8
8
|
backstage.io/source-location: url:https://github.com/simplybusiness/simplycop/
|
|
9
|
-
backstage.io/techdocs-ref: url:https://github.com/simplybusiness/simplycop/
|
|
10
9
|
spec:
|
|
11
10
|
type: library
|
|
12
11
|
lifecycle: production
|
data/docs/index.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# Simplycop
|
|
2
|
+
|
|
3
|
+
Provides standard shared rubocop configuration for Simply Business applications. No more copying `.rubocop.yml`, no more out-of-sync configuration files. Yay!
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
```ruby
|
|
10
|
+
gem 'simplycop'
|
|
11
|
+
|
|
12
|
+
```
|
|
13
|
+
|
|
14
|
+
Then install gems by executing:
|
|
15
|
+
|
|
16
|
+
$ bundle install
|
|
17
|
+
|
|
18
|
+
Put following lines at the beginning of your `rubocop.yml` file:
|
|
19
|
+
|
|
20
|
+
```yaml
|
|
21
|
+
inherit_gem:
|
|
22
|
+
simplycop: .simplycop.yml
|
|
23
|
+
|
|
24
|
+
AllCops:
|
|
25
|
+
Exclude:
|
|
26
|
+
- 'vendor/**/*'
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
* 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:
|
|
30
|
+
|
|
31
|
+
```yaml
|
|
32
|
+
inherit_gem:
|
|
33
|
+
simplycop:
|
|
34
|
+
- .simplycop.yml
|
|
35
|
+
- .simplycop_rails.yml
|
|
36
|
+
- .simplycop_rspec.yml
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
## Usage
|
|
40
|
+
|
|
41
|
+
Run Rubocop as you would usually do, i.e.
|
|
42
|
+
|
|
43
|
+
$ bundle exec rubocop
|
|
44
|
+
|
|
45
|
+
or from your continuous integration tool.
|
|
46
|
+
|
|
47
|
+
## Guidances
|
|
48
|
+
|
|
49
|
+
* 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:
|
|
50
|
+
```yaml
|
|
51
|
+
Rails:
|
|
52
|
+
Enabled: false
|
|
53
|
+
```
|
|
54
|
+
* When adding rubocop and simplycop to a legacy project, you might want to initially disable some of the rules.
|
|
55
|
+
|
|
56
|
+
## Security Cops
|
|
57
|
+
- CheckForVulnerableCode
|
|
58
|
+
|
|
59
|
+
This cop was built to identify possible Rails vulnerable code.
|
|
60
|
+
Its purpose is to raise an awareness of the finding.
|
|
61
|
+
When an offence was raised, please seek for help and guidance from application security team.
|
|
62
|
+
|
|
63
|
+
IMPORTANT:
|
|
64
|
+
This cop must be enabled at all times, if you need to disable it please check with AppSec team first.
|
|
65
|
+
|
|
66
|
+
Example of vulnerable code:
|
|
67
|
+
|
|
68
|
+
```ruby
|
|
69
|
+
class BooksController < ApplicationController
|
|
70
|
+
caches_page :show
|
|
71
|
+
end
|
|
72
|
+
```
|
|
73
|
+
Vulnerability Details: https://nvd.nist.gov/vuln/detail/CVE-2020-8159
|
data/lib/simplycop/version.rb
CHANGED
data/mkdocs.yml
ADDED
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: simplycop
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.7.
|
|
4
|
+
version: 1.7.3
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Simply Business
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2021-
|
|
11
|
+
date: 2021-08-26 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: rubocop
|
|
@@ -124,6 +124,7 @@ files:
|
|
|
124
124
|
- bin/console
|
|
125
125
|
- bin/setup
|
|
126
126
|
- catalog-info.yaml
|
|
127
|
+
- docs/index.md
|
|
127
128
|
- lib/simplycop.rb
|
|
128
129
|
- lib/simplycop/custom_cops/constantize.rb
|
|
129
130
|
- lib/simplycop/custom_cops/define_method.rb
|
|
@@ -135,6 +136,7 @@ files:
|
|
|
135
136
|
- lib/simplycop/security/csrf_token_validation.rb
|
|
136
137
|
- lib/simplycop/security/reject_all_requests_local.rb
|
|
137
138
|
- lib/simplycop/version.rb
|
|
139
|
+
- mkdocs.yml
|
|
138
140
|
- simplycop.gemspec
|
|
139
141
|
- vuln_db.json
|
|
140
142
|
homepage: https://github.com/simplybusiness/simplycop
|
|
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
156
158
|
- !ruby/object:Gem::Version
|
|
157
159
|
version: '0'
|
|
158
160
|
requirements: []
|
|
159
|
-
rubygems_version: 3.2.
|
|
161
|
+
rubygems_version: 3.2.22
|
|
160
162
|
signing_key:
|
|
161
163
|
specification_version: 4
|
|
162
164
|
summary: Provides a single point of reference for common rubocop rules.
|