schmersion 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b913b0f1449212f78614fa4d033a16ee85a839d9992b847978869c35dc4dfc29
+  data.tar.gz: a1452b8b38d15ce8676e20dca1ef936d783b1a66124ab7eedb054a8220cf80e9
+SHA512:
+  metadata.gz: 380925581f98a27eb2b5fb45ab4a0e2e1b09dce184040881e8c4bf8541a71e7d74915e18cae2b09580e2454ab801e959be82ff84d3f005c9258d48079193da9e
+  data.tar.gz: 27720896c464ed1d871cd7841e0caa7b705135d23efe3cdc14db9644eac65b91dcae3b2588e42dabc9778f0724025189a1c3bc857afc4db3f5b8376c3744a13f

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/schmersion

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+require 'schmersion'
+require 'swamp/cli'
+require 'git'
+require 'colorize'
+
+begin
+  cli = Swamp::CLI.new(:schmersion, version: Schmersion::VERSION)
+  cli.load_from_directory(File.expand_path('../cli', __dir__))
+  cli.dispatch(ARGV.empty? ? ['help'] : ARGV)
+rescue Swamp::Error, Git::GitExecuteError, Schmersion::Error => e
+  warn "\e[31mError: #{e.message}\e[0m"
+  exit 2
+rescue Interrupt
+  exit 3
+end

data/cli/help.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+command :help do
+  desc 'Display this help text'
+  action do |context|
+    puts "\e[35mWelcome to Schmersion v#{Schmersion::VERSION}\e[0m"
+    puts 'For documentation see https://github.com/krystal/schmersion.'
+    puts
+
+    puts 'The following commands are supported:'
+    puts
+    context.cli.commands.sort_by { |k, _v| k.to_s }.each do |_, command|
+      if command.description
+        puts "  \e[36m#{command.name.to_s.ljust(18, ' ')}\e[0m #{command.description}"
+      end
+    end
+    puts
+    puts 'For details for the options available for each command, use the --help option.'
+    puts "For example 'schmersion pending --help'."
+  end
+end

data/cli/init.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+command :init do
+  desc 'Create a .schmersion.yml config file'
+
+  option '-f', '--force', 'Override existing hooks if they exist' do |_, options|
+    options[:force] = true
+  end
+
+  action do |context|
+    if File.exist?('.schmersion.yaml') && !context.options[:force]
+      puts 'A file already exists at .schmersion.yaml'
+      puts 'Use --force if you wish to re-generate it.'
+      exit 1
+    end
+
+    example = <<~EXAMPLE
+      # Welcome to the Schmersion config file
+      #
+      # This is an array of all the commit types that are supported. You can
+      # override this to define your own set as needed per-project.
+      #
+      # types: [feat, fix, style, chore, test, refactor, perf, docs, ci, build, revert]
+      #
+      # By default, you can use any scope (the word in brackets following the type).
+      # If you wish to restrict this, you can define a list of valid scopes.
+      # scopes: [auth, api, ...]
+      #
+      # A key part of the configuration is how you wish to export your CHANGELOG files.w
+      exports:
+        - name: CHANGELOG.md
+          formatter: markdown
+          options:
+            title: CHANGELOG
+            description: This file contains all the latest changes and updates to this application.
+            sections:
+              - title: Features
+                types: [feat]
+              - title: Bug Fixes
+                types: [fix]
+      #
+      # There are additional options you can define, check out the README for details.
+      # https://github.com/krystal/schmersion
+    EXAMPLE
+
+    File.write('.schmersion.yaml', example)
+    puts 'Created new .schmersion.yaml file'.green
+  end
+end

data/cli/lint-prepare.rb

@@ -0,0 +1,14 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+command :'lint-prepare' do
+  action do |context|
+    require 'schmersion/repo'
+    require 'schmersion/linter'
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+    linter = Schmersion::Linter.new(repo)
+    linter.prepare(context.args[0], context.args[1])
+  end
+end
+
+# rubocop:enable Naming/FileName

data/cli/lint-validate.rb

@@ -0,0 +1,28 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+command :'lint-validate' do
+  action do |context|
+    require 'schmersion/repo'
+    require 'schmersion/linter'
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+    linter = Schmersion::Linter.new(repo)
+    errors = linter.validate_file(context.args[0])
+    if errors.empty?
+      exit 0
+    end
+
+    puts
+    puts '  Schmersion Commit Linting'.cyan
+    puts
+    puts "  Uh oh. There's a few things wrong with your commit message...".red
+    puts '  Please correct these and re-commit to continue.'.red
+    puts
+    errors.each do |error|
+      puts "  => #{error}"
+    end
+    puts
+    exit 1
+  end
+end
+# rubocop:enable Naming/FileName

data/cli/log.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+command :log do
+  desc 'Print all commits in a range nicely'
+
+  option '--from [REF]', 'Commit to start from (default: beginning of time)' do |value, options|
+    options[:from] = value
+  end
+
+  option '--to [REF]', 'Commit to finish with (default: current branch)' do |value, options|
+    options[:to] = value
+  end
+
+  action do |context|
+    require 'schmersion/repo'
+    require 'schmersion/helpers'
+    require 'colorize'
+
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+
+    from = context.options[:from] || :start
+    to = context.options[:to] || repo.current_branch
+
+    commits = repo.commits(from, to, exclude_with_invalid_messages: true)
+
+    Schmersion::Helpers.print_commit_list(commits)
+  end
+end

data/cli/pending.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+command :pending do
+  desc 'Displays commits pending'
+
+  option '--from [REF]', 'Version to start from (default: latest version)' do |value, options|
+    options[:from] = value
+  end
+
+  option '--to [REF]', 'Commit to end at (default: HEAD)' do |value, options|
+    options[:to] = value
+  end
+
+  option '--pre [PREFIX]', 'Create a pre-release version' do |value, options|
+    options[:pre] = value || true
+  end
+
+  action do |context|
+    require 'schmersion/repo'
+    require 'schmersion/helpers'
+
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+    current_version, next_version = repo.pending_version(
+      from: context.options[:from],
+      to: context.options[:to],
+      version_options: {
+        pre: context.options[:pre]
+      }
+    )
+
+    puts
+    if current_version
+      puts 'The current published version is:'
+      puts
+      puts "    #{current_version.to_s.cyan}"
+      puts
+      puts 'The next version will be:'
+    else
+      puts 'The first version will be:'
+    end
+    puts
+    puts "    #{next_version.version.to_s.green}"
+    puts
+    puts 'The following commits will be included:'
+    puts
+    Schmersion::Helpers.print_commit_list(next_version.commits, prefix: '    ')
+    puts
+  end
+end

data/cli/release.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+command :release do
+  desc 'Create a release'
+
+  option '-r [VERSION]', 'Override the version number' do |value, options|
+    options[:version] = value
+  end
+
+  option '--dry-run', "Don't actually do anything, just show a preview" do |_, options|
+    options[:dry_run] = true
+  end
+
+  option '--pre [PREFIX]', 'Create a pre-release version' do |value, options|
+    options[:pre] = value || true
+  end
+
+  option '--skip-export', "Don't generate new CHANGELOG exports" do |_, options|
+    options[:skips] ||= []
+    options[:skips] << :export
+  end
+
+  option '--skip-commit', "Don't commit anything" do |_, options|
+    options[:skips] ||= []
+    options[:skips] << :commit
+  end
+
+  option '--skip-tag', "Don't create a tag" do |_, options|
+    options[:skips] ||= []
+    options[:skips] << :tag
+  end
+
+  action do |context|
+    require 'schmersion/repo'
+    require 'schmersion/releaser'
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+    releaser = Schmersion::Releaser.new(repo, context.options)
+    releaser.release
+  end
+end

data/cli/setup-linting.rb

@@ -0,0 +1,22 @@
+# rubocop:disable Naming/FileName
+# frozen_string_literal: true
+
+command :'setup-linting' do
+  desc 'Install git hooks to lint commit messages'
+
+  option '-f', '--force', 'Override existing hooks if they exist' do |_, options|
+    options[:force] = true
+  end
+
+  action do |context|
+    require 'schmersion/repo'
+    require 'schmersion/linter'
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+    linter = Schmersion::Linter.new(repo)
+    linter.setup(force: context.options[:force])
+
+    puts 'Installed hooks successfully'.green
+  end
+end
+
+# rubocop:enable Naming/FileName

