boxt_ruby_style_guide 3.1.0 → 4.0.0
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/MIT-LICENSE +20 -0
- data/README.md +19 -24
- data/VERSION +1 -1
- data/lib/boxt_ruby_style_guide.rb +0 -4
- metadata +20 -76
- data/.circleci/config.yml +0 -36
- data/.gitignore +0 -8
- data/.rubocop.yml +0 -1
- data/.ruby-version +0 -1
- data/Gemfile +0 -10
- data/Gemfile.lock +0 -96
- data/LICENSE.txt +0 -21
- data/bin/console +0 -15
- data/bin/setup +0 -8
- data/boxt_ruby_style_guide.gemspec +0 -39
- data/config.reek +0 -6
- data/default.yml +0 -35
- data/tasks/lint.rake +0 -24
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: a45fb671c664118b3f7a7aa5ca2c4360b49a3fd14feee59c04b78dfe66d42f4a
|
|
4
|
+
data.tar.gz: 736c224d686fa748067bbaf89380c0d1b0ccab7733b50a69317ee4a65e72c6cd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: b81736233b707db553d392053bd6021d608aa8dcf8cf8d171167d8ea62e9efa0ec237d0618a29561971d232bfadc8134056ca72759a74149a4d80182af3a6739
|
|
7
|
+
data.tar.gz: 14a5d658ff160ee39e6170b9443e6271151ec38ce14680f8a32fddd59f24173b08eb18d1f96c75b7fe5c9d97b2862c79ad6342600b196f6fd546b06639bfe6e7
|
data/MIT-LICENSE
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
Copyright (c) 2020 Boxt
|
|
2
|
+
|
|
3
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
4
|
+
a copy of this software and associated documentation files (the
|
|
5
|
+
"Software"), to deal in the Software without restriction, including
|
|
6
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
7
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
8
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
9
|
+
the following conditions:
|
|
10
|
+
|
|
11
|
+
The above copyright notice and this permission notice shall be
|
|
12
|
+
included in all copies or substantial portions of the Software.
|
|
13
|
+
|
|
14
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
15
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
16
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
17
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
18
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
19
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
20
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
CHANGED
|
@@ -1,10 +1,11 @@
|
|
|
1
1
|
# BOXT Ruby Style Guide
|
|
2
2
|
|
|
3
|
-
Ruby style guide
|
|
3
|
+
Ruby style guide and base Rubocop settings for Boxt Ruby projects.
|
|
4
4
|
|
|
5
|
-
For the most part we are using [this Ruby style guide](https://github.com/bbatsov/ruby-style-guide) as
|
|
5
|
+
For the most part we are using [this Ruby style guide](https://github.com/bbatsov/ruby-style-guide) as the base guide, with any deviations can be found in the `default.yml`.
|
|
6
6
|
|
|
7
|
-
[](https://badge.fury.io/rb/boxt_ruby_style_guide)
|
|
8
|
+
[](https://circleci.com/gh/boxt/boxt_ruby_style_guide/tree/master)
|
|
8
9
|
|
|
9
10
|
## Installation
|
|
10
11
|
|
|
@@ -34,10 +35,6 @@ Rails apps should have access to the lint tasks by default.
|
|
|
34
35
|
|
|
35
36
|
## Usage
|
|
36
37
|
|
|
37
|
-
### Reek Config
|
|
38
|
-
|
|
39
|
-
The Reek config is loaded automatically by this gem so there shouldn't be anything that you need to do. However am not sure if this will effect using in-editor linters.
|
|
40
|
-
|
|
41
38
|
### Rubocop Config
|
|
42
39
|
|
|
43
40
|
Add a `.rubocop.yml` file to the root of your project with the following settings:
|
|
@@ -48,15 +45,9 @@ inherit_gem:
|
|
|
48
45
|
- default.yml
|
|
49
46
|
```
|
|
50
47
|
|
|
51
|
-
### Lint
|
|
52
|
-
|
|
53
|
-
There are a couple of rake tasks added to the project that allow you to run `reek` and `rubocop` against files listed as changed by Git.
|
|
48
|
+
### Lint Tasks
|
|
54
49
|
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
```sh
|
|
58
|
-
rake lint:reek
|
|
59
|
-
```
|
|
50
|
+
Lint tasks to run against files listed as changed by Git.
|
|
60
51
|
|
|
61
52
|
To run `rubocop` against any changed files use:
|
|
62
53
|
|
|
@@ -66,22 +57,26 @@ rake lint:rubocop
|
|
|
66
57
|
|
|
67
58
|
If there are no changed files the commands will run against all files.
|
|
68
59
|
|
|
69
|
-
|
|
60
|
+
### Editor Plugins
|
|
61
|
+
|
|
62
|
+
There are also some useful Rubocop editor plugins to help with in-editor linting.
|
|
63
|
+
|
|
64
|
+
#### Atom
|
|
65
|
+
|
|
66
|
+
- [linter-rubocop](https://atom.io/packages/linter-rubocop)
|
|
67
|
+
- [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
|
|
70
68
|
|
|
71
|
-
|
|
69
|
+
#### RubyMine
|
|
72
70
|
|
|
73
|
-
|
|
74
|
-
* [linter-rubocop](https://atom.io/packages/linter-rubocop)
|
|
75
|
-
* [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
|
|
71
|
+
- [rubocop](https://www.jetbrains.com/help/ruby/rubocop.html)
|
|
76
72
|
|
|
77
|
-
|
|
73
|
+
#### VSCode
|
|
78
74
|
|
|
79
|
-
|
|
80
|
-
* [rubocop](https://www.jetbrains.com/help/ruby/rubocop.html)
|
|
75
|
+
- [ruby-rubocop](https://marketplace.visualstudio.com/items?itemName=misogi.ruby-rubocop)
|
|
81
76
|
|
|
82
77
|
## Contributing
|
|
83
78
|
|
|
84
|
-
Bug reports and pull requests are welcome on GitHub at https://github.com/boxt/
|
|
79
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/boxt/ruby_style_guide.
|
|
85
80
|
|
|
86
81
|
## License
|
|
87
82
|
|
data/VERSION
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
|
|
1
|
+
4.0.0
|
metadata
CHANGED
|
@@ -1,69 +1,43 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: boxt_ruby_style_guide
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version:
|
|
4
|
+
version: 4.0.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Boxt
|
|
8
8
|
autorequire:
|
|
9
|
-
bindir:
|
|
9
|
+
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date:
|
|
11
|
+
date: 2020-01-07 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
|
-
- !ruby/object:Gem::Dependency
|
|
14
|
-
name: reek
|
|
15
|
-
requirement: !ruby/object:Gem::Requirement
|
|
16
|
-
requirements:
|
|
17
|
-
- - ">="
|
|
18
|
-
- !ruby/object:Gem::Version
|
|
19
|
-
version: 5.3.0
|
|
20
|
-
- - "~>"
|
|
21
|
-
- !ruby/object:Gem::Version
|
|
22
|
-
version: '5.3'
|
|
23
|
-
type: :runtime
|
|
24
|
-
prerelease: false
|
|
25
|
-
version_requirements: !ruby/object:Gem::Requirement
|
|
26
|
-
requirements:
|
|
27
|
-
- - ">="
|
|
28
|
-
- !ruby/object:Gem::Version
|
|
29
|
-
version: 5.3.0
|
|
30
|
-
- - "~>"
|
|
31
|
-
- !ruby/object:Gem::Version
|
|
32
|
-
version: '5.3'
|
|
33
13
|
- !ruby/object:Gem::Dependency
|
|
34
14
|
name: rubocop
|
|
35
15
|
requirement: !ruby/object:Gem::Requirement
|
|
36
16
|
requirements:
|
|
37
17
|
- - "~>"
|
|
38
18
|
- !ruby/object:Gem::Version
|
|
39
|
-
version: 0.
|
|
19
|
+
version: '0.79'
|
|
40
20
|
type: :runtime
|
|
41
21
|
prerelease: false
|
|
42
22
|
version_requirements: !ruby/object:Gem::Requirement
|
|
43
23
|
requirements:
|
|
44
24
|
- - "~>"
|
|
45
25
|
- !ruby/object:Gem::Version
|
|
46
|
-
version: 0.
|
|
26
|
+
version: '0.79'
|
|
47
27
|
- !ruby/object:Gem::Dependency
|
|
48
28
|
name: bundler
|
|
49
29
|
requirement: !ruby/object:Gem::Requirement
|
|
50
30
|
requirements:
|
|
51
31
|
- - "~>"
|
|
52
32
|
- !ruby/object:Gem::Version
|
|
53
|
-
version: '2.
|
|
54
|
-
- - ">="
|
|
55
|
-
- !ruby/object:Gem::Version
|
|
56
|
-
version: 2.0.1
|
|
33
|
+
version: '2.1'
|
|
57
34
|
type: :development
|
|
58
35
|
prerelease: false
|
|
59
36
|
version_requirements: !ruby/object:Gem::Requirement
|
|
60
37
|
requirements:
|
|
61
38
|
- - "~>"
|
|
62
39
|
- !ruby/object:Gem::Version
|
|
63
|
-
version: '2.
|
|
64
|
-
- - ">="
|
|
65
|
-
- !ruby/object:Gem::Version
|
|
66
|
-
version: 2.0.1
|
|
40
|
+
version: '2.1'
|
|
67
41
|
- !ruby/object:Gem::Dependency
|
|
68
42
|
name: minitest
|
|
69
43
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -71,9 +45,6 @@ dependencies:
|
|
|
71
45
|
- - "~>"
|
|
72
46
|
- !ruby/object:Gem::Version
|
|
73
47
|
version: '5.11'
|
|
74
|
-
- - ">="
|
|
75
|
-
- !ruby/object:Gem::Version
|
|
76
|
-
version: 5.11.3
|
|
77
48
|
type: :development
|
|
78
49
|
prerelease: false
|
|
79
50
|
version_requirements: !ruby/object:Gem::Requirement
|
|
@@ -81,92 +52,77 @@ dependencies:
|
|
|
81
52
|
- - "~>"
|
|
82
53
|
- !ruby/object:Gem::Version
|
|
83
54
|
version: '5.11'
|
|
84
|
-
- - ">="
|
|
85
|
-
- !ruby/object:Gem::Version
|
|
86
|
-
version: 5.11.3
|
|
87
55
|
- !ruby/object:Gem::Dependency
|
|
88
56
|
name: minitest-fail-fast
|
|
89
57
|
requirement: !ruby/object:Gem::Requirement
|
|
90
58
|
requirements:
|
|
91
59
|
- - "~>"
|
|
92
60
|
- !ruby/object:Gem::Version
|
|
93
|
-
version: 0.1
|
|
61
|
+
version: '0.1'
|
|
94
62
|
type: :development
|
|
95
63
|
prerelease: false
|
|
96
64
|
version_requirements: !ruby/object:Gem::Requirement
|
|
97
65
|
requirements:
|
|
98
66
|
- - "~>"
|
|
99
67
|
- !ruby/object:Gem::Version
|
|
100
|
-
version: 0.1
|
|
68
|
+
version: '0.1'
|
|
101
69
|
- !ruby/object:Gem::Dependency
|
|
102
70
|
name: minitest-macos-notification
|
|
103
71
|
requirement: !ruby/object:Gem::Requirement
|
|
104
72
|
requirements:
|
|
105
73
|
- - "~>"
|
|
106
74
|
- !ruby/object:Gem::Version
|
|
107
|
-
version: 0.
|
|
75
|
+
version: '0.3'
|
|
108
76
|
type: :development
|
|
109
77
|
prerelease: false
|
|
110
78
|
version_requirements: !ruby/object:Gem::Requirement
|
|
111
79
|
requirements:
|
|
112
80
|
- - "~>"
|
|
113
81
|
- !ruby/object:Gem::Version
|
|
114
|
-
version: 0.
|
|
82
|
+
version: '0.3'
|
|
115
83
|
- !ruby/object:Gem::Dependency
|
|
116
84
|
name: minitest-reporters
|
|
117
85
|
requirement: !ruby/object:Gem::Requirement
|
|
118
86
|
requirements:
|
|
119
87
|
- - "~>"
|
|
120
88
|
- !ruby/object:Gem::Version
|
|
121
|
-
version: '1.
|
|
122
|
-
- - ">="
|
|
123
|
-
- !ruby/object:Gem::Version
|
|
124
|
-
version: 1.3.6
|
|
89
|
+
version: '1.4'
|
|
125
90
|
type: :development
|
|
126
91
|
prerelease: false
|
|
127
92
|
version_requirements: !ruby/object:Gem::Requirement
|
|
128
93
|
requirements:
|
|
129
94
|
- - "~>"
|
|
130
95
|
- !ruby/object:Gem::Version
|
|
131
|
-
version: '1.
|
|
132
|
-
- - ">="
|
|
133
|
-
- !ruby/object:Gem::Version
|
|
134
|
-
version: 1.3.6
|
|
96
|
+
version: '1.4'
|
|
135
97
|
- !ruby/object:Gem::Dependency
|
|
136
98
|
name: rake
|
|
137
99
|
requirement: !ruby/object:Gem::Requirement
|
|
138
100
|
requirements:
|
|
139
101
|
- - "~>"
|
|
140
102
|
- !ruby/object:Gem::Version
|
|
141
|
-
version: '
|
|
142
|
-
- - ">="
|
|
143
|
-
- !ruby/object:Gem::Version
|
|
144
|
-
version: 12.3.2
|
|
103
|
+
version: '13.0'
|
|
145
104
|
type: :development
|
|
146
105
|
prerelease: false
|
|
147
106
|
version_requirements: !ruby/object:Gem::Requirement
|
|
148
107
|
requirements:
|
|
149
108
|
- - "~>"
|
|
150
109
|
- !ruby/object:Gem::Version
|
|
151
|
-
version: '
|
|
152
|
-
- - ">="
|
|
153
|
-
- !ruby/object:Gem::Version
|
|
154
|
-
version: 12.3.2
|
|
110
|
+
version: '13.0'
|
|
155
111
|
- !ruby/object:Gem::Dependency
|
|
156
112
|
name: simplecov
|
|
157
113
|
requirement: !ruby/object:Gem::Requirement
|
|
158
114
|
requirements:
|
|
159
115
|
- - "~>"
|
|
160
116
|
- !ruby/object:Gem::Version
|
|
161
|
-
version: 0.
|
|
117
|
+
version: '0.17'
|
|
162
118
|
type: :development
|
|
163
119
|
prerelease: false
|
|
164
120
|
version_requirements: !ruby/object:Gem::Requirement
|
|
165
121
|
requirements:
|
|
166
122
|
- - "~>"
|
|
167
123
|
- !ruby/object:Gem::Version
|
|
168
|
-
version: 0.
|
|
169
|
-
description: Ruby styleguide info for the BOXT projects, as well
|
|
124
|
+
version: '0.17'
|
|
125
|
+
description: Ruby styleguide info for the BOXT projects, as well as config settings
|
|
170
126
|
for Rubocop
|
|
171
127
|
email:
|
|
172
128
|
- developers@boxt.co.uk
|
|
@@ -174,25 +130,13 @@ executables: []
|
|
|
174
130
|
extensions: []
|
|
175
131
|
extra_rdoc_files: []
|
|
176
132
|
files:
|
|
177
|
-
-
|
|
178
|
-
- ".gitignore"
|
|
179
|
-
- ".rubocop.yml"
|
|
180
|
-
- ".ruby-version"
|
|
181
|
-
- Gemfile
|
|
182
|
-
- Gemfile.lock
|
|
183
|
-
- LICENSE.txt
|
|
133
|
+
- MIT-LICENSE
|
|
184
134
|
- README.md
|
|
185
135
|
- Rakefile
|
|
186
136
|
- VERSION
|
|
187
|
-
- bin/console
|
|
188
|
-
- bin/setup
|
|
189
|
-
- boxt_ruby_style_guide.gemspec
|
|
190
|
-
- config.reek
|
|
191
|
-
- default.yml
|
|
192
137
|
- lib/boxt_ruby_style_guide.rb
|
|
193
138
|
- lib/boxt_ruby_style_guide/railtie.rb
|
|
194
139
|
- lib/boxt_ruby_style_guide/version.rb
|
|
195
|
-
- tasks/lint.rake
|
|
196
140
|
homepage: https://github.com/boxt/ruby-style-guide
|
|
197
141
|
licenses:
|
|
198
142
|
- MIT
|
|
@@ -212,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
212
156
|
- !ruby/object:Gem::Version
|
|
213
157
|
version: '0'
|
|
214
158
|
requirements: []
|
|
215
|
-
rubygems_version: 3.
|
|
159
|
+
rubygems_version: 3.1.2
|
|
216
160
|
signing_key:
|
|
217
161
|
specification_version: 4
|
|
218
162
|
summary: Ruby styleguide info for the BOXT Ruby projects
|
data/.circleci/config.yml
DELETED
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
version: 2
|
|
2
|
-
jobs:
|
|
3
|
-
build:
|
|
4
|
-
parallelism: 1
|
|
5
|
-
docker:
|
|
6
|
-
- image: circleci/ruby:2.6.3
|
|
7
|
-
environment:
|
|
8
|
-
BUNDLE_JOBS: 3
|
|
9
|
-
BUNDLE_RETRY: 3
|
|
10
|
-
BUNDLE_PATH: vendor/bundle
|
|
11
|
-
steps:
|
|
12
|
-
- checkout
|
|
13
|
-
- run:
|
|
14
|
-
name: Configure Bundler
|
|
15
|
-
command: |
|
|
16
|
-
echo 'export BUNDLER_VERSION=$(cat Gemfile.lock | tail -1 | tr -d " ")' >> $BASH_ENV
|
|
17
|
-
source $BASH_ENV
|
|
18
|
-
gem install bundler
|
|
19
|
-
- run:
|
|
20
|
-
name: Which bundler?
|
|
21
|
-
command: bundle -v
|
|
22
|
-
- restore_cache:
|
|
23
|
-
keys:
|
|
24
|
-
- boxt-ruby-style-guide-{{ checksum "Gemfile.lock" }}
|
|
25
|
-
- run:
|
|
26
|
-
name: Bundle Install
|
|
27
|
-
command: bundle install
|
|
28
|
-
- save_cache:
|
|
29
|
-
key: boxt-ruby-style-guide-{{ checksum "Gemfile.lock" }}
|
|
30
|
-
paths:
|
|
31
|
-
- vendor/bundle
|
|
32
|
-
- run:
|
|
33
|
-
name: Run tests
|
|
34
|
-
command: bundle exec rake test | circleci tests split --split-by=timings
|
|
35
|
-
- store_test_results:
|
|
36
|
-
path: test_results
|
data/.gitignore
DELETED
data/.rubocop.yml
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
inherit_from: default.yml
|
data/.ruby-version
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
ruby-2.6.3
|
data/Gemfile
DELETED
data/Gemfile.lock
DELETED
|
@@ -1,96 +0,0 @@
|
|
|
1
|
-
PATH
|
|
2
|
-
remote: .
|
|
3
|
-
specs:
|
|
4
|
-
boxt_ruby_style_guide (3.1.0)
|
|
5
|
-
reek (~> 5.3, >= 5.3.0)
|
|
6
|
-
rubocop (~> 0.67.2)
|
|
7
|
-
|
|
8
|
-
GEM
|
|
9
|
-
remote: https://rubygems.org/
|
|
10
|
-
specs:
|
|
11
|
-
ansi (1.5.0)
|
|
12
|
-
ast (2.4.0)
|
|
13
|
-
axiom-types (0.1.1)
|
|
14
|
-
descendants_tracker (~> 0.0.4)
|
|
15
|
-
ice_nine (~> 0.11.0)
|
|
16
|
-
thread_safe (~> 0.3, >= 0.3.1)
|
|
17
|
-
builder (3.2.3)
|
|
18
|
-
codeclimate-engine-rb (0.4.1)
|
|
19
|
-
virtus (~> 1.0)
|
|
20
|
-
coercible (1.0.0)
|
|
21
|
-
descendants_tracker (~> 0.0.1)
|
|
22
|
-
descendants_tracker (0.0.4)
|
|
23
|
-
thread_safe (~> 0.3, >= 0.3.1)
|
|
24
|
-
docile (1.3.2)
|
|
25
|
-
equalizer (0.0.11)
|
|
26
|
-
ice_nine (0.11.2)
|
|
27
|
-
jaro_winkler (1.5.3)
|
|
28
|
-
json (2.2.0)
|
|
29
|
-
kwalify (0.7.2)
|
|
30
|
-
minitest (5.11.3)
|
|
31
|
-
minitest-fail-fast (0.1.0)
|
|
32
|
-
minitest (~> 5)
|
|
33
|
-
minitest-macos-notification (0.0.6)
|
|
34
|
-
minitest (~> 5.0)
|
|
35
|
-
minitest-reporters (~> 1.3)
|
|
36
|
-
os (~> 1.0)
|
|
37
|
-
terminal-notifier (~> 2.0)
|
|
38
|
-
minitest-reporters (1.3.6)
|
|
39
|
-
ansi
|
|
40
|
-
builder
|
|
41
|
-
minitest (>= 5.0)
|
|
42
|
-
ruby-progressbar
|
|
43
|
-
os (1.0.1)
|
|
44
|
-
parallel (1.17.0)
|
|
45
|
-
parser (2.6.5.0)
|
|
46
|
-
ast (~> 2.4.0)
|
|
47
|
-
psych (3.1.0)
|
|
48
|
-
rainbow (3.0.0)
|
|
49
|
-
rake (12.3.3)
|
|
50
|
-
reek (5.4.0)
|
|
51
|
-
codeclimate-engine-rb (~> 0.4.0)
|
|
52
|
-
kwalify (~> 0.7.0)
|
|
53
|
-
parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
|
|
54
|
-
psych (~> 3.1.0)
|
|
55
|
-
rainbow (>= 2.0, < 4.0)
|
|
56
|
-
rubocop (0.67.2)
|
|
57
|
-
jaro_winkler (~> 1.5.1)
|
|
58
|
-
parallel (~> 1.10)
|
|
59
|
-
parser (>= 2.5, != 2.5.1.1)
|
|
60
|
-
psych (>= 3.1.0)
|
|
61
|
-
rainbow (>= 2.2.2, < 4.0)
|
|
62
|
-
ruby-progressbar (~> 1.7)
|
|
63
|
-
unicode-display_width (>= 1.4.0, < 1.6)
|
|
64
|
-
ruby-progressbar (1.10.1)
|
|
65
|
-
simplecov (0.16.1)
|
|
66
|
-
docile (~> 1.1)
|
|
67
|
-
json (>= 1.8, < 3)
|
|
68
|
-
simplecov-html (~> 0.10.0)
|
|
69
|
-
simplecov-html (0.10.2)
|
|
70
|
-
terminal-notifier (2.0.0)
|
|
71
|
-
thread_safe (0.3.6)
|
|
72
|
-
unicode-display_width (1.5.0)
|
|
73
|
-
virtus (1.0.5)
|
|
74
|
-
axiom-types (~> 0.1)
|
|
75
|
-
coercible (~> 1.0)
|
|
76
|
-
descendants_tracker (~> 0.0, >= 0.0.3)
|
|
77
|
-
equalizer (~> 0.0, >= 0.0.9)
|
|
78
|
-
|
|
79
|
-
PLATFORMS
|
|
80
|
-
ruby
|
|
81
|
-
|
|
82
|
-
DEPENDENCIES
|
|
83
|
-
boxt_ruby_style_guide!
|
|
84
|
-
bundler (~> 2.0, >= 2.0.1)
|
|
85
|
-
minitest (~> 5.11, >= 5.11.3)
|
|
86
|
-
minitest-fail-fast (~> 0.1.0)
|
|
87
|
-
minitest-macos-notification (~> 0.0.5)
|
|
88
|
-
minitest-reporters (~> 1.3, >= 1.3.6)
|
|
89
|
-
rake (~> 12.3, >= 12.3.2)
|
|
90
|
-
simplecov (~> 0.16.1)
|
|
91
|
-
|
|
92
|
-
RUBY VERSION
|
|
93
|
-
ruby 2.6.3p62
|
|
94
|
-
|
|
95
|
-
BUNDLED WITH
|
|
96
|
-
2.0.2
|
data/LICENSE.txt
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
The MIT License (MIT)
|
|
2
|
-
|
|
3
|
-
Copyright (c) 2018 Stuart Chinery
|
|
4
|
-
|
|
5
|
-
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
-
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
-
in the Software without restriction, including without limitation the rights
|
|
8
|
-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
-
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
-
furnished to do so, subject to the following conditions:
|
|
11
|
-
|
|
12
|
-
The above copyright notice and this permission notice shall be included in
|
|
13
|
-
all copies or substantial portions of the Software.
|
|
14
|
-
|
|
15
|
-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
-
THE SOFTWARE.
|
data/bin/console
DELETED
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
#!/usr/bin/env ruby
|
|
2
|
-
# frozen_string_literal: true
|
|
3
|
-
|
|
4
|
-
require "bundler/setup"
|
|
5
|
-
require "boxt/ruby/style/guide"
|
|
6
|
-
|
|
7
|
-
# You can add fixtures and/or initialization code here to make experimenting
|
|
8
|
-
# with your gem easier. You can also use a different console, if you like.
|
|
9
|
-
|
|
10
|
-
# (If you use this, don't forget to add pry to your Gemfile!)
|
|
11
|
-
# require "pry"
|
|
12
|
-
# Pry.start
|
|
13
|
-
|
|
14
|
-
require "irb"
|
|
15
|
-
IRB.start(__FILE__)
|
data/bin/setup
DELETED
|
@@ -1,39 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
# rubocop:disable Style/ExpandPathArguments
|
|
4
|
-
# NOTE: This is because of Gemfury failing with __dir__
|
|
5
|
-
lib = File.expand_path("../lib", __FILE__)
|
|
6
|
-
# rubocop:enable Style/ExpandPathArguments
|
|
7
|
-
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
8
|
-
require "boxt_ruby_style_guide/version"
|
|
9
|
-
|
|
10
|
-
Gem::Specification.new do |spec|
|
|
11
|
-
spec.authors = ["Boxt"]
|
|
12
|
-
spec.description = "Ruby styleguide info for the BOXT projects, as well as"\
|
|
13
|
-
"config settings for Rubocop"
|
|
14
|
-
spec.email = ["developers@boxt.co.uk"]
|
|
15
|
-
spec.homepage = "https://github.com/boxt/ruby-style-guide"
|
|
16
|
-
spec.license = "MIT"
|
|
17
|
-
spec.name = "boxt_ruby_style_guide"
|
|
18
|
-
spec.summary = "Ruby styleguide info for the BOXT Ruby projects"
|
|
19
|
-
spec.version = BoxtRubyStyleGuide::VERSION
|
|
20
|
-
|
|
21
|
-
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
|
22
|
-
f.match(%r{^(test|spec|features)/})
|
|
23
|
-
end
|
|
24
|
-
|
|
25
|
-
spec.bindir = "exe"
|
|
26
|
-
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
|
27
|
-
spec.require_paths = ["lib"]
|
|
28
|
-
|
|
29
|
-
spec.add_dependency "reek", "~> 5.3", ">= 5.3.0"
|
|
30
|
-
spec.add_dependency "rubocop", "~> 0.67.2"
|
|
31
|
-
|
|
32
|
-
spec.add_development_dependency "bundler", "~> 2.0", ">= 2.0.1"
|
|
33
|
-
spec.add_development_dependency "minitest", "~> 5.11", ">= 5.11.3"
|
|
34
|
-
spec.add_development_dependency "minitest-fail-fast", "~> 0.1.0"
|
|
35
|
-
spec.add_development_dependency "minitest-macos-notification", "~> 0.0.5"
|
|
36
|
-
spec.add_development_dependency "minitest-reporters", "~> 1.3", ">= 1.3.6"
|
|
37
|
-
spec.add_development_dependency "rake", "~> 12.3", ">= 12.3.2"
|
|
38
|
-
spec.add_development_dependency "simplecov", "~> 0.16.1"
|
|
39
|
-
end
|
data/config.reek
DELETED
data/default.yml
DELETED
|
@@ -1,35 +0,0 @@
|
|
|
1
|
-
AllCops:
|
|
2
|
-
TargetRubyVersion: 2.6.3
|
|
3
|
-
Exclude:
|
|
4
|
-
- "db/*"
|
|
5
|
-
- "db/**/*"
|
|
6
|
-
- "db/fixtures/**/*"
|
|
7
|
-
- "Gemfile*"
|
|
8
|
-
- "node_modules/**/*"
|
|
9
|
-
- "tmp/**/*"
|
|
10
|
-
- "vendor/**/*"
|
|
11
|
-
|
|
12
|
-
# Increase line length to 120
|
|
13
|
-
Metrics/LineLength:
|
|
14
|
-
Max: 120
|
|
15
|
-
Exclude:
|
|
16
|
-
- "config/routes.rb"
|
|
17
|
-
# Exclude class and method length for test
|
|
18
|
-
Metrics/BlockLength:
|
|
19
|
-
Exclude:
|
|
20
|
-
- "config/routes.rb"
|
|
21
|
-
- "test/**/*"
|
|
22
|
-
Metrics/ClassLength:
|
|
23
|
-
Exclude:
|
|
24
|
-
- "test/**/*"
|
|
25
|
-
Metrics/MethodLength:
|
|
26
|
-
Exclude:
|
|
27
|
-
- "test/**/*"
|
|
28
|
-
|
|
29
|
-
# Disable Style/Documentation because...
|
|
30
|
-
Style/Documentation:
|
|
31
|
-
Enabled: false
|
|
32
|
-
|
|
33
|
-
# Use double quotes ALL THE TIME!!!
|
|
34
|
-
Style/StringLiterals:
|
|
35
|
-
EnforcedStyle: double_quotes
|
data/tasks/lint.rake
DELETED
|
@@ -1,24 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
require "boxt_ruby_style_guide"
|
|
4
|
-
require "reek"
|
|
5
|
-
require "rubocop"
|
|
6
|
-
|
|
7
|
-
namespace :lint do
|
|
8
|
-
desc "Runs reek against all .rb files git lists as changed. Will run
|
|
9
|
-
against all files if none changed"
|
|
10
|
-
task :reek do
|
|
11
|
-
run_cmd("reek -c #{BoxtRubyStyleGuide.reek_config}")
|
|
12
|
-
end
|
|
13
|
-
|
|
14
|
-
desc "Runs rubocop against all .rb files git lists as changed. Will run
|
|
15
|
-
against all files if none changed"
|
|
16
|
-
task :rubocop do
|
|
17
|
-
run_cmd("rubocop")
|
|
18
|
-
end
|
|
19
|
-
end
|
|
20
|
-
|
|
21
|
-
def run_cmd(cmd)
|
|
22
|
-
xargs = "xargs #{cmd}"
|
|
23
|
-
exec("git ls-files -m | xargs ls -1 2>/dev/null | grep '\.rb$' | #{xargs}")
|
|
24
|
-
end
|