milestoner 10.2.0 → 11.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 230253de2d1891b5f81d32c0d3650c2978e442be5d7941f7a72a241eacb3a3de
-  data.tar.gz: bb892f84520d3fd92a22bbf1a55e2b485597859e92bf28ef2afc99baee20e640
+  metadata.gz: 0d13ba3b26332960cca2e9eecec51fa1f6e0b1a976310eeedfa710e705a2281f
+  data.tar.gz: 434f1ed0c6521fd8bcd2611326a2245377f8dd6d448feb8863b57e9c29f4806a
 SHA512:
-  metadata.gz: 3892074d05c2e52320196c16d546d58d99694d916fb38bb79c5ce687bc70cc3ba0d06d2745566b18284ff255c6a351137f44ba6961b716d1090e010ea9496f02
-  data.tar.gz: 6b00430b9c0a686dfc402c60de01283b74d369b7e199db4ce9eb7f578c07c9acfd5296496a6c9864ad865027c87c0df086b955b5f3815afb0df7771a72c4f563
+  metadata.gz: 134d13f84802ba1a167e5d1d5a540c56cadd9ebdcbaf2e63cbad6723b75ef2504b94b26311f0e4d75fa6456a09e33a9e34bb39cdf1930f01861dd38ea9f71d4a
+  data.tar.gz: 7512c0210dac0bdd1d6c6fd87817a11f6d9638ee4b648a731fb6a99a8351ab17f087f8b4c8091b88b2cfb15ca02edd0a8b84bcc1ff0cf4f219a4b004c4c49f43

checksums.yaml.gz.sig

@@ -1,2 +1 @@
-���"��莆�����锄�,��p_p��~��J��v_�&,&u��|�3<YS�L���c�����S<G=��$�Dw�����x0ϵF�#Wᘁs�05���AӲHT>�$q���5���刬p�
-��5Z�C���;�;�x`���	n���|x�@�P{u=_*��H�Z��MnI���𗽕��̫F�)�ɰ�2�6��k�,���Ƕ5���[�G�?�)��&�=(:�b�"3���*w��lʳRYSm
+3���Q�D&I�'�Oյ~$b�]�@n��"'�>�qr�A=OsQ}=9G&\|�ʻS��@

data/LICENSE.adoc

@@ -150,7 +150,7 @@ additional liability.
 
 END OF TERMS AND CONDITIONS
 
-Copyright link:https://www.alchemists.io[Alchemists].
+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 link:https://www.apache.org/licenses/LICENSE-2.0[copy]

data/README.adoc

@@ -6,6 +6,8 @@
 
 [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]
 
@@ -28,11 +30,8 @@ toc::[]
 ** Updated
 ** Removed
 ** Refactored
-* Ensures Git commit merge messages are excluded.
 * Ensures Git commit messages are alphabetically sorted.
 * Ensures duplicate Git commit messages are removed (if any).
-* Ensures Git commit messages are sanitized by removing extra spaces and `+[ci skip]+` text within
-  each Git tag message.
 * Provides optional security for signing Git tags with https://www.gnupg.org[GnuPG] signing key.
 
 == Screencasts
@@ -48,8 +47,6 @@ image::https://www.alchemists.io/images/screencasts/milestoner/cover.svg[Screenc
 
 == Setup
 
-=== Production
-
 To install, run:
 
 [source,bash]
@@ -57,24 +54,6 @@ To install, run:
 gem install milestoner
 ----
 
-=== 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
-----
-
 == Usage
 
 === Command Line Interface (CLI)
@@ -189,13 +168,32 @@ Now, when publishing a new milestone (i.e. `+milestoner --publish <version> --s
 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
 

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

@@ -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

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

data/lib/milestoner/identity.rb

@@ -5,7 +5,7 @@ module Milestoner
   module Identity
     NAME = "milestoner"
     LABEL = "Milestoner"
-    VERSION = "10.2.0"
+    VERSION = "11.1.1"
     VERSION_LABEL = "#{LABEL} #{VERSION}"
   end
 end

data/lib/milestoner/pusher.rb

@@ -3,26 +3,32 @@
 module Milestoner
   # Handles publishing of Git tags to remote repository.
   class Pusher
-    def initialize git: Git::Kit.new
-      @git = git
+    def initialize repository: GitPlus::Repository.new
+      @repository = repository
     end
 
     def push version
       version = Versionaire::Version version
 
-      fail Errors::Git, "Remote repository not configured." unless git.remote?
+      fail Errors::Git, "Remote repository not configured." unless repository.config_origin?
       fail Errors::Git, "Remote tag exists: #{version}." if tag_exists? version
-      return if git.push_tags.empty?
+      return if push_tags
 
       fail Errors::Git, "Tags could not be pushed to remote repository."
     end
 
     private
 
-    attr_reader :git, :version
+    attr_reader :repository, :version
 
     def tag_exists? version
-      git.tag_remote? version
+      repository.tag_remote? version
+    end
+
+    def push_tags
+      repository.tag_push.then do |_stdout, stderr, status|
+        status.success? && stderr.match?(/[new tag]/)
+      end
     end
   end
 end