data/cli/versions.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+command :versions do
+  desc 'Print a list of all versions in version order'
+  action do
+    require 'schmersion/repo'
+    require 'colorize'
+
+    repo = Schmersion::Repo.new(FileUtils.pwd)
+    repo.versions.each do |version, _|
+      puts version
+    end
+  end
+end

data/lib/schmersion.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'schmersion/schmersion_version'
+require 'schmersion/error'

data/lib/schmersion/commit.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal:  true
+
+require 'schmersion/message'
+
+module Schmersion
+  class Commit
+
+    attr_reader :message
+    attr_reader :ref
+    attr_reader :date
+    attr_reader :author
+    attr_reader :raw_commit
+
+    def initialize(commit)
+      @message = Message.new(commit.message)
+      @ref = commit.sha
+      @date = commit.date
+      @author = commit.author.name
+      @raw_commit = commit
+    end
+
+  end
+end

data/lib/schmersion/commit_parser.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'schmersion/commit'
+require 'schmersion/version_calculator'
+
+module Schmersion
+  class CommitParser
+
+    MAX_COMMITS = 100_000_000
+
+    attr_reader :commits
+
+    def initialize(repo, start_commit, end_commit, **options)
+      @start_commit = start_commit
+      @end_commit = end_commit
+      @options = options
+
+      @commits = []
+
+      if @start_commit == :start
+        # If start is provided, use the first commit as the initial reference.
+        # Ideally this would actually start from the beginning of time and include
+        # this commit.
+        first_commit = repo.log(MAX_COMMITS).last
+        @start_commit = first_commit.sha
+      end
+
+      @raw_commits = repo.log(MAX_COMMITS).between(@start_commit, @end_commit)
+
+      parse
+    end
+
+    def parse
+      @commits = []
+      @raw_commits.each do |commit|
+        commit = Commit.new(commit)
+
+        next if skip_commit?(commit)
+
+        @commits << commit
+      end
+      @commits = @commits.reverse
+      @commits
+    end
+
+    def next_version_after(current_version, **options)
+      calculator = VersionCalculator.new(current_version, commits, **options)
+      calculator.calculate
+    end
+
+    def skip_commit?(commit)
+      # We never want to see merge commits...
+      return true if commit.raw_commit.parents.size > 1
+      return true unless commit.message.valid?
+
+      false
+    end
+
+  end
+end

data/lib/schmersion/config.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Schmersion
+  class Config
+
+    DEFAULT_TYPES = %w[feat fix style chore test refactor perf docs ci build revert].freeze
+
+    DEFAULT_VERSION_OPTIONS = {
+      breaking_change_not_major: false
+    }.freeze
+
+    DEFAULT_LINTING_OPTIONS = {
+      max_description_length: 60
+    }.freeze
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def types
+      @hash['types'] || DEFAULT_TYPES
+    end
+
+    def valid_type?(type)
+      return true if types.empty?
+
+      types.include?(type.to_s)
+    end
+
+    def scopes
+      @hash['scopes'] || []
+    end
+
+    def valid_scope?(scope)
+      return true if scopes.empty?
+
+      scopes.include?(scope.to_s)
+    end
+
+    def exports
+      return [] if @hash['exports'].nil?
+
+      @hash['exports'].map { |e| create_export(e) }
+    end
+
+    def linting
+      DEFAULT_LINTING_OPTIONS.merge(@hash['linting']&.transform_keys(&:to_sym) || {})
+    end
+
+    def version_options
+      DEFAULT_VERSION_OPTIONS.merge(@hash['version_options']&.transform_keys(&:to_sym) || {})
+    end
+
+    private
+
+    def create_export(export)
+      name = export['name']
+      formatter = Formatters::FORMATTERS[export['formatter'].to_sym]
+      if formatter.nil?
+        raise Error, "Invalid formatter '#{export['formatter']}' for #{name}"
+      end
+
+      formatter.new(name, export['options'] || {})
+    end
+
+  end
+end