milestoner 10.4.0 → 12.0.0

data/lib/milestoner/cli.rb

@@ -1,120 +0,0 @@
-# frozen_string_literal: true
-
-require "thor"
-require "thor/actions"
-require "runcom"
-
-module Milestoner
-  # The Command Line Interface (CLI) for the gem.
-  class CLI < Thor
-    include Thor::Actions
-
-    package_name Identity::VERSION_LABEL
-
-    def self.configuration
-      Runcom::Config.new "#{Identity::NAME}/configuration.yml",
-                         defaults: {
-                           git_commit_prefixes: %w[Fixed Added Updated Removed Refactored],
-                           git_tag_sign: false
-                         }
-    end
-
-    def initialize args = [], options = {}, config = {}
-      super args, options, config
-      @configuration = self.class.configuration
-      @tagger = Tagger.new commit_prefixes: @configuration.to_h[:git_commit_prefixes]
-      @pusher = Pusher.new
-      @publisher = Publisher.new tagger: tagger, pusher: pusher
-    rescue Runcom::Errors::Base => error
-      abort error.message
-    end
-
-    desc "-C, [--commits]", "Show commits for next milestone."
-    map %w[-C --commits] => :commits
-    def commits
-      tagger.commit_list.each { |commit| say commit }
-    rescue StandardError => error
-      say_status :error, error.message, :red
-    end
-
-    desc "-t, [--tag=VERSION]", "Tag local repository with new version."
-    map %w[-t --tag] => :tag
-    method_option :sign,
-                  aliases: "-s",
-                  desc: "Sign tag with GPG key.",
-                  type: :boolean,
-                  default: false
-    def tag version
-      tagger.create version, sign: sign_tag?(options[:sign])
-      say "Repository tagged: #{tagger.version}."
-    rescue StandardError => error
-      say_status :error, error.message, :red
-    end
-
-    desc "-p, [--push=VERSION]", "Push local tag to remote repository."
-    map %w[-p --push] => :push
-    def push version
-      pusher.push version
-      say_status :info, "Tags pushed to remote repository.", :green
-    rescue StandardError => error
-      say_status :error, error.message, :red
-    end
-
-    desc "-P, [--publish=VERSION]", "Tag and push milestone to remote repository."
-    map %w[-P --publish] => :publish
-    method_option :sign,
-                  aliases: "-s",
-                  desc: "Sign tag with GPG key.",
-                  type: :boolean,
-                  default: false
-    def publish version
-      publisher.publish version, sign: sign_tag?(options[:sign])
-      say_status :info, "Repository tagged and pushed: #{tagger.version}.", :green
-      say_status :info, "Milestone published!", :green
-    rescue StandardError => error
-      say_status :error, error.message, :red
-    end
-
-    desc "-c, [--config]", "Manage gem configuration."
-    map %w[-c --config] => :config
-    method_option :edit,
-                  aliases: "-e",
-                  desc: "Edit gem configuration.",
-                  type: :boolean,
-                  default: false
-    method_option :info,
-                  aliases: "-i",
-                  desc: "Print gem configuration.",
-                  type: :boolean,
-                  default: false
-    def config
-      path = configuration.current
-
-      if options.edit? then `#{ENV["EDITOR"]} #{path}`
-      elsif options.info?
-        path ? say(path) : say("Configuration doesn't exist.")
-      else help :config
-      end
-    end
-
-    desc "-v, [--version]", "Show gem version."
-    map %w[-v --version] => :version
-    def version
-      say Identity::VERSION_LABEL
-    end
-
-    desc "-h, [--help=COMMAND]", "Show this message or get help for a command."
-    map %w[-h --help] => :help
-    def help task = nil
-      say and super
-    end
-
-    private
-
-    attr_reader :configuration, :tagger, :pusher, :publisher
-
-    def sign_tag? sign
-      sign | configuration.to_h[:git_tag_sign]
-    end
-  end
-end

data/lib/milestoner/errors/base.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  module Errors
-    # The base class for all Milestoner related errors.
-    class Base < StandardError
-      def initialize message = "Invalid Milestoner action."
-        super message
-      end
-    end
-  end
-end

data/lib/milestoner/errors/duplicate_tag.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  module Errors
-    # Raised for duplicate tags.
-    class DuplicateTag < Base
-    end
-  end
-end

data/lib/milestoner/errors/git.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  module Errors
-    # Raised for projects not initialized as Git repositories.
-    class Git < Base
-      def initialize message = "Invalid Git repository."
-        super message
-      end
-    end
-  end
-end

data/lib/milestoner/git/config.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require "open3"
-
-module Milestoner
-  module Git
-    # A lightweight Git Config wrapper.
-    class Config
-      def initialize shell: Open3
-        @shell = shell
-      end
-
-      def get key
-        shell.capture3 "git config --get #{key}"
-      end
-
-      def set key, value
-        shell.capture3 %(git config --add #{key} "#{value}")
-      end
-
-      def value key
-        get(key).first.chomp
-      end
-
-      private
-
-      attr_reader :shell
-    end
-  end
-end

data/lib/milestoner/git/kit.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  module Git
-    # A lightweight Git wrapper.
-    class Kit
-      def initialize
-        @git_dir = File.join Dir.pwd, ".git"
-      end
-
-      def supported?
-        File.exist? git_dir
-      end
-
-      def commits?
-        !shell("git log").empty?
-      end
-
-      def push_tags
-        shell "git push --tags"
-      end
-
-      def tagged?
-        !shell("git tag").empty?
-      end
-
-      def tag_local? tag
-        shell("git tag --list #{tag}").match?(/\A#{tag}\Z/)
-      end
-
-      def tag_remote? tag
-        shell("git ls-remote --tags origin #{tag}").match?(%r(.+tags/#{tag}\Z))
-      end
-
-      def remote?
-        !shell("git config remote.origin.url").empty?
-      end
-
-      private
-
-      attr_reader :git_dir
-
-      def shell command
-        String `#{command}`
-      end
-    end
-  end
-end

data/lib/milestoner/publisher.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  # Handles the tagging and pushing of a milestone to a remote repository.
-  class Publisher
-    def initialize tagger: Tagger.new, pusher: Pusher.new
-      @tagger = tagger
-      @pusher = pusher
-    end
-
-    # :reek:BooleanParameter
-    def publish version, sign: false
-      tagger.create version, sign: sign
-      pusher.push version
-    end
-
-    private
-
-    attr_reader :tagger, :pusher
-  end
-end

data/lib/milestoner/pusher.rb

@@ -1,28 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  # Handles publishing of Git tags to remote repository.
-  class Pusher
-    def initialize git: Git::Kit.new
-      @git = git
-    end
-
-    def push version
-      version = Versionaire::Version version
-
-      fail Errors::Git, "Remote repository not configured." unless git.remote?
-      fail Errors::Git, "Remote tag exists: #{version}." if tag_exists? version
-      return if git.push_tags.empty?
-
-      fail Errors::Git, "Tags could not be pushed to remote repository."
-    end
-
-    private
-
-    attr_reader :git, :version
-
-    def tag_exists? version
-      git.tag_remote? version
-    end
-  end
-end

data/lib/milestoner/tagger.rb

@@ -1,115 +0,0 @@
-# frozen_string_literal: true
-
-require "open3"
-require "thor"
-require "versionaire"
-require "tempfile"
-
-module Milestoner
-  # Handles the tagging of a project repository.
-  # :reek:TooManyMethods
-  # :reek:InstanceVariableAssumption
-  class Tagger
-    attr_reader :version, :commit_prefixes
-
-    def initialize commit_prefixes: [], git: Git::Kit.new
-      @commit_prefixes = commit_prefixes
-      @git = git
-      @shell = Thor::Shell::Color.new
-    end
-
-    def commit_prefix_regex
-      return Regexp.new "" if commit_prefixes.empty?
-
-      Regexp.union commit_prefixes
-    end
-
-    def commits
-      groups = build_commit_prefix_groups
-      group_by_commit_prefix groups
-      groups.each_value(&:sort!)
-      groups.values.flatten.uniq
-    end
-
-    def commit_list
-      commits.map { |commit| "- #{commit}" }
-    end
-
-    # :reek:BooleanParameter
-    def create version, sign: false
-      @version = Versionaire::Version version
-      fail Errors::Git, "Unable to tag without commits." unless git.commits?
-      return if existing_tag?
-
-      git_tag sign: sign
-    end
-
-    private
-
-    attr_reader :git, :shell
-
-    def git_log_command
-      "git log --oneline --no-merges --format='%s'"
-    end
-
-    def git_tag_command
-      "$(git describe --abbrev=0 --tags --always)..HEAD"
-    end
-
-    def git_commits_command
-      return "#{git_log_command} #{git_tag_command}" if git.tagged?
-
-      git_log_command
-    end
-
-    def raw_commits
-      `#{git_commits_command}`.split "\n"
-    end
-
-    def build_commit_prefix_groups
-      groups = commit_prefixes.map.with_object({}) { |prefix, group| group.merge! prefix => [] }
-      groups.merge! "Other" => []
-    end
-
-    def group_by_commit_prefix groups = {}
-      raw_commits.each do |commit|
-        prefix = commit[commit_prefix_regex]
-        key = groups.key?(prefix) ? prefix : "Other"
-        groups[key] << commit.gsub(/\[ci\sskip\]/, "").squeeze(" ").strip
-      end
-    end
-
-    def git_message
-      %(Version #{@version}\n\n#{commit_list.join "\n"}\n\n)
-    end
-
-    # :reek:BooleanParameter
-    # :reek:ControlParameter
-    def git_options message_file, sign: false
-      options = %(--sign --annotate "#{@version}" ) +
-                %(--cleanup verbatim --file "#{message_file.path}")
-      return options.gsub "--sign ", "" unless sign
-
-      options
-    end
-
-    def existing_tag?
-      return false unless git.tag_local? @version
-
-      shell.say_status :warn, "Local tag exists: #{@version}. Skipped.", :yellow
-      true
-    end
-
-    # :reek:BooleanParameter
-    # :reek:TooManyStatements
-    def git_tag sign: false
-      message_file = Tempfile.new Identity::NAME
-      File.open(message_file, "w") { |file| file.write git_message }
-      status = system "git tag #{git_options message_file, sign: sign}"
-      fail Errors::Git, "Unable to create tag: #{@version}." unless status
-    ensure
-      message_file.close
-      message_file.unlink
-    end
-  end
-end