gem_hadar 2.11.0 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d873e582074092072360c3800181732ab53d2e27a5e7663262c36b60bd3f96a6
-  data.tar.gz: 6074b1585ff125a9ee21f18e0231ea34840a24ec1246cfce41ff1ca58ad60603
+  metadata.gz: 0b073276ec181a5e9a9b2683fe8da14ac53c41f9234c643920883e575d7bc843
+  data.tar.gz: 805eb33b1fcbd4adc8b2c14dfc56a8d2c38564331d7534ebf5220355f8388920
 SHA512:
-  metadata.gz: 57c0aeac59a2447bfd6073cbf4ea7f4411e3930249e863d0f6a9dffa171933a40d94646e1eb4a5a03dc5fd1519178bb613fa0a1c9b02b684e918af36e42fc0d7
-  data.tar.gz: 648d51b596c0f5b50a58d4c0e9189775356ad7de3657fe959bfe31af67b17f9634c4d89c2ee2672f2d4dc92e4f7d4be5297cec607cbb51ce22af73280d15d898
+  metadata.gz: 2ca31b3c96e97f75ac16187337814ac43cc876c873342a0fb78daf4eaaecdfb3c1e56fd0ea3dc55ba657798e1b88e58a2084555b5e962891713b32397d9e4c9b
+  data.tar.gz: 97013a6905db1762f5f0c19fdfa329e1db0311f0d5044f6a0810a5ac89cf5e6133667c84af098c2c3dc9917eeb8876d55d4b5500f03d8d0f53c4cc5b8902fd79

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.11.0 ruby lib
+# stub: gem_hadar 2.13.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.11.0".freeze
+  s.version = "2.13.0".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.10".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

@@ -47,18 +47,18 @@ class GemHadar
     # @return [ String ] a minimal changelog entry with just date and version
     #   when no changes are found
     def generate(from, to = 'HEAD')
-      from_spec = GemHadar::VersionSpec[from]
-      to_spec   = GemHadar::VersionSpec[to]
+      from = GemHadar::VersionSpec[from]
+      to   = GemHadar::VersionSpec[to]
 
-      range = "#{from_spec.tag}..#{to_spec.tag}"
+      range = "#{from.tag}..#{to.tag}"
 
       log = `git log #{range}`
       $?.success? or raise "Failed to get git log for range #{range}"
 
-      date = `git log -n1 --pretty='format:%cd' --date=short #{to_spec.tag.inspect}`.chomp
+      date = `git log -n1 --pretty='format:%cd' --date=short #{to.tag.inspect}`.chomp
 
       if log.strip.empty?
-        return "\n## #{date} #{to_spec.without_prefix.to_s}\n"
+        return "\n## #{date} #{to.without_prefix.to_s}\n"
       end
 
       system          = xdg_config('gem_hadar', 'changelog_system_prompt.txt', default_changelog_system_prompt)
@@ -69,7 +69,7 @@ class GemHadar
 
       changes = response.gsub(/\t/, '  ')
 
-      return "\n## #{date} #{to_spec.tag}\n\n#{changes}\n"
+      return "\n## #{date} #{to.tag}\n\n#{changes}\n"
     end
 
     # The generate_range method creates a changelog for a specific version
@@ -87,8 +87,8 @@ class GemHadar
     # @param to [ String ] the ending version or commit reference for the
     #   range, defaults to 'HEAD'
     def generate_range(output, from, to)
-      from_spec = GemHadar::VersionSpec[from]
-      to_spec   = GemHadar::VersionSpec[to]
+      from = GemHadar::VersionSpec[from]
+      to   = GemHadar::VersionSpec[to]
 
       versions = read_versions
 
@@ -97,7 +97,7 @@ class GemHadar
       end
 
       versions = versions.select do |v|
-        v.version >= from_spec.version && v.version <= to_spec.version
+        v >= from && v <= to
       end
 
       changelog = generate_changelog(versions)
@@ -134,7 +134,7 @@ class GemHadar
 
       changelog = generate_changelog(versions, changelog:)
 
-      changelog << "# Changes\n"
+      changelog.unshift "# Changes\n"
 
       output << changelog.join("")
     end
