gem_hadar 1.24.0 → 1.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad8ef3c017e74aa89e444380b3017ec092bf53c2cc8020402a57d3e847f78f5a
-  data.tar.gz: 89e9769d1c6935ac1213aa430cf39222ea1040b7d4a30085fcfa4c861a5bf53e
+  metadata.gz: 5277b0542113dc8de861927c702b9a17c0dc30fc000b0aad88f77559177bd562
+  data.tar.gz: 32cfd43ba8dd14a74fd0db9cfba009851866f22bb78decd0dd6cbdd0f3cb9b62
 SHA512:
-  metadata.gz: dc28e7d7d4c9acc70d7bdc6e5c59e775d55cce975d39e82f1d919af6c90a3f8114a9ca665031736f899ab857ebbd7746ea5abd0cf41c2b99ae34602f19274ff6
-  data.tar.gz: 9f4e9c24186ae498b86c741eb6f5afe4e80c36cb8dbff28dbfbc9e789ef4da5d07f92b8bbce9569baaa916cc97c91621c8ffd5810a24b6a48c5b93e3fd477ac4
+  metadata.gz: a77a1a309790aac939d7aff2f3973c495baa92a3d36e3443747e7243aa0a6e09781a7162ddde5e36868316b85db3ab58c20bcb3f137b818dc5f458ed3b741fd1
+  data.tar.gz: 8754d4b122caf5a5df4af137097440e84a4841f8c0b83fec7e635716997c59cbba36671e6b6b03230dbe1bceb319e131fbfb9c2734a155c8d5771692bfe31289

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.25.0

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 1.24.0 ruby lib
+# stub: gem_hadar 1.25.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "1.24.0".freeze
+  s.version = "1.25.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.24".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,54 @@
+module GemHadar::PromptTemplate
+  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
+
+  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
+
+  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
+
+  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/utils.rb

@@ -0,0 +1,18 @@
+module GemHadar::Utils
+  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:
+  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.25.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/gem_hadar.rb

@@ -25,12 +25,16 @@ require_maybe 'rspec/core/rake_task'
 class GemHadar
 end
 require 'gem_hadar/version'
+require 'gem_hadar/utils'
 require 'gem_hadar/setup'
 require 'gem_hadar/template_compiler'
 require 'gem_hadar/github'
+require 'gem_hadar/prompt_template'
 
 class GemHadar
   include Term::ANSIColor
+  include GemHadar::Utils
+  include GemHadar::PromptTemplate
 
   if defined?(::RbConfig)
     include ::RbConfig
@@ -338,10 +342,7 @@ class GemHadar
 
       desc "Displaying the diff from env var VERSION to the next version or HEAD"
       task :diff do
-        version_tags = versions.map { version_tag(_1) } + %w[ HEAD ]
-        found_version_tag = version_tags.index(version_tag(version))
-        found_version_tag.nil? and fail "cannot find version tag #{version_tag(version)}"
-        start_version, end_version = version_tags[found_version_tag, 2]
+        start_version, end_version = determine_version_range
         puts color(172) { "Showing diff from version %s to %s:" % [ start_version, end_version ] }
         puts `git diff --color=always #{start_version}..#{end_version}`
       end
@@ -459,23 +460,40 @@ class GemHadar
       namespace :bump do
         desc 'Bump major version'
         task :major do
-          version = File.read('VERSION').chomp.version
-          version.bump(:major)
-          secure_write('VERSION') { |v| v.puts version }
+          version_bump_to(:major)
         end
 
         desc 'Bump minor version'
         task :minor do
-          version = File.read('VERSION').chomp.version
-          version.bump(:minor)
-          secure_write('VERSION') { |v| v.puts version }
+          version_bump_to(:minor)
         end
 
         desc 'Bump build version'
         task :build do
-          version = File.read('VERSION').chomp.version
-          version.bump(:build)
-          secure_write('VERSION') { |v| v.puts version }
+          version_bump_to(:build)
+        end
+      end
+
+      desc 'Bump version with suggestion'
+      task :bump do
+        log_diff = version_log_diff(from_version: nil, to_version: 'HEAD')
+        system   = xdg_config('version_bump_system_prompt.txt', default_version_bump_system_prompt)
+        prompt   = xdg_config('version_bump_prompt.txt', default_version_bump_prompt) % { version:, log_diff: }
+        response = ollama_generate(system:, prompt:)
+        puts response
+        default = nil
+        if response =~ /(major|minor|build)\s*$/
+          default = $1
+        end
+        response = ask?(
+          'Bump a major, minor, or build version%{default}? ',
+          /\A(major|minor|build)\z/,
+          default:
+        )
+        if version_type = response&.[](1)
+          version_bump_to(version_type)
+        else
+          exit 1
         end
       end
     end
@@ -595,43 +613,11 @@ class GemHadar
     end
   end
 
-  def create_body
-    base_url = ENV['OLLAMA_URL']
-    if base_url.blank? && host = ENV['OLLAMA_HOST'].full?
-      base_url = 'http://%s' % host
-    end
-    base_url.present? or return
+  def create_git_release_body
     log_diff = version_log_diff(to_version: version)
-    model    = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
-    ollama   = Ollama::Client.new(base_url:, read_timeout: 600, connect_timeout: 60)
-    system = <<~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
-    prompt = (<<~EOT) % { name:, version:, log_diff: }
-      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
-    options = ENV['OLLAMA_OPTIONS'].full? { |o| JSON.parse(o) } || {}
-    options |= { "temperature" => 0, "top_p" => 1, "min_p" => 0.1 }
-    ollama.generate(model:, system:, prompt:, options:, stream: false, think: false).response
+    system   = xdg_config('release_system_prompt.txt', default_git_release_system_prompt)
+    prompt   = xdg_config('release_prompt.txt', default_git_release_prompt) % { name:, version:, log_diff: }
+    ollama_generate(system:, prompt:)
   end
 
   def edit_temp_file(content)
@@ -675,7 +661,7 @@ class GemHadar
           rc = GitHub::ReleaseCreator.new(owner:, repo:, token: github_api_token)
           tag_name         = version_tag(version)
           target_commitish = `git show -s --format=%H #{tag_name.inspect}^{commit}`.chomp
-          body             = edit_temp_file(create_body)
+          body             = edit_temp_file(create_git_release_body)
           if body.present?
             begin
               response = rc.perform(tag_name:, target_commitish:, body:)
@@ -812,6 +798,52 @@ class GemHadar
     self
   end
 
+  # Generates a response from an AI model using the Ollama::Client.
+  #
+  # @param [String] system The system prompt for the AI model.
+  # @param [String] prompt The user prompt to generate a response to.
+  # @return [String, nil] The generated response or nil if generation fails.
+  def ollama_generate(system:, prompt:)
+    base_url = ENV['OLLAMA_URL']
+    if base_url.blank? && host = ENV['OLLAMA_HOST'].full?
+      base_url = 'http://%s' % host
+    end
+    base_url.present? or return
+    ollama   = Ollama::Client.new(base_url:, read_timeout: 600, connect_timeout: 60)
+    model    = ENV.fetch('OLLAMA_MODEL', 'llama3.1')
+    options  = ENV['OLLAMA_OPTIONS'].full? { |o| JSON.parse(o) } || {}
+    options |= { "temperature" => 0, "top_p" => 1, "min_p" => 0.1 }
+    ollama.generate(model:, system:, prompt:, options:, stream: false, think: false).response
+  end
+
+  # Increases the specified part of the version number and writes it back to
+  # the VERSION  file.
+  #
+  # @param [Symbol, String] type The part of the version to bump (:major, :minor, or :build)
+  def version_bump_to(type)
+    type    = type.to_sym
+    version = File.read('VERSION').chomp.version
+    version.bump(type)
+    secure_write('VERSION') { |v| v.puts version }
+    exit 0
+  end
+
+  # Determine the start and end versions for diff comparison.
+  #
+  # If the VERSION env var is set, it will be used as the starting version tag.
+  # Otherwise, it defaults to the current commit's version or the latest tag.
+  #
+  # @return [Array(String, String)] A fixed-size array containing:
+  #   - The start version (e.g., '1.2.3') from which changes are compared.
+  #   - The end version (e.g., '1.2.4' or 'HEAD') up to which changes are compared.
+  def determine_version_range
+    version_tags = versions.map { version_tag(_1) } + %w[ HEAD ]
+    found_version_tag = version_tags.index(version_tag(version))
+    found_version_tag.nil? and fail "cannot find version tag #{version_tag(version)}"
+    start_version, end_version = version_tags[found_version_tag, 2]
+    return start_version, end_version
+  end
+
   # The write_ignore_file method writes the current ignore_files configuration
   # to a .gitignore file in the project root directory.
   def write_ignore_file
@@ -934,12 +966,6 @@ class GemHadar
     end
     super(*args)
   end
-  def fail(*args)
-    args.map! do |a|
-      a.respond_to?(:to_str) ? color(196) { a.to_str } : a
-    end
-    super(*args)
-  end
 
   # The git_remotes method retrieves the list of remote repositories configured
   # for the current Git project.
@@ -999,19 +1025,28 @@ class GemHadar
   #
   # @return [ Array<String> ] an array of version strings sorted in ascending
   # order according to semantic versioning rules.
+  memoize method:
   def versions
-    @versions ||= `git tag`.lines.grep(/^v?\d+\.\d+\.\d+$/).map(&:chomp).map {
+    `git tag`.lines.grep(/^v?\d+\.\d+\.\d+$/).map(&:chomp).map {
       _1.sub(/\Av/, '')
     }.sort_by(&:version)
   end
 
   # The version_tag method prepends a 'v' prefix to the given version
-  # string.
+  # string, unless it's HEAD.
   #
   # @param version [String] the version string to modify
   # @return [String] the modified version string with a 'v' prefix
   def version_tag(version)
-    version.dup.prepend ?v
+    if version != 'HEAD'
+      version.dup.prepend ?v
+    else
+      version.dup
+    end
+  end
+
+  def version_untag(version_tag)
+    version.sub(/\Av/, '')
   end
 
   # The github_remote_url method retrieves and parses the GitHub remote URL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 1.24.0
+  version: 1.25.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.24'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.23'
+        version: '1.24'
 - !ruby/object:Gem::Dependency
   name: tins
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +65,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: mize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -103,8 +117,10 @@ extra_rdoc_files:
 - README.md
 - lib/gem_hadar.rb
 - lib/gem_hadar/github.rb
+- lib/gem_hadar/prompt_template.rb
 - lib/gem_hadar/setup.rb
 - lib/gem_hadar/template_compiler.rb
+- lib/gem_hadar/utils.rb
 - lib/gem_hadar/version.rb
 files:
 - ".gitignore"
@@ -117,8 +133,10 @@ files:
 - gem_hadar.gemspec
 - lib/gem_hadar.rb
 - lib/gem_hadar/github.rb
+- lib/gem_hadar/prompt_template.rb
 - lib/gem_hadar/setup.rb
 - lib/gem_hadar/template_compiler.rb
+- lib/gem_hadar/utils.rb
 - lib/gem_hadar/version.rb
 homepage: https://github.com/flori/gem_hadar
 licenses: