gem_hadar 2.13.1 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46cb64331f3aa5f93bb51121b1134547c847f07130349af38d25bdf2db16582c
-  data.tar.gz: 6cfa451785cfafda768a2aebd0594fb5059dbfcccadf29c4ba7c4d9769fab18d
+  metadata.gz: c1526fc633cc4869edfeebe3b9b80abc73737c70484fef234517076870b8a809
+  data.tar.gz: 5cc2ad8d79884970d57130c2f7bb43a9d9d681834ff7bec707effb74a03f73b7
 SHA512:
-  metadata.gz: 83fae17af6f0b76d6df9e50ee55ab506e3ce05947d2927dd117bf5f58a6ce1b78ae1e35458e7e87bcca09388693bbdcd7282207962e9098e9e56fe30251907a7
-  data.tar.gz: 81ccf75c79c92ed844a6e673813ae09272d9add1585fb5464733f55ff87da0447db1c82cb1c35efd7ef93222e3b3fd8f9fda46b52a14d625a729b3166eb5eebe
+  metadata.gz: 1fce02764c683dab0b0a96294d9050868f20edcdb0c5843aa91b500f2d09e9866c4f4c945bbacbee59eb8502a67092e578f3eb118f346b938ad1a0bbfa9c062a
+  data.tar.gz: 1398928830339c43d4005e53d2629cb7ed90ca46b34ee3e2dede5e06be41a54b215e14919de22d2772c7266ec7a3692223817a50acfb1b37b70902390b2bcc59

data/README.md

@@ -470,8 +470,11 @@ $ rake -T
 - `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:add` - Append to changelog file
+- `rake changes:edit` - Edit changelog file
 - `rake changes:added` - Check if current version was added to changelog
+- `rake changes:commit` - Commit changes to changelog file
+- `rake changes:update` - Add and commit changes to changelog file
 
 ### Documentation
 

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.13.1 ruby lib
+# stub: gem_hadar 2.14.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.13.1".freeze
+  s.version = "2.14.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/changelog_generator.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/ollama_support.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/rvm_config.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/version_spec.rb".freeze, "lib/gem_hadar/warn.rb".freeze]
-  s.files = [".all_images.yml".freeze, ".github/workflows/static.yml".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/changelog_generator.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/github_workflows/static.yml.erb".freeze, "lib/gem_hadar/ollama_support.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/rvm_config.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/version_spec.rb".freeze, "lib/gem_hadar/warn.rb".freeze, "spec/gem_hadar_spec.rb".freeze, "spec/spec_helper.rb".freeze]
+  s.extra_rdoc_files = ["README.md".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/changelog_config.rb".freeze, "lib/gem_hadar/changelog_generator.rb".freeze, "lib/gem_hadar/editor.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/ollama_support.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/rvm_config.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/version_spec.rb".freeze, "lib/gem_hadar/warn.rb".freeze]
+  s.files = [".all_images.yml".freeze, ".github/workflows/static.yml".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "bin/gem_hadar".freeze, "gem_hadar.gemspec".freeze, "lib/gem_hadar.rb".freeze, "lib/gem_hadar/changelog_config.rb".freeze, "lib/gem_hadar/changelog_generator.rb".freeze, "lib/gem_hadar/editor.rb".freeze, "lib/gem_hadar/github.rb".freeze, "lib/gem_hadar/github_workflows/static.yml.erb".freeze, "lib/gem_hadar/ollama_support.rb".freeze, "lib/gem_hadar/prompt_template.rb".freeze, "lib/gem_hadar/rvm_config.rb".freeze, "lib/gem_hadar/setup.rb".freeze, "lib/gem_hadar/simplecov.rb".freeze, "lib/gem_hadar/template_compiler.rb".freeze, "lib/gem_hadar/utils.rb".freeze, "lib/gem_hadar/version.rb".freeze, "lib/gem_hadar/version_spec.rb".freeze, "lib/gem_hadar/warn.rb".freeze, "spec/gem_hadar_spec.rb".freeze, "spec/spec_helper.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]

data/lib/gem_hadar/changelog_config.rb

@@ -0,0 +1,52 @@
+# A class that encapsulates changelog configuration settings for a gem project.
+#
+# This class provides a structured way to define and manage settings related to
+# changelog generation within the GemHadar framework. It allows configuration
+# of the changelog filename and the commit message used when adding entries.
+#
+# @example Configuring changelog settings
+#   GemHadar do
+#     changelog do
+#       filename 'CHANGELOG.md'
+#       commit_message 'Update changelog'
+#     end
+#   end
+class GemHadar::ChangelogConfig
+  extend DSLKit::DSLAccessor
+
+  # This method creates a new instance of the ChangelogConfig class and then
+  # evaluates the provided block in the context of the new instance to
+  # configure the changelog settings.
+  #
+  # @param block [Proc] the block to be evaluated for configuring the changelog
+  #   settings
+  #
+  # @return [GemHadar::ChangelogConfig] the initialized ChangelogConfig
+  #   instance
+  def initialize(&block)
+    instance_eval(&block)
+  end
+
+  # The filename attribute accessor for configuring the changelog filename.
+  #
+  # This method sets up a DSL accessor for the filename attribute, which specifies
+  # the name of the changelog file to be used when generating or modifying
+  # changelog entries. It provides a way to define the location of the changelog
+  # file that will be processed during various changelog operations within the
+  # gem project.
+  #
+  # @return [ String, nil ] the name of the changelog file or nil if not set
+  dsl_accessor :filename
+
+  # The commit_message method retrieves or sets the Git commit message used
+  # when adding changelog entries.
+  #
+  # This method serves as an accessor for the commit_message attribute within
+  # the ChangelogConfig class. When called without arguments, it returns the
+  # configured commit message, which defaults to 'Add to changes'. When called
+  # with an argument, it sets the commit message to be used for Git operations
+  # related to changelog management.
+  #
+  # @return [ String ] the default commit message 'Add to changes' when no custom message is set
+  dsl_accessor :commit_message, 'Add to changes'
+end

data/lib/gem_hadar/changelog_generator.rb

@@ -146,10 +146,15 @@ class GemHadar
     # changelog file, retrieves all subsequent version tags from the Git
     # repository, and generates changelog entries for each consecutive pair of
     # versions. It then inserts these entries into the file after the existing
-    # content, maintaining the chronological order of changes.
+    # content, maintaining the
+    # chronological order of changes.
     #
-    # @param filename [ String ] the path to the changelog file to which
-    #   entries will be added
+    # @param filename [ String ] the path to the changelog file to which entries will be added
+    #
+    # @return [ Integer ] the count of changelog entries inserted into the file
+    # @return [ nil ] if no entries were added or if the file was empty
+    #
+    # @raise [ ArgumentError ] if the changelog file does not exist or if no highest version is found
     def add_to_file(filename)
       highest_version = find_highest_version(filename)
 
@@ -269,6 +274,7 @@ class GemHadar
         changelog << generate(range_from, range_to)
         +infobar
       end
+      infobar.newline
       changelog.reverse
     end
 
@@ -280,12 +286,10 @@ class GemHadar
     # the provided changelog entries immediately after the header
     # and before the next empty line.
     #
-    # @param filename [ String ] the path to the file into which changelog
-    #   entries will be injected
-    # @param changelog [ Array<String> ] an array of changelog entry strings to
-    #   be inserted into the file
+    # @param filename [ String ] the path to the file into which changelog entries will be injected
+    # @param changelog [ Array<String> ] an array of changelog entry strings to be inserted into the file
     #
-    # @see GemHadar::ChangelogGenerator#add_to_file
+    # @return [ Integer ] the count of changelog entries inserted into the file
     def inject_into_filename(filename, changelog)
       File.open(filename) do |input|
         File.secure_write(filename) do |output|
@@ -308,6 +312,7 @@ class GemHadar
           end
         end
       end
+      changelog.size
     end
 
     # The find_highest_version method extracts version specifications from

data/lib/gem_hadar/editor.rb

@@ -0,0 +1,85 @@
+# A module that provides editor integration functionality for GemHadar.
+#
+# This module contains methods for determining the appropriate editor to use
+# for interactive tasks, opening temporary files in editors for user modification,
+# and editing specified files in an editor. It serves as a utility for
+# automating text editing operations within the GemHadar framework.
+#
+# @example Finding and using an editor
+#   editor = GemHadar::Editor.find_editor
+#
+# @example Editing a temporary file returning the changed content
+#   content = "Initial content"
+#   edited_content = GemHadar::Editor.edit_temp_file(content)
+#
+# @example Editing a specific file
+#   GemHadar::Editor.edit_file('CHANGELOG.md')
+module GemHadar::Editor
+  # The find_editor method determines the appropriate editor to use for
+  # interactive tasks.
+  #
+  # This method first checks the EDITOR environment variable for a custom
+  # editor specification. If the environment variable is not set, it falls back
+  # to using the vi editor by default. It then verifies that the identified
+  # editor exists in the file system before returning it.
+  #
+  # @return [ String, nil ] the path to the editor command if found, or nil if
+  #   the editor cannot be located
+  # @return [ nil ] if the editor cannot be found in the file system
+  def find_editor
+    editor = ENV.fetch('EDITOR', `which vi`.chomp)
+    unless File.exist?(editor)
+      warn "Can't find EDITOR. => Returning."
+      return
+    end
+    editor
+  end
+
+  # The edit_temp_file method opens a temporary file in an editor for user
+  # modification.
+  #
+  # This method creates a temporary markdown file with the provided content,
+  # opens it in the configured editor, waits for the user to finish editing,
+  # and then reads the modified content back from the file.
+  #
+  # @param content [ String ] the initial content to write to the temporary file
+  #
+  # @return [ String ] the content of the file after editing, or nil if the editor
+  #   could not be invoked or the file could not be read
+  # @return [ nil ] if the editor could not be found or the operation was aborted
+  def edit_temp_file(content)
+    temp_file = Tempfile.new(%w[ changelog .md ])
+    temp_file.write(content)
+    temp_file.close
+
+    edit_file(temp_file.path) or return
+
+    File.read(temp_file.path)
+  ensure
+    temp_file&.close&.unlink
+  end
+
+  # The edit_file method opens a specified file in an editor for user
+  # modification.
+  #
+  # This method retrieves the configured editor using find_editor, then invokes
+  # the editor command with the provided filename as an argument. It waits for
+  # the editor process to complete and returns true if successful, or false if
+  # the editor command fails.
+  #
+  # @param filename [ String ] the path to the file to be opened in the editor
+  #
+  # @return [ true ] if the editor command executes successfully
+  # @return [ false ] if the editor command fails or returns a non-zero exit status
+  # @return [ nil ] if the editor cannot be found or the operation is aborted
+  def edit_file(filename)
+    editor = find_editor or return
+
+    unless system("#{editor} #{filename}")
+      warn "#{editor} returned #{$?.exitstatus} => Returning."
+      return false
+    end
+
+    true
+  end
+end

data/lib/gem_hadar/template_compiler.rb

@@ -9,11 +9,23 @@ require 'erb'
 # context, and writing the resulting content to specified destination files.
 #
 # @example Compiling a template file
-#   compiler = GemHadar::TemplateCompiler.new do |t|
-#     t.name = 'my_template'
-#     t.version = '1.0.0'
+#   # Set up template compiler
+#   compiler = GemHadar::TemplateCompiler.new do
+#     name    'my_template'
+#     version '1.0.0'
 #   end
+#   # Template (template.erb): Contains ERB placeholders for name and version.
+#   #   Name: <%= name %>
+#   #   Version: <%= version %>
+#   #   Description: This is a template for <%= name %> v<%= version %>
+#
+#   # Compile the template.
 #   compiler.compile('template.erb', 'output.txt')
+#
+#   # Result (output.txt): The rendered output with interpolated values.
+#   #   Name: my_template
+#   #   Version: 1.0.0
+#   #   Description: This is a template for my_template v1.0.0
 class GemHadar::TemplateCompiler
   include Tins::BlockSelf
   include Tins::MethodMissingDelegator::DelegatorModule

data/lib/gem_hadar/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '2.13.1'
+  VERSION         = '2.14.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

@@ -64,6 +64,8 @@ require 'gem_hadar/version_spec'
 require 'gem_hadar/prompt_template'
 require 'gem_hadar/changelog_generator'
 require 'gem_hadar/rvm_config'
+require 'gem_hadar/changelog_config'
+require 'gem_hadar/editor'
 
 class GemHadar
   include Term::ANSIColor
@@ -71,6 +73,7 @@ class GemHadar
   include GemHadar::PromptTemplate
   include GemHadar::Warn
   include GemHadar::OllamaSupport
+  include GemHadar::Editor
 
   if defined?(::RbConfig)
     include ::RbConfig
@@ -598,16 +601,27 @@ class GemHadar
     @rvm
   end
 
-  # The changelog_filename attribute accessor for configuring the gem's
-  # changelog file name.
+  # The changelog method configures or retrieves the changelog settings for the
+  # gem project.
   #
-  # 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.
+  # This method serves as an accessor for the changelog configuration, allowing
+  # the gem project to define settings related to changelog generation and
+  # management. When a block is provided, it initializes a new ChangelogConfig
+  # instance with the block's configuration. If no block is provided and no
+  # existing changelog configuration exists, it creates a new default
+  # ChangelogConfig instance.
   #
-  # @return [ String, nil ] the name of the changelog file or nil if disabled.
-  dsl_accessor :changelog_filename
+  # @param block [ Proc ] optional block to configure the changelog settings
+  #
+  # @return [ GemHadar::ChangelogConfig ] the changelog configuration instance
+  def changelog(&block)
+    if block
+      @changelog = ChangelogConfig.new(&block)
+    elsif !@changelog
+      @changelog = ChangelogConfig.new {}
+    end
+    @changelog
+  end
 
   # The default_task_dependencies method manages the list of dependencies for
   # the default Rake task.
@@ -1726,18 +1740,47 @@ class GemHadar
 
       desc 'Append new entries to existing changelog file'
       task :add do
-        filename = ARGV[1] || changelog_filename
-        filename or raise 'Need file to add to'
-        GemHadar::ChangelogGenerator.new(self).add_to_file(filename)
+        filename = ARGV[1] || changelog.filename
+        filename or next
+        if count = GemHadar::ChangelogGenerator.new(self).add_to_file(filename)
+          edit_file filename
+          puts "#{count} changes were added to #{filename.inspect}."
+        else
+          puts "No new changes added to #{filename.inspect}."
+        end
+      end
+
+      desc 'Edit the existing changelog file'
+      task :edit do
+        filename = ARGV[1] || changelog.filename
+        filename or raise 'Need changelog file to edit'
+        edit_file filename
       end
 
       desc 'Check if current version was added to the changelog'
       task :added do
-        changelog_filename or next
+        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."
+          "documented in changelog #{changelog.filename.inspect} file."
+      end
+
+      desc 'Commit changes in changelog filename'
+      task :commit do
+        changelog.filename or next
+        `git status --porcelain #{changelog.filename.inspect}`.empty? and next
+        system "git add #{changelog.filename.inspect}"
+        msg = changelog.commit_message || "n/a"
+        system "git commit -m #{msg.inspect} #{changelog.filename.inspect}"
+        if $?.success?
+          puts "Successfully commited changes in changelog filename."
+        else
+          warn "Committing changes in changelog filename has failed!"
+        end
       end
+
+      desc 'Update changelog file if necessary'
+      task :update => %i[ add commit ]
     end
 
     # Main changes task that shows help when called directly
@@ -1749,17 +1792,20 @@ class GemHadar
             rake changes:current       Show changes between two latest version tags
             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:add [file]    Append new entries to changelog file
             rake changes:added         Check if current version was added to changelog
+            rake changes:edit [file]   Edit changelog file
+            rake changes:commit        Commit changes in changelog if any
+            rake changes:update        Add and commit changes to changelog
 
           Examples:
-            rake changes:pending
-            rake changes:current
             rake changes:range v1.0.0..v1.2.0
-            rake changes:full
+            rake changes:full # or
             rake changes:full CHANGES.md
+            rake changes:add # or
             rake changes:add CHANGES.md
-            rake changes:added
+            rake changes:edit # or
+            rake changes:edit CHANGES.md
       EOT
     end
   end
@@ -1804,42 +1850,6 @@ class GemHadar
     self
   end
 
-  # The edit_temp_file method creates a temporary file with the provided
-  # content, opens it in an editor for user modification, and returns the
-  # updated content.
-  #
-  # This method first determines the editor to use from the EDITOR environment
-  # variable or defaults to vi. If the editor cannot be found, it issues a
-  # warning and returns nil. It then creates a temporary file, writes the
-  # initial content to it, and opens the file in the editor. After the user
-  # saves and closes the editor, it reads the modified content from the
-  # temporary file. The temporary file is automatically cleaned up after use.
-  #
-  # @param content [ String ] the initial content to write to the temporary
-  # file
-  #
-  # @return [ String, nil ] the content of the temporary file after editing, or
-  # nil if the editor could not be found or failed
-  def edit_temp_file(content)
-    editor = ENV.fetch('EDITOR', `which vi`.chomp)
-    unless File.exist?(editor)
-      warn "Can't find EDITOR. => Returning."
-      return
-    end
-    temp_file = Tempfile.new(%w[ changelog .md ])
-    temp_file.write(content)
-    temp_file.close
-
-    unless system("#{editor} #{temp_file.path}")
-      warn "#{editor} returned #{$?.exitstatus} => Returning."
-      return
-    end
-
-    File.read(temp_file.path)
-  ensure
-    temp_file&.close&.unlink
-  end
-
   # The ollama_model_default method returns the default name of the Ollama AI
   # model to be used for generating responses when no custom model is
   # specified.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gem_hadar
 version: !ruby/object:Gem::Version
-  version: 2.13.1
+  version: 2.14.0
 platform: ruby
 authors:
 - Florian Frank
@@ -256,7 +256,9 @@ extensions: []
 extra_rdoc_files:
 - README.md
 - lib/gem_hadar.rb
+- lib/gem_hadar/changelog_config.rb
 - lib/gem_hadar/changelog_generator.rb
+- lib/gem_hadar/editor.rb
 - lib/gem_hadar/github.rb
 - lib/gem_hadar/ollama_support.rb
 - lib/gem_hadar/prompt_template.rb
@@ -278,7 +280,9 @@ files:
 - bin/gem_hadar
 - gem_hadar.gemspec
 - lib/gem_hadar.rb
+- lib/gem_hadar/changelog_config.rb
 - lib/gem_hadar/changelog_generator.rb
+- lib/gem_hadar/editor.rb
 - lib/gem_hadar/github.rb
 - lib/gem_hadar/github_workflows/static.yml.erb
 - lib/gem_hadar/ollama_support.rb