@@ -151,11 +151,11 @@ class GemHadar
     # @param filename [ String ] the path to the changelog file to which
     #   entries will be added
     def add_to_file(filename)
-      highest_version = find_highest_version_spec(filename)
+      highest_version = find_highest_version(filename)
 
       if highest_version
         versions = read_versions
-        versions = versions.drop_while { |t| t.version < highest_version.version }
+        versions = versions.drop_while { |t| t < highest_version }
       else
         raise ArgumentError, "Could not find highest version in #{filename.inspect}"
       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.
     #
@@ -264,7 +310,7 @@ class GemHadar
       end
     end
 
-    # The find_highest_version_spec method extracts version specifications from
+    # The find_highest_version method extracts version specifications from
     # a changelog file and returns the highest version found
     #
     # This method reads through the specified file line by line, scanning for
@@ -277,7 +323,7 @@ class GemHadar
     #
     # @return [ GemHadar::VersionSpec, nil ] the highest version specification
     #   found in the file, or nil if no versions are found
-    def find_highest_version_spec(filename)
+    def find_highest_version(filename)
       File.open(filename, ?r) do |input|
         specs = []
         input.each do |line|

data/lib/gem_hadar/version.rb

@@ -1,6 +1,6 @@
 class GemHadar
   # GemHadar version
-  VERSION         = '2.11.0'
+  VERSION         = '2.13.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/version_spec.rb

@@ -7,15 +7,15 @@
 # representation.
 #
 # @example Creating a version specification
-#   version_spec = GemHadar::VersionSpec['1.2.3']
+#   version = GemHadar::VersionSpec['1.2.3']
 #
 # @example Checking if a version is a HEAD reference
-#   version_spec = GemHadar::VersionSpec['HEAD']
-#   version_spec.head? # => true
+#   version = GemHadar::VersionSpec['HEAD']
+#   version.head? # => true
 #
 # @example Getting the version tag with appropriate prefixing
-#   version_spec = GemHadar::VersionSpec['1.2.3']
-#   version_spec.tag # => 'v1.2.3'
+#   version = GemHadar::VersionSpec['1.2.3']
+#   version.tag # => 'v1.2.3'
 #
 # @example Comparing versions
 #   version1 = GemHadar::VersionSpec['1.2.3']
@@ -141,4 +141,55 @@ class GemHadar::VersionSpec
   def with_prefix
     to_s.sub(/\A(?!v)/, 'v')
   end
+
+  # The <=> method compares this version specification with another object.
+  #
+  # This method implements the comparison operator for VersionSpec objects,
+  # allowing them to be sorted and compared using standard Ruby comparison
+  # operators.
+  #
+  # @param other [ Object ] the object to compare against
+  #
+  # @return [ Integer ] -1 if this version is less than the other, 0 if they
+  #   are equal, 1 if this version is greater than the other
+  #
+  # @raise [ TypeError ] if the other object is not a VersionSpec instance
+  # @raise [ TypeError ] if the other object has no valid version to compare against
+  def <=>(other)
+    other.is_a?(self.class) or raise TypeError, "other needs to be a #{self.class}"
+    other.version or raise TypeError, "cannot compare to #{other.inspect}"
+    version <=> other.version
+  end
+  include Comparable
+
+  # The eql? method checks for equality between this version specification and
+  # another object.
+  #
+  # This method determines if the current VersionSpec instance is equal to another
+  # object by first checking if the other object is of the same class. If so, it
+  # compares either both objects represent HEAD references or their underlying
+  # version objects for equality.
+  #
+  # @param other [ Object ] the object to compare against
+  #
+  # @return [ TrueClass, FalseClass ] true if the objects are equal, false otherwise
+  def eql?(other)
+    other.is_a?(self.class) && (head? && other.head? || version == other.version)
+  end
+
+  # The hash method computes a hash value for the version specification.
+  #
+  # This method returns a hash code that represents the version specification.
+  # If the version specification has a valid version object, it returns the
+  # hash of that version object. Otherwise, it returns the hash of the string
+  # representation of the version specification.
+  #
+  # @return [ Integer ] the hash value of the version specification
+  def hash
+    if version?
+      version.hash
+    else
+      to_s.hash
+    end
+  end
 end

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.
   #
