sem_ver_components 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 350d90498079e7485e8eab0897b6d02c92c8aa9bddea07d04e31425dcef60152
+  data.tar.gz: 4414c65c293c951d94346108c67523430229e22b2764205877a6c10e350b02b8
+SHA512:
+  metadata.gz: a5b77dd8f100c03fe7b77f09adb0291c478095458d35756a3f10799e2d66e423c219bab025a81d19d9e382bc66db08cc56a1fb5a78ff5dcfcf178263f52092ab
+  data.tar.gz: e6ce0c0d97f7cdc3c336da1a28af412a037a3ca7ca278ca3d07adc4911672a17b2f947821078fff81f9ef751635ce75baea736308d82d0d5beadad0beb8c3e34

data/bin/sem_ver_git

@@ -0,0 +1,43 @@
+#!/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'
+
+# Default values
+git_repo = '.'
+git_from = nil
+git_to = 'HEAD'
+output = :info
+output_plugins = SemVerComponents::Plugins.new(:outputs)
+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('-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|
+    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|
+    git_repo = git_url
+  end
+  opts.on('-t', '--to GIT_REF', "Git reference to which commits are to be analyzed (defaults to #{git_to})") do |git_ref|
+    git_to = git_ref
+  end
+  opts.on('-v', '--version', 'Display version') do
+    puts "#{File.basename($0)} v#{SemVerComponents::VERSION}"
+    exit 0
+  end
+end.parse!
+
+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)

data/lib/sem_ver_components/local_git.rb

@@ -0,0 +1,65 @@
+require 'git'
+
+module SemVerComponents
+
+  class LocalGit
+
+    attr_reader *%i[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
+    def initialize(git_repo, git_from, git_to)
+      @git_repo = git_repo
+      @git_from = git_from
+      @git_to = git_to
+      @git = Git.open(@git_repo)
+    end
+
+    # Get full the git log.
+    # Keep a cache of it.
+    #
+    # Result::
+    # * Array< Git::Object::Commit >: Full git log
+    def git_log
+      @git_log = @git.log(nil) 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
+    def analyze_commits
+      git_log.between(git_from.nil? ? git_log.last.sha : git_from, git_to).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]
+          components_bump_levels[component] = [] unless components_bump_levels.key?(component)
+          components_bump_levels[component] <<
+            case commit_type.downcase
+            when 'feat', 'feature'
+              1
+            when 'break', 'breaking'
+              2
+            else
+              0
+            end
+        end
+        {
+          commit: git_commit,
+          components_bump_levels: Hash[components_bump_levels.map { |component, component_bump_levels| [component, component_bump_levels.max] }]
+        }
+      end
+    end
+
+  end
+
+end

data/lib/sem_ver_components/output.rb

@@ -0,0 +1,15 @@
+module SemVerComponents
+
+  class Output
+
+    # Constructor
+    #
+    # Parameters::
+    # * *local_git* (LocalGit): The git repository
+    def initialize(local_git)
+      @local_git = local_git
+    end
+
+  end
+
+end

data/lib/sem_ver_components/outputs/info.rb

@@ -0,0 +1,39 @@
+module SemVerComponents
+
+  module Outputs
+
+    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
+      def process(commits_info)
+        # Display bump levels 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|
+          puts "#{component.nil? ? 'Global' : component}: Bump #{
+              case bump_level
+              when 0
+                'patch'
+              when 1
+                'minor'
+              when 2
+                'major'
+              else
+                raise "Invalid bump level: #{bump_level}"
+              end
+            } version"
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/sem_ver_components/outputs/semantic_release_analyze.rb

@@ -0,0 +1,33 @@
+module SemVerComponents
+
+  module Outputs
+
+    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
+      def process(commits_info)
+        bump_level = commits_info.map { |commit_info| commit_info[:components_bump_levels].values }.flatten(1).max
+        puts(
+          case bump_level
+          when 0
+            'patch'
+          when 1
+            'minor'
+          when 2
+            'major'
+          else
+            raise "Invalid bump level: #{bump_level}"
+          end
+        )
+      end
+
+    end
+
+  end
+
+end

data/lib/sem_ver_components/outputs/semantic_release_generate_notes.rb

@@ -0,0 +1,104 @@
+require 'time'
+
+module SemVerComponents
+
+  module Outputs
+
+    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
+      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
+        git_url = @local_git.git.remote('origin').url
+        git_url = git_url[0..-5] if git_url.end_with?('.git')
+        # 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|
+            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
+        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?
+          component_info.each do |bump_level, commits|
+            puts "### #{
+              case bump_level
+              when 0
+                'Patches'
+              when 1
+                'Features'
+              when 2
+                'Breaking changes'
+              else
+                raise "Invalid bump level: #{bump_level}"
+              end
+            }"
+            puts
+            # Gather an ordered set of commit lines (with the corresponding commit sha) in order to not duplicate the info when there are merge commits
+            # 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 .+$/
+                # Consider the next line as commit line
+                next_line = message_lines[1..-1].join("\n").strip.split("\n").first
+                commit_line = next_line unless next_line.nil?
+              end
+              commit_lines[commit_line] = commit.sha
+            end
+            commit_lines.each do |commit_line, commit_sha|
+              puts "* [#{commit_line}](#{git_url}/commit/#{commit_sha})"
+            end
+            puts
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/sem_ver_components/plugins.rb

@@ -0,0 +1,43 @@
+module SemVerComponents
+
+  class Plugins
+
+    # Constructor
+    #
+    # Parameters::
+    # * *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|
+        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)
+        ]
+      end]
+    end
+
+    # List available plugin names
+    #
+    # Result::
+    # * 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
+    def [](plugin_name)
+      @plugins[plugin_name]
+    end
+
+  end
+
+end

data/lib/sem_ver_components/version.rb

@@ -0,0 +1,5 @@
+module SemVerComponents
+
+  VERSION = '0.0.1'
+
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification
+name: sem_ver_components
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Muriel Salvan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+description: Tools helping in maintaining semantic versioning at a components level
+  instead of a global package-only level.
+email:
+- muriel@x-aeon.com
+executables:
+- sem_ver_git
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/sem_ver_git
+- 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/version.rb
+homepage: https://github.com/Muriel-Salvan/sem_ver_components
+licenses:
+- BSD-3-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Apply semantic versioning to various components of a same package
+test_files: []