milestoner 11.2.0 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 162f8f50f2f6d09758f25aff2e10a416e19b15e2d8468b28c8c58b9fa3f363af
-  data.tar.gz: 7d2401141fd1ad1596f10ef30b093fb1844d56fe43594b0dcd40844614ac3691
+  metadata.gz: e354d38d2b846b1a2a81a3ca0d028162996117fc085456aa51f4e9d43c304abc
+  data.tar.gz: a8ea79c2c41ad41aefa14227732730ecf5641019767f02babbd98b92fbfcc6cf
 SHA512:
-  metadata.gz: 6c6a6171c291547866078bfb165cfe70b5d4b20c6d09c09a9be0d810678a2985955a26f22fb3cfe4df56ce51b82b4a18d35662e576287408dbae6112c718b42a
-  data.tar.gz: 5067878d843e14e8048a27fc0a5a4febaee780f8f207a3b9035fd12e4c01c42f8151c981de909bf98fe413a35f52e104424872a9fa87840948a10df448c6a555
+  metadata.gz: bedab4bb46309260ae5f06f04eab4039d612ac70eeed58bcefee7051895a3c455c56d7650764d9174c96741f2a300bc709a8004d6d34208942f81ce9d2e955db
+  data.tar.gz: e395deb28d54854f649bcbfa1c8f995d04e482b8bd05e66b2af531c283abe145b2de3dc2e776a8c06760946c1b5dc8a6c3e6ed861c5233379059f562fdb80b37

data.tar.gz.sig

@@ -1,2 +1,2 @@
-[��H�����&�)!�C�H���g��hk+���[�K�'�3�m��7��Z�J�nƄ<�
-�g�Hf<��t2m���J�Q��OjN]eˢR��f������v�âTG�T���[[���5U�)��['���ٽb����u:���H}»Lvb?1�b,D��24}L6K��Y�-Ig5)��3��$
+�r�Il S���zA���-Q�oErq���h�-�`����
+\�P�d�:a�վ�#� �ƻ�,������eȃ@�<�s�ƌ�)���E��r��qV�V������4m�@�R��N��{-)���6Qݴ���4sX�=3��վ z#�]Y�7�V�cJɕ-we���
�*����+Jf�.�kB԰&<W��

data/README.adoc

@@ -23,8 +23,8 @@ toc::[]
 ** Example: `+0.1.0+`.
 * Ensures Git commits since last tag (or initialization of repository) are included.
 * Ensures Git commit messages are grouped by prefix, in order defined. For more details, see
-  link:https://www.alchemists.io/projects/git-cop/#_commit_subject_prefix[Git Cop Subject Prefix]
-  for details. Defaults (can be customized):
+  link:https://www.alchemists.io/projects/git-lint/#_commit_subject_prefix[Git Lint Commit Subject
+  Prefix] for details. Defaults (can be customized):
 ** Fixed
 ** Added
 ** Updated
@@ -34,11 +34,6 @@ toc::[]
 * Ensures duplicate Git commit messages are removed (if any).
 * Provides optional security for signing Git tags with https://www.gnupg.org[GnuPG] signing key.
 
-== Screencasts
-
-[link=https://www.alchemists.io/screencasts/milestoner]
-image::https://www.alchemists.io/images/screencasts/milestoner/cover.svg[Screencast,600,240,role=focal_point]
-
 == Requirements
 
 . A UNIX-based system.
@@ -58,41 +53,36 @@ gem install milestoner
 
 === Command Line Interface (CLI)
 
-From the command line, type: `+milestoner help+`
+From the command line, type: `milestoner --help`
 
 ....
-milestoner -C, [--commits]          # Show commits for next milestone.
-milestoner -P, [--publish=VERSION]  # Tag and push milestone to remote repository.
-milestoner -c, [--config]           # Manage gem configuration.
-milestoner -h, [--help=COMMAND]     # Show this message or get help for a command.
-milestoner -p, [--push=VERSION]     # Push local tag to remote repository.
-milestoner -t, [--tag=VERSION]      # Tag local repository with new version.
-milestoner -v, [--version]          # Show gem version.
+USAGE:
+  -c, --config ACTION                      Manage gem configuration. Actions: edit || view.
+  -h, --help                               Show this message.
+  -P, --publish VERSION                    Tag and push milestone to remote repository.
+  -s, --status                             Show project status.
+  -v, --version                            Show gem version.
+
+SECURITY OPTIONS:
+      --[no-]sign                          Sign with GPG key. Default: true.
 ....
 
-For config options, type: `+milestoner help --config+`
+Examples:
 
-....
--e, [--edit], [--no-edit]  # Edit gem configuration.
--i, [--info], [--no-info]  # Print gem configuration info.
-....
-
-For tag options, type: `+milestoner help --tag+`
-
-....
--s, [--sign], [--no-sign]  # Sign tag with GPG key.
-....
+[source,bash]
+----
+milestoner --config edit
+milestoner --config view
 
-For publish options, type: `+milestoner help --publish+`
+milestoner --help
 
-....
--s, [--sign], [--no-sign]  # Sign tag with GPG key.
-....
+milestoner --publish 0.1.0
+milestoner --publish 0.1.0 --sign
+milestoner --publish 0.1.0 --no-sign
 
-When using Milestoner, the `+--publish+` command is intended to be the only command necessary for
-publishing a new release as it handles all of the steps necessary for tagging and pushing a new
-milestone. Should individual steps be needed, then the `+--tag+` and `+--push+` options are
-available.
+milestoner --status
+milestoner --version
+----
 
 === Customization
 
@@ -108,13 +98,18 @@ The default configuration is as follows:
 
 [source,yaml]
 ----
-:git_commit_prefixes:
-  - Fixed
-  - Added
-  - Updated
-  - Removed
-  - Refactored
-:git_tag_sign: false
+:documentation:
+  :format: "md"
+:git:
+  :commit:
+    :prefixes:
+      - Fixed
+      - Added
+      - Updated
+      - Removed
+      - Refactored
+  :tag:
+    :sign: false
 ----
 
 Feel free to take this default configuration, modify, and save as your own custom
@@ -122,15 +117,18 @@ Feel free to take this default configuration, modify, and save as your own custo
 
 The `+configuration.yml+` file can be configured as follows:
 
-* `+git_commit_prefixes+`: Should the default prefixes not be desired, you can define Git commit
-prefixes that match your style. _NOTE: Prefix order is important with the first prefix defined
-taking precedence over the second and so forth._ Special characters are allowed for prefixes but
-should be enclosed in quotes. To disable prefix usage completely, use an empty array. Example:
-`+:git_commit_prefixes: []+`.
-* `+git_tag_sign+`: Defaults to `+false+` but can be enabled by setting to `+true+`. When enabled, a
-Git tag will require GPG signing for enhanced security and include a signed signature as part of the
-Git tag. This is useful for public milestones where the author of a milestone can be verified to
-ensure milestone integrity/security.
+* *Documenation Format*: Determines what format the status information should be rendered. Defaults
+  to link:https://daringfireball.net/projects/markdown[Markdown] (i.e. `md`) but
+  link:https://asciidoctor.org/docs/what-is-asciidoc[ASCII Doc] (i.e. `adoc`) is supported too.
+* *Git Commit Prefixes*: Should the default prefixes not be desired, you can define Git commit
+  prefixes that match your style. _NOTE: Prefix order is important with the first prefix defined
+  taking precedence over the second and so forth._ Special characters are allowed for prefixes but
+  should be enclosed in quotes. To disable prefix usage completely, use an empty array. Example:
+  `:prefixes: []`.
+* *Git Tag Sign*: Defaults to `false` but can be enabled by setting to `true`. When enabled, a
+  Git tag will require GPG signing for enhanced security and include a signed signature as part of
+  the Git tag. This is useful for public milestones where the author of a milestone can be verified
+  to ensure milestone integrity/security.
 
 == Security
 

data/bin/milestoner

@@ -2,8 +2,6 @@
 # frozen_string_literal: true
 
 require "milestoner"
-require "milestoner/cli"
-require "milestoner/identity"
 
 Process.setproctitle Milestoner::Identity::VERSION_LABEL
-Milestoner::CLI.start
+Milestoner::CLI::Shell.new.call ARGV

data/lib/milestoner.rb

@@ -1,12 +1,11 @@
 # frozen_string_literal: true
 
-require "git_plus"
-require "milestoner/identity"
-require "milestoner/errors/base"
-require "milestoner/errors/duplicate_tag"
-require "milestoner/errors/git"
-require "milestoner/commit"
-require "milestoner/tagger"
-require "milestoner/pusher"
-require "milestoner/publisher"
-require "milestoner/cli"
+require "zeitwerk"
+
+loader = Zeitwerk::Loader.for_gem
+loader.inflector.inflect "cli" => "CLI"
+loader.setup
+
+# Main namespace.
+module Milestoner
+end

data/lib/milestoner/cli/actions/config.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module CLI
+    module Actions
+      # Handles the gem configuration action.
+      class Config
+        def initialize configuration: Configuration::Loader::HANDLER, container: Container
+          @configuration = configuration
+          @container = container
+        end
+
+        def call action
+          case action
+            when :edit then edit
+            when :view then view
+            else logger.error { "Invalid configuration action: #{action}." }
+          end
+        end
+
+        private
+
+        attr_reader :configuration, :container
+
+        def edit = kernel.system("$EDITOR #{configuration.current}")
+
+        def view = kernel.system("cat #{configuration.current}")
+
+        def kernel = container[__method__]
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/milestoner/cli/actions/publish.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module CLI
+    module Actions
+      # Handles tag creation and pushing of tag to local repository.
+      class Publish
+        def initialize publisher: Tags::Publisher.new
+          @publisher = publisher
+        end
+
+        def call(configuration) = publisher.call(configuration)
+
+        private
+
+        attr_reader :publisher
+      end
+    end
+  end
+end

data/lib/milestoner/cli/actions/status.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module CLI
+    module Actions
+      # Handles listing project status of untagged commit history.
+      class Status
+        def initialize presenter: Presenters::Commit,
+                       categorizer: Commits::Categorizer.new,
+                       container: Container
+          @presenter = presenter
+          @categorizer = categorizer
+          @container = container
+        end
+
+        def call
+          categorizer.call
+                     .tap { |records| info "All is quiet." if records.empty? }
+                     .map { |record| presenter.new(record).line_item }
+                     .each { |line_item| info line_item }
+        end
+
+        private
+
+        attr_reader :presenter, :categorizer, :container
+
+        def info(message) = logger.info { message }
+
+        def logger = container[__method__]
+      end
+    end
+  end
+end

data/lib/milestoner/cli/configuration/content.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Milestoner
+  module CLI
+    module Configuration
+      # Defines configuration content as the primary source of truth for use throughout the gem.
+      Content = Struct.new :action_config,
+                           :action_publish,
+                           :action_push,
+                           :action_status,
+                           :action_tag,
+                           :action_version,
+                           :action_help,
+                           :documentation_format,
+                           :git_commit_prefixes,
+                           :git_tag_sign,
+                           :git_tag_version,
+                           keyword_init: true
+    end
+  end
+end

data/lib/milestoner/cli/configuration/defaults.yml

@@ -0,0 +1,12 @@
+:documentation:
+  :format: "md"
+:git:
+  :commit:
+    :prefixes:
+      - Fixed
+      - Added
+      - Updated
+      - Removed
+      - Refactored
+  :tag:
+    :sign: false

data/lib/milestoner/cli/configuration/loader.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require "pathname"
+require "refinements/hashes"
+require "refinements/structs"
+require "runcom"
+require "yaml"
+
+module Milestoner
+  module CLI
+    module Configuration
+      # Represents the fully assembled Command Line Interface (CLI) configuration.
+      class Loader
+        using Refinements::Hashes
+        using Refinements::Structs
+
+        DEFAULTS = YAML.load_file(Pathname(__dir__).join("defaults.yml")).freeze
+        HANDLER = Runcom::Config.new "#{Identity::NAME}/configuration.yml", defaults: DEFAULTS
+
+        def self.call = new.call
+
+        def self.with_defaults = new(handler: DEFAULTS)
+
+        def initialize content: Content.new, handler: HANDLER
+          @content = content
+          @handler = handler
+        end
+
+        def call = content.merge(**handler.to_h.flatten_keys)
+
+        private
+
+        attr_reader :content, :handler
+      end
+    end
+  end
+end

data/lib/milestoner/cli/parsers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+module Milestoner
+  module CLI
+    module Parsers
+      CLIENT = OptionParser.new nil, 40, "  "
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require "runcom"
+
+module Milestoner
+  module CLI
+    module Parsers
+      SECTIONS = [Core, Security].freeze # Order is important.
+
+      # Assembles and parses all Command Line Interface (CLI) options.
+      class Assembler
+        def initialize configuration = CLI::Configuration::Loader.call,
+                       sections: SECTIONS,
+                       client: CLIENT
+          @configuration = configuration
+          @sections = sections
+          @client = client
+        end
+
+        def call arguments = []
+          sections.each { |parser| parser.call configuration, client: client }
+          client.parse! arguments
+          configuration
+        end
+
+        def to_s = client.to_s
+
+        private
+
+        attr_reader :configuration, :client, :sections
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+require "versionaire/extensions/option_parser"
+require "refinements/structs"
+
+module Milestoner
+  module CLI
+    # Handles parsing of Command Line Interface (CLI) primary options.
+    module Parsers
+      using Refinements::Structs
+
+      # Handles parsing of Command Line Interface (CLI) core options.
+      class Core
+        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.banner = "#{Identity::LABEL} - #{Identity::SUMMARY}"
+          client.separator "\nUSAGE:\n"
+          collate
+          arguments.empty? ? arguments : client.parse!(arguments)
+        end
+
+        private
+
+        attr_reader :configuration, :client
+
+        def collate = private_methods.sort.grep(/add_/).each { |method| __send__ method }
+
+        def add_config
+          client.on(
+            "-c",
+            "--config ACTION",
+            %i[edit view],
+            "Manage gem configuration. Actions: edit || view."
+          ) do |action|
+            configuration.action_config = action
+          end
+        end
+
+        def add_publish
+          client.on(
+            "-P",
+            "--publish VERSION",
+            Versionaire::Version,
+            "Tag and push milestone to remote repository."
+          ) do |version|
+            configuration.merge! action_publish: true, git_tag_version: version
+          end
+        end
+
+        def add_status
+          client.on "-s", "--status", "Show project status." do
+            configuration.action_status = true
+          end
+        end
+
+        def add_version
+          client.on "-v", "--version", "Show gem version." do
+            configuration.action_version = Identity::VERSION_LABEL
+          end
+        end
+
+        def add_help
+          client.on "-h", "--help", "Show this message." do
+            configuration.action_help = true
+          end
+        end
+      end
+    end
+  end
+end