@@ -838,7 +849,9 @@ class GemHadar
   #
   # @return [ String ] the git log output in patch format showing changes between the two versions
   def version_log_diff(to_version: 'HEAD', from_version: nil)
-    if to_version == 'HEAD'
+    to_version   = GemHadar::VersionSpec[to_version]
+    from_version = from_version.full? { GemHadar::VersionSpec[from_version] }
+    if to_version.head?
       if from_version.blank?
         from_version = versions.last
       else
@@ -846,7 +859,7 @@ class GemHadar
           fail "Could not find #{from_version.inspect}."
         end
       end
-      `git log -p #{version_tag(from_version)}..HEAD`
+      `git log -p #{from_version.tag}..HEAD`
     else
       unless versions.find { |v| v == to_version }
         fail "Could not find #{to_version.inspect}."
@@ -858,14 +871,14 @@ class GemHadar
           end
         end
         unless from_version
-          return `git log -p #{version_tag(to_version)}`
+          return `git log -p #{to_version.tag}`
         end
       else
         unless versions.find { |v| v == from_version }
           fail "Could not find #{from_version.inspect}."
         end
       end
-      `git log -p #{version_tag(from_version)}..#{version_tag(to_version)}`
+      `git log -p #{from_version.tag}..#{to_version.tag}`
     end
   end
 
@@ -911,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"
@@ -1097,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.
   #
@@ -1108,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} #{version_tag(version)}"
-        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
@@ -1256,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
@@ -1324,7 +1371,7 @@ class GemHadar
         end
         if %r(\A/*(?<owner>[^/]+)/(?<repo>[^/.]+)) =~ github_remote_url&.path
           rc = GitHub::ReleaseCreator.new(owner:, repo:, token: github_api_token)
-          tag_name         = version_tag(version)
+          tag_name         = GemHadar::VersionSpec[version].tag
           target_commitish = `git show -s --format=%H #{tag_name.inspect}^{commit}`.chomp
           body             = edit_temp_file(create_git_release_body)
           if body.present?
@@ -1344,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,
@@ -1371,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
@@ -1391,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.
@@ -1604,6 +1662,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'
@@ -1668,9 +1727,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
@@ -1683,6 +1751,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
@@ -1691,6 +1760,7 @@ class GemHadar
             rake changes:full
             rake changes:full CHANGES.md
             rake changes:add CHANGES.md
+            rake changes:added
       EOT
     end
   end
@@ -1799,9 +1869,9 @@ class GemHadar
   #   - 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)}"
+    version_tags      = versions.map { GemHadar::VersionSpec[_1].tag } + %w[ HEAD ]
+    found_version_tag = version_tags.index(GemHadar::VersionSpec[version].tag)
+    found_version_tag.nil? and fail "cannot find version tag #{GemHadar::VersionSpec[version].tag}"
     start_version, end_version = version_tags[found_version_tag, 2]
     return start_version, end_version
   end
@@ -1886,7 +1956,7 @@ class GemHadar
   def gemspec
     Gem::Specification.new do |s|
       s.name        = name
-      s.version     = ::Gem::Version.new(version_untag(version))
+      s.version     = ::Gem::Version.new(GemHadar::VersionSpec[version].untag)
       s.author      = author
       s.email       = email
       s.homepage    = assert_valid_link(:homepage, homepage)
@@ -1975,24 +2045,6 @@ class GemHadar
     }.sort_by(&:version)
   end
 
-  # The version_tag method prepends a 'v' prefix to the given version
-  # 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)
-    GemHadar::VersionSpec[version].tag
-  end
-
-  # The version_untag method removes the 'v' prefix from a version tag string.
-  #
-  # @param version_tag [ String ] the version tag string that may start with 'v'
-  #
-  # @return [ String ] the version string with the 'v' prefix removed
-  def version_untag(version_tag)
-    GemHadar::VersionSpec[version].untag
-  end
-
   # The github_remote_url method retrieves and parses the GitHub remote URL
   # from the local Git configuration.
   #

metadata

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