sem_ver_components 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c769d2f50e4b9b47d7244d596c497781797539059ae577b3922221a0b55fdfb4
-  data.tar.gz: c265fe89c722f6092b0f8061ea556244131f1d3ce13de0ba24c2fb0714e05d04
+  metadata.gz: 3bd9072dcf7ef8166885ae3f8cf08c3d50cf5b99e557f9c22b51c9523ddb263a
+  data.tar.gz: 66036176a6028833f51c4f5f5118f4d68c934106c8e90dc08f478ae4a57e78d0
 SHA512:
-  metadata.gz: fc08045f4e3552af8deefe3e4086b8d9e4e80c39bfe65a2c00a8ab25b7eeccbcf089207adcdcb5832308abaa3a2008343c393a124dba4948f8a49b0e161e82d6
-  data.tar.gz: 021e88d06a2ce6fc31cb5d146e211c9436db6ec4da7eaafd151ce16df08347f179cd286782d42e4f10cfeb89f668bac14420a91786e449d757c51205f2b70905
+  metadata.gz: '049f38d9969d07d80af92c82ec6a70f9e9de84ac1df68e549c72962ce0d63958d182ebb8ae9b966e9371511d2d76fc7539ebb0c62e7f6b0d0d9e2df2a93ee13f'
+  data.tar.gz: 355307ad5bee9481fdc7d7b29c0dad165c5d573ae805a77d2241a1826ee6b6ef35bcf4013b652d56f57b761fe67b00a24e1d2945f8c76d7e7b4354cba7a069da

data/bin/sem_ver_git

@@ -17,7 +17,7 @@ git_hosting_plugins = SemVerComponents::Plugins.new(:git_hostings)
 OptionParser.new do |opts|
   opts.banner = "Usage: #{File.basename($0)} [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
+    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|
     git_hosting = git_hosting_str.to_sym

data/lib/sem_ver_components/git_hostings/bitbucket.rb

@@ -10,7 +10,7 @@ module SemVerComponents
       # * *git_url* (String): The git URL
       # * *commit_sha* (String): The commit sha
       def commit_url(git_url, commit_sha)
-        "#{git_url}/commits/#{commit_sha}"
+        "#{public_url(git_url)}/commits/#{commit_sha}"
       end
 
       # Get the URL to compare 2 tags
@@ -20,7 +20,26 @@ module SemVerComponents
       # * *tag_1* (String): The first tag
       # * *tag_2* (String): The second tag
       def compare_url(git_url, tag_1, tag_2)
-        "#{git_url}/compare/commits?targetBranch=refs%2Ftags%2F#{tag_2}&sourceBranch=refs%2Ftags%2F#{tag_1}"
+        "#{public_url(git_url)}/compare/commits?targetBranch=refs%2Ftags%2F#{tag_1}&sourceBranch=refs%2Ftags%2F#{tag_2}"
+      end
+
+      private
+
+      # Convert the git remote URL to the public URL
+      #
+      # Parameters::
+      # * *git_url* (String): Git remote URL
+      # Result::
+      # * String: The corresponding public URL
+      def public_url(git_url)
+        if git_url =~ /^(.+)\/scm\/([^\/]+)\/(.+)$/
+          base_url = $1
+          project = $2
+          repo = $3
+          "#{base_url}/projects/#{project}/repos/#{repo}"
+        else
+          git_url
+        end
       end
 
     end

data/lib/sem_ver_components/local_git.rb

@@ -60,6 +60,14 @@ module SemVerComponents
       end
     end
 
+    # Is the git to ref part of a release branch?
+    #
+    # Result::
+    # * Boolean: Is the git to ref part of a release branch?
+    def on_release_branch?
+      @git_to == 'master'
+    end
+
   end
 
 end

data/lib/sem_ver_components/outputs/info.rb

@@ -1,3 +1,5 @@
+require 'sem_ver_components/semver'
+
 module SemVerComponents
 
   module Outputs
@@ -12,11 +14,12 @@ module SemVerComponents
       #   * *commit* (Git::Object::Commit): Corresponding git commit
       def process(commits_info)
         # Display bump levels per component
-        commits_info.inject({}) do |components_bump_levels, commit_info|
+        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
           end
-        end.each do |component, bump_level|
+        end
+        bumps_per_component.each do |component, bump_level|
           puts "#{component.nil? ? 'Global' : component}: Bump #{
               case bump_level
               when 0
@@ -30,6 +33,15 @@ module SemVerComponents
               end
             } version"
         end
+        # Compute new version
+        global_bump_level = bumps_per_component.values.max
+        if global_bump_level.nil?
+          puts 'No next version'
+        else
+          puts "Next global version#{@local_git.on_release_branch? ? '' : ' (not 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

data/lib/sem_ver_components/outputs/semantic_release_generate_notes.rb

@@ -1,4 +1,5 @@
 require 'time'
+require 'sem_ver_components/semver'
 
 module SemVerComponents
 
@@ -14,31 +15,10 @@ module SemVerComponents
       #   * *commit* (Git::Object::Commit): Corresponding git commit
       def process(commits_info)
         # Compute new version
-        new_version =
-          if @local_git.git_from.nil?
-            '0.0.1'
-          elsif @local_git.git_from =~ /^v(\d+)\.(\d+)\.(\d+)$/
-            major = Integer($1)
-            minor = Integer($2)
-            patch = Integer($3)
-            bump_level = commits_info.map { |commit_info| commit_info[:components_bump_levels].values }.flatten(1).max
-            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}"
-          else
-            raise "Can't generate release notes from a git ref that is not a semantic release (#{@local_git.git_from})"
-          end
+        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 = 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.
@@ -67,10 +47,14 @@ module SemVerComponents
           # If we are dealing with a merge commit, consider the components' bump levels of the merged commits
           if merge_commits.key?(git_commit_sha)
             merge_commits[git_commit_sha].each do |merged_commit_sha|
-              components_bump_levels = components_bump_levels.merge(
-                commits_info.find { |search_commit_info| search_commit_info[:commit].sha == merged_commit_sha }[:components_bump_levels]
-              ) do |component, bump_level_1, bump_level_2|
-                [bump_level_1, bump_level_2].max
+              merged_commit_info = commits_info.find { |search_commit_info| search_commit_info[:commit].sha == merged_commit_sha }
+              # 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
               end
             end
           end
@@ -80,7 +64,7 @@ module SemVerComponents
             commits_per_component[component][bump_level] << git_commit
           end
         end
-        puts "# [v#{new_version}](#{@git_hosting.compare_url(git_url, @local_git.git_from, new_version)}) (#{Time.now.utc.strftime('%F %T')})"
+        puts "# [v#{new_version}](#{@git_hosting.compare_url(git_url, @local_git.git_from, "v#{new_version}")}) (#{Time.now.utc.strftime('%F %T')})"
         puts
         commits_per_component.sort_by { |component, _component_info| component || '' }.each do |(component, component_info)|
           puts "## #{component.nil? ? 'Global changes' : "Changes for #{component}"}\n" if commits_per_component.size > 1 || !component.nil?

data/lib/sem_ver_components/semver.rb

@@ -0,0 +1,66 @@
+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
+    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}" : ''}"
+      else
+        raise "Invalid version: #{version}"
+      end
+    end
+
+    # Get a version from a git ref
+    #
+    # Parameters::
+    # * *git_ref* (String): The git ref
+    # Result::
+    # * 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
+      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
+    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,5 @@
 module SemVerComponents
 
-  VERSION = '0.2.0'
+  VERSION = '0.3.1'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sem_ver_components
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2021-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -71,6 +71,7 @@ files:
 - lib/sem_ver_components/outputs/semantic_release_analyze.rb
 - lib/sem_ver_components/outputs/semantic_release_generate_notes.rb
 - lib/sem_ver_components/plugins.rb
+- lib/sem_ver_components/semver.rb
 - lib/sem_ver_components/version.rb
 homepage: https://github.com/Muriel-Salvan/sem_ver_components
 licenses: