gem_hadar 2.12.0 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 695a7ff7bd975c62a492a7201233a82758d5f1ba55c2da575f4efc90d477b3d6
-  data.tar.gz: 24338fcf746d7af9bbe140283ef9d90257f04fb10c3e36f8bb2bcf4a6beee140
+  metadata.gz: 46cb64331f3aa5f93bb51121b1134547c847f07130349af38d25bdf2db16582c
+  data.tar.gz: 6cfa451785cfafda768a2aebd0594fb5059dbfcccadf29c4ba7c4d9769fab18d
 SHA512:
-  metadata.gz: d50e942241bb49b5aacacaf84760bd8123e3bef6b4c8addb7e988d16c71434d8506ac28ba382a99193483bd2a37c53ef56f4d091a9c1c655715276a038f1b8a8
-  data.tar.gz: a25eda3b38ebc77b8b5eb2fa15532b7e5f6f83da7f257accd2ec4e2e12eee835f9b087523b6b8c6a7e142946cf81f7da0320dc9e6a9badf90bf76486bf7f3452
+  metadata.gz: 83fae17af6f0b76d6df9e50ee55ab506e3ce05947d2927dd117bf5f58a6ce1b78ae1e35458e7e87bcca09388693bbdcd7282207962e9098e9e56fe30251907a7
+  data.tar.gz: 81ccf75c79c92ed844a6e673813ae09272d9add1585fb5464733f55ff87da0447db1c82cb1c35efd7ef93222e3b3fd8f9fda46b52a14d625a729b3166eb5eebe

data/README.md

@@ -107,7 +107,6 @@ The following environment variables can be used to configure `gem_hadar`:
 | `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` |
@@ -230,7 +229,7 @@ This task displays all current configuration values including:
 - Repository information (gem name, version)
 - Build parameters (MAKE, EDITOR)
 - Git configuration (remote)
-- Other flags (FORCE, VERSION, GITHUB_RELEASE_ENABLED)
+- Other flags (VERSION, GITHUB_RELEASE_ENABLED)
 - XDG/HOME directories
 - AI prompt defaults
 
@@ -359,6 +358,17 @@ rvm do
 end
 ```
 
+#### GitHub Workflows Configuration
+
+```ruby
+github_workflows do
+  'ci.yml' => {
+    name: 'Continuous Integration',
+    ruby_versions: ['3.0', '3.1', '3.2']
+  }
+end
+```
+
 #### Task Dependencies
 
 - **`default_task_dependencies`** - Default: `[:gemspec, :test]`
@@ -418,7 +428,7 @@ 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.
 
-### Available Tasks
+## Available Tasks
 
 You can list all available tasks with:
 
@@ -426,12 +436,12 @@ You can list all available tasks with:
 $ rake -T
 ```
 
-#### Core Tasks
+### 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
+### Build Tasks
 
 - `rake gemspec` - Create a gemspec file
 - `rake package` - Build all the packages
@@ -440,7 +450,7 @@ $ rake -T
 - `rake clobber_package` - Remove package products
 - `rake repackage` - Force a rebuild of the package files
 
-#### Version Management
+### Version Management
 
 - `rake version` - Writing version information for foo
 - `rake version:show` - Displaying the current version
@@ -454,7 +464,16 @@ $ rake -T
 - `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
+### Changelog Generation
+
+- `rake changes:pending` - Show changes since last version tag
+- `rake changes:current` - Show changes between two latest version tags
+- `rake changes:range` - Show changes for a specific Git range (e.g., v1.0.0..v1.2.0)
+- `rake changes:full` - Generate complete changelog from first tag
+- `rake changes:add` - Append to existing changelog file
+- `rake changes:added` - Check if current version was added to changelog
+
+### Documentation
 
 - `rake doc` - Create yard documentation (including private)
 - `rake yard_doc` - Generate YARD Documentation
@@ -465,7 +484,7 @@ $ rake -T
 - `rake yard:view` - View the yard documentation
 - `rake yard:list-undoc` - List all undocumented classes/modules/methods
 
-#### Testing & Development
+### Testing & Development
 
 - `rake run_specs` - Run RSpec code examples
 - `rake clean` - Remove any temporary products
@@ -475,12 +494,12 @@ $ rake -T
 - `rake default` - Default task
 - `rake compile` - Compile project extensions (if configured)
 
-#### Publishing Tasks
+### 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
 
-### Code Coverage with SimpleCov
+## Code Coverage with SimpleCov
 
 To enable detailed code coverage reporting in your project using `GemHadar`,
 follow these steps:
@@ -524,7 +543,7 @@ follow these steps:
 > branch coverage statistics per file, making it ideal for integration with CI
 > tools or custom dashboards.
 
-### Update Gem Version
+## Update Gem Version
 
 Use one of the following rake tasks to bump the version:
 
@@ -535,7 +554,7 @@ Use one of the following rake tasks to bump the version:
 
 Or bump your [VERSION](./VERSION) file by hand.
 
-### Release
+## Release
 
 ```bash
 $ rake build
@@ -556,6 +575,75 @@ 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.
 
+## Template System
+
+GemHadar includes a template compilation system for generating project files:
+
+```ruby
+# In your Rakefile
+template 'templates/Dockerfile.erb', 'Dockerfile' do |t|
+  t.version = version
+  t.name = name
+end
+```
+
+This system uses ERB templates and provides a clean way to generate files
+during your build process.
+
+## GitHub Workflows
+
+Configure automated workflows with ERB templates:
+
+```ruby
+GemHadar do
+  github_workflows do
+    'ci.yml' => {
+      name: 'Continuous Integration',
+      ruby_versions: ['3.0', '3.1', '3.2']
+    }
+  end
+end
+```
+
+This creates workflow files in `.github/workflows/` using templates from the
+gem's internal templates directory.
+
+## Advanced Usage Patterns
+
+### Custom Prompt Templates
+
+Override AI behavior by creating custom prompt files in your XDG config:
+
+```bash
+# Create custom prompt files
+mkdir -p ~/.config/gem_hadar
+cp /path/to/gem_hadar/lib/gem_hadar/default_changelog_prompt.txt ~/.config/gem_hadar/changelog_prompt.txt
+```
+
+### CI/CD Integration
+
+Use the following workflow for automated releases:
+
+```bash
+# Build and test
+$ rake build
+$ rake test
+
+# Bump version and create release
+$ rake version:bump
+$ rake build
+$ rake release
+```
+
+### Troubleshooting
+
+If you encounter issues with AI prompts:
+
+1. Check that Ollama is running
+2. Verify your model is pulled: `ollama list`
+3. Check configuration with: `rake gem_hadar:config`
+4. Review error messages in the console output
+
 ## Author
 
 **GemHadar** was written by [Florian Frank](mailto:flori@ping.de).

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.12.0 ruby lib
+# stub: gem_hadar 2.13.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.12.0".freeze
+  s.version = "2.13.1".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.12".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.13".freeze])
   s.add_development_dependency(%q<all_images>.freeze, [">= 0".freeze])
   s.add_development_dependency(%q<rspec>.freeze, ["~> 3.13".freeze])
   s.add_development_dependency(%q<simplecov>.freeze, [">= 0".freeze])

data/lib/gem_hadar/changelog_generator.rb

@@ -134,7 +134,7 @@ class GemHadar
 
       changelog = generate_changelog(versions, changelog:)
 
-      changelog << "# Changes\n"
+      changelog.unshift "# Changes\n"
 
       output << changelog.join("")
     end
@@ -167,8 +167,54 @@ class GemHadar
       inject_into_filename(filename, changelog)
     end
 
+    # The changelog_exist? method checks whether a changelog file exists in the
+    # project.
+    #
+    # This method verifies the presence of a changelog file by checking if the
+    # file path determined by changelog_filename exists in the filesystem.
+    #
+    # @return [ TrueClass, FalseClass ] true if the changelog file exists,
+    #   false otherwise
+    def changelog_exist?
+      changelog_filename.exist?
+    end
+
+    # The changelog_version_added? method checks whether a specific version has
+    # already been added to the changelog file.
+    #
+    # This method verifies if a given version is present in the changelog file
+    # by examining each line for a match with the version tag.
+    #
+    # @param version [ String ] the version to check for in the changelog
+    #
+    # @return [ TrueClass, FalseClass ] true if the version is found in the
+    #   changelog, false otherwise
+    #
+    # @raise [ ArgumentError ] if the changelog file does not exist
+    def changelog_version_added?(version)
+      version = GemHadar::VersionSpec[version]
+      changelog_exist? or
+        raise ArgumentError, "Changelog #{changelog_filename.to_s} doesn't exist!"
+      File.new(changelog_filename).any? do |line|
+        line =~ /#{version.tag}/ and return true
+      end
+      false
+    end
+
     private
 
+    # The changelog_filename method returns the Pathname object for the
+    # changelog file path.
+    #
+    # This method accesses the changelog_filename attribute from the associated
+    # GemHadar instance and wraps it in a Pathname object for convenient file
+    # path manipulation.
+    #
+    # @return [ Pathname ] the Pathname object representing the changelog file path
+    def changelog_filename
+      Pathname.new(@gem_hadar.changelog_filename)
+    end
+
     # The ollama_generate method delegates AI generation requests to the
     # associated GemHadar instance.
     #

data/lib/gem_hadar/version.rb

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

data/lib/gem_hadar/warn.rb

@@ -29,7 +29,7 @@ class GemHadar
     # @param msgs [ Array<String> ] the array of message strings to display as warnings
     def warn(*msgs)
       msgs.map! do |a|
-        a.respond_to?(:to_str) ? color(208) { a.to_str } : a
+        a.respond_to?(:to_str) ? color(220) { a.to_str } : a
       end
       super(*msgs, uplevel: 1)
     end
@@ -49,5 +49,22 @@ class GemHadar
       end
       super(*msgs)
     end
+
+    # The abort method formats and displays failure messages using red colored
+    # output.
+    #
+    # This method takes an array of message objects, applies red color formatting
+    # to string representations of the messages, and then passes them to the
+    # superclass's abort method for display. The uplevel: 1 option ensures that
+    # the failure message originates from the caller's context rather than from
+    # within this method itself.
+    #
+    # @param msgs [ Array<Object> ] the array of message objects to display as failures
+    def abort(*msgs)
+      msgs.map! do |a|
+        a.respond_to?(:to_str) ? color(208) { a.to_str } : a
+      end
+      super(*msgs)
+    end
   end
 end

data/lib/gem_hadar.rb

@@ -598,6 +598,17 @@ class GemHadar
     @rvm
   end
 
+  # The changelog_filename attribute accessor for configuring the gem's
+  # changelog file name.
+  #
+  # This method sets up a DSL accessor for the changelog_filename attribute,
+  # which specifies the name of the changelog file to be used in the project.
+  # It provides a way to define a custom changelog filename that will be used
+  # during documentation generation and version management tasks.
+  #
+  # @return [ String, nil ] the name of the changelog file or nil if disabled.
+  dsl_accessor :changelog_filename
+
   # The default_task_dependencies method manages the list of dependencies for
   # the default Rake task.
   #
@@ -913,8 +924,7 @@ class GemHadar
       task :update do
         answer = ask?("Which gem_hadar version? ", /^((?:\d+.){2}(?:\d+))$/)
         unless answer
-          warn "Invalid version specification!"
-          exit 1
+          abort "Invalid version specification!"
         end
         gem_hadar_version = answer[0]
         filename = "#{name}.gemspec"
@@ -1099,6 +1109,37 @@ class GemHadar
     end
   end
 
+  # The version_tag_local method retrieves the Git revision hash for the current version tag
+  #
+  # This method executes a Git command to obtain the full revision hash (commit SHA) associated
+  # with the current gem version tag. It constructs the tag name using the GemHadar::VersionSpec
+  # class and then uses Git's rev-parse command to resolve the tag to its corresponding commit.
+  #
+  # @return [ String ] the Git revision hash for the current version tag
+  # @return [ String ] an empty string if the Git command fails
+  # @return [ String ] the output of the Git rev-parse command as a string
+  def version_tag_local
+    `git show-ref #{GemHadar::VersionSpec[version].tag.inspect}`.
+      chomp.sub(/\s.*/, '').full?
+  end
+  memoize method: :version_tag_local
+
+  # The version_tag_remote method retrieves the Git revision hash for the remote version tag
+  #
+  # This method executes a Git command to obtain the full revision hash (commit SHA) associated
+  # with the current gem version tag on the remote repository. It constructs the tag name using
+  # the GemHadar::VersionSpec class and then uses Git's ls-remote command to resolve the tag
+  # to its corresponding commit on the specified remote.
+  #
+  # @return [ String ] the Git revision hash for the remote version tag
+  # @return [ String ] an empty string if the Git command fails or no remote tag is found
+  # @return [ String ] the output of the Git ls-remote command as a string
+  def version_tag_remote
+    `git ls-remote --tags #{git_remote} #{GemHadar::VersionSpec[version].tag.inspect}`.
+      chomp.sub(/\s.*/, '').full?
+  end
+  memoize method: :version_tag_remote
+
   # The version_tag_task method defines a Rake task that creates a Git tag for
   # the current version.
   #
@@ -1110,24 +1151,29 @@ class GemHadar
   # overwrite it forcefully.
   def version_tag_task
     namespace :version do
+      namespace :tag do
+        desc "show local tag revision"
+        task :local do
+          system 'git fetch --tags'
+          puts version_tag_local
+        end
+
+        desc "show remote tag revision"
+        task :remote do
+          puts version_tag_remote
+        end
+      end
+
       desc "Tag this commit as version #{version}"
-      task :tag do
-        force = ENV['FORCE'].to_i == 1
-        begin
-          sh "git tag -a -m 'Version #{version}' #{'-f' if force} #{GemHadar::VersionSpec[version].tag}"
-        rescue RuntimeError
-          if `git diff v#{version}..HEAD`.empty?
-            puts "Version #{version} is already tagged, but it's no different"
-          else
-            if ask?("Different version tag #{version} already exists. Overwrite with "\
-                "force? (yes/NO) ", /\Ayes\z/i)
-              force = true
-              retry
-            else
-              exit 1
-            end
-          end
+      task :tag => :modified do
+        version_spec = GemHadar::VersionSpec[version]
+        if sha = version_tag_remote
+          abort <<~EOT.chomp
+            Remote version tag #{version_spec.tag.inspect} already exists and points to #{sha.inspect}!"
+            Call version:bump first to create a new version before release.
+          EOT
         end
+        sh "git tag -a -m 'Version #{version_spec.untag}' -f #{version_spec.tag.inspect}"
       end
     end
   end
@@ -1258,8 +1304,7 @@ class GemHadar
               exit 1
             end
           else
-            warn "Cannot push gem to rubygems: #{path.inspect} doesn't exist."
-            exit 1
+            abort "Cannot push gem to rubygems: #{path.inspect} doesn't exist."
           end
         end
       end
@@ -1346,6 +1391,23 @@ class GemHadar
     end
   end
 
+  # The modified_task method defines a Rake task that checks for uncommitted
+  # changes in the Git repository
+  #
+  # This method creates a Rake task named :modified that runs a Git status
+  # command to identify any modified files that are not yet committed. If any
+  # changed files are found, it aborts the task execution and displays a
+  # message
+  # listing all the uncommitted files
+  def modified_task
+    task :modified do
+      changed_files = `git status --porcelain`.gsub(/^\s*\S\s+/, '').lines
+      unless changed_files.empty?
+        abort "There are still modified files:\n#{changed_files * ''}"
+      end
+    end
+  end
+
   # The push_task_dependencies method manages the list of dependencies for the push task.
   #
   # This method sets up a DSL accessor for the push_task_dependencies attribute,
@@ -1373,13 +1435,7 @@ class GemHadar
     gem_push_task
     git_remotes_task
     github_release_task
-    task :modified do
-      changed_files = `git status --porcelain`.gsub(/^\s*\S\s+/, '').lines
-      unless changed_files.empty?
-        warn "There are still modified files:\n#{changed_files * ''}"
-        exit 1
-      end
-    end
+    modified_task
     desc "Push all changes for version #{version} into the internets."
     task :push => push_task_dependencies
   end
@@ -1393,7 +1449,7 @@ class GemHadar
   # with a single command.
   def release_task
     desc "Release the new version #{version} for the gem #{name}."
-    task :release => :push
+    task :release => [ :'changes:added', :push ]
   end
 
   # The compile_task method sets up a Rake task to compile project extensions.
@@ -1579,7 +1635,6 @@ class GemHadar
         puts "Git Remote(s): #{ENV['GIT_REMOTE'] || 'origin'}"
 
         # Other
-        puts "Force Operations: #{ENV['FORCE'] || '0'}"
         puts "Version Override: #{ENV['VERSION'] || 'Not set'}"
         puts "GitHub Release Enabled: #{ENV['GITHUB_RELEASE_ENABLED'] || 'Not set'}"
 
@@ -1606,6 +1661,7 @@ class GemHadar
   # - :changes:range - Show changes for a specific Git range
   # - :changes:full - Generate complete changelog from first tag
   # - :changes:add - Append to existing changelog file
+  # - :changes:added - Check if the current version was added to changelog file
   def changes_task
     namespace :changes do
       desc 'Show changes since last version tag'
@@ -1670,9 +1726,18 @@ class GemHadar
 
       desc 'Append new entries to existing changelog file'
       task :add do
-        filename = ARGV[1] or raise 'Need file to add to'
+        filename = ARGV[1] || changelog_filename
+        filename or raise 'Need file to add to'
         GemHadar::ChangelogGenerator.new(self).add_to_file(filename)
       end
+
+      desc 'Check if current version was added to the changelog'
+      task :added do
+        changelog_filename or next
+        GemHadar::ChangelogGenerator.new(self).changelog_version_added?(version) and next
+        abort "Version #{GemHadar::VersionSpec[version].untag} has not been "\
+          "documented in changelog #{changelog_filename.inspect} file."
+      end
     end
 
     # Main changes task that shows help when called directly
@@ -1685,6 +1750,7 @@ class GemHadar
             rake changes:range <range> Show changes for a specific Git range (e.g., v1.0.0..v1.2.0)
             rake changes:full [file]   Generate complete changelog from first tag
             rake changes:add <file>    Append new entries to existing changelog file
+            rake changes:added         Check if current version was added to changelog
 
           Examples:
             rake changes:pending
@@ -1693,6 +1759,7 @@ class GemHadar
             rake changes:full
             rake changes:full CHANGES.md
             rake changes:add CHANGES.md
+            rake changes:added
       EOT
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 2.12.0
+  version: 2.13.1
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.12'
+        version: '2.13'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement