gem_hadar 1.24.0 → 1.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8ef3c017e74aa89e444380b3017ec092bf53c2cc8020402a57d3e847f78f5a
-  data.tar.gz: 89e9769d1c6935ac1213aa430cf39222ea1040b7d4a30085fcfa4c861a5bf53e
+  metadata.gz: f3fefed7b5fd9123e2944de9cf2defcd9f1794aaa7d0058621539b22a2e076d3
+  data.tar.gz: 8734f8f3cf30c0a0b501e5484a58bc5b4bbc4190258133f6de7b1105f17c7383
 SHA512:
-  metadata.gz: dc28e7d7d4c9acc70d7bdc6e5c59e775d55cce975d39e82f1d919af6c90a3f8114a9ca665031736f899ab857ebbd7746ea5abd0cf41c2b99ae34602f19274ff6
-  data.tar.gz: 9f4e9c24186ae498b86c741eb6f5afe4e80c36cb8dbff28dbfbc9e789ef4da5d07f92b8bbce9569baaa916cc97c91621c8ffd5810a24b6a48c5b93e3fd477ac4
+  metadata.gz: 867a63019ba90544ba9b0c91478482128d3527221d9c11473929d9f18b5c74673d2fc3ab5844bc26779680b724965a9a7a455518286c5ca9a496342371c31c1a
+  data.tar.gz: a6fa278536336a668d025947b3d9f274d4cc02ae9e2a3d50bb2a2a87b42ee2d351bfb191d9eb472bd215b521c34b561c4ee5d9f15cfcec93576f98871df23c10

data/README.md

@@ -2,7 +2,76 @@
 
 ## Description
 
-Ruby library that provides support for building gems.
+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:
+
+- **Automated gem building and packaging** - Complete build workflows with
+  🛠️Rake task orchestration
+- **Git workflow automation** - Version management, tagging, remote operations,
+  and repository setup with 🔄git integration
+- **GitHub release management** - Automated release creation with 🤖AI-powered
+  changelog generation using Ollama
+- **Testing framework integration** - Built-in support for RSpec, Test::Unit,
+  and RCov code coverage testing with 🧪testing tools
+- **Documentation generation** - YARD integration with private/public
+  documentation tasks and coverage reporting with 📚documentation
+- **RVM configuration management** - Automatic .rvmrc file generation for
+  consistent development environments with 🎯RVM setup
+- **CI/CD pipeline capabilities** - Complete workflows from build to publish
+  with dependency management using ⚙️CI/CD automation
+- **Semantic versioning automation** - 👾AI-powered version bump suggestions
+  based on code changes
+- **Extension compilation support** - Automatic compilation of C extensions
+  when needed with 🏗️extension building
+- **DSL-based configuration** - Simple block syntax in Rakefile for easy
+  workflow setup with 📝configuration
+- **Gemfile and .gitignore automation** - Automatic creation and management of
+  essential project files with 📦dependency management
+
+## Workflow Diagrams
+
+### Gem Build Process
+```mermaid
+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]
+```
+
+### AI Versioning Flow
+
+```mermaid
+graph LR
+    A[Code Changes] --> B[Semantic Analysis]
+    B --> C[AI Suggestion]
+    C --> D[Version Decision]
+    D --> E[Changelog Generation]
+    E --> F[Release Creation]
+```
+
+### Testing Suite Overview
+
+```mermaid
+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]
+```
 
 ## Download
 
@@ -12,37 +81,183 @@ The source of this library is located at
 
 or can be installed via
 
-```
+```bash
 $ gem install gem_hadar
 ```
 
 ## Usage
 
-Create a new directory and excecute
+### Pre-requisites
 
-```
+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.
+
+### Quick Start with Generator
+
+Create a new directory and execute:
+
+```bash
 $ gem_hadar
 ```
 
-Edit the created Rakefile until
+This generates a basic gem structure with a Rakefile. Edit the generated Rakefile until:
 
-```
+```bash
 $ rake gemspec
 ```
 
 and then
 
+```bash
+$ rake build
+```
+
+are performed as desired.
+
+### YARD Documentation
+
+`gem_hadar` supports generating YARD documentation. To generate documentation, run:
+
+```bash
+$ rake doc
 ```
+
+This will create documentation in the `doc` directory using YARD.
+
+### Rakefile Configuration Example
+
+For more advanced control, here's a complete Rakefile configuration example:
+
+```ruby
+# 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"](Rakefile)
+
+### Available Tasks
+
+You can list all available tasks with:
+
+```bash
+$ rake -T
+```
+
+#### Core Tasks
+
+- `rake build` - Build task (builds all packages for a release)
+- `rake release` - Release the new version 1.2.3 for the gem foo
+
+#### Build Tasks
+
+- `rake gemspec` - Create a gemspec file
+- `rake package` - Build all the packages
+- `rake gem` - Build the gem file foo-1.2.3.gem
+- `rake clobber` - Remove any generated files
+- `rake clobber_package` - Remove package products
+- `rake repackage` - Force a rebuild of the package files
+
+#### Version Management
+
+- `rake version` - Writing version information for foo
+- `rake version:show` - Displaying the current version
+- `rake version:list` - List all versions in order
+- `rake version:diff` - Displaying the diff from env var VERSION to the next version or HEAD
+- `rake version:tag` - Tag this commit as version 1.2.3
+- `rake version:bump` - Bump version with AI suggestion
+- `rake version:bump:major` - Bump major version
+- `rake version:bump:minor` - Bump minor version
+- `rake version:bump:build` - Bump build version
+- `rake version:push` - Push version 1.2.3 to all git remotes: origin
+- `rake version:origin:push` - Push version 1.2.3 to git remote origin
+
+#### Documentation
+
+- `rake doc` - Create yard documentation (including private)
+- `rake yard_doc` - Generate YARD Documentation
+- `rake yard:doc` - Create yard documentation
+- `rake yard:private` - Create yard documentation (including private)
+- `rake yard:public` - Create yard documentation
+- `rake yard:clean` - Clean the yard documentation
+- `rake yard:view` - View the yard documentation
+- `rake yard:list-undoc` - List all undocumented classes/modules/methods
+
+#### Testing & Development
+
+- `rake run_specs` - Run RSpec code examples
+- `rake clean` - Remove any temporary products
+- `rake gems:install` - Install all gems from the Gemfile
+- `rake gem_hadar:update` - Update `gem_hadar` to a different version
+- `rake rvm` - Create .rvmrc file
+- `rake default` - Default task
+- `rake compile` - Compile project extensions (if configured)
+
+#### Publishing Tasks
+- `rake push` - Push all changes for version 1.2.3 into the internets
+- `rake github:release` - Create a new GitHub release for the current version
+  with AI-generated changelog
+
+### Update Version
+
+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 level
+
+Or bump your [VERSION](./VERSION) file by hand.
+
+### Release
+
+```bash
 $ rake build
 ```
 
-are perfomed as desired.
+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:
+
+```bash
+$ 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.
 
 ## Author
 
-Florian Frank \<mailto:flori@ping.de\>
-**GemHadar** was written by [Florian Frank](mailto:flori@ping.de)
+**GemHadar** was written by [Florian Frank](mailto:flori@ping.de).
 
 ## License
 
-This software is licensed under the _MIT_ license.
+This software is licensed under the [MIT](./LICENSE) license.

data/Rakefile

@@ -18,6 +18,7 @@ GemHadar do
   dependency  'tins',           '~> 1.0'
   dependency  'term-ansicolor', '~> 1.0'
   dependency  'ollama-ruby',    '~> 1.0'
+  dependency  'mize'
   dependency  'rake'
   dependency  'yard'
 

data/VERSION

@@ -1 +1 @@
-1.24.0
+1.26.0

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 1.24.0 ruby lib
+# stub: gem_hadar 1.26.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "1.24.0".freeze
+  s.version = "1.26.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   s.description = "This library contains some useful functionality to support the development of Ruby Gems".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["gem_hadar".freeze]
-  s.extra_rdoc_files = ["README.md".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/version.rb".freeze]
-  s.files = [".gitignore".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/version.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze]
+  s.files = [".gitignore".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze]
   s.homepage = "https://github.com/flori/gem_hadar".freeze
   s.licenses = ["MIT".freeze]
   s.rdoc_options = ["--title".freeze, "GemHadar - Library for the development of Ruby Gems".freeze, "--main".freeze, "README.md".freeze]
@@ -22,10 +22,11 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.23".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.26".freeze])
   s.add_runtime_dependency(%q<tins>.freeze, ["~> 1.0".freeze])
   s.add_runtime_dependency(%q<term-ansicolor>.freeze, ["~> 1.0".freeze])
   s.add_runtime_dependency(%q<ollama-ruby>.freeze, ["~> 1.0".freeze])
+  s.add_runtime_dependency(%q<mize>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<rake>.freeze, [">= 0".freeze])
   s.add_runtime_dependency(%q<yard>.freeze, [">= 0".freeze])
 end

data/lib/gem_hadar/prompt_template.rb

@@ -0,0 +1,91 @@
+module GemHadar::PromptTemplate
+  # The default_git_release_system_prompt method returns the system prompt used
+  # for generating GitHub release changelogs.
+  #
+  # This prompt instructs the AI model to act as a Ruby programmer who creates
+  # markdown-formatted changelog entries for new releases. The generated
+  # content helps users understand what has changed in the software.
+  #
+  # @return [ String ] the system prompt for GitHub release changelog generation
+  def default_git_release_system_prompt
+    <<~EOT
+      You are a Ruby programmer generating changelog messages in markdown
+      format for new releases, so users can see what has changed. Remember you
+      are not a chatbot of any kind.
+    EOT
+  end
+
+  # The default_git_release_prompt method returns the prompt used for
+  # generating GitHub release changelogs.
+  #
+  # This prompt instructs the AI model to create a markdown-formatted changelog
+  # entry for a new release. It specifies guidelines for what constitutes
+  # significant changes, emphasizing the exclusion of trivial updates
+  # and the inclusion of only verified and impactful modifications.
+  #
+  # @return [ String ] the prompt template for GitHub release changelog generation
+  def default_git_release_prompt
+    <<~EOT
+      Output the content of a changelog for the new release of %{name} %{version}
+
+      **Strictly** follow these guidelines:
+
+        - Use bullet points in markdown format (`-`) to list significant changes.
+        - Exclude trivial updates such as:
+          * Version number increments
+          * Dependency version bumps (unless they resolve critical issues)
+          * Minor code style adjustments
+          * Internal documentation tweaks
+        - Include only verified and substantial changes that impact
+          functionality, performance, or user experience.
+        - If unsure about a change's significance, omit it from the output.
+        - Avoid adding any comments or notes; keep the output purely factual.
+
+      These are the log messages including patches for the new release:
+
+      %{log_diff}
+    EOT
+  end
+
+  # The default_version_bump_system_prompt method returns the system prompt
+  # used for generating semantic version bump suggestions.
+  #
+  # This prompt instructs the AI model to act as an expert in semantic versioning,
+  # analyzing provided changes and determining whether a major, minor, or build
+  # version bump is appropriate. It requires the model to provide a brief
+  # explanation of its reasoning followed by a single line containing only one
+  # word: 'major', 'minor', or 'build'.
+  #
+  # @return [ String ] the system prompt for semantic version bump suggestion generation
+  def default_version_bump_system_prompt
+    <<~EOT
+      You are an expert at semantic versioning. Analyze the provided changes
+      and suggest whether to bump major, minor, or build version according to
+      Semantic Versioning. Provide a brief explanation of your reasoning,
+      followed by a single line containing only one word: 'major', 'minor', or
+      'build'.
+    EOT
+  end
+
+  # The default_version_bump_prompt method returns the prompt template used for
+  # generating semantic version bump suggestions.
+  #
+  # This prompt instructs the AI model to analyze provided changes and
+  # determine whether a major, minor, or build version bump is appropriate
+  # according to Semantic Versioning principles. It requires the model to first
+  # provide a brief explanation of its reasoning, followed by a single line
+  # containing only one word: 'major', 'minor', or 'build'.
+  #
+  # @return [ String ] the prompt template for semantic version bump suggestion generation
+  def default_version_bump_prompt
+    <<~EOT
+      Given the current version %{version} and the following changes:
+
+      %{log_diff}
+
+      Please explain your reasoning for suggesting a version bump and then end
+      with a single line containing only one word: 'major', 'minor', or
+      'build'.
+    EOT
+  end
+end

data/lib/gem_hadar/setup.rb

@@ -1,6 +1,10 @@
 class GemHadar::Setup
   include FileUtils
 
+  # The perform method sets up the basic project structure by creating the lib
+  # directory, initializing a VERSION file with '0.0.0' if it doesn't exist,
+  # and creating a default Rakefile with basic GemHadar configuration if one
+  # doesn't already exist.
   def perform
     mkdir_p 'lib'
     unless File.exist?('VERSION')

data/lib/gem_hadar/template_compiler.rb

@@ -4,12 +4,26 @@ class GemHadar::TemplateCompiler
   include Tins::BlockSelf
   include Tins::MethodMissingDelegator::DelegatorModule
 
+  # The initialize method sets up the template compiler instance by evaluating
+  # the provided block in the context of the object.
+  #
+  # @param block [ Proc ] the block to be evaluated for configuring the template compiler
   def initialize(&block)
     super block_self(&block)
     @values = {}
     instance_eval(&block)
   end
 
+  # The compile method processes an ERB template file and writes the rendered
+  # output to a destination file.
+  #
+  # This method reads the content of a source file, treats it as an ERB
+  # template, and renders it using the provided binding.
+  # The result is then written to a specified destination file, effectively
+  # generating a new file based on the template.
+  #
+  # @param src [ String ] the path to the source ERB template file
+  # @param dst [ String ] the path to the destination file where the rendered content will be written
   def compile(src, dst)
     template = File.read(src)
     File.open(dst, 'w') do |output|
@@ -19,6 +33,21 @@ class GemHadar::TemplateCompiler
     end
   end
 
+  # The method_missing method handles dynamic attribute access and assignment.
+  #
+  # This method intercepts calls to undefined methods on the object, allowing
+  # for dynamic retrieval and setting of values through method calls. If a
+  # method name corresponds to a key in @values and no arguments are provided,
+  # it returns the stored value. If a single argument is provided, it stores
+  # the argument under the method name as a key in @values. For all other
+  # cases, it delegates the call to the superclass implementation.
+  #
+  # @param id [ Symbol ] the name of the method being called
+  # @param a [ Array ] the arguments passed to the method
+  # @param b [ Proc ] the block passed to the method
+  #
+  # @return [ Object ] the value associated with the method name if retrieving,
+  #                    otherwise delegates to super
   def method_missing(id, *a, &b)
     if a.empty? && id && @values.key?(id)
       @values[id]

data/lib/gem_hadar/utils.rb

@@ -0,0 +1,41 @@
+module GemHadar::Utils
+  # The xdg_config_filename method constructs the full path to a configuration
+  # file based on the XDG Base Directory specification.
+  #
+  # It first checks if the XDG_CONFIG_HOME environment variable is set and not
+  # empty. If it is set, the method joins this directory with the provided
+  # filename to form the complete path. If XDG_CONFIG_HOME is not set, it
+  # defaults to using the HOME environment variable to construct the path
+  # within the standard .config directory.
+  #
+  # @param name [ String ] the name of the configuration file
+  #
+  # @return [ String ] the full path to the configuration file
+  def xdg_config_filename(name)
+    if xdg = ENV['XDG_CONFIG_HOME'].full?
+      File.join(xdg, name)
+    else
+      File.join(ENV.fetch('HOME'), '.config', name)
+    end
+  end
+
+  memoize method:
+  # The xdg_config method retrieves configuration data from a file following
+  # the XDG Base Directory specification.
+  #
+  # It checks for the existence of a configuration file using the
+  # xdg_config_filename method and returns its contents if found. If the file
+  # does not exist, it returns the provided default value instead.
+  #
+  # @param name [ String ] the name of the configuration file to retrieve
+  # @param default [ Object ] the default value to return if the configuration file is not found
+  #
+  # @return [ String ] the content of the configuration file or the default value
+  def xdg_config(name, default)
+    if File.exist?(xdg_config_filename(name))
+      File.read(xdg_config_filename(name))
+    else
+      default
+    end
+  end
+end

data/lib/gem_hadar/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '1.24.0'
+  VERSION         = '1.26.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc: