milestoner 10.0.2 → 11.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a578c120a88aac89a49c98fbfb50bb30b17e9303a1dab67f7e7d6029e56e2193
-  data.tar.gz: 4925f570e411f4a432526abc66574170cf0934351c499acc94d9f5d6021e3768
+  metadata.gz: 5152a1a412828716c3e01a280e473011f66335cb0cb007d18603a7fe973fa298
+  data.tar.gz: 325015f1de0b136f8d817c3f24ec96f7b429b8c5bf1847551fdb5cc0cdde420d
 SHA512:
-  metadata.gz: 351f67a208771f8f9c0b1de65bb89645b1b5d4642653e3a9f945ca12b7fc182cd00e8de6ab681f2b75ce5c5077466cc8ed14c01c23e1fd16ac7698f65c3495f3
-  data.tar.gz: e339dc73f6b8b41525c348ec26b2a9b2d8909d7cacd6e22a41ca6c9770a12b8be9cb4437e9481718369d84202fc6b1625af29e8e14d8ab827323041f61a02db8
+  metadata.gz: dc1808ca74a11de0ed5e751faa47832e2c2cbebfcd544c99a045886b004f00bb29c9d80c078fe0b043a802f492e2afddbef289f5c028ac60072a940f14d3d978
+  data.tar.gz: 444fce8423e259ec58ea353464c204a2d94eb4d3de51f04d2ab3bb7cf71f358962ff670c979c2bef354848a6944f75d58e966262d17b304cf518001643b24cd3

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-���W ��0�����m�$�Wϋ"���!	\X4s���(�Q��ZMd1����`t�m��Iā��J��$��ω���HB���);/��W�tc(C# ��:Ҳxr���j�!v�D>b�.�i��m^��H+(?t�\J�e�f���Ia,�;�����?����Q%��M�y�������=�သB�
+���y�.�{yԒ�`/6�5���C�;�kX�[���q�X+�����@ȕ�W!�Q�2B>e}L��F�J��"K�#S��Fc�:����Θ�aQ�	�EV�	��g%�Z-_��
+A�z_M��0�rS�;$��\}Ⱥ,��ѻ�ћ��T�t��O��(��^�/)�xSz�G�j��
��wx$��l{Ɛ��D.*Piۦ�v�c4-���IQ���������4��iZ2 ��b>������e�U-�:��

data/{LICENSE.md → LICENSE.adoc}

@@ -1,4 +1,4 @@
-# Apache License
+= Apache License
 
 Version 2.0, January 2004
 
@@ -6,7 +6,7 @@ http://www.apache.org/licenses
 
 TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
 
-## 1. Definitions
+== 1. Definitions
 
 "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by
 Sections 1 through 9 of this document.
@@ -54,14 +54,14 @@ Contribution."
 "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a
 Contribution has been received by Licensor and subsequently incorporated within the Work.
 
-## 2. Grant of Copyright License
+== 2. Grant of Copyright License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to
 reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and
 distribute the Work and such Derivative Works in Source or Object form.
 
-## 3. Grant of Patent License
+== 3. Grant of Patent License
 
 Subject to the terms and conditions of this License, each Contributor hereby grants to You a
 perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this
@@ -74,39 +74,38 @@ a Contribution incorporated within the Work constitutes direct or contributory p
 then any patent licenses granted to You under this License for that Work shall terminate as of the
 date such litigation is filed.
 
-## 4. Redistribution
+== 4. Redistribution
 
 You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with
 or without modifications, and in Source or Object form, provided that You meet the following
 conditions:
 
-1. You must give any other recipients of the Work or Derivative Works a copy of this License; and
+. You must give any other recipients of the Work or Derivative Works a copy of this License; and
 
-2. You must cause any modified files to carry prominent notices stating that You changed the
-   files; and
+. You must cause any modified files to carry prominent notices stating that You changed the files;
+  and
 
-3. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
-   patent, trademark, and attribution notices from the Source form of the Work, excluding those
-   notices that do not pertain to any part of the Derivative Works; and
+. You must retain, in the Source form of any Derivative Works that You distribute, all copyright,
+  patent, trademark, and attribution notices from the Source form of the Work, excluding those
+  notices that do not pertain to any part of the Derivative Works; and
 
-4. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative
-   Works that You distribute must include a readable copy of the attribution notices contained
-   within such NOTICE file, excluding those notices that do not pertain to any part of the
-   Derivative Works, in at least one of the following places: within a NOTICE text file
-   distributed as part of the Derivative Works; within the Source form or documentation, if
-   provided along with the Derivative Works; or, within a display generated by the Derivative
-   Works, if and wherever such third-party notices normally appear. The contents of the NOTICE
-   file are for informational purposes only and do not modify the License. You may add Your own
-   attribution notices within Derivative Works that You distribute, alongside or as an addendum to
-   the NOTICE text from the Work, provided that such additional attribution notices cannot be
-   construed as modifying the License.
+. If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works
+  that You distribute must include a readable copy of the attribution notices contained within such
+  NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in
+  at least one of the following places: within a NOTICE text file distributed as part of the
+  Derivative Works; within the Source form or documentation, if provided along with the Derivative
+  Works; or, within a display generated by the Derivative Works, if and wherever such third-party
+  notices normally appear. The contents of the NOTICE file are for informational purposes only and
+  do not modify the License. You may add Your own attribution notices within Derivative Works that
+  You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such
+  additional attribution notices cannot be construed as modifying the License.
 
 You may add Your own copyright statement to Your modifications and may provide additional or
 different license terms and conditions for use, reproduction, or distribution of Your modifications,
 or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of
 the Work otherwise complies with the conditions stated in this License.
 
-## 5. Submission of Contributions
+== 5. Submission of Contributions
 
 Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the
 Work by You to the Licensor shall be under the terms and conditions of this License, without any
@@ -114,13 +113,13 @@ additional terms or conditions. Notwithstanding the above, nothing herein shall
 the terms of any separate license agreement you may have executed with Licensor regarding such
 Contributions.
 
-## 6. Trademarks
+== 6. Trademarks
 
 This License does not grant permission to use the trade names, trademarks, service marks, or product
 names of the Licensor, except as required for reasonable and customary use in describing the origin
 of the Work and reproducing the content of the NOTICE file.
 
-## 7. Disclaimer of Warranty
+== 7. Disclaimer of Warranty
 
 Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each
 Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -129,7 +128,7 @@ TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. Y
 responsible for determining the appropriateness of using or redistributing the Work and assume any
 risks associated with Your exercise of permissions under this License.
 
-## 8. Limitation of Liability
+== 8. Limitation of Liability
 
 In no event and under no legal theory, whether in tort (including negligence), contract, or
 otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or
@@ -139,7 +138,7 @@ License or out of the use or inability to use the Work (including but not limite
 loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial
 damages or losses), even if such Contributor has been advised of the possibility of such damages.
 
-## 9. Accepting Warranty or Additional Liability
+== 9. Accepting Warranty or Additional Liability
 
 While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee
 for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights
@@ -151,11 +150,11 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright 2015 [Alchemists](https://www.alchemists.io).
+Copyright 2015 link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].
 
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in
-compliance with the License. You may obtain a [copy](http://www.apache.org/licenses/LICENSE-2.0) of
-the License.
+compliance with the License. You may obtain a link:https://www.apache.org/licenses/LICENSE-2.0[copy]
+of the License.
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is
 distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or

data/README.adoc

@@ -0,0 +1,225 @@
+:toc: macro
+:toclevels: 5
+:figure-caption!:
+
+= Milestoner
+
+[link=http://badge.fury.io/rb/milestoner]
+image::https://badge.fury.io/rb/milestoner.svg[Gem Version]
+[link=https://www.alchemists.io/projects/code_quality]
+image::https://img.shields.io/badge/code_style-alchemists-brightgreen.svg[Alchemists Style Guide]
+[link=https://circleci.com/gh/bkuhlmann/milestoner]
+image::https://circleci.com/gh/bkuhlmann/milestoner.svg?style=svg[Circle CI Status]
+
+A command line interface for crafting Git repository milestones (also known as _tags_).
+
+toc::[]
+
+== Features
+
+* Uses link:https://www.alchemists.io/projects/versionaire[Versionaire] for
+  link:https://semver.org[Semantic Versioning].
+** Format: `+<major>.<minor>.<patch>+`.
+** 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):
+** Fixed
+** Added
+** Updated
+** Removed
+** Refactored
+* Ensures Git commit messages are alphabetically sorted.
+* 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.
+. https://www.ruby-lang.org[Ruby].
+. https://www.gnupg.org[GnuPG].
+
+== Setup
+
+To install, run:
+
+[source,bash]
+----
+gem install milestoner
+----
+
+== Usage
+
+=== Command Line Interface (CLI)
+
+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.
+....
+
+For config options, type: `+milestoner help --config+`
+
+....
+-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.
+....
+
+For publish options, type: `+milestoner help --publish+`
+
+....
+-s, [--sign], [--no-sign]  # Sign tag with GPG key.
+....
+
+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.
+
+=== Customization
+
+This gem can be configured via a global configuration:
+
+....
+~/.config/milestoner/configuration.yml
+....
+
+It can also be configured via https://www.alchemists.io/projects/xdg[XDG] environment variables.
+
+The default configuration is as follows:
+
+[source,yaml]
+----
+:git_commit_prefixes:
+  - Fixed
+  - Added
+  - Updated
+  - Removed
+  - Refactored
+:git_tag_sign: false
+----
+
+Feel free to take this default configuration, modify, and save as your own custom
+`+configuration.yml+`.
+
+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.
+
+== Security
+
+To securely sign your Git tags, install and configure https://www.gnupg.org[GPG]:
+
+[source,bash]
+----
+brew install gpg
+gpg --gen-key
+----
+
+When creating your GPG key, choose these settings:
+
+* Key kind: RSA and RSA (default)
+* Key size: 4096
+* Key validity: 0
+* Real Name: `+<your name>+`
+* Email: `+<your email>+`
+* Passphrase: `+<your passphrase>+`
+
+To obtain your key, run the following and take the part after the forward slash:
+
+....
+gpg --list-keys | grep pub
+....
+
+Add your key to your global Git configuration in the `+[user]+` section. Example:
+
+....
+[user]
+  signingkey = <your GPG key>
+....
+
+Now, when publishing a new milestone (i.e. `+milestoner --publish <version> --sign+`), signing of
+your Git tag will happen automatically. You will be prompted for the GPG Passphrase each time but
+that is to be expected.
+
+== Development
+
+To contribute, run:
+
+[source,bash]
+----
+git clone https://github.com/bkuhlmann/milestoner.git
+cd milestoner
+bin/setup
+----
+
+You can also use the IRB console for direct access to all objects:
+
+[source,bash]
+----
+bin/console
+----
+
+== Tests
+
+To test, run:
+
+[source,bash]
+----
+bundle exec spec
+----
+
+== Versioning
+
+Read link:https://semver.org[Semantic Versioning] for details. Briefly, it means:
+
+* Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+* Minor (x.Y.z) - Incremented for new, backwards compatible, public API enhancements/fixes.
+* Patch (x.y.Z) - Incremented for small, backwards compatible, bug fixes.
+
+== Code of Conduct
+
+Please note that this project is released with a link:CODE_OF_CONDUCT.adoc[CODE OF CONDUCT]. By
+participating in this project you agree to abide by its terms.
+
+== Contributions
+
+Read link:CONTRIBUTING.adoc[CONTRIBUTING] for details.
+
+== License
+
+Read link:LICENSE.adoc[LICENSE] for details.
+
+== History
+
+Read link:CHANGES.adoc[CHANGES] for details.
+
+== Credits
+
+Engineered by link:https://www.alchemists.io/team/brooke_kuhlmann[Brooke Kuhlmann].

data/bin/milestoner

@@ -5,5 +5,5 @@ require "milestoner"
 require "milestoner/cli"
 require "milestoner/identity"
 
-Process.setproctitle Milestoner::Identity.version_label
+Process.setproctitle Milestoner::Identity::VERSION_LABEL
 Milestoner::CLI.start

data/lib/milestoner.rb

@@ -1,11 +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/git/config"
-require "milestoner/git/kit"
+require "milestoner/commit"
 require "milestoner/tagger"
 require "milestoner/pusher"
 require "milestoner/publisher"

data/lib/milestoner/cli.rb

@@ -9,10 +9,10 @@ module Milestoner
   class CLI < Thor
     include Thor::Actions
 
-    package_name Identity.version_label
+    package_name Identity::VERSION_LABEL
 
     def self.configuration
-      Runcom::Config.new "#{Identity.name}/configuration.yml",
+      Runcom::Config.new "#{Identity::NAME}/configuration.yml",
                          defaults: {
                            git_commit_prefixes: %w[Fixed Added Updated Removed Refactored],
                            git_tag_sign: false
@@ -46,7 +46,7 @@ module Milestoner
                   default: false
     def tag version
       tagger.create version, sign: sign_tag?(options[:sign])
-      say "Repository tagged: #{tagger.version}."
+      say "Repository tagged: #{version}."
     rescue StandardError => error
       say_status :error, error.message, :red
     end
@@ -69,7 +69,7 @@ module Milestoner
                   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, "Repository tagged and pushed: #{version}.", :green
       say_status :info, "Milestone published!", :green
     rescue StandardError => error
       say_status :error, error.message, :red
@@ -100,7 +100,7 @@ module Milestoner
     desc "-v, [--version]", "Show gem version."
     map %w[-v --version] => :version
     def version
-      say Identity.version_label
+      say Identity::VERSION_LABEL
     end
 
     desc "-h, [--help=COMMAND]", "Show this message or get help for a command."

data/lib/milestoner/commit.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "forwardable"
+
+module Milestoner
+  # Wraps the Git Kit Commit for presentation purposes.
+  class Commit
+    extend Forwardable
+
+    delegate [*GitPlus::Commit.members, :fixup?, :squash?] => :source
+
+    def initialize source
+      @source = source
+    end
+
+    def subject_author delimiter: " - "
+      "#{subject}#{delimiter}#{author_name}"
+    end
+
+    private
+
+    attr_reader :source
+  end
+end