sem_ver_components 0.4.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9e216df289d82a84408ea7065a7e87f953522902ea23daffd47ebe78c5e34f1
-  data.tar.gz: a66c7806d23ae04380f5c973d3ae2532d93236b456b22fd290a4db37b184c98e
+  metadata.gz: 478f0c6d8c4367e4892b9fb22a2ac76fd3673abd9dfa8d9f9931a091943646ea
+  data.tar.gz: 5a671cb67c267a9e72b5fe618fe32253ba2ee0ac2878e23e49d307395df2b06c
 SHA512:
-  metadata.gz: 1308ca4ce4f106e8eab7485bfeedd1e2b35122e218eb53fcb44580f3ae3593360524da32971124c4ca9d1ee8d1ebb6922cde0326a79562b1a068ce4fae93d469
-  data.tar.gz: 2dfc7f87397008be4c2219e1298dd8fd7f4375fc51b446f30226ee171a4ebfb533c8dfa831fe70618c3e09190929d38a53fc57b92a1f1105f5e8ffef4e2b18e0
+  metadata.gz: 50942553eb735fa7d94647a223e13b441db129dd5ddfa565a00a065519d3a6533d5247927328f7171c9ffea3b1cac474b277995a95e43416db1a04b7f23ad149
+  data.tar.gz: e5147c73184abbbe1c6435005a4cdc39198540420952bd39e96f31d1a2bd1f3149845ed502f001b6882b44174194bdf54007a5c0b5e80b871a171f7716fd1ac1

data/bin/sem_ver_git

@@ -1,10 +1,6 @@
 #!/usr/bin/env ruby
 require 'optparse'
-require 'sem_ver_components/plugins'
-require 'sem_ver_components/local_git'
-require 'sem_ver_components/version'
-require 'sem_ver_components/output'
-require 'sem_ver_components/git_hosting'
+require 'sem_ver_components'
 
 # Default values
 git_repo = '.'
@@ -15,18 +11,27 @@ output = :info
 output_plugins = SemVerComponents::Plugins.new(:outputs)
 git_hosting_plugins = SemVerComponents::Plugins.new(:git_hostings)
 OptionParser.new do |opts|
-  opts.banner = "Usage: #{File.basename($0)} [options]"
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
   opts.on('-f', '--from GIT_REF', 'Git reference from which commits are to be analyzed (defaults to first commit)') do |git_ref|
     git_from = git_ref.empty? ? nil : git_ref
   end
-  opts.on('-g', '--git_hosting GIT_HOSTING', "Specify which kind of git hosting is used. Used to format URLs to commits and comparisons. Possible values are #{git_hosting_plugins.list.sort.join(', ')}. (defaults to #{git_hosting})") do |git_hosting_str|
+  opts.on(
+    '-g',
+    '--git_hosting GIT_HOSTING',
+    'Specify which kind of git hosting is used. Used to format URLs to commits and comparisons. ' \
+      "Possible values are #{git_hosting_plugins.list.sort.join(', ')}. (defaults to #{git_hosting})"
+  ) do |git_hosting_str|
     git_hosting = git_hosting_str.to_sym
   end
   opts.on('-h', '--help', 'Display this help') do
     puts opts
     exit 0
   end
-  opts.on('-o', '--output OUTPUT', "Specify the output format of the analysis. Possible values are #{output_plugins.list.sort.join(', ')} (defauts to #{output})") do |output_str|
+  opts.on(
+    '-o',
+    '--output OUTPUT',
+    "Specify the output format of the analysis. Possible values are #{output_plugins.list.sort.join(', ')} (defauts to #{output})"
+  ) do |output_str|
     output = output_str.to_sym
   end
   opts.on('-r', '--repo GIT_URL', "Specify the Git URL of the repository to analyze (defaults to #{git_repo})") do |git_url|
@@ -36,7 +41,7 @@ OptionParser.new do |opts|
     git_to = git_ref
   end
   opts.on('-v', '--version', 'Display version') do
-    puts "#{File.basename($0)} v#{SemVerComponents::VERSION}"
+    puts "#{File.basename($PROGRAM_NAME)} v#{SemVerComponents::VERSION}"
     exit 0
   end
 end.parse!

data/lib/sem_ver_components/git_hosting.rb

@@ -1,8 +1,7 @@
+# Tools helping in maintaining semantic versioning at a components level instead of a global package-only level
 module SemVerComponents
-
   # Base class for all git hosting plugins
   class GitHosting
-
+    # Marker class for all plugins of type GitHosting
   end
-
 end

data/lib/sem_ver_components/git_hostings/bitbucket.rb

@@ -1,49 +1,43 @@
 module SemVerComponents
-
+  # Namespace for all git hosting plugins
   module GitHostings
-
+    # Plugin providing URLs to a Bitbucket hosting
     class Bitbucket < GitHosting
-
       # Get the URL to a given commit sha
       #
-      # Parameters::
-      # * *git_url* (String): The git URL
-      # * *commit_sha* (String): The commit sha
+      # @param git_url [String] The git URL
+      # @param commit_sha [String] The commit sha
+      # @return [String] The URL to the commit
       def commit_url(git_url, commit_sha)
         "#{public_url(git_url)}/commits/#{commit_sha}"
       end
 
       # Get the URL to compare 2 tags
       #
-      # Parameters::
-      # * *git_url* (String): The git URL
-      # * *tag_1* (String): The first tag
-      # * *tag_2* (String): The second tag
-      def compare_url(git_url, tag_1, tag_2)
-        "#{public_url(git_url)}/compare/commits?targetBranch=refs%2Ftags%2F#{tag_1}&sourceBranch=refs%2Ftags%2F#{tag_2}"
+      # @param git_url [String] The git URL
+      # @param tag1 [String] The first tag
+      # @param tag2 [String] The second tag
+      # @return [String] The URL to compare the 2 tags
+      def compare_url(git_url, tag1, tag2)
+        "#{public_url(git_url)}/compare/commits?targetBranch=refs%2Ftags%2F#{tag1}&sourceBranch=refs%2Ftags%2F#{tag2}"
       end
 
       private
 
       # Convert the git remote URL to the public URL
       #
-      # Parameters::
-      # * *git_url* (String): Git remote URL
-      # Result::
-      # * String: The corresponding public URL
+      # @param git_url [String] Git remote URL
+      # @return [String] The corresponding public URL
       def public_url(git_url)
-        if git_url =~ /^(.+)\/scm\/([^\/]+)\/(.+)$/
-          base_url = $1
-          project = $2
-          repo = $3
+        if git_url =~ %r{^(.+)/scm/([^/]+)/(.+)$}
+          base_url = ::Regexp.last_match(1)
+          project = ::Regexp.last_match(2)
+          repo = ::Regexp.last_match(3)
           "#{base_url}/projects/#{project}/repos/#{repo}"
         else
           git_url
         end
       end
-
     end
-
   end
-
 end

data/lib/sem_ver_components/git_hostings/github.rb

@@ -1,30 +1,25 @@
 module SemVerComponents
-
   module GitHostings
-
+    # Plugin providing URLs to a GitHub hosting
     class Github < GitHosting
-
       # Get the URL to a given commit sha
       #
-      # Parameters::
-      # * *git_url* (String): The git URL
-      # * *commit_sha* (String): The commit sha
+      # @param git_url [String] The git URL
+      # @param commit_sha [String] The commit sha
+      # @return [String] The URL to the commit
       def commit_url(git_url, commit_sha)
         "#{git_url}/commit/#{commit_sha}"
       end
 
       # Get the URL to compare 2 tags
       #
-      # Parameters::
-      # * *git_url* (String): The git URL
-      # * *tag_1* (String): The first tag
-      # * *tag_2* (String): The second tag
-      def compare_url(git_url, tag_1, tag_2)
-        "#{git_url}/compare/#{tag_1}...#{tag_2}"
+      # @param git_url [String] The git URL
+      # @param tag1 [String] The first tag
+      # @param tag2 [String] The second tag
+      # @return [String] The URL to compare the 2 tags
+      def compare_url(git_url, tag1, tag2)
+        "#{git_url}/compare/#{tag1}...#{tag2}"
       end
-
     end
-
   end
-
 end

data/lib/sem_ver_components/local_git.rb

@@ -1,17 +1,15 @@
 require 'git'
 
 module SemVerComponents
-
+  # Analyzer of a local git repository
   class LocalGit
-
-    attr_reader *%i[git_from git_to git]
+    attr_reader :git_from, :git_to, :git
 
     # Constructor
     #
-    # Parameters::
-    # * *git_repo* (String): The git repository to analyze
-    # * *git_from* (String or nil): The git from ref
-    # * *git_to* (String): The git to ref
+    # @param git_repo [String] The git repository to analyze
+    # @param git_from [String, nil] The git from ref
+    # @param git_to [String] The git to ref
     def initialize(git_repo, git_from, git_to)
       @git_repo = git_repo
       @git_from = git_from
@@ -22,26 +20,31 @@ module SemVerComponents
     # Get full the git log.
     # Keep a cache of it.
     #
-    # Result::
-    # * Array< Git::Object::Commit >: Full git log
+    # @return [Git::Log::Result] Full git log (Enumerable of Git::Object::Commit)
     def git_log
-      @git_log = @git.log(nil) unless defined?(@git_log)
+      @git_log = @git.log(nil).execute unless defined?(@git_log)
       @git_log
     end
 
     # Semantically analyze commits.
     #
-    # Result::
-    # * Array< Hash<Symbol, Object> >: The commits information:
-    #   * *components_bump_levels* (Hash<String or nil, Integer>): Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
-    #   * *commit* (Git::Object::Commit): Corresponding git commit
+    # @return [Array<Hash{Symbol => Object}>] The commits information:
+    #   - +:components_bump_levels+ [Hash\\{String or nil => Integer}] Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
+    #   - +:commit+ (Git::Object::Commit): Corresponding git commit
     def analyze_commits
-      git_log.between(git_from.nil? ? git_log.last.sha : git_from, git_to).map do |git_commit|
+      @git.log(nil).between(git_from.nil? ? git_log.last.sha : git_from, git_to).execute.map do |git_commit|
         # Analyze the message
         # Always consider a minimum of global patch bump per commit.
         components_bump_levels = { nil => [0] }
-        git_commit.message.scan(/\[([^\]]+)\]/).flatten(1).each do |commit_label|
-          commit_type, component = commit_label =~ /^(.+)\((.+)\)$/ ? [$1, $2] : [commit_label, nil]
+        # Extract tags enclosed in square brackets, like in '[feat] Some change' or '[feat(customers)] Some change'
+        commit_labels = git_commit.message.scan(/\[([^\]]+)\]/).flatten(1).map do |commit_label|
+          commit_label =~ /^(.+)\((.+)\)$/ ? [::Regexp.last_match(1), ::Regexp.last_match(2)] : [commit_label, nil]
+        end
+        # Extract also tags of the form 'type: Some change' or 'type(component): Some change' at the beginning of the message,
+        # like in 'feat: Some change' or 'feat(customers): Some change'
+        conventional_commit_tag = git_commit.message.match(/\A(feat|feature|break|breaking|major|minor|fix|patch|chore)(?:\(([^)]+)\))?:\s+/i)
+        commit_labels << [conventional_commit_tag[1], conventional_commit_tag[2]] unless conventional_commit_tag.nil?
+        commit_labels.each do |commit_type, component|
           components_bump_levels[component] = [] unless components_bump_levels.key?(component)
           components_bump_levels[component] <<
             case commit_type.downcase
@@ -55,19 +58,16 @@ module SemVerComponents
         end
         {
           commit: git_commit,
-          components_bump_levels: Hash[components_bump_levels.map { |component, component_bump_levels| [component, component_bump_levels.max] }]
+          components_bump_levels: components_bump_levels.to_h { |component, component_bump_levels| [component, component_bump_levels.max] }
         }
       end
     end
 
     # Is the git to ref part of a release branch?
     #
-    # Result::
-    # * Boolean: Is the git to ref part of a release branch?
+    # @return [Boolean] Is the git to ref part of a release branch?
     def on_release_branch?
-      @git_to == 'master'
+      %w[master main].include?(@git_to)
     end
-
   end
-
 end

data/lib/sem_ver_components/output.rb

@@ -1,18 +1,13 @@
 module SemVerComponents
-
   # Base class for all output plugins
   class Output
-
     # Constructor
     #
-    # Parameters::
-    # * *local_git* (LocalGit): The git repository
-    # * *git_hosting* (GitHosting): The git hosting to be used for URLs
+    # @param local_git [LocalGit] The git repository
+    # @param git_hosting [GitHosting] The git hosting to be used for URLs
     def initialize(local_git, git_hosting)
       @local_git = local_git
       @git_hosting = git_hosting
     end
-
   end
-
 end

data/lib/sem_ver_components/outputs/info.rb

@@ -1,22 +1,18 @@
-require 'sem_ver_components/semver'
-
 module SemVerComponents
-
+  # Namespace for all output plugins
   module Outputs
-
+    # Output plugin displaying components' bump levels and next version info
     class Info < Output
-
       # Process commits info
       #
-      # Parameters::
-      # * *commits_info* (Array< Hash<Symbol, Object> >): List of commits info:
-      #   * *components_bump_levels* (Hash<String or nil, Integer>): Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
-      #   * *commit* (Git::Object::Commit): Corresponding git commit
+      # @param commits_info [Array<Hash{Symbol => Object}>] List of commits info:
+      #   - +:components_bump_levels+ [Hash\\{String or nil => Integer}] Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
+      #   - +:commit+ [Git::Object::Commit] Corresponding git commit
       def process(commits_info)
         # Display bump levels per component
         bumps_per_component = commits_info.inject({}) do |components_bump_levels, commit_info|
-          components_bump_levels.merge(commit_info[:components_bump_levels]) do |_component, bump_level_1, bump_level_2|
-            [bump_level_1, bump_level_2].max
+          components_bump_levels.merge(commit_info[:components_bump_levels]) do |_component, bump_level1, bump_level2|
+            [bump_level1, bump_level2].max
           end
         end
         bumps_per_component.each do |component, bump_level|
@@ -38,14 +34,11 @@ module SemVerComponents
         if global_bump_level.nil?
           puts 'No next version'
         else
-          puts "Next global version#{@local_git.on_release_branch? ? '' : ' (not on release branch)'}: #{
+          puts "Next global version#{' (not on release branch)' unless @local_git.on_release_branch?}: #{
             Semver.next_version_from(Semver.version_from_git_ref(@local_git.git_from), global_bump_level, pre_release: !@local_git.on_release_branch?)
           }"
         end
       end
-
     end
-
   end
-
 end

data/lib/sem_ver_components/outputs/semantic_release_analyze.rb

@@ -1,15 +1,12 @@
 module SemVerComponents
-
   module Outputs
-
+    # Output plugin reporting the next version bump level in the semantic-release format
     class SemanticReleaseAnalyze < Output
-
       # Process commits info
       #
-      # Parameters::
-      # * *commits_info* (Array< Hash<Symbol, Object> >): List of commits info:
-      #   * *components_bump_levels* (Hash<String or nil, Integer>): Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
-      #   * *commit* (Git::Object::Commit): Corresponding git commit
+      # @param commits_info [Array<Hash{Symbol => Object}>] List of commits info:
+      #   - +:components_bump_levels+ [Hash\\{String or nil => Integer}] Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
+      #   - +:commit+ [Git::Object::Commit] Corresponding git commit
       def process(commits_info)
         bump_level = commits_info.map { |commit_info| commit_info[:components_bump_levels].values }.flatten(1).max
         puts(
@@ -28,9 +25,6 @@ module SemVerComponents
           end
         )
       end
-
     end
-
   end
-
 end

data/lib/sem_ver_components/outputs/semantic_release_generate_notes.rb

@@ -1,27 +1,24 @@
 require 'time'
-require 'sem_ver_components/semver'
 
 module SemVerComponents
-
   module Outputs
-
+    # Output plugin generating release notes in the semantic-release changelog format
     class SemanticReleaseGenerateNotes < Output
-
       # Process commits info
       #
-      # Parameters::
-      # * *commits_info* (Array< Hash<Symbol, Object> >): List of commits info:
-      #   * *components_bump_levels* (Hash<String or nil, Integer>): Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
-      #   * *commit* (Git::Object::Commit): Corresponding git commit
+      # @param commits_info [Array<Hash{Symbol => Object}>] List of commits info:
+      #   - +:components_bump_levels+ [Hash\\{String or nil => Integer}] Set of bump levels (0: patch, 1: minor, 2: major) per component name (nil for global)
+      #   - +:commit+ [Git::Object::Commit] Corresponding git commit
       def process(commits_info)
         # Compute new version
         new_version = Semver.next_version_from(
           Semver.version_from_git_ref(@local_git.git_from),
           commits_info.map { |commit_info| commit_info[:components_bump_levels].values }.flatten(1).max
         )
-        git_url = @local_git.git.remote('origin').url
+        git_url = @local_git.git.remote_list.find { |remote| remote.name == 'origin' }.url.first
         git_url = git_url[0..-5] if git_url.end_with?('.git')
-        # Reference merge commits: merged commits will not be part of the changelog, but their bump level will be taken into account when reporting the merge commit.
+        # Reference merge commits: merged commits will not be part of the changelog,
+        # but their bump level will be taken into account when reporting the merge commit.
         # List of merged commits' shas, per merge commit sha.
         # Hash< String, Array< String > >
         merge_commits = {}
@@ -29,10 +26,11 @@ module SemVerComponents
           git_commit = commit_info[:commit]
           git_commit_parents = git_commit.parents
           # In the case of a merge commit, reference all commits that are part of this merge commit, directly from the graph
-          if git_commit_parents.size > 1
-            git_commit_sha = git_commit.sha
-            merge_commits[git_commit_sha] = @local_git.git_log.between(@local_git.git.merge_base(*git_commit_parents.map(&:sha)).first.sha, git_commit_sha)[1..-1].map(&:sha)
-          end
+          next unless git_commit_parents.size > 1
+
+          git_commit_sha = git_commit.sha
+          merge_commits[git_commit_sha] =
+            @local_git.git.log(nil).between(@local_git.git.merge_base(*git_commit_parents.map(&:sha)).first, git_commit_sha).execute[1..].map(&:sha)
         end
         commits_to_ignore = merge_commits.values.flatten(1).sort.uniq
         # Group commits per bump level, per component
@@ -43,6 +41,7 @@ module SemVerComponents
           git_commit_sha = git_commit.sha
           # Don't put merged commits as we consider the changelog should contain the merge commit comment.
           next if commits_to_ignore.include?(git_commit_sha)
+
           components_bump_levels = commit_info[:components_bump_levels]
           # If we are dealing with a merge commit, consider the components' bump levels of the merged commits
           if merge_commits.key?(git_commit_sha)
@@ -51,10 +50,10 @@ module SemVerComponents
               # If the merged commit is not part of the list of commits, it means that the merge commit was not rebased on the previous release tag.
               # In this case we can have some merged commits that are already part of the previous release.
               # So we can ignore them.
-              unless merged_commit_info.nil?
-                components_bump_levels = components_bump_levels.merge(merged_commit_info[:components_bump_levels]) do |component, bump_level_1, bump_level_2|
-                  [bump_level_1, bump_level_2].max
-                end
+              next if merged_commit_info.nil?
+
+              components_bump_levels = components_bump_levels.merge(merged_commit_info[:components_bump_levels]) do |_component, bump_level1, bump_level2|
+                [bump_level1, bump_level2].max
               end
             end
           end
@@ -90,7 +89,7 @@ module SemVerComponents
               commit_line = message_lines.first
               if commit_line =~ /^Merge pull request .+$/
                 # Consider the next line as commit line
-                next_line = message_lines[1..-1].join("\n").strip.split("\n").first
+                next_line = message_lines[1..].join("\n").strip.split("\n").first
                 commit_line = next_line unless next_line.nil?
               end
               commit_lines[commit_line] = commit.sha
@@ -102,9 +101,6 @@ module SemVerComponents
           end
         end
       end
-
     end
-
   end
-
 end

data/lib/sem_ver_components/plugins.rb

@@ -1,43 +1,36 @@
 module SemVerComponents
-
+  # Loader of plugin classes available in the plugin directories
   class Plugins
-
     # Constructor
     #
-    # Parameters::
-    # * *plugins_type* (Symbol): Plugins type we are parsing
+    # @param plugins_type [Symbol] Plugins type we are parsing
     def initialize(plugins_type)
       @plugins_type = plugins_type
-      @plugins = Hash[Dir.glob("#{__dir__}/#{plugins_type}/*.rb").map do |plugin_file|
+      @plugins = Dir.glob("#{__dir__}/#{plugins_type}/*.rb").to_h do |plugin_file|
         plugin_name = File.basename(plugin_file, '.rb').to_sym
         require "#{__dir__}/#{plugins_type}/#{plugin_name}.rb"
         [
           plugin_name,
-          SemVerComponents.
-            const_get(plugins_type.to_s.split('_').collect(&:capitalize).join.to_sym).
-            const_get(plugin_name.to_s.split('_').collect(&:capitalize).join.to_sym)
+          SemVerComponents
+            .const_get(plugins_type.to_s.split('_').collect(&:capitalize).join.to_sym)
+            .const_get(plugin_name.to_s.split('_').collect(&:capitalize).join.to_sym)
         ]
-      end]
+      end
     end
 
     # List available plugin names
     #
-    # Result::
-    # * Array<Symbol>: Available plugin names
+    # @return [Array<Symbol>] Available plugin names
     def list
       @plugins.keys
     end
 
     # Get a plugin class
     #
