The gem_hadar gem is a Ruby library that provides support for building gems
using rake tasks. It is a comprehensive Ruby gem automation tool that provides:
graph LR
A[Source Code] --> B[Gemfile Setup]
B --> C[Bundle Install]
C --> D[Run Tests]
D --> E[Generate Documentation]
E --> F[Build Gem]
F --> G[Version Bump]
G --> H[Push to GitHub]
G --> I[Push to Rubygems]
I --> J[AI Changelog]
H --> J[AI Changelog]
J --> K[Create Release]
graph LR
A[Code Changes] --> B[Semantic Analysis]
B --> C[AI Suggestion]
C --> D[Version Decision]
D --> E[Changelog Generation]
E --> F[Release Creation]
graph TD
A[Test Run] --> B[RSpec Tests]
A[Test Run] --> C[Test::Unit Tests]
B --> D[Code Coverage]
C --> D[Code Coverage]
D --> E[Failures?]
E -->|Yes| F[Fix Code]
E -->|No| G[Proceed]
F --> H[Re-run Tests]
H --> I[Success]
I --> J[Build Gem]
The source of this library is located at
or can be installed via
$ gem install gem_hadar
The following environment variables can be used to configure gem_hadar:
| Variable | Description | Default |
|---|---|---|
GEM_HOST_API_KEY | API key for gem hosting services | Not set |
GITHUB_API_TOKEN | GitHub personal access token for releases | Not set |
OLLAMA_MODEL | Ollama model name for AI generation | llama3.1 |
OLLAMA_HOST | Ollama server host URL | localhost:11434 |
OLLAMA_URL | Direct Ollama API URL (takes precedence over OLLAMA_HOST) | Not set |
OLLAMA_MODEL_OPTIONS | JSON configuration for Ollama model | Not set |
HOME | User's home directory (used for config file locations) | System default |
XDG_CONFIG_HOME | XDG configuration directory override | System default |
MAKE | Make program to use for building extensions | gmake or make |
VERSION | Override the version string for some tasks | Not set |
FORCE | Force certain operations (1 to enable) | 0 |
GIT_REMOTE | Git remote name(s) for operations, space separated | origin |
GITHUB_RELEASE_ENABLED | Enable GitHub releases (yes/no) | Auto-detected |
EDITOR | Editor to use for interactive tasks | vi |
To publish gems to RubyGems.org, you'll need to set up an API key:
export GEM_HOST_API_KEY="your_api_key_here"
Security Note: Never commit your API key to version control. Use a .env
file or your shell's configuration with appropriate loading mechanisms.
This key is required for tasks like rake release which push the gem package to RubyGems.org.
To enable GitHub release creation and other GitHub API interactions, you'll need to set up a personal access token.
repo scope for full repository accessexport GITHUB_API_TOKEN="your_token_here"
Security Note: Never commit your token to version control. Use a .env
file or your shell's configuration with appropriate loading mechanisms.
This token is required for tasks like rake github:release which create GitHub
releases with AI-generated changelogs.
The gem supports AI-powered changelog generation using Ollama. To configure this functionality:
ollama pull deepseek-r1:32b)export OLLAMA_HOST="http://localhost:11434"
export OLLAMA_MODEL="deepseek-r1:32b"
export OLLAMA_MODEL_OPTIONS='{"num_ctx":16384,"seed":-1,"num_predict":512,"temperature":0.4,"top_p":0.95,"top_k":20,"min_p":0}'
The default model is llama3.1 and the default host is
http://localhost:11434. These can be overridden based on your local Ollama
setup.
The model options example configures:
num_ctx: Context window size (16384 tokens)temperature: Response randomness (0.4 for balanced output)num_predict: Maximum tokens to generate (512)top_p, top_k, min_p: Sampling parameters for controlled generationThis functionality is used by the rake github:release and rake version:bump
task to generate AI-powered changelogs or suggest a version bump.
To customize the AI prompts used by gem_hadar, you can override the default
prompt files in your XDG configuration directory.
First, display the current default prompts using:
$ rake gem_hadar:config
This will show you the XDG_CONFIG_HOME, default system and user prompts for
version bumping and release generation. The output includes the exact template
variables that are available for use in your custom prompts.
Then, create the following files in your XDG configuration home directory:
version_bump_system_prompt.txtversion_bump_prompt.txtrelease_system_prompt.txtrelease_prompt.txtStart with the default values shown by rake gem_hadar:config and modify them
to suit your needs. The prompts support standard Ruby string interpolation with
the following variables:
For version bump prompts:
%{version} - Current gem version%{log_diff} - Git diff of changesFor release prompts:
%{name} - Gem name%{version} - New version being released%{log_diff} - Git diff of changesThis approach ensures your custom prompts work correctly with the template variables while maintaining consistency with the gem's expected input format.
To debug or verify your gem_hadar configuration, you can use the following
rake task:
$ rake gem_hadar:config
This task displays all current configuration values including:
Before using gem_hadar, ensure you have initialized a Git repository in your
project directory. Many of the gem's commands assume Git is available and
properly configured in the current working directory.
Create a new directory and execute:
$ gem_hadar
This generates a basic gem structure with a Rakefile. Edit the generated Rakefile until:
$ rake gemspec
and then
$ rake build
are performed as desired.
gem_hadar supports generating YARD documentation. To generate documentation, run:
$ rake doc
This will create documentation in the doc directory using YARD.
For more advanced control, here's a complete Rakefile configuration example:
# Rakefile
require 'gem_hadar'
GemHadar do
# Set developing to true if you don't have a homepage set yet
#developing true
name 'mygemname'
path_name 'mygem'
path_module 'Mygem'
author 'My name'
email 'my@mail'
homepage "https://github.com/younameit/mygem"
summary 'Precious gem'
description 'Precious detailed gem'
test_dir 'spec'
ignore 'pkg', 'Gemfile.lock', '.DS_Store'
readme 'README.md'
title "#{name.camelize} -- My library"
licenses << 'Apache-2.0'
dependency 'sinatra', '~> 3.2'
development_dependency 'rake'
development_dependency 'rspec'
end
Note that gem_hadar is "self hosted"
name - Required gem name (raises error if not set)version - Required version with fallback to VERSION file or ENV overrideauthors - Required author names (mapped from author)email - Required author email (raises error if not set)homepage - Required homepage URL (raises error if not set). Validation: When developing is false, validates that the URL returns an HTTP OK status after following redirects.summary - Required summary description (raises error if not set)description - Required full description (raises error if not set)licenses - Default: Set[]. License information for the gemrequired_ruby_version - Default: nil. Ruby version requirementrequire_paths - Default: Set['lib'] (mapped to require_paths)test_dir - Default: nilspec_dir - Default: nilextensions - Default: FileList['ext/**/extconf.rb'] (mapped to extensions)make - Default: ENV['MAKE'] or system detectionexecutables - Default: Set[] (mapped to executables)ignore_files - Default: Set[]package_ignore_files - Default: Set[]readme - Default: niltitle - Default: nildoc_files - Default: nilyard_dir - Default: niltest_files - Default: nilspec_pattern - Default: nilbindir - Default: nil (mapped to bindir)rvm do
use # Default: detected ruby version from `rvm tools strings`
gemset # Default: gem name
end
default_task_dependencies - Default: [:gemspec, :test]build_task_dependencies - Default: [:clobber, :gemspec, :package, :'version:tag']push_task_dependencies - Default: [:modified, :build, :master:push, :version:push, :gem:push, :github:release]developing - Default: false. When set to true, skips URL validation including homepage link verification for faster development cycles.path_name - Default: name. Returns the raw gem name value by default.
It is used for generating file paths and module names. This is particularly
useful for creating consistent directory structures and file naming
conventions. It's used internally by GemHadar to create the root directory
for the gem (lib/my_gem for name "my_gem") and generate a version.rb file
in that location.
This can be changed for nested namespaces if desired.
Example: For gems in namespaces like ACME like
ACME::BrainfuckCompiler, you might set path_name to
"acme/brainfuck_compiler" to create the directory structure
lib/acme/brainfuck_compiler/.
path_module - Default: path_name.camelize. Automatically converts the
gem name to CamelCase format (e.g., "my_gem" becomes "MyGem",
"namespace/my_gem" becomes "Namespace::MyGem") for use in Ruby module and
class declarations, ensuring consistency with Ruby naming
conventions. This value can be overridden if needed.
module_type - Default: :module. Determines whether the generated code
structure for the version module should be a :module or :class. This
controls the type of Ruby construct created when generating code skeletons and
version files. The value
can be set to either:
:module (default) - Generates module-based structure:class - Generates class-based structureThis is used in the generated version.rb file to create either:
module MyGem
# ... version constants
end
or
class MyGem
# ... version constants
end
These computed values serve as intelligent defaults that can be overridden
based on your specific requirements. They are automatically derived from other
DSL accessors and provide powerful convenience features that enable GemHadar
to generate consistent, well-structured Ruby code automatically.
You can list all available tasks with:
$ rake -T
rake build - Build task (builds all packages for a release)rake release - Release the new version 1.2.3 for the gem foorake gemspec - Create a gemspec filerake package - Build all the packagesrake gem - Build the gem file foo-1.2.3.gemrake clobber - Remove any generated filesrake clobber_package - Remove package productsrake repackage - Force a rebuild of the package filesrake version - Writing version information for foorake version:show - Displaying the current versionrake version:list - List all versions in orderrake version:diff - Displaying the diff from env var VERSION to the next version or HEADrake version:tag - Tag this commit as version 1.2.3rake version:bump - Bump version with AI suggestionrake version:bump:major - Bump major versionrake version:bump:minor - Bump minor versionrake version:bump:build - Bump build versionrake version:push - Push version 1.2.3 to all git remotes: originrake version:origin:push - Push version 1.2.3 to git remote originrake doc - Create yard documentation (including private)rake yard_doc - Generate YARD Documentationrake yard:doc - Create yard documentationrake yard:private - Create yard documentation (including private)rake yard:public - Create yard documentationrake yard:clean - Clean the yard documentationrake yard:view - View the yard documentationrake yard:list-undoc - List all undocumented classes/modules/methodsrake run_specs - Run RSpec code examplesrake clean - Remove any temporary productsrake gems:install - Install all gems from the Gemfilerake gem_hadar:update - Update gem_hadar to a different versionrake rvm - Create .rvmrc filerake default - Default taskrake compile - Compile project extensions (if configured)rake push - Push all changes for version 1.2.3 into the internetsrake github:release - Create a new GitHub release for the current version
with AI-generated changelogTo enable detailed code coverage reporting in your project using GemHadar,
follow these steps:
Install Required Dependencies
Ensure that simplecov is included in your Gemfile:
gem 'simplecov'
Initialize Coverage in Your Test Setup
Add this line to the top of your test helper file (e.g., spec_helper.rb,
test_helper.rb):
require 'gem_hadar/simplecov'
GemHadar::SimpleCov.start
Enable Coverage Reporting
Run tests with the environment variable START_SIMPLECOV=1:
START_SIMPLECOV=1 bundle exec rspec
This will generate coverage reports in both HTML and JSON formats.
Viewing Reports
After running tests, you can view:
coverage/index.htmlcoverage/coverage_context.json🧪 Tip: Enable coverage reporting by setting the
START_SIMPLECOVenvironment variable to1. The JSON output includes detailed line and branch coverage statistics per file, making it ideal for integration with CI tools or custom dashboards.
Use one of the following rake tasks to bump the version:
rake version:bump:major - Bump major version (e.g., 1.2.3 → 2.0.0)rake version:bump:minor - Bump minor version (e.g., 1.2.3 → 1.3.0)rake version:bump:build - Bump build version (e.g., 1.2.3 → 1.2.4)rake version:bump - Get AI-powered suggestion for appropriate bump levelOr bump your VERSION file by hand.
$ rake build
This command will execute a series of dependent tasks in order: cleaning previous builds, generating the gem specification, packaging the gem, and creating a git tag with the current version in git.
After all the files have been changed correctly and the git tags have been moved forward to the appropriate commit you can finally enter:
$ rake release
The rake release command performs the final publishing steps: pushing the
master branch and version tag to all git remotes, pushing the gem package to
RubyGems.org, and creating a GitHub release with AI-generated changelog.
GemHadar was written by Florian Frank.
This software is licensed under the MIT license.
FAQs
Unknown package
We found that gem_hadar demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
This episode explores the hard problem of reachability analysis, from static analysis limits to handling dynamic languages and massive dependency trees.
Security News
/Research
Malicious Nx npm versions stole secrets and wallet info using AI CLI tools; Socket’s AI scanner detected the supply chain attack and flagged the malware.
Security News
CISA’s 2025 draft SBOM guidance adds new fields like hashes, licenses, and tool metadata to make software inventories more actionable.