milestoner 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 048fc5e408dc33ae259639732315a07158ae5531
+  data.tar.gz: e6f3f12e4329cb47c58b1413f87aea235effab16
+SHA512:
+  metadata.gz: d176b7238258c0ba630ef0dfd81c05657b8da54463bb5c2b00844c22fbe3280d8cc13eee80d73520b238bbbb106bed144018b53be95a489212950fe4c49998e2
+  data.tar.gz: 61ee34af933007993308d74765d8375fe7a7e1c583a8f8a9f0e4d50774690c39f1d9df3b815d7a900a03af994d0af2ca75d6d18e8a32e953c908e5f61e8a195e

data/LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Milestoner
+
+[![Gem Version](https://badge.fury.io/rb/milestoner.svg)](http://badge.fury.io/rb/milestoner)
+[![Code Climate GPA](https://codeclimate.com/github/bkuhlmann/milestoner.svg)](https://codeclimate.com/github/bkuhlmann/milestoner)
+[![Code Climate Coverage](https://codeclimate.com/github/bkuhlmann/milestoner/coverage.svg)](https://codeclimate.com/github/bkuhlmann/milestoner)
+[![Gemnasium Status](https://gemnasium.com/bkuhlmann/milestoner.svg)](https://gemnasium.com/bkuhlmann/milestoner)
+[![Travis CI Status](https://secure.travis-ci.org/bkuhlmann/milestoner.svg)](http://travis-ci.org/bkuhlmann/milestoner)
+
+A tool for automating and releasing Git repository milestones.
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+# Table of Contents
+
+- [Features](#features)
+- [Requirements](#requirements)
+- [Setup](#setup)
+- [Usage](#usage)
+- [Tests](#tests)
+- [Versioning](#versioning)
+- [Code of Conduct](#code-of-conduct)
+- [Contributions](#contributions)
+- [License](#license)
+- [History](#history)
+- [Credits](#credits)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+# 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 support for signing tags using GPG signing key.
+- Automatically includes commits since last tag (or HEAD if no tags exist) within each tag message.
+
+# Requirements
+
+0. A UNIX-based system.
+0. [MRI 2.x.x](http://www.ruby-lang.org).
+0. [GnuPG](https://www.gnupg.org).
+
+# Setup
+
+For a secure install, type the following (recommended):
+
+    gem cert --add <(curl -Ls http://www.my-website.com/gem-public.pem)
+    gem install milestoner --trust-policy MediumSecurity
+
+NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while
+allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
+
+For an insecure install, type the following (not recommended):
+
+    gem install milestoner
+
+# Usage
+
+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.
+
+For more gem creation options, type: milestoner help tag
+
+    -s, [--sign], [--no-sign]  # Sign tag with GPG key.
+
+# Tests
+
+To test, run:
+
+    bundle exec spec
+
+# Versioning
+
+Read [Semantic Versioning](http://semver.org) for details. Briefly, it means:
+
+- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
+- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
+- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
+
+# Code of Conduct
+
+Please note that this project is released with a [CODE OF CONDUCT](CODE_OF_CONDUCT.md). By participating in this project
+you agree to abide by its terms.
+
+# Contributions
+
+Read [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+# License
+
+Copyright (c) 2015 [Alchemists](https://www.alchemists.io).
+Read the [LICENSE](LICENSE.md) for details.
+
+# History
+
+Read the [CHANGELOG](CHANGELOG.md) for details.
+Built with [Gemsmith](https://github.com/bkuhlmann/gemsmith).
+
+# Credits
+
+Developed by [Brooke Kuhlmann](https://www.alchemists.io) at [Alchemists](https://www.alchemists.io).

data/bin/milestoner

@@ -0,0 +1,8 @@
+#!/usr/bin/ruby
+
+require "milestoner"
+require "milestoner/cli"
+require "milestoner/identity"
+
+Process.setproctitle Milestoner::Identity.label_version
+Milestoner::CLI.start

data/lib/milestoner.rb

@@ -0,0 +1,3 @@
+require "milestoner/identity"
+require "milestoner/exceptions"
+require "milestoner/release"

data/lib/milestoner/cli.rb

@@ -0,0 +1,41 @@
+require "yaml"
+require "thor"
+require "thor/actions"
+require "thor_plus/actions"
+
+module Milestoner
+  # The Command Line Interface (CLI) for the gem.
+  class CLI < Thor
+    include Thor::Actions
+    include ThorPlus::Actions
+
+    package_name Milestoner::Identity.label
+
+    def initialize args = [], options = {}, config = {}
+      super args, options, config
+    end
+
+    desc "-t, [--tag=TAG]", "Tag 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}."
+    rescue Milestoner::VersionError => version_error
+      error version_error.message
+    end
+
+    desc "-v, [--version]", "Show version."
+    map %w(-v --version) => :version
+    def version
+      say Milestoner::Identity.label_version
+    end
+
+    desc "-h, [--help=HELP]", "Show this message or get help for a command."
+    map %w(-h --help) => :help
+    def help task = nil
+      say && super
+    end
+  end
+end

data/lib/milestoner/exceptions.rb

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

data/lib/milestoner/identity.rb

@@ -0,0 +1,20 @@
+module Milestoner
+  # The canonical source of gem information.
+  module Identity
+    def self.name
+      "milestoner"
+    end
+
+    def self.label
+      "Milestoner"
+    end
+
+    def self.version
+      "0.1.0"
+    end
+
+    def self.label_version
+      [label, version].join " "
+    end
+  end
+end

data/lib/milestoner/release.rb

@@ -0,0 +1,91 @@
+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

data/lib/milestoner/tasks/rspec.rake

@@ -0,0 +1,6 @@
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError => error
+  puts error.message
+end

data/lib/milestoner/tasks/rubocop.rake

@@ -0,0 +1,6 @@
+begin
+  require "rubocop/rake_task"
+  RuboCop::RakeTask.new
+rescue LoadError => error
+  puts error.message
+end

metadata

@@ -0,0 +1,345 @@
+--- !ruby/object:Gem::Specification
+name: milestoner
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brooke Kuhlmann
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMQ8wDQYDVQQDDAZicm9v
+  a2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQBGRYC
+  aW8wHhcNMTUwNzA1MTQ1MzExWhcNMTYwNzA0MTQ1MzExWjBBMQ8wDQYDVQQDDAZi
+  cm9va2UxGjAYBgoJkiaJk/IsZAEZFgphbGNoZW1pc3RzMRIwEAYKCZImiZPyLGQB
+  GRYCaW8wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCzhOVcvLGBCceM
+  PppVpJLUKsnskWzc1VqBXmv30feKNw+MOxMQaDsIP421qwqGO/2JHY60Kuobssk+
+  8/wqZkVFF/FFKxoQjuhlhc+VWLm8jWgXd4N1kwO2yytscQTzxc5qXarwA+36fqVH
+  RhBAHhjka+HdBI+6o3CXRHJoC47iav+QpR7u/wYl3gNq6MJO3MmTKqHegEDLjRN0
+  FJAr3bRAwq03ZtTuAVA2bdKLGThehe1RRRtJHJ/PHpmL2c203/GTXYtG6C8ILZIp
+  ZroTqQ8yglCJ+3hSOmodZqSAQ0Rj7GJgtuNH81qlSrHu5sTvoZjGmEqSIhvsSJ80
+  wKoPdZnFAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBSUnF478a5lB4xuOBiktJdMJv6JmDAfBgNVHREEGDAWgRRicm9va2VAYWxjaGVt
+  aXN0cy5pbzAfBgNVHRIEGDAWgRRicm9va2VAYWxjaGVtaXN0cy5pbzANBgkqhkiG
+  9w0BAQUFAAOCAQEAT7KtBXWsq1KA7NOSMeFEDeSvhrgdLwCG/37pIu0rjvx9iAW4
+  gncxV0MccqIUtaF+lekjlXkIO+rXAVjvdha23KtpFTW90dYXp4NLPnPlSdyvYzJy
+  FIAaWGvujOT8xEu4umd45q5aepE8li4bR071i5Z7F0trKNVYYrxjQFmH5SSKYRT/
+  fXtICtAh1de3z3SOSK58IMPwjuoApYBxiqlmx0Uhla7mrzCE5+NmLPit3hLH6JFK
+  aSif+qBc6oHD7EQWPF5cZkzkIURuwNwPBngZGxIKaMAgRhjGFXzUMAaq++r59cS9
+  xTfQ4k6fglKEgpnLAXiKdo2c8Ym+X4rIKFfedQ==
+  -----END CERTIFICATE-----
+date: 2015-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor_plus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: gemsmith
+  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: pry
+  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: pry-byebug
+  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: pry-state
+  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: pry-stack_explorer
+  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: pry-remote
+  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: pry-rescue
+  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
+    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: rb-fsevent
+  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: guard-rspec
+  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: terminal-notifier
+  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: terminal-notifier-guard
+  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: climate_control
+  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: greenletters
+  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: rubocop
+  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: codeclimate-test-reporter
+  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'
+description: A tool for automating and releasing Git repository milestones.
+email:
+- brooke@alchemists.io
+executables:
+- milestoner
+extensions: []
+extra_rdoc_files:
+- README.md
+- LICENSE.md
+files:
+- LICENSE.md
+- README.md
+- bin/milestoner
+- lib/milestoner.rb
+- lib/milestoner/cli.rb
+- lib/milestoner/exceptions.rb
+- lib/milestoner/identity.rb
+- lib/milestoner/release.rb
+- lib/milestoner/tasks/rspec.rake
+- lib/milestoner/tasks/rubocop.rake
+homepage: https://www.alchemists.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: A tool for automating and releasing Git repository milestones.
+test_files: []

metadata.gz.sig

@@ -0,0 +1,3 @@
+�����c*��nK����x̩���t��[�CS�����
+��i竆
+�)���cZ)�0