-    # Parameters::
-    # * *plugin_name* (Symbol): The plugin name
-    # Result::
-    # * Class: The corresponding plugin class
+    # @param plugin_name [Symbol] The plugin name
+    # @return [Class] The corresponding plugin class
     def [](plugin_name)
       @plugins[plugin_name]
     end
-
   end
-
 end

data/lib/sem_ver_components/semver.rb

@@ -1,66 +1,53 @@
 module SemVerComponents
-
   # Helpers giving ways to adapt to semantic versioning conventions
   module Semver
-
     # Compute next version from an existing one and a bump level
     #
-    # Parameters::
-    # * *version* (String): Existing version
-    # * *bump_level* (Integer): The bump level (0: patch, 1: minor, 2: major)
-    # * *pre_release* (Boolean): Should we get a pre-release version (adding a unique metadata)? [default: false]
-    # Result::
-    # * String: The next version
+    # @param version [String] Existing version
+    # @param bump_level [Integer] The bump level (0: patch, 1: minor, 2: major)
+    # @param pre_release [Boolean] Should we get a pre-release version (adding a unique metadata)?
+    # @return [String] The next version
     def self.next_version_from(version, bump_level, pre_release: false)
-      if version =~ /^(\d+)\.(\d+)\.(\d+)$/
-        major = Integer($1)
-        minor = Integer($2)
-        patch = Integer($3)
-        case bump_level
-        when 0
-          patch += 1
-        when 1
-          minor += 1
-          patch = 0
-        when 2
-          major += 1
-          minor = 0
-          patch = 0
-        else
-          raise "Invalid bump level: #{bump_level}"
-        end
-        "#{major}.#{minor}.#{patch}#{pre_release ? "-#{pre_release_metadata}" : ''}"
+      raise "Invalid version: #{version}" unless version =~ /^(\d+)\.(\d+)\.(\d+)$/
+
+      major = Integer(::Regexp.last_match(1))
+      minor = Integer(::Regexp.last_match(2))
+      patch = Integer(::Regexp.last_match(3))
+      case bump_level
+      when 0
+        patch += 1
+      when 1
+        minor += 1
+        patch = 0
+      when 2
+        major += 1
+        minor = 0
+        patch = 0
       else
-        raise "Invalid version: #{version}"
+        raise "Invalid bump level: #{bump_level}"
       end
+      "#{major}.#{minor}.#{patch}#{"-#{pre_release_metadata}" if pre_release}"
     end
 
     # Get a version from a git ref
     #
-    # Parameters::
-    # * *git_ref* (String): The git ref
-    # Result::
-    # * String: Corresponding version
+    # @param git_ref [String, nil] The git ref
+    # @return [String] Corresponding version
     def self.version_from_git_ref(git_ref)
       if git_ref.nil?
         '0.0.0'
       elsif git_ref =~ /^v(\d+\.\d+\.\d+)$/
-        $1
+        ::Regexp.last_match(1)
       else
         raise "Can't assume version from git ref: #{git_ref}"
       end
     end
 
-    private
-
     # Get a pre-release metadata to be appended to a version
     #
-    # Result::
-    # * String: The pre-release metadata
+    # @return [String] The pre-release metadata
     def self.pre_release_metadata
       "#{`whoami`.strip}-#{Time.now.utc.strftime('%Y%m%d%H%M%S')}-SNAPSHOT"
     end
-
   end
-
 end

data/lib/sem_ver_components/version.rb

@@ -1,5 +1,4 @@
 module SemVerComponents
-
-  VERSION = '0.4.1'
-
+  # Version of the gem
+  VERSION = '1.0.0'
 end

data/lib/sem_ver_components.rb

@@ -0,0 +1,3 @@
+require 'zeitwerk'
+
+Zeitwerk::Loader.for_gem.setup

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sem_ver_components
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Muriel Salvan
 bindir: bin
 cert_chain: []
-date: 2026-03-23 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -15,14 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '5.4'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
 description: Tools helping in maintaining semantic versioning at a components level
   instead of a global package-only level.
 email:
@@ -33,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/sem_ver_git
+- lib/sem_ver_components.rb
 - lib/sem_ver_components/git_hosting.rb
 - lib/sem_ver_components/git_hostings/bitbucket.rb
 - lib/sem_ver_components/git_hostings/github.rb
@@ -47,7 +62,8 @@ files:
 homepage: https://github.com/Muriel-Salvan/sem_ver_components
 licenses:
 - BSD-3-Clause
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -55,7 +71,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="