gem_hadar 2.17.0 → 2.17.1
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/.github/workflows/static.yml +5 -5
- data/README.md +33 -16
- data/gem_hadar.gemspec +4 -4
- data/lib/gem_hadar/github_workflows/static.yml.erb +5 -5
- data/lib/gem_hadar/simplecov.rb +0 -1
- data/lib/gem_hadar/utils.rb +0 -2
- data/lib/gem_hadar/version.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8bafeed87a6a67bb46a1efe076696990fc7f025b74304791e872f31aaa76bdd7
|
|
4
|
+
data.tar.gz: b18ea90c3b3f4af53f6a8a83c3b62ba25d82d19012d8291f35e2db4564fd1acf
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: df62a1eb30b6d729e06d5cd1dde8fa30386d2a7b84c97d6537c0c53404b0d154abac464e20ccfd0708e5382f3d695616b6965b6e0f9444ce006964cff66f20d4
|
|
7
|
+
data.tar.gz: 88ebe10e8c10abb45eebaab902609ede35f2e92979d9768f27253288480d684a35ebef000731f1cbc0d0bd4c0eb2d2117fbbe33dbb856c9ff59d29a12a522a28
|
|
@@ -30,22 +30,22 @@ jobs:
|
|
|
30
30
|
runs-on: ubuntu-latest
|
|
31
31
|
steps:
|
|
32
32
|
- name: Checkout
|
|
33
|
-
uses: actions/checkout@
|
|
33
|
+
uses: actions/checkout@v6
|
|
34
34
|
- name: Setup Pages
|
|
35
|
-
uses: actions/configure-pages@
|
|
35
|
+
uses: actions/configure-pages@v6
|
|
36
36
|
- name: Setup Ruby
|
|
37
37
|
uses: ruby/setup-ruby@v1
|
|
38
38
|
with:
|
|
39
|
-
ruby-version: '
|
|
39
|
+
ruby-version: '4.0'
|
|
40
40
|
- name: Generate Documentation
|
|
41
41
|
run: |
|
|
42
42
|
gem install gem_hadar
|
|
43
43
|
bundle install
|
|
44
44
|
rake doc
|
|
45
45
|
- name: Upload artifact
|
|
46
|
-
uses: actions/upload-pages-artifact@
|
|
46
|
+
uses: actions/upload-pages-artifact@v5
|
|
47
47
|
with:
|
|
48
48
|
path: 'doc'
|
|
49
49
|
- name: Deploy to GitHub Pages
|
|
50
50
|
id: deployment
|
|
51
|
-
uses: actions/deploy-pages@
|
|
51
|
+
uses: actions/deploy-pages@v5
|
data/README.md
CHANGED
|
@@ -125,7 +125,8 @@ export GEM_HOST_API_KEY="your_api_key_here"
|
|
|
125
125
|
**Security Note**: Never commit your API key to version control. Use a `.env`
|
|
126
126
|
file or your shell's configuration with appropriate loading mechanisms.
|
|
127
127
|
|
|
128
|
-
This key is required for tasks like `rake release` which push the gem package
|
|
128
|
+
This key is required for tasks like `rake release` which push the gem package
|
|
129
|
+
to RubyGems.org.
|
|
129
130
|
|
|
130
131
|
### Github API
|
|
131
132
|
|
|
@@ -175,6 +176,12 @@ The model options example configures:
|
|
|
175
176
|
This functionality is used by the `rake github:release` and `rake version:bump`
|
|
176
177
|
task to generate AI-powered changelogs or suggest a version bump.
|
|
177
178
|
|
|
179
|
+
**Human-in-the-Loop Review** ✍️: To ensure high quality and accuracy, `gem_hadar`
|
|
180
|
+
does not blindly trust AI output. For tasks like `rake github:release` and
|
|
181
|
+
`rake changes:add`, the tool will automatically open your configured `EDITOR`
|
|
182
|
+
with the AI-generated content, allowing you to review and polish the text
|
|
183
|
+
before it is committed or published.
|
|
184
|
+
|
|
178
185
|
### Custom AI Prompts
|
|
179
186
|
|
|
180
187
|
To customize the AI prompts used by `gem_hadar`, you can override the default
|
|
@@ -237,7 +244,7 @@ This task displays all current configuration values including:
|
|
|
237
244
|
|
|
238
245
|
### Pre-requisites
|
|
239
246
|
|
|
240
|
-
Before using `gem_hadar`, ensure you have initialized a Git repository in
|
|
247
|
+
Before using `gem_hadar`, ensure you have initialized a Git repository in the
|
|
241
248
|
project directory. Many of the gem's commands assume Git is available and
|
|
242
249
|
properly configured in the current working directory.
|
|
243
250
|
|
|
@@ -249,7 +256,8 @@ Create a new directory and execute:
|
|
|
249
256
|
$ gem_hadar
|
|
250
257
|
```
|
|
251
258
|
|
|
252
|
-
This generates a basic gem structure with a Rakefile. Edit the generated
|
|
259
|
+
This generates a basic gem structure with a Rakefile. Edit the generated
|
|
260
|
+
Rakefile until:
|
|
253
261
|
|
|
254
262
|
```bash
|
|
255
263
|
$ rake gemspec
|
|
@@ -265,7 +273,8 @@ are performed as desired.
|
|
|
265
273
|
|
|
266
274
|
### YARD Documentation
|
|
267
275
|
|
|
268
|
-
`gem_hadar` supports generating YARD documentation. To generate documentation,
|
|
276
|
+
`gem_hadar` supports generating YARD documentation. To generate documentation,
|
|
277
|
+
run:
|
|
269
278
|
|
|
270
279
|
```bash
|
|
271
280
|
$ rake doc
|
|
@@ -316,7 +325,9 @@ Note that `gem_hadar` is ["self hosted"](Rakefile)
|
|
|
316
325
|
- **`version`** - Required version with fallback to `VERSION` file or ENV override
|
|
317
326
|
- **`authors`** - Required author names (mapped from `author`)
|
|
318
327
|
- **`email`** - Required author email (raises error if not set)
|
|
319
|
-
- **`homepage`** - Required homepage URL (raises error if not set).
|
|
328
|
+
- **`homepage`** - Required homepage URL (raises error if not set).
|
|
329
|
+
**Validation**: When `developing` is false, validates that the URL returns an
|
|
330
|
+
HTTP OK status after following redirects.
|
|
320
331
|
- **`summary`** - Required summary description (raises error if not set)
|
|
321
332
|
- **`description`** - Required full description (raises error if not set)
|
|
322
333
|
|
|
@@ -377,16 +388,19 @@ end
|
|
|
377
388
|
|
|
378
389
|
#### Configuration Flags
|
|
379
390
|
|
|
380
|
-
- **`developing`** - Default: `false`. When set to `true`, skips URL
|
|
391
|
+
- **`developing`** - Default: `false`. When set to `true`, it skips URL
|
|
392
|
+
validation (including homepage link verification) and **acts as a safety
|
|
393
|
+
brake 🛑 by disabling actual `gem push` operations to RubyGems**, preventing
|
|
394
|
+
accidental publications during development.
|
|
381
395
|
|
|
382
396
|
### Paths and Module Types
|
|
383
397
|
|
|
384
398
|
- **`path_name`** - Default: `name`. Returns the raw gem name value by default.
|
|
385
399
|
It is used for generating file paths and module names. This is particularly
|
|
386
400
|
useful for creating consistent directory structures and file naming
|
|
387
|
-
conventions. It's used internally by `GemHadar` to create the root
|
|
388
|
-
for the gem (`lib/my_gem` for name "my\_gem") and generate a
|
|
389
|
-
in that location.
|
|
401
|
+
conventions. It's used internally by `GemHadar` to create the root
|
|
402
|
+
directory for the gem (`lib/my_gem` for name "my\_gem") and generate a
|
|
403
|
+
`version.rb` file in that location.
|
|
390
404
|
|
|
391
405
|
This can be changed for nested namespaces if desired.
|
|
392
406
|
|
|
@@ -398,13 +412,13 @@ end
|
|
|
398
412
|
- **`path_module`** - Default: `path_name.camelize`. Automatically converts the
|
|
399
413
|
gem name to CamelCase format (e.g., "my\_gem" becomes "MyGem",
|
|
400
414
|
"namespace/my\_gem" becomes "Namespace::MyGem") for use in Ruby module and
|
|
401
|
-
class declarations, ensuring consistency with Ruby naming
|
|
402
|
-
|
|
415
|
+
class declarations, ensuring consistency with Ruby naming conventions.
|
|
416
|
+
This value can be overridden if needed.
|
|
403
417
|
|
|
404
418
|
- **`module_type`** - Default: `:module`. Determines whether the generated code
|
|
405
419
|
structure for the version module should be a `:module` or `:class`. This
|
|
406
|
-
controls the type of Ruby construct created when generating code skeletons
|
|
407
|
-
version files. The value
|
|
420
|
+
controls the type of Ruby construct created when generating code skeletons
|
|
421
|
+
and version files. The value
|
|
408
422
|
can be set to either:
|
|
409
423
|
|
|
410
424
|
- `:module` (default) - Generates module-based structure
|
|
@@ -424,9 +438,9 @@ end
|
|
|
424
438
|
```
|
|
425
439
|
|
|
426
440
|
These computed values serve as intelligent defaults that can be overridden
|
|
427
|
-
based on
|
|
428
|
-
DSL accessors and provide powerful convenience features that enable
|
|
429
|
-
to generate consistent, well-structured Ruby code automatically.
|
|
441
|
+
based on on their specific requirements. They are automatically derived from
|
|
442
|
+
other DSL accessors and provide powerful convenience features that enable
|
|
443
|
+
`GemHadar` to generate consistent, well-structured Ruby code automatically.
|
|
430
444
|
|
|
431
445
|
## Available Tasks
|
|
432
446
|
|
|
@@ -557,6 +571,9 @@ Use one of the following rake tasks to bump the version:
|
|
|
557
571
|
|
|
558
572
|
Or bump your [VERSION](./VERSION) file by hand.
|
|
559
573
|
|
|
574
|
+
*💡 Note: The tool intelligently handles version strings, treating prefixed
|
|
575
|
+
(`v1.2.3`) and non-prefixed (`1.2.3`) formats interchangeably.*
|
|
576
|
+
|
|
560
577
|
## Release
|
|
561
578
|
|
|
562
579
|
```bash
|
data/gem_hadar.gemspec
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
# -*- encoding: utf-8 -*-
|
|
2
|
-
# stub: gem_hadar 2.17.
|
|
2
|
+
# stub: gem_hadar 2.17.1 ruby lib
|
|
3
3
|
|
|
4
4
|
Gem::Specification.new do |s|
|
|
5
5
|
s.name = "gem_hadar".freeze
|
|
6
|
-
s.version = "2.17.
|
|
6
|
+
s.version = "2.17.1".freeze
|
|
7
7
|
|
|
8
8
|
s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
|
|
9
9
|
s.require_paths = ["lib".freeze]
|
|
@@ -17,13 +17,13 @@ Gem::Specification.new do |s|
|
|
|
17
17
|
s.homepage = "https://github.com/flori/gem_hadar".freeze
|
|
18
18
|
s.licenses = ["MIT".freeze]
|
|
19
19
|
s.rdoc_options = ["--title".freeze, "GemHadar - Library for the development of Ruby Gems".freeze, "--main".freeze, "README.md".freeze]
|
|
20
|
-
s.rubygems_version = "4.0.
|
|
20
|
+
s.rubygems_version = "4.0.6".freeze
|
|
21
21
|
s.summary = "Library for the development of Ruby Gems".freeze
|
|
22
22
|
s.test_files = ["spec/gem_hadar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
|
|
23
23
|
|
|
24
24
|
s.specification_version = 4
|
|
25
25
|
|
|
26
|
-
s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.
|
|
26
|
+
s.add_development_dependency(%q<gem_hadar>.freeze, [">= 2.17.0".freeze])
|
|
27
27
|
s.add_development_dependency(%q<all_images>.freeze, [">= 0".freeze])
|
|
28
28
|
s.add_development_dependency(%q<rspec>.freeze, ["~> 3.13".freeze])
|
|
29
29
|
s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])
|
|
@@ -30,22 +30,22 @@ jobs:
|
|
|
30
30
|
runs-on: ubuntu-latest
|
|
31
31
|
steps:
|
|
32
32
|
- name: Checkout
|
|
33
|
-
uses: actions/checkout@
|
|
33
|
+
uses: actions/checkout@v6
|
|
34
34
|
- name: Setup Pages
|
|
35
|
-
uses: actions/configure-pages@
|
|
35
|
+
uses: actions/configure-pages@v6
|
|
36
36
|
- name: Setup Ruby
|
|
37
37
|
uses: ruby/setup-ruby@v1
|
|
38
38
|
with:
|
|
39
|
-
ruby-version: '
|
|
39
|
+
ruby-version: '4.0'
|
|
40
40
|
- name: Generate Documentation
|
|
41
41
|
run: |
|
|
42
42
|
gem install gem_hadar
|
|
43
43
|
bundle install
|
|
44
44
|
rake doc
|
|
45
45
|
- name: Upload artifact
|
|
46
|
-
uses: actions/upload-pages-artifact@
|
|
46
|
+
uses: actions/upload-pages-artifact@v5
|
|
47
47
|
with:
|
|
48
48
|
path: 'doc'
|
|
49
49
|
- name: Deploy to GitHub Pages
|
|
50
50
|
id: deployment
|
|
51
|
-
uses: actions/deploy-pages@
|
|
51
|
+
uses: actions/deploy-pages@v5
|
data/lib/gem_hadar/simplecov.rb
CHANGED
data/lib/gem_hadar/utils.rb
CHANGED
data/lib/gem_hadar/version.rb
CHANGED
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: gem_hadar
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 2.17.
|
|
4
|
+
version: 2.17.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Florian Frank
|
|
@@ -15,14 +15,14 @@ dependencies:
|
|
|
15
15
|
requirements:
|
|
16
16
|
- - ">="
|
|
17
17
|
- !ruby/object:Gem::Version
|
|
18
|
-
version: 2.
|
|
18
|
+
version: 2.17.0
|
|
19
19
|
type: :development
|
|
20
20
|
prerelease: false
|
|
21
21
|
version_requirements: !ruby/object:Gem::Requirement
|
|
22
22
|
requirements:
|
|
23
23
|
- - ">="
|
|
24
24
|
- !ruby/object:Gem::Version
|
|
25
|
-
version: 2.
|
|
25
|
+
version: 2.17.0
|
|
26
26
|
- !ruby/object:Gem::Dependency
|
|
27
27
|
name: all_images
|
|
28
28
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -319,7 +319,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
319
319
|
- !ruby/object:Gem::Version
|
|
320
320
|
version: '0'
|
|
321
321
|
requirements: []
|
|
322
|
-
rubygems_version: 4.0.
|
|
322
|
+
rubygems_version: 4.0.6
|
|
323
323
|
specification_version: 4
|
|
324
324
|
summary: Library for the development of Ruby Gems
|
|
325
325
|
test_files:
|