gem_hadar 2.11.0 → 2.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d873e582074092072360c3800181732ab53d2e27a5e7663262c36b60bd3f96a6
-  data.tar.gz: 6074b1585ff125a9ee21f18e0231ea34840a24ec1246cfce41ff1ca58ad60603
+  metadata.gz: 695a7ff7bd975c62a492a7201233a82758d5f1ba55c2da575f4efc90d477b3d6
+  data.tar.gz: 24338fcf746d7af9bbe140283ef9d90257f04fb10c3e36f8bb2bcf4a6beee140
 SHA512:
-  metadata.gz: 57c0aeac59a2447bfd6073cbf4ea7f4411e3930249e863d0f6a9dffa171933a40d94646e1eb4a5a03dc5fd1519178bb613fa0a1c9b02b684e918af36e42fc0d7
-  data.tar.gz: 648d51b596c0f5b50a58d4c0e9189775356ad7de3657fe959bfe31af67b17f9634c4d89c2ee2672f2d4dc92e4f7d4be5297cec607cbb51ce22af73280d15d898
+  metadata.gz: d50e942241bb49b5aacacaf84760bd8123e3bef6b4c8addb7e988d16c71434d8506ac28ba382a99193483bd2a37c53ef56f4d091a9c1c655715276a038f1b8a8
+  data.tar.gz: a25eda3b38ebc77b8b5eb2fa15532b7e5f6f83da7f257accd2ec4e2e12eee835f9b087523b6b8c6a7e142946cf81f7da0320dc9e6a9badf90bf76486bf7f3452

data/gem_hadar.gemspec

@@ -1,9 +1,9 @@
 # -*- encoding: utf-8 -*-
-# stub: gem_hadar 2.11.0 ruby lib
+# stub: gem_hadar 2.12.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "gem_hadar".freeze
-  s.version = "2.11.0".freeze
+  s.version = "2.12.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.12".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)
@@ -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
@@ -264,7 +264,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 +277,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.12.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.rb

@@ -838,7 +838,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 +848,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 +860,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
 
@@ -1112,7 +1114,7 @@ class GemHadar
       task :tag do
         force = ENV['FORCE'].to_i == 1
         begin
-          sh "git tag -a -m 'Version #{version}' #{'-f' if force} #{version_tag(version)}"
+          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"
@@ -1324,7 +1326,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?
@@ -1799,9 +1801,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 +1888,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 +1977,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.12.0
 platform: ruby
 authors:
 - Florian Frank
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.12'
 - !ruby/object:Gem::Dependency
   name: all_images
   requirement: !ruby/object:Gem::Requirement