milestoner 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 048fc5e408dc33ae259639732315a07158ae5531
-  data.tar.gz: e6f3f12e4329cb47c58b1413f87aea235effab16
+  metadata.gz: c0f6d4ae3cad5d263731f769567b7ea089dd6b01
+  data.tar.gz: 32d6f0cc922a456c84c0428450d06b9e36863652
 SHA512:
-  metadata.gz: d176b7238258c0ba630ef0dfd81c05657b8da54463bb5c2b00844c22fbe3280d8cc13eee80d73520b238bbbb106bed144018b53be95a489212950fe4c49998e2
-  data.tar.gz: 61ee34af933007993308d74765d8375fe7a7e1c583a8f8a9f0e4d50774690c39f1d9df3b815d7a900a03af994d0af2ca75d6d18e8a32e953c908e5f61e8a195e
+  metadata.gz: 237f10aa51dccebe908b0ccbea8de79cb33bb7dbb6e48d589a8460923a2aff576715ac86442deda9442acb03063ca26dee4eac8c99fbaec53289cd77ff33b972
+  data.tar.gz: 059b456ca8328cb62c923ddd11df136ea022bfb99262549fedceeecb9a540d912aef8202b3c977cbe275a718d3ae0e295259b592fd43a2362dd937f80b508c63

data/README.md

@@ -57,14 +57,24 @@ For an insecure install, type the following (not recommended):
 
 From the command line, type: milestoner help
 
-    milestoner -h, [--help=HELP]  # Show this message or get help for a command.
-    milestoner -t, [--tag=TAG]    # Tag repository with new version.
-    milestoner -v, [--version]    # Show version.
+    milestoner -P, [--publish=PUBLISH]  # Tag and push to remote repository.
+    milestoner -h, [--help=HELP]        # Show this message or get help for a command.
+    milestoner -p, [--push]             # Push tags to remote repository.
+    milestoner -t, [--tag=TAG]          # Tag local repository with new version.
+    milestoner -v, [--version]          # Show version.
 
-For more gem creation 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
+
+    -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 release. Should individual steps
+be needed, then the `--tag` and `--push` options are available.
+
 # Tests
 
 To test, run:

data/lib/milestoner.rb

@@ -1,3 +1,4 @@
 require "milestoner/identity"
 require "milestoner/exceptions"
-require "milestoner/release"
+require "milestoner/pusher"
+require "milestoner/tagger"

data/lib/milestoner/cli.rb

@@ -15,15 +15,38 @@ module Milestoner
       super args, options, config
     end
 
-    desc "-t, [--tag=TAG]", "Tag repository with new version."
+    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
-      release = Milestoner::Release.new version
-      release.tag sign: options[:sign]
-      say "Repository tagged: #{release.version_label}."
+      tagger = Milestoner::Tagger.new version
+      tagger.create sign: 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
+    end
+
+    desc "-p, [--push]", "Push tags to remote repository."
+    map %w(-p --push) => :push
+    def push
+      pusher = Milestoner::Pusher.new
+      pusher.push
+      info "Tags pushed to remote repository."
+    end
+
+    desc "-P, [--publish=PUBLISH]", "Tag and push 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
     end
 
     desc "-v, [--version]", "Show version."
@@ -37,5 +60,16 @@ module Milestoner
     def help task = nil
       say && super
     end
+
+    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!"
+      else
+        tagger.destroy
+      end
+    end
   end
 end

data/lib/milestoner/exceptions.rb

@@ -2,4 +2,8 @@ module Milestoner
   # Raised for invalid version formats.
   class VersionError < StandardError
   end
+
+  # Raised for duplicate tags.
+  class DuplicateTagError < StandardError
+  end
 end

data/lib/milestoner/identity.rb

@@ -10,7 +10,7 @@ module Milestoner
     end
 
     def self.version
-      "0.1.0"
+      "0.2.0"
     end
 
     def self.label_version

data/lib/milestoner/pusher.rb

@@ -0,0 +1,16 @@
+module Milestoner
+  # Handles publishing of Git tags to remote repository.
+  class Pusher
+    def initialize kernel: Kernel
+      @kernel = kernel
+    end
+
+    def push
+      kernel.system "git push --tags"
+    end
+
+    private
+
+    attr_reader :kernel
+  end
+end

data/lib/milestoner/tagger.rb

