sem_ver_components 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3dfbf1225479b15f20c2d05e722e3b2c55639bd487c2116ea876e9242b761cf
-  data.tar.gz: db32b6f0e269ace834c2deebbe15a17e7cc6c99912769e48810ef7e6caba8dde
+  metadata.gz: 615e48cee99768167dff45e0889a1718250c4a7188a8c7d2ad0ed2dcb193dd1c
+  data.tar.gz: 4e4233b956a6e99179c7c5f10dc2f4bba5ade9c90b27b7a3b85326f259ade41c
 SHA512:
-  metadata.gz: 56f653d99f3917916f2c9f5d7f13aa3287af6d609736fc530d6b0862edff47205b308cad5e92f32207eee9509cea97116d1241cc5f945c8ff1a78d3c5752ac6a
-  data.tar.gz: 2cf423be84f46c9657f610c54d47587b8d6c3a1821742d715f91defd65d7aa60ff617881ccdb0b0297739e2da8128eb8e7133992db41bd351dc7d66c217ecab0
+  metadata.gz: fe8e33a730795782a2576b065aaa074295afc3f10eabb8f9f7070cbdb93d30e62545f0daab470072b76c8b92ea71cb7729f7a7b75b61c11eaa3109b7b66ebbb9
+  data.tar.gz: 1a7572ba83c6b9b643e25bdb13ce41ee7e4bdc0f08bc95392ec68e2941a75bafa22e16f157eba7b7a7a52a2c5110a65870ddf84bef72894f081ccf2691147345

data/bin/sem_ver_git

@@ -4,18 +4,24 @@ 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'
 
 # Default values
 git_repo = '.'
 git_from = nil
 git_to = 'HEAD'
+git_hosting = :github
 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.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
   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
+  end
   opts.on('-h', '--help', 'Display this help') do
     puts opts
     exit 0
@@ -40,4 +46,4 @@ raise "Unknown parameters: #{ARGV.join(' ')}" unless ARGV.empty?
 local_git = SemVerComponents::LocalGit.new(git_repo, git_from, git_to)
 commits_info = local_git.analyze_commits
 
-output_plugins[output].new(local_git).process(commits_info)
+output_plugins[output].new(local_git, git_hosting_plugins[git_hosting].new).process(commits_info)

data/lib/sem_ver_components/git_hosting.rb

@@ -0,0 +1,8 @@
+module SemVerComponents
+
+  # Base class for all git hosting plugins
+  class GitHosting
+
+  end
+
+end

data/lib/sem_ver_components/git_hostings/bitbucket.rb

@@ -0,0 +1,49 @@
+module SemVerComponents
+
+  module GitHostings
+
+    class Bitbucket < GitHosting
+
+      # Get the URL to a given commit sha
+      #
+      # Parameters::
+      # * *git_url* (String): The git URL
+      # * *commit_sha* (String): The commit sha
+      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}"
+      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
+
+  end
+
+end

data/lib/sem_ver_components/git_hostings/github.rb

@@ -0,0 +1,30 @@
+module SemVerComponents
+
+  module GitHostings
+
+    class Github < GitHosting
+
+      # Get the URL to a given commit sha
+      #
+      # Parameters::
+      # * *git_url* (String): The git URL
+      # * *commit_sha* (String): The commit sha
+      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}"
+      end
+
+    end
+
+  end
+
+end

data/lib/sem_ver_components/output.rb

@@ -1,13 +1,16 @@
 module SemVerComponents
 
+  # Base class for all output plugins
   class Output
 
     # Constructor
     #
     # Parameters::
     # * *local_git* (LocalGit): The git repository
-    def initialize(local_git)
+    # * *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

data/lib/sem_ver_components/outputs/semantic_release_analyze.rb

@@ -14,6 +14,9 @@ module SemVerComponents
         bump_level = commits_info.map { |commit_info| commit_info[:components_bump_levels].values }.flatten(1).max
         puts(
           case bump_level
+          when nil
+            # No commit. Return nothing to bump.
+            ''
           when 0
             'patch'
           when 1

data/lib/sem_ver_components/outputs/semantic_release_generate_notes.rb

@@ -41,22 +41,46 @@ module SemVerComponents
           end
         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.
+        # List of merged commits' shas, per merge commit sha.
+        # Hash< String, Array< String > >
+        merge_commits = {}
+        commits_info.each do |commit_info|
+          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
+        end
+        commits_to_ignore = merge_commits.values.flatten(1).sort.uniq
         # Group commits per bump level, per component
         # Hash< String or nil, Hash< Integer, Array<Git::Object::Commit> >
         commits_per_component = {}
-        # Also reference commits to be ignored: commits that are part of a merge commit
-        merged_commits = []
         commits_info.each do |commit_info|
           git_commit = commit_info[:commit]
-          commit_info[:components_bump_levels].each do |component, bump_level|
+          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)
+            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
+              end
+            end
+          end
+          components_bump_levels.each do |component, bump_level|
             commits_per_component[component] = {} unless commits_per_component.key?(component)
             commits_per_component[component][bump_level] = [] unless commits_per_component[component].key?(bump_level)
             commits_per_component[component][bump_level] << git_commit
           end
-          # In the case of a merge commit, reference all commits that are part of this merge commit, directly from the graph
-          merged_commits.concat(@local_git.git_log.between(@local_git.git.merge_base(*git_commit.parents.map(&:sha)).first.sha, git_commit.sha)[1..-1].map(&:sha)) if git_commit.parents.size > 1
         end
-        puts "# [v#{new_version}](#{git_url}/compare/#{@local_git.git_from}...v#{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?
@@ -78,8 +102,6 @@ module SemVerComponents
             # Hash< String, String >
             commit_lines = {}
             commits.each do |commit|
-              # Don't put merged commits as we consider the changelog should contain the merge commit comment.
-              next if merged_commits.include?(commit.sha)
               message_lines = commit.message.split("\n")
               commit_line = message_lines.first
               if commit_line =~ /^Merge pull request .+$/
@@ -90,7 +112,7 @@ module SemVerComponents
               commit_lines[commit_line] = commit.sha
             end
             commit_lines.each do |commit_line, commit_sha|
-              puts "* [#{commit_line}](#{git_url}/commit/#{commit_sha})"
+              puts "* [#{commit_line}](#{@git_hosting.commit_url(git_url, commit_sha)})"
             end
             puts
           end

data/lib/sem_ver_components/version.rb

@@ -1,5 +1,5 @@
 module SemVerComponents
 
-  VERSION = '0.1.0'
+  VERSION = '0.2.2'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sem_ver_components
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -62,6 +62,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/sem_ver_git
+- lib/sem_ver_components/git_hosting.rb
+- lib/sem_ver_components/git_hostings/bitbucket.rb
+- lib/sem_ver_components/git_hostings/github.rb
 - lib/sem_ver_components/local_git.rb
 - lib/sem_ver_components/output.rb
 - lib/sem_ver_components/outputs/info.rb