milestoner 11.2.0 → 12.0.0

data/lib/milestoner/cli/parsers/security.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module CLI
+    module Parsers
+      # Handles parsing of Command Line Interface (CLI) security options.
+      class Security
+        def self.call configuration = Configuration::Loader.call, client: CLIENT
+          new(configuration, client: client).call
+        end
+
+        def initialize configuration = Configuration::Loader.call, client: CLIENT
+          @configuration = configuration
+          @client = client
+        end
+
+        def call arguments = []
+          client.separator "\nSECURITY OPTIONS:\n"
+          add_sign
+          arguments.empty? ? arguments : client.parse!(arguments)
+        end
+
+        private
+
+        attr_reader :configuration, :client
+
+        def add_sign
+          client.on(
+            "--[no-]sign",
+            %(Sign with GPG key. Default: #{configuration.git_tag_sign}.)
+          ) do |value|
+            compute_git_tag_sign value
+          end
+        end
+
+        def compute_git_tag_sign value
+          truth_table = [true, false].repeated_permutation(2).to_a
+
+          case truth_table.index [value, configuration.git_tag_sign]
+            when 0..1 then configuration.git_tag_sign = true
+            when 2..3 then configuration.git_tag_sign = false
+            else fail Error, "--sign must be a boolean. Check gem configuration."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/cli/shell.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module CLI
+    # The main Command Line Interface (CLI) object.
+    class Shell
+      ACTIONS = {
+        config: Actions::Config.new,
+        publish: Actions::Publish.new,
+        status: Actions::Status.new
+      }.freeze
+
+      def initialize parser: Parsers::Assembler.new, actions: ACTIONS, container: Container
+        @parser = parser
+        @actions = actions
+        @container = container
+      end
+
+      def call arguments = []
+        perform parser.call(arguments)
+      rescue OptionParser::ParseError, Error => error
+        logger.error error.message
+      end
+
+      private
+
+      attr_reader :parser, :actions, :container
+
+      def perform configuration
+        case configuration
+          in action_config: Symbol => action then config action
+          in action_publish: true then publish configuration
+          in action_status: true then status
+          in action_version: String => version then logger.info version
+          in action_help: then usage
+          else usage
+        end
+      end
+
+      def config(action) = actions.fetch(__method__).call(action)
+
+      def publish(configuration) = actions.fetch(__method__).call(configuration)
+
+      def status = actions.fetch(__method__).call
+
+      def usage = logger.unknown { parser.to_s }
+
+      def logger = container[__method__]
+    end
+  end
+end

data/lib/milestoner/commits/categorizer.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "versionaire"
+
+module Milestoner
+  module Commits
+    # Retrieves and categorizes Git repository commit tagged or untagged history.
+    class Categorizer
+      def initialize expression: Regexp, container: Container
+        @expression = expression
+        @container = container
+      end
+
+      def call configuration = CLI::Configuration::Loader.call
+        prefixes = configuration.git_commit_prefixes
+
+        prefixes.reduce({}) { |group, prefix| group.merge prefix => [] }
+                .merge("Unknown" => [])
+                .then { |groups| group_by_prefix prefixes, groups }
+                .each_value { |commits| commits.sort_by!(&:subject) }
+                .values
+                .flatten
+                .uniq(&:subject)
+      end
+
+      private
+
+      attr_reader :expression, :container
+
+      def group_by_prefix prefixes, groups
+        computed_commits.each.with_object groups do |commit, collection|
+          prefix = commit.subject[subject_pattern(prefixes)]
+          key = collection.key?(prefix) ? prefix : "Unknown"
+          collection[key] << commit
+        end
+      end
+
+      def subject_pattern prefixes
+        prefixes.empty? ? expression.new(//) : expression.union(prefixes)
+      end
+
+      def computed_commits = repository.tagged? ? tagged_commits : saved_commits
+
+      def tagged_commits = repository.commits("#{repository.tag_last}..HEAD")
+
+      def saved_commits = repository.commits
+
+      def repository = container[__method__]
+    end
+  end
+end

data/lib/milestoner/container.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "dry-container"
+require "git_plus"
+require "logger"
+require "pastel"
+
+module Milestoner
+  # Provides a global gem container for injection into other objects.
+  module Container
+    extend Dry::Container::Mixin
+
+    register(:configuration) { CLI::Configuration::Loader.call }
+    register(:colorizer) { Pastel.new enabled: $stdout.tty? }
+    register(:kernel) { Kernel }
+
+    register :log_colors do
+      {
+        "DEBUG" => self[:colorizer].white.detach,
+        "INFO" => self[:colorizer].green.detach,
+        "WARN" => self[:colorizer].yellow.detach,
+        "ERROR" => self[:colorizer].red.detach,
+        "FATAL" => self[:colorizer].white.bold.on_red.detach,
+        "ANY" => self[:colorizer].white.bold.detach
+      }
+    end
+
+    register :logger do
+      Logger.new $stdout,
+                 level: Logger.const_get(ENV.fetch("LOG_LEVEL", "INFO")),
+                 formatter: (
+                   lambda do |severity, _at, _name, message|
+                     self[:log_colors][severity].call "#{message}\n"
+                   end
+                 )
+    end
+
+    register(:repository) { GitPlus::Repository.new }
+  end
+end

data/lib/milestoner/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Milestoner
+  # The base class for all Milestoner related errors.
+  class Error < StandardError
+  end
+end

data/lib/milestoner/identity.rb

@@ -5,7 +5,8 @@ module Milestoner
   module Identity
     NAME = "milestoner"
     LABEL = "Milestoner"
-    VERSION = "11.2.0"
+    VERSION = "12.0.0"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
+    SUMMARY = "A command line interface for crafting Git repository tags."
   end
 end

data/lib/milestoner/presenters/commit.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "forwardable"
+require "git_plus"
+
+module Milestoner
+  module Presenters
+    # Wraps the Git Kit Commit for presentation purposes.
+    class Commit
+      extend Forwardable
+
+      delegate [*GitPlus::Commit.members, :fixup?, :squash?] => :record
+
+      def initialize record, container: Container
+        @record = record
+        @container = container
+      end
+
+      def line_item(delimiter: " - ") = "#{bullet}#{subject}#{delimiter}#{author_name}"
+
+      private
+
+      attr_reader :record, :container
+
+      def bullet
+        case container[:configuration].documentation_format
+          when "md" then "- "
+          when "adoc" then "* "
+          else ""
+        end
+      end
+    end
+  end
+end

data/lib/milestoner/tags/creator.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "versionaire"
+
+module Milestoner
+  module Tags
+    # Handles the creation of project repository tags.
+    class Creator
+      using Versionaire::Cast
+
+      def initialize categorizer: Commits::Categorizer.new,
+                     presenter: Presenters::Commit,
+                     container: Container
+
+        @categorizer = categorizer
+        @presenter = presenter
+        @container = container
+      end
+
+      def call configuration = CLI::Configuration::Loader.call
+        return false if local? configuration
+        fail Error, "Unable to tag without commits." if categorizer.call.empty?
+
+        sign configuration
+      rescue Versionaire::Errors::Cast, GitPlus::Errors::Base => error
+        raise Error, error.message
+      end
+
+      private
+
+      attr_reader :categorizer, :presenter, :container
+
+      def local? configuration
+        version = Version configuration.git_tag_version
+
+        if repository.tag_local? version
+          logger.warn "Local tag exists: #{version}. Skipped."
+          true
+        else
+          false
+        end
+      end
+
+      def sign configuration
+        version = configuration.git_tag_version
+        content = message configuration
+
+        if configuration.git_tag_sign
+          repository.tag_sign version, content
+        else
+          repository.tag_unsign version, content
+        end
+
+        logger.debug "Local tag created: #{version}."
+      end
+
+      def message configuration
+        categorizer.call(configuration)
+                   .map { |record| presenter.new(record).line_item }
+                   .then do |line_items|
+                     %(Version #{configuration.git_tag_version}\n\n#{line_items.join "\n"}\n\n)
+                   end
+      end
+
+      def repository = container[__method__]
+
+      def logger = container[__method__]
+    end
+  end
+end

data/lib/milestoner/tags/publisher.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module Tags
+    # Handles the tagging and pushing of a tag to a remote repository.
+    class Publisher
+      def initialize tagger: Tags::Creator.new, pusher: Tags::Pusher.new, container: Container
+        @tagger = tagger
+        @pusher = pusher
+        @container = container
+      end
+
+      def call configuration = CLI::Configuration::Loader.call
+        tagger.call configuration
+        pusher.call configuration
+        logger.info { "Published: #{configuration.git_tag_version}!" }
+      end
+
+      private
+
+      attr_reader :tagger, :pusher, :container
+
+      def logger = container[__method__]
+    end
+  end
+end

data/lib/milestoner/tags/pusher.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "versionaire"
+
+module Milestoner
+  module Tags
+    # Handles publishing of tags to a remote repository.
+    class Pusher
+      using Versionaire::Cast
+
+      def initialize container: Container
+        @container = container
+      end
+
+      def call configuration = CLI::Configuration::Loader.call
+        version = Version configuration.git_tag_version
+
+        fail Error, "Remote repository not configured." unless repository.config_origin?
+        fail Error, "Remote tag exists: #{version}." if repository.tag_remote? version
+        fail Error, "Tags could not be pushed to remote repository." unless push
+
+        logger.debug "Local tag pushed: #{version}."
+      end
+
+      private
+
+      attr_reader :container
+
+      def push
+        repository.tag_push.then do |_stdout, stderr, status|
+          status.success? && stderr.match?(/[new tag]/)
+        end
+      end
+
+      def repository = container[__method__]
+
+      def logger = container[__method__]
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 11.2.0
+  version: 12.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,8 +28,22 @@ cert_chain:
   lkHilIrX69jq8wMPpBhlaw2mRmeSL50Wv5u6xVBvOHhXFSP1crXM95vfLhLyRYod
   W2A=
   -----END CERTIFICATE-----
-date: 2021-04-04 00:00:00.000000000 Z
+date: 2021-06-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-container
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: git_plus
   requirement: !ruby/object:Gem::Requirement
@@ -44,6 +58,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: pastel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: refinements
   requirement: !ruby/object:Gem::Requirement
@@ -73,33 +101,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: thor
+  name: versionaire
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '9.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '9.2'
 - !ruby/object:Gem::Dependency
-  name: versionaire
+  name: zeitwerk
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.0'
+        version: '2.4'
 description:
 email:
 - brooke@alchemists.io
@@ -114,15 +142,25 @@ files:
 - README.adoc
 - bin/milestoner
 - lib/milestoner.rb
-- lib/milestoner/cli.rb
-- lib/milestoner/commit.rb
-- lib/milestoner/errors/base.rb
-- lib/milestoner/errors/duplicate_tag.rb
-- lib/milestoner/errors/git.rb
+- lib/milestoner/cli/actions/config.rb
+- lib/milestoner/cli/actions/publish.rb
+- lib/milestoner/cli/actions/status.rb
+- lib/milestoner/cli/configuration/content.rb
+- lib/milestoner/cli/configuration/defaults.yml
+- lib/milestoner/cli/configuration/loader.rb
+- lib/milestoner/cli/parsers.rb
+- lib/milestoner/cli/parsers/assembler.rb
+- lib/milestoner/cli/parsers/core.rb
+- lib/milestoner/cli/parsers/security.rb
+- lib/milestoner/cli/shell.rb
+- lib/milestoner/commits/categorizer.rb
+- lib/milestoner/container.rb
+- lib/milestoner/error.rb
 - lib/milestoner/identity.rb
-- lib/milestoner/publisher.rb
-- lib/milestoner/pusher.rb
-- lib/milestoner/tagger.rb
+- lib/milestoner/presenters/commit.rb
+- lib/milestoner/tags/creator.rb
+- lib/milestoner/tags/publisher.rb
+- lib/milestoner/tags/pusher.rb
 homepage: https://www.alchemists.io/projects/milestoner
 licenses:
 - Apache-2.0
@@ -146,8 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.2.19
 signing_key:
 specification_version: 4
-summary: A command line interface for crafting Git repository milestones.
+summary: A command line interface for crafting Git repository tags.
 test_files: []