data/lib/milestoner/tagger.rb

@@ -1,115 +1,89 @@
 # 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
+  # :reek:TooManyInstanceVariables
   class Tagger
-    attr_reader :version, :commit_prefixes
+    attr_reader :commit_prefixes
 
-    def initialize commit_prefixes: [], git: Git::Kit.new
+    def initialize commit_prefixes: [], repository: GitPlus::Repository.new, presenter: Commit
       @commit_prefixes = commit_prefixes
-      @git = git
+      @repository = repository
+      @presenter = presenter
       @shell = Thor::Shell::Color.new
     end
 
     def commit_prefix_regex
-      return Regexp.new "" if commit_prefixes.empty?
-
-      Regexp.union commit_prefixes
+      commit_prefixes.empty? ? Regexp.new("") : 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
+      groups.each_value { |commits| commits.sort_by!(&:subject) }
+      groups.values.flatten.uniq(&:subject)
     end
 
     def commit_list
-      commits.map { |commit| "- #{commit}" }
+      commits.map { |source| presenter.new source }
+             .map { |commit| "- #{commit.subject_author}" }
     end
 
     # :reek:BooleanParameter
+    # :reek:ControlParameter
+    # :reek:TooManyStatements
     def create version, sign: false
-      @version = Versionaire::Version version
-      fail Errors::Git, "Unable to tag without commits." unless git.commits?
-      return if existing_tag?
+      version = Versionaire::Version version
+
+      return if local? version
+      fail Errors::Git, "Unable to tag without commits." if computed_commits.empty?
 
-      git_tag sign: sign
+      content = message version
+      sign ? repository.tag_sign(version, content) : repository.tag_unsign(version, content)
     end
 
     private
 
-    attr_reader :git, :shell
+    attr_reader :repository, :presenter, :shell
 
-    def git_log_command
-      "git log --oneline --no-merges --format='%s'"
+    def saved_commits
+      repository.commits
     end
 
-    def git_tag_command
-      "$(git describe --abbrev=0 --tags --always)..HEAD"
+    def tagged_commits
+      repository.commits "#{repository.tag_last}..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"
+    def computed_commits
+      (repository.tagged? ? tagged_commits : saved_commits)
     end
 
     def build_commit_prefix_groups
-      groups = commit_prefixes.map.with_object({}) { |prefix, group| group.merge! prefix => [] }
-      groups.merge! "Other" => []
+      commit_prefixes.map
+                     .with_object({}) { |prefix, group| group.merge! prefix => [] }
+                     .merge! "Other" => []
     end
 
     def group_by_commit_prefix groups = {}
-      raw_commits.each do |commit|
-        prefix = commit[commit_prefix_regex]
+      computed_commits.each do |commit|
+        prefix = commit.subject[commit_prefix_regex]
         key = groups.key?(prefix) ? prefix : "Other"
-        groups[key] << commit.gsub(/\[ci\sskip\]/, "").squeeze(" ").strip
+        groups[key] << commit
       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
+    def message version
+      %(Version #{version}\n\n#{commit_list.join "\n"}\n\n)
     end
 
-    def existing_tag?
-      return false unless git.tag_local? @version
+    def local? version
+      return false unless repository.tag_local? version
 
-      shell.say_status :warn, "Local tag exists: #{@version}. Skipped.", :yellow
+      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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 10.2.0
+  version: 11.1.1
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -28,38 +28,24 @@ cert_chain:
   2XV8FRa7/JimI07sPLC13eLY3xd/aYTi85Z782KIA4j0G8XEEWAX0ouBhlXPocZv
   QWc=
   -----END CERTIFICATE-----
-date: 2020-07-23 00:00:00.000000000 Z
+date: 2021-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: runcom
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: thor
+  name: git_plus
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.20'
+        version: '0.2'
 - !ruby/object:Gem::Dependency
-  name: versionaire
+  name: refinements
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -73,215 +59,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8.0'
 - !ruby/object:Gem::Dependency
-  name: bundler-audit
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.6'
-- !ruby/object:Gem::Dependency
-  name: climate_control
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.1'
-- !ruby/object:Gem::Dependency
-  name: gemsmith
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '14.2'
-- !ruby/object:Gem::Dependency
-  name: git-lint
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: guard-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '4.7'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.13'
-- !ruby/object:Gem::Dependency
-  name: pry-byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '6.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.83'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.83'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rake
+  name: runcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
-  type: :development
+        version: '7.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
-  type: :development
+        version: '0.20'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.39'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: versionaire
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
-  type: :development
+        version: '9.0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '9.0'
 description:
 email:
 - brooke@alchemists.io
@@ -297,11 +115,10 @@ files:
 - 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/git/config.rb
-- lib/milestoner/git/kit.rb
 - lib/milestoner/identity.rb
 - lib/milestoner/publisher.rb
 - lib/milestoner/pusher.rb
@@ -322,14 +139,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.4
 signing_key:
 specification_version: 4
 summary: A command line interface for crafting Git repository milestones.

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