caliber 0.15.0 → 0.15.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- checksums.yaml.gz.sig +0 -0
- data/README.adoc +37 -43
- data/caliber.gemspec +1 -1
- data/config/ruby.yml +2 -0
- data.tar.gz.sig +0 -0
- metadata +3 -3
- metadata.gz.sig +0 -0
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: a7c2d60719881d4a0ac80a425d56155822cdbc93a666805a368074c4863ce9af
|
4
|
+
data.tar.gz: d0f21630f3a3096ca8778e210227465c998fb835db9c2b0fabf17b755829a9c8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6f981991744b32fc86f8eea5ec8b7a32c05438ca7bed128632071801808e1ecbad2d26084be7309b685c3602183d130616439dc2044e3109f4967b925caed853
|
7
|
+
data.tar.gz: cb46a305d6f556f3583022ccb8814220b90ae0ac1183971f51eef45bd4533a41c1a4dd7d590bbb663273c1b598dbcc98fe139f62d8e80ab868590cbee5ea1de2
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data/README.adoc
CHANGED
@@ -2,23 +2,29 @@
|
|
2
2
|
:toclevels: 5
|
3
3
|
:figure-caption!:
|
4
4
|
|
5
|
+
:rubocop_link: link:https://docs.rubocop.org/rubocop[RuboCop]
|
6
|
+
:rubocop_performance_link: link:https://docs.rubocop.org/rubocop-performance[RuboCop Performance]
|
7
|
+
:rubocop_thread_saftey_link: link:https://github.com/rubocop/rubocop-thread_safety[RuboCop Thread Safety]
|
8
|
+
:rubocop_rake_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop Rake]
|
9
|
+
:rubocop_rspec_link: link:https://docs.rubocop.org/rubocop-rspec[RuboCop RSpec]
|
10
|
+
|
5
11
|
= Caliber
|
6
12
|
|
7
13
|
This gem provides global link:https://docs.rubocop.org/rubocop[RuboCop] configurations for ensuring
|
8
14
|
high quality _and_ consistent software development practices.
|
9
15
|
|
10
|
-
_Due to the ever changing nature of the RuboCop
|
16
|
+
_Due to the ever changing nature of the RuboCop ecosystem -- and the fact that it's very easy to fall behind quickly -- this gem takes an aggressive approach to staying up to date with latest changes within the RuboCop community. This also means this gem will probably never reach 1.0.0 status because new changes are being introduced in each minor release. That said, if you always want to be on top of recent changes -- because you know how costly technical debt is -- then this gem has you covered. 🎉_
|
11
17
|
|
12
18
|
toc::[]
|
13
19
|
|
14
20
|
== Features
|
15
21
|
|
16
22
|
* Provides a global configuration for the following code quality gems:
|
17
|
-
**
|
18
|
-
**
|
19
|
-
**
|
20
|
-
**
|
21
|
-
**
|
23
|
+
** {rubocop_link}
|
24
|
+
** {rubocop_performance_link}
|
25
|
+
** {rubocop_thread_saftey_link}
|
26
|
+
** {rubocop_rake_link}
|
27
|
+
** {rubocop_rspec_link}
|
22
28
|
|
23
29
|
== Requirements
|
24
30
|
|
@@ -59,8 +65,7 @@ That's it!
|
|
59
65
|
|
60
66
|
=== Customization
|
61
67
|
|
62
|
-
|
63
|
-
the gem further by specifiying what you need:
|
68
|
+
You can customize the gem by specifiying what you need:
|
64
69
|
|
65
70
|
[source,yaml]
|
66
71
|
----
|
@@ -73,14 +78,11 @@ inherit_gem:
|
|
73
78
|
- config/rspec.yml
|
74
79
|
----
|
75
80
|
|
76
|
-
The above is what `config/all.yml` expands to but now you can mix and match how you like for your
|
77
|
-
needs.
|
81
|
+
The above is what `config/all.yml` expands to but now you can mix and match how you like for your specific needs.
|
78
82
|
|
79
|
-
===
|
83
|
+
=== Requirements
|
80
84
|
|
81
|
-
When Caliber is added to your `Gemfile`, you don't have to require RuboCop because Caliber does that
|
82
|
-
for you by default. All RuboCop dependencies are also auto-required because they are defined in each
|
83
|
-
configuration. Here's a full breakdown of how this works:
|
85
|
+
When Caliber is added to your `Gemfile`, you don't have to require RuboCop because Caliber does that for you by default. All RuboCop dependencies are also automatically required because they are defined in each configuration. Here's a full breakdown of how this works:
|
84
86
|
|
85
87
|
[source,yaml]
|
86
88
|
----
|
@@ -89,12 +91,12 @@ inherit_gem:
|
|
89
91
|
- config/all.yml
|
90
92
|
----
|
91
93
|
|
92
|
-
The above will
|
94
|
+
The above will require and load the configurations for following gems:
|
93
95
|
|
94
|
-
*
|
95
|
-
*
|
96
|
-
*
|
97
|
-
*
|
96
|
+
* {rubocop_performance_link}
|
97
|
+
* {rubocop_thread_saftey_link}
|
98
|
+
* {rubocop_rake_link}
|
99
|
+
* {rubocop_rspec_link}
|
98
100
|
|
99
101
|
When you don't use the default `all.yml` configuration, then behavior changes as follows:
|
100
102
|
|
@@ -144,11 +146,9 @@ inherit_gem:
|
|
144
146
|
|
145
147
|
The above will only require the RuboCop RSpec gem _and_ load the associated configuration.
|
146
148
|
|
147
|
-
===
|
149
|
+
=== Inheritance
|
148
150
|
|
149
|
-
Should you not want to include this gem in your project for some reason, you can directly
|
150
|
-
configuration files supported by this project instead. To do this, you'd need to add the following
|
151
|
-
to the top of your `.rubocop.yml`:
|
151
|
+
Should you not want to include this gem in your project for some reason, you can directly inherit the configuration files supported by this project instead. To do this, you'll need to add the following to the top of your `.rubocop.yml`:
|
152
152
|
|
153
153
|
[source,yaml]
|
154
154
|
----
|
@@ -156,13 +156,9 @@ inherit_from:
|
|
156
156
|
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/all.yml
|
157
157
|
----
|
158
158
|
|
159
|
-
You'll also want to add `.rubocop-https*` to your project's `.gitignore` since imported RuboCop YAML
|
160
|
-
configurations will be cached locally and you'll not want them checked into your source code
|
161
|
-
repository.
|
159
|
+
You'll also want to add `.rubocop-https*` to your project's `.gitignore` since imported RuboCop YAML configurations will be cached locally and you'll not want them checked into your source code repository.
|
162
160
|
|
163
|
-
If importing all configurations from `all.yml` is too much -- and much like you can do with
|
164
|
-
requiring this gem directly -- you can mix and match what you want to import by defining which
|
165
|
-
configurations you want to use. For example, the following is what `all.yml` expands too:
|
161
|
+
If importing all configurations from `all.yml` is too much -- and much like you can do with requiring this gem directly -- you can mix and match what you want to import by defining which configurations you want to use. For example, the following is what `all.yml` expands too:
|
166
162
|
|
167
163
|
[source,yaml]
|
168
164
|
----
|
@@ -174,17 +170,19 @@ inherit_from:
|
|
174
170
|
- https://raw.githubusercontent.com/bkuhlmann/caliber/main/config/rspec.yml
|
175
171
|
----
|
176
172
|
|
177
|
-
You can also target a specific version of this gem by swapping out the `main` path in the YAML URLs
|
178
|
-
|
173
|
+
You can also target a specific version of this gem by swapping out the `main` path in the YAML URLs listed above with a specific version like `0.0.0`.
|
174
|
+
|
175
|
+
Lastly, when using this YAML import approach, you'll not benefit from having all gems you need required and installed for you. So you'll need to manually require these gems in your `Gemfile`:
|
179
176
|
|
180
|
-
|
181
|
-
|
177
|
+
* {rubocop_link}
|
178
|
+
* {rubocop_performance_link}
|
179
|
+
* {rubocop_thread_saftey_link}
|
180
|
+
* {rubocop_rake_link}
|
181
|
+
* {rubocop_rspec_link}
|
182
182
|
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
* link:https://docs.rubocop.org/rubocop-rspec[RuboCop Rake]
|
187
|
-
* link:https://docs.rubocop.org/rubocop-rspec[RuboCop RSpec]
|
183
|
+
=== Troubleshooting
|
184
|
+
|
185
|
+
If you are having issues requiring additional RuboCop gems in conjunction with what this gem provides for you, there is a link:https://github.com/rubocop/rubocop/issues/5251#issuecomment-1142638815[known issue and workaround] to this problem. Until the RuboCop team can fix the bug, you'll have to re-require your dependencies until then.
|
188
186
|
|
189
187
|
== Development
|
190
188
|
|
@@ -192,7 +190,7 @@ To contribute, run:
|
|
192
190
|
|
193
191
|
[source,bash]
|
194
192
|
----
|
195
|
-
git clone https://github.com/bkuhlmann/caliber
|
193
|
+
git clone https://github.com/bkuhlmann/caliber
|
196
194
|
cd caliber
|
197
195
|
bin/setup
|
198
196
|
----
|
@@ -246,10 +244,6 @@ To test, run:
|
|
246
244
|
bundle exec rake
|
247
245
|
----
|
248
246
|
|
249
|
-
== Troubleshooting
|
250
|
-
|
251
|
-
If you are having issues requiring additional RuboCop gems in conjunction with what this gem provides for you, there is a link:https://github.com/rubocop/rubocop/issues/5251#issuecomment-1142638815[known issue and workaround] to this problem. Until the RuboCop team can fix the bug, you'll have to re-require your dependencies until then.
|
252
|
-
|
253
247
|
== link:https://www.alchemists.io/policies/license[License]
|
254
248
|
|
255
249
|
== link:https://www.alchemists.io/policies/security[Security]
|
data/caliber.gemspec
CHANGED
data/config/ruby.yml
CHANGED
data.tar.gz.sig
CHANGED
Binary file
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: caliber
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.15.
|
4
|
+
version: 0.15.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brooke Kuhlmann
|
@@ -28,7 +28,7 @@ cert_chain:
|
|
28
28
|
CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
|
29
29
|
RFE=
|
30
30
|
-----END CERTIFICATE-----
|
31
|
-
date: 2022-
|
31
|
+
date: 2022-10-20 00:00:00.000000000 Z
|
32
32
|
dependencies:
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
34
|
name: rubocop
|
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
145
145
|
- !ruby/object:Gem::Version
|
146
146
|
version: '0'
|
147
147
|
requirements: []
|
148
|
-
rubygems_version: 3.3.
|
148
|
+
rubygems_version: 3.3.24
|
149
149
|
signing_key:
|
150
150
|
specification_version: 4
|
151
151
|
summary: Provides a high quality style guide and configuration for your projects.
|
metadata.gz.sig
CHANGED
Binary file
|