schmersion 1.0.0

data/lib/schmersion/message.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Schmersion
+  class Message
+
+    REGEX = /^([\w-]+)(?:\(([\w-]+)\))?(!)?:\s(.*?)(?:\(#(\d+)\))?$/.freeze
+    FOOTER_COLON_REGEX = /^([\w-]+:|BREAKING CHANGE:)\s*(.*)$/.freeze
+    FOOTER_TICKET_REGEX = /^([\w-]+)\s+(#.*)$/.freeze
+
+    attr_reader :header
+    attr_reader :footers
+    attr_reader :type
+    attr_reader :scope
+    attr_reader :description
+    attr_reader :body
+    attr_reader :pull_request_id
+    attr_reader :breaking_changes
+
+    def initialize(raw_message)
+      @raw_message = clean(raw_message)
+
+      parts = @raw_message.split("\n\n").map(&:strip)
+
+      @header = parts.shift
+      @paragraphs = parts
+      @breaking_changes = []
+      @footers = []
+
+      parse_header
+      parse_footers
+
+      @body = @paragraphs.join("\n\n")
+    end
+
+    def valid?
+      !@type.nil?
+    end
+
+    def breaking_change?
+      @breaking_change == true ||
+        @breaking_changes.size.positive?
+    end
+
+    private
+
+    def parse_header
+      match = @header.match(REGEX)
+      return unless match
+
+      @type = match[1]
+      @scope = match[2]
+      @description = match[4].strip
+      @pull_request_id = match[5]
+
+      @breaking_change = true if match[3] == '!'
+
+      match
+    end
+
+    def parse_footers
+      footer = []
+      @paragraphs.last&.each_line do |line|
+        case line.strip
+        when FOOTER_COLON_REGEX, FOOTER_TICKET_REGEX
+          if footer.any?
+            handle_footer(footer)
+            footer = []
+          end
+          footer << "#{Regexp.last_match(1)} #{Regexp.last_match(2)}"
+        else
+          footer << line.strip
+        end
+      end
+
+      handle_footer(footer) if footer.any?
+
+      @paragraphs.pop if @footers.any? || @breaking_changes.any?
+    end
+
+    def handle_footer(footer_lines = [])
+      footer = footer_lines.join("\n")
+
+      if footer.start_with?('BREAKING CHANGE:')
+        @breaking_changes << footer.delete_prefix('BREAKING CHANGE:').strip
+      else
+        @footers << footer
+      end
+    end
+
+    def clean(message)
+      message.sub(/.*-----END PGP SIGNATURE-----\n\n/m, '')
+    end
+
+  end
+end

data/lib/schmersion/message_validator.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Schmersion
+  class MessageValidator
+
+    attr_reader :errors
+
+    def initialize(config, message)
+      @config = config
+      @message = message
+      @errors = []
+      validate_all
+    end
+
+    def valid?
+      @errors.empty?
+    end
+
+    def validate_all
+      validate_valid_format
+      return unless @message.valid?
+
+      validate_type
+      validate_scope
+      validate_description_presence
+      validate_description_length
+    end
+
+    private
+
+    def validate_valid_format
+      return if @message.valid?
+
+      errors << 'The commit message is not in a valid format'
+    end
+
+    def validate_type
+      return if @message.type.nil?
+      return if @config.valid_type?(@message.type)
+
+      errors << "Type (#{@message.type}) is not valid"
+    end
+
+    def validate_scope
+      return if @message.scope.nil?
+      return if @config.valid_scope?(@message.scope)
+
+      errors << "Scope (#{@message.scope}) is not valid"
+    end
+
+    def validate_description_presence
+      return if @message.description&.size&.positive?
+
+      errors << 'A description (text after the type) must be provided'
+    end
+
+    def validate_description_length
+      return if @message.description.nil?
+      return if @message.description.size.zero?
+      return if @message.description.size <= @config.linting[:max_description_length]
+
+      errors << "Commit description must be less than #{@config.linting[:max_description_length]} " \
+                "characters (currently #{@message.description.size})"
+    end
+
+  end
+end

data/lib/schmersion/releaser.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'schmersion/formatters'
+
+module Schmersion
+  class Releaser
+
+    COLORS = [:blue, :red, :yellow, :magenta, :green, :cyan].freeze
+
+    def initialize(repo, **options)
+      @repo = repo
+      @options = options
+      @exports = {}
+    end
+
+    def release
+      check_for_for_existing_version
+      generate_exports
+      preview_exports
+      save_exports
+      commit
+      tag
+      display_prompt
+    end
+
+    private
+
+    def check_for_for_existing_version
+      if @repo.version?(version.version)
+        raise Error, "#{version.version} already exists in this repository"
+      end
+
+      true
+    end
+
+    def generate_exports
+      return if skip?(:export)
+
+      @exports = {}
+      @repo.config.exports.each do |formatter|
+        output = formatter.generate(@repo, version)
+        @exports[formatter] = output
+      end
+      @exports
+    end
+
+    def preview_exports
+      return if skip?(:export)
+      return unless dry_run?
+
+      @exports.each_with_index do |(formatter, output), index|
+        color = COLORS[index % COLORS.size]
+        puts formatter.filename.colorize(color: :white, background: color)
+        output.split("\n").each do |line|
+          print '> '.colorize(color: color)
+          puts line
+        end
+      end
+    end
+
+    def save_exports
+      return if skip?(:export)
+
+      @exports.each do |formatter, output|
+        action 'save', formatter.filename do
+          formatter.insert(output)
+        end
+      end
+    end
+
+    def commit
+      return if skip?(:commit)
+
+      action 'commit', version.commit_message do
+        @repo.repo.reset
+        @exports.each_key do |formatter|
+          @repo.repo.add(formatter.filename)
+        end
+        @repo.repo.commit(version.commit_message, allow_empty: true)
+      end
+    end
+
+    def tag
+      return if skip?(:tag)
+
+      action 'tag', version.version.to_s do
+        @repo.repo.add_tag(version.version.to_s)
+      end
+    end
+
+    def display_prompt
+      puts
+      puts "Release of #{version.version} completed".white.on_green
+
+      return if skip?(:tag) && skip?(:commit)
+
+      print 'Now run '
+      print "git push --follow-tags origin #{@repo.current_branch}".cyan
+      puts ' to publish'
+    end
+
+    def version
+      @version ||= begin
+        @repo.pending_version(
+          override_version: @options[:version],
+          version_options: {
+            pre: @options[:pre],
+            breaking_change_not_major: @repo.config.version_options['breaking_change_not_major']
+          }
+        )[1]
+      end
+    end
+
+    def dry_run?
+      @options[:dry_run] == true
+    end
+
+    def action_color
+      dry_run? ? :magenta : :green
+    end
+
+    def action(action, text)
+      yield unless dry_run?
+      print "#{action}: ".colorize(action_color)
+      puts text
+    end
+
+    def skip?(type)
+      return false if @options[:skips].nil?
+
+      @options[:skips].include?(type)
+    end
+
+  end
+end

data/lib/schmersion/repo.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'git'
+require 'semantic'
+require 'schmersion/commit_parser'
+require 'schmersion/commit'
+require 'schmersion/version'
+require 'schmersion/config'
+require 'schmersion/hosts'
+
+module Schmersion
+  class Repo
+
+    attr_reader :path
+    attr_reader :repo
+
+    def initialize(path)
+      @path = path
+      @repo = Git.open(path)
+    rescue ArgumentError => e
+      if e.message =~ /path does not exist/
+        raise Error, "No git repository found at #{path}"
+      end
+
+      raise
+    end
+
+    def path_for(*join)
+      File.join(@path, *join)
+    end
+
+    def config
+      @config ||= load_config(['.schmersion.yaml', '.schmersion.yml'])
+    end
+
+    def origin
+      @origin ||= @repo.remotes.find { |r| r.name == 'origin' }&.url
+    end
+
+    def host
+      return nil if origin.nil?
+
+      Hosts.host_for_url(origin)
+    end
+
+    # Get the pending version for the currently checked out branch
+    # for the repository.
+    def pending_version(from: nil, to: 'HEAD', **options)
+      options[:version_options] ||= {}
+
+      if from.nil?
+        from_version = versions.last
+      else
+        from_version = versions.find { |v, _| v.to_s == from }
+        if from_version.nil?
+          raise Error, "Could not find existing version named #{from}"
+        end
+      end
+
+      if from_version
+        previous_version, previous_version_commit = from_version
+      end
+
+      parser = CommitParser.new(@repo, previous_version_commit&.ref || :start, to)
+      if v = options[:override_version]
+        begin
+          next_version = Semantic::Version.new(v)
+        rescue ArgumentError => e
+          if e.message =~ /not a valid SemVer/
+            raise Error, "'#{v}' is not a valid version"
+          end
+
+          raise
+        end
+      else
+        next_version = parser.next_version_after(previous_version, **options[:version_options])
+      end
+
+      [
+        previous_version,
+        Version.new(self, next_version, parser)
+      ]
+    end
+
+    def commits(start_commit, end_commit, **options)
+      parser = CommitParser.new(@repo, start_commit, end_commit, **options)
+      parser.commits
+    end
+
+    def current_branch
+      @repo.branch.name
+    end
+
+    def version?(version)
+      @repo.tag(version.to_s).is_a?(Git::Object::Tag)
+    rescue Git::GitTagNameDoesNotExist
+      false
+    end
+
+    def versions
+      versions = @repo.tags.each_with_object([]) do |tag, array|
+        commit = @repo.gcommit(tag.sha)
+        version = Semantic::Version.new(tag.name)
+        array << [version, Commit.new(commit)]
+      rescue ArgumentError => e
+        raise unless e.message =~ /not a valid SemVer/
+      end
+      versions.sort_by { |_, c| c.date }
+    end
+
+    private
+
+    def load_config(filenames)
+      filenames.each do |filename|
+        path = path_for(filename)
+        if File.file?(path)
+          return Config.new(::YAML.load_file(path))
+        end
+      end
+
+      warn 'No config file was found, using defaults'
+      Config.new({})
+    end
+
+  end
+end

data/lib/schmersion/schmersion_version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Schmersion
+
+  VERSION_FILE_ROOT = File.expand_path('../../VERSION', __dir__)
+  if File.file?(VERSION_FILE_ROOT)
+    VERSION = File.read(VERSION_FILE_ROOT).strip.sub(/\Av/, '')
+  else
+    VERSION = '0.0.0.dev'
+  end
+
+end

data/lib/schmersion/version.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Schmersion
+  class Version
+
+    attr_reader :version
+    attr_reader :commit_parser
+
+    def initialize(repo, version, commit_parser)
+      @repo = repo
+      @version = version
+      @commit_parser = commit_parser
+    end
+
+    def commits
+      @commit_parser.commits
+    end
+
+    def start_commit
+      @commit_parser.start_commit
+    end
+
+    def end_commit
+      @commit_parser.end_commit
+    end
+
+    def commit_message
+      "chore(release): #{version}"
+    end
+
+  end
+end