@@ -0,0 +1,96 @@
+module Milestoner
+  # Handles the tagging of a project repository.
+  class Tagger
+    attr_reader :version
+
+    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
+
+    def self.version_regex
+      /\A\d{1}\.\d{1}\.\d{1}\z/
+    end
+
+    def initialize version
+      @version = validate_version version
+    end
+
+    def version_label
+      "v#{version}"
+    end
+
+    def version_message
+      "Version #{version}."
+    end
+
+    def tagged?
+      response = `git tag`
+      !(response.nil? || response.empty?)
+    end
+
+    def duplicate?
+      system "git rev-parse #{version_label} > /dev/null 2>&1"
+    end
+
+    def commits
+      groups = build_commit_prefix_groups
+      group_by_commit_prefix! groups
+      groups.values.flatten
+    end
+
+    def create sign: false
+      fail(DuplicateTagError, "Duplicate tag exists: #{version_label}.") if duplicate?
+      `git tag #{tag_options sign: sign}`
+    end
+
+    def destroy
+      `git tag --delete #{version_label}`
+    end
+
+    private
+
+    def validate_version version
+      message = "Invalid version: #{version}. Use: <major>.<minor>.<maintenance>."
+      fail(VersionError, message) unless version.match(self.class.version_regex)
+      version
+    end
+
+    def raw_commits
+      tag_command = "$(git describe --abbrev=0 --tags --always)..HEAD"
+      full_command = "git log --oneline --reverse --no-merges --format='%s' #{tag_command}"
+      full_command.gsub!(tag_command, "") unless tagged?
+
+      `#{full_command}`.split("\n")
+    end
+
+    def build_commit_prefix_groups
+      groups = self.class.commit_prefixes.map.with_object({}) do |prefix, group|
+        group.merge! prefix => []
+      end
+      groups.merge! "Other" => []
+    end
+
+    def group_by_commit_prefix! groups = {}
+      raw_commits.each do |commit|
+        prefix = commit[self.class.commit_prefix_regex]
+        key = groups.key?(prefix) ? prefix : "Other"
+        groups[key] << commit
+      end
+    end
+
+    def tag_message
+      commit_list = commits.map { |commit| "- #{commit}\n" }
+      %(#{version_message}\n\n#{commit_list.join})
+    end
+
+    def tag_options sign: false
+      options = %(--sign --annotate "#{version_label}" --message "#{tag_message}")
+      return options.gsub("--sign ", "") unless sign
+      options
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: milestoner
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -30,7 +30,7 @@ cert_chain:
   aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
   xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
   -----END CERTIFICATE-----
-date: 2015-09-06 00:00:00.000000000 Z
+date: 2015-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -315,7 +315,8 @@ files:
 - lib/milestoner/cli.rb
 - lib/milestoner/exceptions.rb
 - lib/milestoner/identity.rb
-- lib/milestoner/release.rb
+- lib/milestoner/pusher.rb
+- lib/milestoner/tagger.rb
 - lib/milestoner/tasks/rspec.rake
 - lib/milestoner/tasks/rubocop.rake
 homepage: https://www.alchemists.io

data/lib/milestoner/release.rb

@@ -1,91 +0,0 @@
-module Milestoner
-  # Handles the release of new project milestones.
-  class Release
-    attr_reader :version
-
-    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
-
-    def self.version_regex
-      /\A\d{1}\.\d{1}\.\d{1}\z/
-    end
-
-    def initialize version
-      @version = validate_version version
-    end
-
-    def version_label
-      "v#{version}"
-    end
-
-    def version_message
-      "Version #{version}."
-    end
-
-    def tagged?
-      response = `git tag`
-      !(response.nil? || response.empty?)
-    end
-
-    def commits
-      command = "git log --oneline --reverse --no-merges --format='%s'"
-
-      return `#{command}` unless tagged?
-      `#{command} $(git describe --abbrev=0 --tags --always)..HEAD`
-    end
-
-    def commits_sorted
-      prefix_regex = self.class.commit_prefix_regex
-
-      commits.split("\n").sort do |a, b|
-        next 1 unless a.match(prefix_regex) && b.match(prefix_regex)
-        sort_by_prefix a, b
-      end
-    end
-
-    def tag sign: false
-      `git tag #{tag_options sign: sign}`
-    end
-
-    private
-
-    def validate_version version
-      message = "Invalid version: #{version}. Use: <major>.<minor>.<maintenance>."
-      raise(VersionError, message) unless version.match(self.class.version_regex)
-      version
-    end
-
-    def index_for_prefix message
-      self.class.commit_prefixes.index message[self.class.commit_prefix_regex]
-    end
-
-    def sort_by_prefix a, b
-      a_index = index_for_prefix a
-      b_index = index_for_prefix b
-
-      case
-        when a_index > b_index then 1
-        when a_index == b_index then 0
-        when a_index < b_index then -1
-        else
-          a <=> b
-      end
-    end
-
-    def tag_message
-      commit_list = commits_sorted.map { |commit| "- #{commit}\n" }
-      %(#{version_message}\n\n#{commit_list.join})
-    end
-
-    def tag_options sign: false
-      options = %(--sign --annotate "#{version_label}" --message "#{tag_message}")
-      return options.gsub("--sign ", "") unless sign
-      options
-    end
-  end
-end