milestoner 2.2.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c9069703d542f4240535b561b66d0281abedfc1
-  data.tar.gz: fffc9ae8af389de2d28c4f87385d3f288172fff9
+  metadata.gz: 9aa59dc5b98238b6b0f20689142e7926443d0fd8
+  data.tar.gz: 87653a11e6ecf0f2f74f605188ebe20ac63c1ab7
 SHA512:
-  metadata.gz: 078922346541fb99108b8be870d5ac926d2b338ebfa5b7524d546d5cf76fec806e0443fd10a7ef5dc3c162e894c48fac4c6123f8b05165406f3c149eb467e549
-  data.tar.gz: bf20f9b2b67ba672cb89e1a9b8fee361d53ffa1621990d173024633b08d456705ed51cc60b401857a4326d101d0f38aeddc20c83dc57d6c9cc3e0a60506a3445
+  metadata.gz: 38595bb8f085651035d26b5440cd86e1656a4b35acdfaf7e8ab788cd7cca5a7047cf8813d16fba0eabc4f59756fcb17903254bad7541d33903204a8a90ab2f49
+  data.tar.gz: ccdf5a94d6b5189cfc2555e1bab248fcbe0bb9ad1869f3ba015518ce12e43e2b2bc6ca1911a8d31434f986c68f33c8898dc1dbc7e14a0db273e19b3bd5b09f5d

data/README.md

@@ -33,7 +33,7 @@ A command line interface for releasing Git repository milestones.
 
 # Features
 
-- Ensures [Semantic Versioning](http://semver.org) of Git repository tags:
+- Uses [Versionaire](https://github.com/bkuhlmann/versionaire) for [Semantic Versioning](http://semver.org).
     - Format: `v<major>.<minor>.<maintenance>`.
     - Example: `v0.1.0`.
 - Ensures Git commits since last tag (or initialization of repository) are included within each Git tag message.
@@ -52,7 +52,7 @@ A command line interface for releasing Git repository milestones.
 
 # Screencasts
 
-[![asciicast](https://asciinema.org/a/26561.png)](https://asciinema.org/a/26561)
+[![asciicast](https://asciinema.org/a/41207.png)](https://asciinema.org/a/41207)
 
 # Requirements
 
@@ -80,19 +80,23 @@ For an insecure install, type the following (not recommended):
 
 From the command line, type: `milestoner help`
 
+    milestoner -C, [--commits]          # Show 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 -c, [--config]           # Show/manage gem configuration.
     milestoner -h, [--help=HELP]        # Show this message or get help for a command.
     milestoner -p, [--push]             # Push local tag to remote repository.
     milestoner -t, [--tag=TAG]          # Tag local repository with new version.
-    milestoner -v, [--version]          # Show Milestoner version.
+    milestoner -v, [--version]          # Show gem version.
 
-For tag options, type: `milestoner help tag`
+For config options, type: `milestoner help --config`
+
+    -e, [--edit], [--no-edit]  # Edit gem configuration.
+
+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.
 
@@ -121,7 +125,7 @@ no inheritance when local *and* global settings exist at the same time.
 
 The `.milestonerrc` uses the following default settings:
 
-    :version: ""
+    :version: "0.1.0"
     :git_commit_prefixes:
       - Fixed
       - Added
@@ -132,10 +136,9 @@ The `.milestonerrc` uses the following default settings:
 
 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`.
+- `version`: Useful if desired to have the current version checked into source code per project. 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,
+  it *must* be semantic: `<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

data/lib/milestoner.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-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/git"
 require "milestoner/identity"
 require "milestoner/publisher"
 require "milestoner/pusher"

data/lib/milestoner/cli.rb

@@ -22,12 +22,12 @@ module Milestoner
       @publisher = Publisher.new tagger: tagger, pusher: pusher
     end
 
-    desc "-c, [--commits]", "Show commits for next milestone."
-    map %w(-c --commits) => :commits
+    desc "-C, [--commits]", "Show commits for next milestone."
+    map %w(-C --commits) => :commits
     def commits
       tagger.commit_list.each { |commit| say commit }
-    rescue Errors::Base => base_error
-      error base_error.message
+    rescue StandardError => exception
+      error exception.message
     end
 
     desc "-t, [--tag=TAG]", "Tag local repository with new version."
@@ -36,8 +36,8 @@ module Milestoner
     def tag version = configuration.settings[:version]
       tagger.create version, sign: sign_tag?(options[:sign])
       say "Repository tagged: #{tagger.version_label}."
-    rescue Errors::Base => base_error
-      error base_error.message
+    rescue StandardError => exception
+      error exception.message
     end
 
     desc "-p, [--push]", "Push local tag to remote repository."
@@ -45,8 +45,8 @@ module Milestoner
     def push
       pusher.push
       info "Tags pushed to remote repository."
-    rescue Errors::Base => base_error
-      error base_error.message
+    rescue StandardError => exception
+      error exception.message
     end
 
     desc "-P, [--publish=PUBLISH]", "Tag and push milestone to remote repository."
@@ -56,18 +56,22 @@ module Milestoner
       publisher.publish version, sign: sign_tag?(options[:sign])
       info "Repository tagged and pushed: #{tagger.version_label}."
       info "Milestone published!"
-    rescue Errors::Base => base_error
-      error base_error.message
+    rescue StandardError => exception
+      error exception.message
     end
 
-    desc "-e, [--edit]", "Edit #{Identity.label} settings in default editor."
-    map %w(-e --edit) => :edit
-    def edit
-      info "Editing: #{configuration.computed_file_path}..."
-      `#{editor} #{configuration.computed_file_path}`
+    desc "-c, [--config]", "Show/manage gem configuration."
+    map %w(-c --config) => :config
+    method_option :edit, aliases: "-e", desc: "Edit gem configuration.", type: :boolean, default: false
+    def config
+      if options[:edit]
+        `#{editor} #{configuration.computed_file_path}`
+      else
+        print_config_info
+      end
     end
 
-    desc "-v, [--version]", "Show #{Identity.label} version."
+    desc "-v, [--version]", "Show gem version."
     map %w(-v --version) => :version
     def version
       say Identity.version_label
@@ -85,7 +89,7 @@ module Milestoner
 
     def defaults
       {
-        version: "",
+        version: "0.1.0",
         git_commit_prefixes: %w(Fixed Added Updated Removed Refactored),
         git_tag_sign: false
       }
@@ -94,5 +98,13 @@ module Milestoner
     def sign_tag? sign
       sign | configuration.settings[:git_tag_sign]
     end
+
+    def print_config_info
+      case
+        when configuration.local? then say("Use local configuration: #{configuration.computed_file_path}.")
+        when configuration.global? then say("Using global configuration: #{configuration.computed_file_path}.")
+        else say("Global and local gem configuration not defined, using defaults instead.")
+      end
+    end
   end
 end

data/lib/milestoner/configuration.rb

@@ -16,6 +16,14 @@ module Milestoner
       File.join ENV["HOME"], file_name
     end
 
+    def global?
+      File.exist? global_file_path
+    end
+
+    def local?
+      File.exist? local_file_path
+    end
+
     def computed_file_path
       File.exist?(local_file_path) ? local_file_path : global_file_path
     end

data/lib/milestoner/git.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Milestoner
+  # A lightweight Git wrapper.
+  class Git
+    def supported?
+      File.exist? File.join(Dir.pwd, ".git")
+    end
+
+    def commits?
+      system "git log > /dev/null 2>&1"
+    end
+
+    def remote?
+      system "git config remote.origin.url"
+    end
+  end
+end

data/lib/milestoner/identity.rb

@@ -12,7 +12,7 @@ module Milestoner
     end
 
     def self.version
-      "2.2.0"
+      "3.0.0"
     end
 
     def self.version_label

data/lib/milestoner/pusher.rb

@@ -3,20 +3,19 @@
 module Milestoner
   # Handles publishing of Git tags to remote repository.
   class Pusher
-    include Aids::Git
-
-    def initialize kernel: Kernel
-      @kernel = kernel
+    def initialize git: Git.new, shell: Kernel
+      @git = git
+      @shell = shell
     end
 
     def push
-      fail(Errors::Git) unless git_supported?
-      fail(Errors::Git, "Git remote repository is not configured.") unless git_remote?
-      kernel.system "git push --tags"
+      fail(Errors::Git) unless git.supported?
+      fail(Errors::Git, "Git remote repository not configured.") unless git.remote?
+      fail(Errors::Git, "Git tags could not be pushed to remote repository.") unless shell.system("git push --tags")
     end
 
     private
 
-    attr_reader :kernel
+    attr_reader :git, :shell
   end
 end

data/lib/milestoner/tagger.rb

@@ -1,29 +1,22 @@
 # frozen_string_literal: true
 
+require "forwardable"
 require "open3"
+require "versionaire"
 
 module Milestoner
   # Handles the tagging of a project repository.
   class Tagger
-    include Aids::Git
+    extend Forwardable
 
-    attr_reader :version_number, :commit_prefixes
+    attr_reader :version, :commit_prefixes
 
-    def self.version_regex
-      /\A\d+\.\d+\.\d+\z/
-    end
+    def_delegator :version, :label, :version_label
 
-    def initialize version = nil, commit_prefixes: []
-      @version_number = version
+    def initialize version = "0.1.0", commit_prefixes: [], git: Git.new
+      @version = Versionaire::Version version
       @commit_prefixes = commit_prefixes
-    end
-
-    def version_label
-      "v#{version_number}"
-    end
-
-    def version_message
-      "Version #{version_number}."
+      @git = git
     end
 
     def commit_prefix_regex
@@ -32,18 +25,18 @@ module Milestoner
     end
 
     def tagged?
-      fail(Errors::Git) unless git_supported?
+      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"
+      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?
+      fail(Errors::Git) unless git.supported?
       groups = build_commit_prefix_groups
       group_by_commit_prefix! groups
       sort_by_commit_prefix! groups
@@ -54,32 +47,23 @@ module Milestoner
       commits.map { |commit| "- #{commit}" }
     end
 
-    def create version = version_number, sign: false
-      @version_number = validate_version version
-      fail(Errors::Git) unless git_supported?
-      fail(Errors::Git, "Unable to tag without commits.") unless git_commits?
-      fail(Errors::DuplicateTag, "Duplicate tag exists: #{version_label}.") if duplicate?
-      create_tag sign: sign
-    end
-
-    def delete version = version_number
-      @version_number = validate_version version
-      fail(Errors::Git) unless git_supported?
-      Open3.capture3 "git tag --delete #{version_label}" if duplicate?
+    def create raw_version = version, sign: false
+      @version = Versionaire::Version raw_version
+      fail(Errors::Git) unless git.supported?
+      fail(Errors::Git, "Unable to tag without commits.") unless git.commits?
+      fail(Errors::DuplicateTag, "Duplicate tag exists: #{version.label}.") if duplicate?
+      git_tag sign: sign
     end
 
-    def destroy
-      warn "[DEPRECATION]: #destroy is deprecated, use #delete instead."
-      delete
+    def delete raw_version = version
+      @version = Versionaire::Version raw_version
+      fail(Errors::Git) unless git.supported?
+      Open3.capture3 "git tag --delete #{version.label}" if duplicate?
     end
 
     private
 
-    def validate_version version
-      message = "Invalid version: #{version}. Use: <major>.<minor>.<maintenance>."
-      fail(Errors::Version, message) unless version.match(self.class.version_regex)
-      version
-    end
+    attr_reader :git
 
     def raw_commits
       log_command = "git log --oneline --no-merges --format='%s'"
@@ -110,20 +94,20 @@ module Milestoner
       groups.each { |_, values| values.sort! }
     end
 
-    def tag_message
-      %(#{version_message}\n\n#{commit_list.join "\n"}\n\n)
+    def git_message
+      %(Version #{version}.\n\n#{commit_list.join "\n"}\n\n)
     end
 
-    def tag_options message_file, sign: false
-      options = %(--sign --annotate "#{version_label}" --cleanup verbatim --file "#{message_file.path}")
+    def git_options message_file, sign: false
+      options = %(--sign --annotate "#{version.label}" --cleanup verbatim --file "#{message_file.path}")
       return options.gsub("--sign ", "") unless sign
       options
     end
 
-    def create_tag sign: false
+    def git_tag sign: false
       message_file = Tempfile.new Identity.name
-      File.open(message_file, "w") { |file| file.write tag_message }
-      `git tag #{tag_options message_file, sign: sign}`
+      File.open(message_file, "w") { |file| file.write git_message }
+      `git tag #{git_options message_file, sign: sign}`
     ensure
       message_file.close
       message_file.unlink

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2016-03-14 00:00:00.000000000 Z
+date: 2016-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -60,6 +60,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: versionaire
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: bond
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: wirb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -312,7 +382,6 @@ files:
 - README.md
 - bin/milestoner
 - lib/milestoner.rb
-- lib/milestoner/aids/git.rb
 - lib/milestoner/cli.rb
 - lib/milestoner/configuration.rb
 - lib/milestoner/errors/base.rb
@@ -320,6 +389,7 @@ files:
 - lib/milestoner/errors/duplicate_tag.rb
 - lib/milestoner/errors/git.rb
 - lib/milestoner/errors/version.rb
+- lib/milestoner/git.rb
 - lib/milestoner/identity.rb
 - lib/milestoner/publisher.rb
 - lib/milestoner/pusher.rb
@@ -347,7 +417,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.1
+rubygems_version: 2.6.2
 signing_key: 
 specification_version: 4
 summary: A command line interface for releasing Git repository milestones.

data/lib/milestoner/aids/git.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Milestoner
-  module Aids
-    # Augments an object with Git support.
-    module Git
-      def git_supported?
-        File.exist? File.join(Dir.pwd, ".git")
-      end
-
-      def git_commits?
-        system "git log > /dev/null 2>&1"
-      end
-
-      def git_remote?
-        system "git config remote.origin.url"
-      end
-    end
-  end
-end