milestoner 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a383b5ca439d263af13d3a99df04900c5cf9af6d
-  data.tar.gz: 7bbeabe417fa74b1ea2de76f98ca4ad5cbc02468
+  metadata.gz: 2f8ac8304b27843a087593b12cf0ed45945701bc
+  data.tar.gz: 2fc0db25d0afba6db7131dc340d3404b478e19a2
 SHA512:
-  metadata.gz: 203b4857ce7f978e63560a760ed56369853cad84405bfadb8b83e0b1f459023f495a44a0bd7b196ae4a17c14da44ab17cd6f6fe0b156b7d72047e442a28db62e
-  data.tar.gz: 87add04071261e77f5964cf8202a914891228af308b3f90bf65c66ea94f585c3671b903a2a488dd6c1d6e92eb63e9003ec303dcaeb05c177625ac75637ac42b9
+  metadata.gz: 1eebacca1ca1eb38c801ffbd1ee35ad749e07a6f64394faa381385a325f83a11f6ad2fbdb533b313109e267775ce9fca4057f6eebf076929c205ead896cd57b4
+  data.tar.gz: bf566fa3250f24929aa519d647f64b2b77e47e0c6c235a79d70e68060d0bbf61d562bf91454988f187834d8e43c70cf9b77081240b1e226d7e12bdcad74bde83

data/README.md

@@ -16,6 +16,8 @@ A tool for automating and releasing Git repository milestones.
 - [Requirements](#requirements)
 - [Setup](#setup)
 - [Usage](#usage)
+  - [Command Line Interface (CLI)](#command-line-interface-cli)
+  - [Customization](#customization)
 - [Tests](#tests)
 - [Versioning](#versioning)
 - [Code of Conduct](#code-of-conduct)
@@ -28,15 +30,19 @@ A tool for automating and releasing Git repository milestones.
 
 # Features
 
-- Provides [Semantic Versioning](http://semver.org) for Git repositories in the form of
-  `v<major>.<minor>.</maintenance>` tags. Example: `v0.1.0`.
-- Provides optional security for signing tags using GPG signing key.
-- Automatically includes commits since last tag (or HEAD if no tags exist) within each tag message.
-- Groups commit messages by consistent prefixes in order defined: "Fixed", "Added", "Updated", "Removed", "Refactored".
-  Otherwise, they are alphabetically sorted.
-- Alphabetically sorts commit messages within each prefix group.
-- Ensures duplicate commit messages are removed (if any).
-- Sanitizes commit messages by removing extra spaces and `[ci skip]` text.
+- Ensures [Semantic Versioning](http://semver.org) of Git repository tags:
+    - Format: `v<major>.<minor>.</maintenance>`.
+    - Example: `v0.1.0`.
+- Ensures Git commits since last tag (or since initialization of repository if no tags exist) are included within each
+  Git tag message.
+- Ensures Git commit messages are grouped by prefix, in order defined, for each Git tag message (prefixes can be
+  customized): "Fixed", "Added", "Updated", "Removed", "Refactored".
+- Ensures Git commit messages are alphabetically sorted within each Git tag message.
+- Ensures duplicate Git commit messages are removed (if any) within each Git tag message.
+- 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 [GnuPG](https://www.gnupg.org) signing key.
+
+[![asciicast](https://asciinema.org/a/ecyzvq1uvy3mn6mrknd36f5b7.png)](https://asciinema.org/a/ecyzvq1uvy3mn6mrknd36f5b7)
 
 # Requirements
 
@@ -48,7 +54,7 @@ A tool for automating and releasing Git repository milestones.
 
 For a secure install, type the following (recommended):
 
-    gem cert --add <(curl -Ls http://www.my-website.com/gem-public.pem)
+    gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem)
     gem install milestoner --trust-policy MediumSecurity
 
 NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
@@ -60,20 +66,23 @@ For an insecure install, type the following (not recommended):
 
 # Usage
 
-From the command line, type: milestoner help
+## Command Line Interface (CLI)
+
+From the command line, type: `milestoner help`
 
-    milestoner -P, [--publish=PUBLISH]  # Tag and push to remote repository.
-    milestoner -c, [--commits]          # Show tag message commits for next milestone.
+    milestoner -P, [--publish=PUBLISH]  # Tag and push milestone to remote repository.
+    milestoner -c, [--commits]          # Show commits for next milestone.
+    milestoner -e, [--edit]             # Edit Milestoner settings in default editor.
     milestoner -h, [--help=HELP]        # Show this message or get help for a command.
-    milestoner -p, [--push]             # Push tags to remote repository.
+    milestoner -p, [--push]             # Push local tag to remote repository.
     milestoner -t, [--tag=TAG]          # Tag local repository with new version.
-    milestoner -v, [--version]          # Show version.
+    milestoner -v, [--version]          # Show Milestoner version.
 
-For tag options, type: milestoner help tag
+For tag options, type: `milestoner help tag`
 
     -s, [--sign], [--no-sign]  # Sign tag with GPG key.
 
-For publish options, type: milestoner help publish
+For publish options, type: `milestoner help publish`
 
     -s, [--sign], [--no-sign]  # Sign tag with GPG key.
 
@@ -81,6 +90,51 @@ When using Milestoner, the `--publish` command is intended to be the only comman
 release as it handles all of the steps necessary for tagging and pushing a new release. Should individual steps
 be needed, then the `--tag` and `--push` options are available.
 
+## Customization
+
+Should the default settings not be desired, customization is allowed via the `.milestonerrc` file. The `.milestonerrc`
+can be created at a global and/or local level. Example:
+
+- Global: `~/.milestonerrc`
+- Local: `<project repository root>/.milestonerrc`
+
+Order of precedence for any setting is resolved as follows (with the first taking top priority):
+
+0. CLI option. Example: A version passed to either the `--tag` or `--publish` commands.
+0. Local project repository `.milestonerrc`.
+0. Global `~/.milestonerrc`.
+
+Any setting provided to the CLI during runtime would trump a local/global setting and a local setting would trump a
+global setting. The global setting is the weakest of all but great for situations where custom settings should be
+applied to *all* projects. It is important to note that local settings completely trump any global settings -- there is
+no inheritance when local *and* global settings exist at the same time.
+
+The `.milestonerrc` uses the following default settings:
+
+    ---
+    :version: ""
+    :git_commit_prefixes:
+      - Fixed
+      - Added
+      - Updated
+      - Removed
+      - Refactored
+    :git_tag_sign: false
+
+Each `.milestonerrc` setting can be configured as follows:
+
+- `version`: By default it is left blank so you'll be prompted by the CLI. However, it can be nice to bump this version
+  prior to each release and have the current version checked into source code at a per project level. The version, if
+  set, will be used to tag the repository. If the version is a duplicate, an error will be thrown. When supplying a
+  version, use this format: `<major>.<minor>.</maintenance>`. Example: `0.1.0`.
+- `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 if used. 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.
+
 # Tests
 
 To test, run:

data/bin/milestoner

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

data/lib/milestoner.rb

@@ -1,4 +1,10 @@
+require "milestoner/aids/git"
+require "milestoner/errors/base"
+require "milestoner/errors/configuration"
+require "milestoner/errors/duplicate_tag"
+require "milestoner/errors/git"
+require "milestoner/errors/version"
+require "milestoner/configuration"
 require "milestoner/identity"
-require "milestoner/exceptions"
 require "milestoner/pusher"
 require "milestoner/tagger"

data/lib/milestoner/aids/git.rb

@@ -0,0 +1,10 @@
+module Milestoner
+  module Aids
+    # Augments an object with Git support.
+    module Git
+      def git_supported?
+        File.exist? File.join(Dir.pwd, ".git")
+      end
+    end
+  end
+end

data/lib/milestoner/cli.rb

@@ -9,58 +9,63 @@ module Milestoner
     include Thor::Actions
     include ThorPlus::Actions
 
-    package_name Milestoner::Identity.label
+    package_name Milestoner::Identity.version_label
 
     def initialize args = [], options = {}, config = {}
       super args, options, config
+      @configuration = Milestoner::Configuration.new Milestoner::Identity.file_name, defaults: defaults
+      @tagger = Milestoner::Tagger.new configuration.settings[:version],
+                                       commit_prefixes: configuration.settings[:git_commit_prefixes]
+      @pusher = Milestoner::Pusher.new
     end
 
-    desc "-c, [--commits]", "Show tag message commits for next milestone."
+    desc "-c, [--commits]", "Show commits for next milestone."
     map %w(-c --commits) => :commits
-    def commits version
-      tagger = Milestoner::Tagger.new version
-      say "Milestone #{version} Commits:"
+    def commits
       tagger.commit_list.each { |commit| say commit }
+    rescue Milestoner::Errors::Base => base_error
+      error base_error.message
     end
 
     desc "-t, [--tag=TAG]", "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 = Milestoner::Tagger.new version
-      tagger.create sign: options[:sign]
+    def tag version = configuration.settings[:version]
+      tagger.create version, sign: sign_tag?(options[:sign])
       say "Repository tagged: #{tagger.version_label}."
-    rescue Milestoner::VersionError => version_error
-      error version_error.message
-    rescue Milestoner::DuplicateTagError => tag_error
-      error tag_error.message
+    rescue Milestoner::Errors::Base => base_error
+      error base_error.message
     end
 
-    desc "-p, [--push]", "Push tags to remote repository."
+    desc "-p, [--push]", "Push local tag to remote repository."
     map %w(-p --push) => :push
     def push
-      pusher = Milestoner::Pusher.new
       pusher.push
       info "Tags pushed to remote repository."
+    rescue Milestoner::Errors::Base => base_error
+      error base_error.message
     end
 
-    desc "-P, [--publish=PUBLISH]", "Tag and push to remote repository."
+    desc "-P, [--publish=PUBLISH]", "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
-      tagger = Milestoner::Tagger.new version
-      pusher = Milestoner::Pusher.new
-      tag_and_push tagger, pusher, options
-    rescue Milestoner::VersionError => version_error
-      error version_error.message
-    rescue Milestoner::DuplicateTagError => tag_error
-      error tag_error.message
+    def publish version = configuration.settings[:version]
+      tag_and_push version, options
+    rescue Milestoner::Errors::Base => base_error
+      error base_error.message
     end
 
-    desc "-v, [--version]", "Show version."
+    desc "-e, [--edit]", "Edit #{Milestoner::Identity.label} settings in default editor."
+    map %w(-e --edit) => :edit
+    def edit
+      info "Editing: #{configuration.computed_file_path}..."
+      `#{editor} #{configuration.computed_file_path}`
+    end
+
+    desc "-v, [--version]", "Show #{Milestoner::Identity.label} version."
     map %w(-v --version) => :version
     def version
-      say Milestoner::Identity.label_version
+      say Milestoner::Identity.version_label
     end
 
     desc "-h, [--help=HELP]", "Show this message or get help for a command."
@@ -71,10 +76,24 @@ module Milestoner
 
     private
 
-    def tag_and_push tagger, pusher, options
-      if tagger.create(sign: options[:sign]) && pusher.push
-        say "Repository tagged and pushed: #{tagger.version_label}."
-        say "Milestone published!"
+    attr_reader :configuration, :tagger, :pusher
+
+    def defaults
+      {
+        version: "",
+        git_commit_prefixes: %w(Fixed Added Updated Removed Refactored),
+        git_tag_sign: false
+      }
+    end
+
+    def sign_tag? sign
+      sign | configuration.settings[:git_tag_sign]
+    end
+
+    def tag_and_push version, options
+      if tagger.create(version, sign: sign_tag?(options[:sign])) && pusher.push
+        info "Repository tagged and pushed: #{tagger.version_label}."
+        info "Milestone published!"
       else
         tagger.destroy
       end

data/lib/milestoner/configuration.rb

@@ -0,0 +1,36 @@
+module Milestoner
+  # Default configuration for gem with support for custom settings.
+  class Configuration
+    def initialize file_name = ".unknownrc", defaults: {}
+      @file_name = file_name
+      @defaults = defaults
+    end
+
+    def local_file_path
+      File.join Dir.pwd, file_name
+    end
+
+    def global_file_path
+      File.join ENV["HOME"], file_name
+    end
+
+    def computed_file_path
+      File.exist?(local_file_path) ? local_file_path : global_file_path
+    end
+
+    def settings
+      defaults.merge(load_settings).reject { |_, value| value.nil? }
+    end
+
+    private
+
+    attr_reader :file_name, :defaults
+
+    def load_settings
+      yaml = YAML.load_file computed_file_path
+      yaml.is_a?(Hash) ? yaml : {}
+    rescue
+      defaults
+    end
+  end
+end

data/lib/milestoner/errors/base.rb

@@ -0,0 +1,10 @@
+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/configuration.rb

@@ -0,0 +1,7 @@
+module Milestoner
+  module Errors
+    # Raised for invalid gem configuration.
+    class Configuration < Base
+    end
+  end
+end

data/lib/milestoner/errors/duplicate_tag.rb

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

data/lib/milestoner/errors/git.rb

@@ -0,0 +1,10 @@
+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/errors/version.rb

@@ -0,0 +1,7 @@
+module Milestoner
+  module Errors
+    # Raised for invalid version formats.
+    class Version < Base
+    end
+  end
+end

data/lib/milestoner/identity.rb

@@ -10,11 +10,15 @@ module Milestoner
     end
 
     def self.version
-      "0.3.0"
+      "0.4.0"
     end
 
-    def self.label_version
+    def self.version_label
       [label, version].join " "
     end
+
+    def self.file_name
+      ".#{name}rc"
+    end
   end
 end

data/lib/milestoner/pusher.rb

@@ -1,11 +1,14 @@
 module Milestoner
   # Handles publishing of Git tags to remote repository.
   class Pusher
+    include Aids::Git
+
     def initialize kernel: Kernel
       @kernel = kernel
     end
 
     def push
+      fail(Errors::Git) unless git_supported?
       kernel.system "git push --tags"
     end
 

data/lib/milestoner/tagger.rb

@@ -1,42 +1,45 @@
 module Milestoner
   # Handles the tagging of a project repository.
   class Tagger
-    attr_reader :version
+    include Aids::Git
 
-    def self.commit_prefixes
-      %w(Fixed Added Updated Removed Refactored) # Order is important for controlling the sort.
-    end
-
-    def self.commit_prefix_regex
-      /\A(#{commit_prefixes.join "|"})/
-    end
+    attr_reader :version_number, :commit_prefixes
 
     def self.version_regex
       /\A\d{1}\.\d{1}\.\d{1}\z/
     end
 
-    def initialize version
-      @version = validate_version version
+    def initialize version = nil, commit_prefixes: []
+      @version_number = version
+      @commit_prefixes = commit_prefixes
     end
 
     def version_label
-      "v#{version}"
+      "v#{version_number}"
     end
 
     def version_message
-      "Version #{version}."
+      "Version #{version_number}."
+    end
+
+    def commit_prefix_regex
+      return // if commit_prefixes.empty?
+      Regexp.union commit_prefixes
     end
 
     def tagged?
+      fail(Errors::Git) unless git_supported?
       response = `git tag`
       !(response.nil? || response.empty?)
     end
 
     def duplicate?
+      fail(Errors::Git) unless git_supported?
       system "git rev-parse #{version_label} > /dev/null 2>&1"
     end
 
     def commits
+      fail(Errors::Git) unless git_supported?
       groups = build_commit_prefix_groups
       group_by_commit_prefix! groups
       sort_by_commit_prefix! groups
@@ -47,20 +50,15 @@ module Milestoner
       commits.map { |commit| "- #{commit}" }
     end
 
-    def create sign: false
-      fail(DuplicateTagError, "Duplicate tag exists: #{version_label}.") if duplicate?
-
-      begin
-        message_file = Tempfile.new Milestoner::Identity.name
-        File.open(message_file, "w") { |file| file.write tag_message }
-        `git tag #{tag_options message_file, sign: sign}`
-      ensure
-        message_file.close
-        message_file.unlink
-      end
+    def create version = version_number, sign: false
+      fail(Errors::Git) unless git_supported?
+      @version_number = validate_version version
+      fail(Errors::DuplicateTag, "Duplicate tag exists: #{version_label}.") if duplicate?
+      create_tag sign: sign
     end
 
     def destroy
+      fail(Errors::Git) unless git_supported?
       `git tag --delete #{version_label}`
     end
 
@@ -68,7 +66,7 @@ module Milestoner
 
     def validate_version version
       message = "Invalid version: #{version}. Use: <major>.<minor>.<maintenance>."
-      fail(VersionError, message) unless version.match(self.class.version_regex)
+      fail(Errors::Version, message) unless version.match(self.class.version_regex)
       version
     end
 
@@ -81,7 +79,7 @@ module Milestoner
     end
 
     def build_commit_prefix_groups
-      groups = self.class.commit_prefixes.map.with_object({}) { |prefix, group| group.merge! prefix => [] }
+      groups = commit_prefixes.map.with_object({}) { |prefix, group| group.merge! prefix => [] }
       groups.merge! "Other" => []
     end
 
@@ -91,7 +89,7 @@ module Milestoner
 
     def group_by_commit_prefix! groups = {}
       raw_commits.each do |commit|
-        prefix = commit[self.class.commit_prefix_regex]
+        prefix = commit[commit_prefix_regex]
         key = groups.key?(prefix) ? prefix : "Other"
         groups[key] << sanitize_commit(commit)
       end
@@ -110,5 +108,14 @@ module Milestoner
       return options.gsub("--sign ", "") unless sign
       options
     end
+
+    def create_tag sign: false
+      message_file = Tempfile.new Milestoner::Identity.name
+      File.open(message_file, "w") { |file| file.write tag_message }
+      `git tag #{tag_options message_file, sign: sign}`
+    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: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2015-09-09 00:00:00.000000000 Z
+date: 2015-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -312,8 +312,14 @@ files:
 - README.md
 - bin/milestoner
 - lib/milestoner.rb
+- lib/milestoner/aids/git.rb
 - lib/milestoner/cli.rb
-- lib/milestoner/exceptions.rb
+- lib/milestoner/configuration.rb
+- lib/milestoner/errors/base.rb
+- lib/milestoner/errors/configuration.rb
+- lib/milestoner/errors/duplicate_tag.rb
+- lib/milestoner/errors/git.rb
+- lib/milestoner/errors/version.rb
 - lib/milestoner/identity.rb
 - lib/milestoner/pusher.rb
 - lib/milestoner/tagger.rb

data/lib/milestoner/exceptions.rb

@@ -1,9 +0,0 @@
-module Milestoner
-  # Raised for invalid version formats.
-  class VersionError < StandardError
-  end
-
-  # Raised for duplicate tags.
-  class DuplicateTagError < StandardError
-  end
-end