rubysmith 3.6.0 → 3.7.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
- checksums.yaml.gz.sig +0 -0
- data/README.adoc +31 -41
- data/lib/rubysmith/cli/actions/import.rb +2 -2
- data/lib/rubysmith/import.rb +2 -2
- data/lib/rubysmith/templates/%project_name%/README.adoc.erb +12 -0
- data/lib/rubysmith/templates/%project_name%/README.md.erb +11 -0
- data/rubysmith.gemspec +3 -3
- data.tar.gz.sig +4 -2
- metadata +15 -15
- 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: 699368358e8834f42f015b3e9bc7dc8c277324bf64cdd563b23033096f7d9dfb
|
4
|
+
data.tar.gz: 853c6e4a912a44f6f296e473ca31866f485059671bc1c344dbe117cb0deefe6e
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 40f29192eace34156acb6533cc652583c5c7c196e5179290a5aec781da22989642dac4f09934aa975089c49e10fb008101d1eb40ddb93413b458d2a03481dd6a
|
7
|
+
data.tar.gz: 7a1b554e089ea574ec43d8c78dadad7d14743e7567d6984633843d9d8164e08d073080f895cce8d274c061c55f3e6033f83de64c27a47da7a8043a3016b196d6
|
checksums.yaml.gz.sig
CHANGED
Binary file
|
data/README.adoc
CHANGED
@@ -65,16 +65,6 @@ To install, run:
|
|
65
65
|
gem install rubysmith
|
66
66
|
----
|
67
67
|
|
68
|
-
== Upgrade
|
69
|
-
|
70
|
-
If upgrading from 1.0.0 to 2.0.0, you'll need to make the following changes:
|
71
|
-
|
72
|
-
* README badges are no longer injected so you can customize as desired.
|
73
|
-
* The `:rubocop:` build configuration has been removed. Use `:caliber:` instead.
|
74
|
-
* The `--rubocop` build option has been removed. Use `--caliber` instead.
|
75
|
-
* You no longer have to Git ignore RuboCop cached configurations since this is handled by the
|
76
|
-
Caliber gem now.
|
77
|
-
|
78
68
|
== Usage
|
79
69
|
|
80
70
|
=== Command Line Interface (CLI)
|
@@ -121,7 +111,7 @@ BUILD OPTIONS:
|
|
121
111
|
--[no-]zeitwerk Add Zeitwerk gem. Default: true.
|
122
112
|
....
|
123
113
|
|
124
|
-
|
114
|
+
==== Build
|
125
115
|
|
126
116
|
The core functionality of this gem centers around the `--build` command and associated options
|
127
117
|
(flags). The build options allow you to further customize the kind of project you want to build.
|
@@ -172,161 +162,161 @@ There is a lot of flexibility when building a new project through the various bu
|
|
172
162
|
walk you through each so you can better understand why you'd want to enable or disable any one of
|
173
163
|
them.
|
174
164
|
|
175
|
-
|
165
|
+
===== Amazing Print
|
176
166
|
|
177
167
|
The `--amazing_print` option allows you to build your project with the
|
178
168
|
link:https://github.com/amazing-print/amazing_print[Amazing Print] gem for debugging purposes and is
|
179
169
|
a handy debugging tool when inspecting your Ruby objects and printing details in a quick to read
|
180
170
|
format.
|
181
171
|
|
182
|
-
|
172
|
+
===== Bundler Leak
|
183
173
|
|
184
174
|
The `--bundler-leak` option allows you to build your project with the
|
185
175
|
link:https://github.com/rubymem/bundler-leak[Bundler Leak] gem which helps detect memory leaks in
|
186
176
|
your gem dependencies.
|
187
177
|
|
188
|
-
|
178
|
+
===== Caliber
|
189
179
|
|
190
180
|
The `--caliber` option allows you to build your project with the
|
191
181
|
link:https://www.alchemists.io/projects/caliber[Caliber] gem so you have an immediate working -- and
|
192
182
|
high quality -- link:https://docs.rubocop.org/rubocop[RuboCop] configuration. Read the Caliber
|
193
183
|
documentation for further customization.
|
194
184
|
|
195
|
-
|
185
|
+
===== Circle CI
|
196
186
|
|
197
187
|
The `--circle_ci` option allows you to build your project with link:https://circleci.com[Circle CI]
|
198
188
|
configured so you can get your project building as quickly as possible.
|
199
189
|
|
200
|
-
|
190
|
+
===== Citation
|
201
191
|
|
202
192
|
The `--citation` option allows you to add a link:https://citation-file-format.github.io[citation]
|
203
193
|
file to your project so you can help the research community cite your work in their studies if your
|
204
194
|
project is used.
|
205
195
|
|
206
|
-
|
196
|
+
===== Community
|
207
197
|
|
208
198
|
The `--community` option allows you to link to your open source community, organization, or group
|
209
199
|
chat to help with community engagement of your work.
|
210
200
|
|
211
|
-
|
201
|
+
===== Code of Conduct
|
212
202
|
|
213
203
|
The `--conduct` option allows you to link to your link:https://www.contributor-covenant.org[Code of
|
214
204
|
Conduct] to encourage good community participation. Regardless of whether you have a community or
|
215
205
|
not, the code of conduct is good to encourage in general.
|
216
206
|
|
217
|
-
|
207
|
+
===== Console
|
218
208
|
|
219
209
|
The `--console` option allows you to add a `console` script for local development. So instead of
|
220
210
|
typing `irb`, you can type `bin/console` and get an IRB session with all of your project's code
|
221
211
|
loaded.
|
222
212
|
|
223
|
-
|
213
|
+
===== Contributions
|
224
214
|
|
225
215
|
The `--contributions` option allows you to link to contributing documentation so people know to
|
226
216
|
contribute back to your work.
|
227
217
|
|
228
|
-
|
218
|
+
===== Debug
|
229
219
|
|
230
220
|
The `--debug` option allows you add the link:https://github.com/ruby/debug[Debug] gem to your
|
231
221
|
project for debugging your code by setting breakpoints, remotely connecting to running code, and
|
232
222
|
much more.
|
233
223
|
|
234
|
-
|
224
|
+
===== Funding
|
235
225
|
|
236
226
|
The `--funding` option allows you add a link:https://github.com[GitHub] funding configuration to
|
237
227
|
your project so you can attract link:https://docs.github.com/en/sponsors[sponsors]. This option
|
238
228
|
doesn't require use of the `--git_hub` option but is encouraged.
|
239
229
|
|
240
|
-
|
230
|
+
===== Git
|
241
231
|
|
242
232
|
The `--git` option allows you add link:https://git-scm.com[Git] repository support.
|
243
233
|
|
244
|
-
|
234
|
+
===== GitHub
|
245
235
|
|
246
236
|
The `--git_hub` option allows you add link:https://github.com[GitHub] templates to your project for
|
247
237
|
issues and pull requests.
|
248
238
|
|
249
|
-
|
239
|
+
===== Git Lint
|
250
240
|
|
251
241
|
The `--git-lint` option allows you to add the link:https://www.alchemists.io/projects/git-lint[Git
|
252
242
|
Lint] gem to your project to ensure you are crafting your Git commits in a consistent and readable
|
253
243
|
manner.
|
254
244
|
|
255
|
-
|
245
|
+
===== Guard
|
256
246
|
|
257
247
|
The `--guard` option allows you add the link:https://github.com/guard/guard[Guard] gem to your
|
258
248
|
project for rapid red, green, refactor development cycles.
|
259
249
|
|
260
|
-
|
250
|
+
===== License
|
261
251
|
|
262
252
|
The `--license` option ensures you build your project with a license.
|
263
253
|
|
264
|
-
|
254
|
+
===== Maximum
|
265
255
|
|
266
256
|
The `--max` option allows you to build your project with _all_ options _enabled_. This is a quick way
|
267
257
|
to build a new project with all options enabled without having to pick and choose.
|
268
258
|
|
269
|
-
|
259
|
+
===== Minimum
|
270
260
|
|
271
261
|
The `--min` option allows you to build your project with _all_ options _disabled_. This is a quick
|
272
262
|
way to build a new project with the bare minimum of support which is a one step above reaching for a
|
273
263
|
Bundler Inline script.
|
274
264
|
|
275
|
-
|
265
|
+
===== Rake
|
276
266
|
|
277
267
|
The `--rake` option allows you to add the link:https://github.com/ruby/rake[Rake] gem for quickly
|
278
268
|
crafting build scripts.
|
279
269
|
|
280
|
-
|
270
|
+
===== Readme
|
281
271
|
|
282
272
|
The `--readme` option allows you to add README documentation to your project.
|
283
273
|
|
284
|
-
|
274
|
+
===== Reek
|
285
275
|
|
286
276
|
The `--reek` option allows you add the link:https://github.com/troessner/reek[Reek] gem to your
|
287
277
|
project for code smell and code quality support.
|
288
278
|
|
289
|
-
|
279
|
+
===== Refinements
|
290
280
|
|
291
281
|
The `--refinements` option allows you to add the
|
292
282
|
link:https://www.alchemists.io/projects/refinements[Refinements] gem to your project which enhances
|
293
283
|
Ruby core objects without monkey patching your code.
|
294
284
|
|
295
|
-
|
285
|
+
===== RSpec
|
296
286
|
|
297
287
|
The `--rspec` option allows you add the link:https://rspec.info[RSpec] gem to your project for
|
298
288
|
defining your project specifications and have a framework for testing your code.
|
299
289
|
|
300
|
-
|
290
|
+
===== Setup
|
301
291
|
|
302
292
|
The `--setup` option allows you to configure you project with automated setup instructions so anyone
|
303
293
|
new to your project can quickly get started by running the `bin/setup` script.
|
304
294
|
|
305
|
-
|
295
|
+
===== SimpleCov
|
306
296
|
|
307
297
|
The `--simple_cov` option allows you add the
|
308
298
|
link:https://github.com/simplecov-ruby/simplecov[SimpleCov] gem to your project to provide full
|
309
299
|
analysis of what your quality of code is for the project.
|
310
300
|
|
311
|
-
|
301
|
+
===== Versions
|
312
302
|
|
313
303
|
The `--versions` option allows you add a `VERSIONS` file to your project to provide details about
|
314
304
|
all published versions of your project.
|
315
305
|
|
316
|
-
|
306
|
+
===== YARD
|
317
307
|
|
318
308
|
The `--yard` option allows you add the link:https://yardoc.org/[YARD] gem to your project so you can
|
319
309
|
automate the generation of project documentation. Once your project is built, you can use `rake
|
320
310
|
yard` to build documentation into the `doc/yard` folder. This folder is ignored by Git by default.
|
321
311
|
Additional customization is possible via the YARD Rake task as found in the `Rakefile`.
|
322
312
|
|
323
|
-
|
313
|
+
===== Zeitwerk
|
324
314
|
|
325
315
|
The `--zeitwerk` option allows you add the link:https://github.com/fxn/zeitwerk[Zeitwerk] gem to
|
326
316
|
your project so you can reduce the maintence burden of managing requirements when adding new objects
|
327
317
|
to your project.
|
328
318
|
|
329
|
-
|
319
|
+
==== Publish
|
330
320
|
|
331
321
|
Rubysmith can be used to publish your Ruby projects. This is done via the `--publish` command. If,
|
332
322
|
for example, you want to publish `0.1.0` of your `demo` project you could do that as follows:
|
@@ -552,7 +542,7 @@ To contribute, run:
|
|
552
542
|
|
553
543
|
[source,bash]
|
554
544
|
----
|
555
|
-
git clone https://github.com/bkuhlmann/rubysmith
|
545
|
+
git clone https://github.com/bkuhlmann/rubysmith
|
556
546
|
cd rubysmith
|
557
547
|
bin/setup
|
558
548
|
----
|
data/lib/rubysmith/import.rb
CHANGED
@@ -28,6 +28,18 @@ bin/setup
|
|
28
28
|
== Usage
|
29
29
|
|
30
30
|
== Development
|
31
|
+
|
32
|
+
To contribute, run:
|
33
|
+
|
34
|
+
[source,bash]
|
35
|
+
----
|
36
|
+
git clone <%= configuration.computed_project_url_source %>
|
37
|
+
cd <%= configuration.project_name %>
|
38
|
+
<% if configuration.build_setup %>
|
39
|
+
bin/setup
|
40
|
+
<% end %>
|
41
|
+
----
|
42
|
+
|
31
43
|
<% if configuration.build_console %>
|
32
44
|
|
33
45
|
You can also use the IRB console for direct access to all objects:
|
@@ -22,6 +22,17 @@ To set up the project, run:
|
|
22
22
|
## Usage
|
23
23
|
|
24
24
|
## Development
|
25
|
+
|
26
|
+
To contribute, run:
|
27
|
+
|
28
|
+
``` bash
|
29
|
+
git clone <%= configuration.computed_project_url_source %>
|
30
|
+
cd <%= configuration.project_name %>
|
31
|
+
<% if configuration.build_setup %>
|
32
|
+
bin/setup
|
33
|
+
<% end %>
|
34
|
+
```
|
35
|
+
|
25
36
|
<% if configuration.build_console %>
|
26
37
|
|
27
38
|
You can also use the IRB console for direct access to all objects:
|
data/rubysmith.gemspec
CHANGED
@@ -2,7 +2,7 @@
|
|
2
2
|
|
3
3
|
Gem::Specification.new do |spec|
|
4
4
|
spec.name = "rubysmith"
|
5
|
-
spec.version = "3.
|
5
|
+
spec.version = "3.7.0"
|
6
6
|
spec.authors = ["Brooke Kuhlmann"]
|
7
7
|
spec.email = ["brooke@alchemists.io"]
|
8
8
|
spec.homepage = "https://github.com/bkuhlmann/rubysmith"
|
@@ -23,10 +23,10 @@ Gem::Specification.new do |spec|
|
|
23
23
|
spec.cert_chain = [Gem.default_cert_path]
|
24
24
|
|
25
25
|
spec.required_ruby_version = "~> 3.1"
|
26
|
-
spec.add_dependency "auto_injector", "~> 0.7"
|
27
26
|
spec.add_dependency "cogger", "~> 0.2"
|
28
|
-
spec.add_dependency "dry-container", "~> 0.
|
27
|
+
spec.add_dependency "dry-container", "~> 0.11"
|
29
28
|
spec.add_dependency "git_plus", "~> 1.4"
|
29
|
+
spec.add_dependency "infusible", "~> 0.0"
|
30
30
|
spec.add_dependency "milestoner", "~> 14.2"
|
31
31
|
spec.add_dependency "pastel", "~> 0.8"
|
32
32
|
spec.add_dependency "pragmater", "~> 11.2"
|
data.tar.gz.sig
CHANGED
@@ -1,2 +1,4 @@
|
|
1
|
-
��
|
2
|
-
|
1
|
+
�l���bT���]��Pix]*��e�5U��.���>qs��=R��
|
2
|
+
V(�H&�#H�o
|
3
|
+
$(�
|
4
|
+
]���3�t� `���
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: rubysmith
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.
|
4
|
+
version: 3.7.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Brooke Kuhlmann
|
@@ -28,64 +28,64 @@ cert_chain:
|
|
28
28
|
CxDe2+VuChj4I1nvIHdu+E6XoEVlanUPKmSg6nddhkKn2gC45Kyzh6FZqnzH/CRp
|
29
29
|
RFE=
|
30
30
|
-----END CERTIFICATE-----
|
31
|
-
date: 2022-
|
31
|
+
date: 2022-09-16 00:00:00.000000000 Z
|
32
32
|
dependencies:
|
33
33
|
- !ruby/object:Gem::Dependency
|
34
|
-
name:
|
34
|
+
name: cogger
|
35
35
|
requirement: !ruby/object:Gem::Requirement
|
36
36
|
requirements:
|
37
37
|
- - "~>"
|
38
38
|
- !ruby/object:Gem::Version
|
39
|
-
version: '0.
|
39
|
+
version: '0.2'
|
40
40
|
type: :runtime
|
41
41
|
prerelease: false
|
42
42
|
version_requirements: !ruby/object:Gem::Requirement
|
43
43
|
requirements:
|
44
44
|
- - "~>"
|
45
45
|
- !ruby/object:Gem::Version
|
46
|
-
version: '0.
|
46
|
+
version: '0.2'
|
47
47
|
- !ruby/object:Gem::Dependency
|
48
|
-
name:
|
48
|
+
name: dry-container
|
49
49
|
requirement: !ruby/object:Gem::Requirement
|
50
50
|
requirements:
|
51
51
|
- - "~>"
|
52
52
|
- !ruby/object:Gem::Version
|
53
|
-
version: '0.
|
53
|
+
version: '0.11'
|
54
54
|
type: :runtime
|
55
55
|
prerelease: false
|
56
56
|
version_requirements: !ruby/object:Gem::Requirement
|
57
57
|
requirements:
|
58
58
|
- - "~>"
|
59
59
|
- !ruby/object:Gem::Version
|
60
|
-
version: '0.
|
60
|
+
version: '0.11'
|
61
61
|
- !ruby/object:Gem::Dependency
|
62
|
-
name:
|
62
|
+
name: git_plus
|
63
63
|
requirement: !ruby/object:Gem::Requirement
|
64
64
|
requirements:
|
65
65
|
- - "~>"
|
66
66
|
- !ruby/object:Gem::Version
|
67
|
-
version: '
|
67
|
+
version: '1.4'
|
68
68
|
type: :runtime
|
69
69
|
prerelease: false
|
70
70
|
version_requirements: !ruby/object:Gem::Requirement
|
71
71
|
requirements:
|
72
72
|
- - "~>"
|
73
73
|
- !ruby/object:Gem::Version
|
74
|
-
version: '
|
74
|
+
version: '1.4'
|
75
75
|
- !ruby/object:Gem::Dependency
|
76
|
-
name:
|
76
|
+
name: infusible
|
77
77
|
requirement: !ruby/object:Gem::Requirement
|
78
78
|
requirements:
|
79
79
|
- - "~>"
|
80
80
|
- !ruby/object:Gem::Version
|
81
|
-
version: '
|
81
|
+
version: '0.0'
|
82
82
|
type: :runtime
|
83
83
|
prerelease: false
|
84
84
|
version_requirements: !ruby/object:Gem::Requirement
|
85
85
|
requirements:
|
86
86
|
- - "~>"
|
87
87
|
- !ruby/object:Gem::Version
|
88
|
-
version: '
|
88
|
+
version: '0.0'
|
89
89
|
- !ruby/object:Gem::Dependency
|
90
90
|
name: milestoner
|
91
91
|
requirement: !ruby/object:Gem::Requirement
|
@@ -330,7 +330,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
330
330
|
- !ruby/object:Gem::Version
|
331
331
|
version: '0'
|
332
332
|
requirements: []
|
333
|
-
rubygems_version: 3.3.
|
333
|
+
rubygems_version: 3.3.22
|
334
334
|
signing_key:
|
335
335
|
specification_version: 4
|
336
336
|
summary: A command line interface for smithing Ruby projects.
|
metadata.gz.sig
CHANGED
Binary file
|