sem_ver_components 0.1.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9da50f9edee211f731452cdfb03e376d2b895f75d04a5ebdbfe2d30c87dfb90
-  data.tar.gz: 1ad69a75e32306303ae841aa9aecf633a7c90db25cd529d9c8c791837e154e04
+  metadata.gz: 387992ffe83f018c9096f517580fc810be55fce48f32ed519091d226aa480fed
+  data.tar.gz: 6b624945d92655aee943be4e1f380498b70e0fbb070917a1d1bd7eaacf00d353
 SHA512:
-  metadata.gz: d4b54b6a41a4060da5171f2f809ca57aac59d75a72194da62b84d6e1a598f40e0ea29682221fdb0fda163db6dc494dcaf7dcd74b52fdbea6b20b167af3cc75b7
-  data.tar.gz: 2111a729b803e12870b3df2d1e4efc2411d34deeff6882218b2313b17686748d8350f47f56a89a39f12b5c0d997b3caef7ec4134e7c57462dc05f0704605694b
+  metadata.gz: a4d1bf087e0922fe5eaa3439497279d8562fd865527c65f915d61ffe0fe5abd594af4ba6290f085297028dbf903e3c3d428bbb3ef885393ccabad3690b7107f2
+  data.tar.gz: dc626df24fc0c635c86aeed396e4eeed80ef11840d65008846dd1c40568f0f6955385d93aa5c2b9cef767dca3b65793e3acd76022dd930dce2fdcdfbe6ea6f55

data/bin/sem_ver_git

@@ -4,17 +4,23 @@ 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
+    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
   end
   opts.on('-h', '--help', 'Display this help') do
     puts opts
@@ -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/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/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/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.
@@ -80,7 +60,7 @@ module SemVerComponents
             commits_per_component[component][bump_level] << git_commit
           end
         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?
@@ -112,7 +92,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/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.1.2'
+  VERSION = '0.3.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sem_ver_components
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-15 00:00:00.000000000 Z
+date: 2021-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
@@ -62,12 +62,16 @@ 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
 - 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: