make_release 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9fbb23cdf86da813754fd4e9c9a91a152ee45600
+  data.tar.gz: ac4a0c3b38dc3015566c298ed0120eae68cbf81e
+SHA512:
+  metadata.gz: bdc3e3cc59912ed6ed74b017b6335f3ff23692142e40ba21d090aedeb6d12b6f26f440bc17dad7fe2f7ca5ca3c5efca2b17936be600d8a0f03c744816de43d9c
+  data.tar.gz: d663f98969f8810629ecb41aed8df0a8fd57c7e61d367827be19a2fa96663a98ae29f757fddd6b8e7a0fb91004b1c634250cc5b922fe59995ad733f71b368f02

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in make_release.gemspec
+gemspec

data/README.md

@@ -0,0 +1,45 @@
+# MakeRelease
+
+This is a standalone utility which will collect multiple JIRA stories and programmatically builds a release candidate branch.
+ - Can compare multiple feature branches against a single production branch (typically `master`)
+ - Displays the SHAs for all stories not yet merged into production
+ - Produce a release-candidate branch
+
+
+## Installation
+
+Install the `mkrelease` executable
+
+    $ gem install make_release
+
+## Usage
+
+	Usage: mkrelease [options]
+
+    Common Options:
+        -d, --directory DIR              Use DIR as our source directory
+        -m, --master BRANCH              Specify a master branch (default: master)
+        -r, --release-version VER        Specify the release version (REQUIRED)
+        -s, --source BRANCH              Use BRANCH as our starting branch to compare against (may be used more than once)
+    
+    Additional Options:
+        -q, --silent                     Run quietly (same as --no-verbose)
+        -v, --[no-]verbose               Run verbosely (default)
+    
+    Informational:
+        -h, --help                       Show this message
+        -V, --version                    Show version (and exit)
+            --diff                       Display a list of stories from all sources which haven't been merged into master
+            --dryrun                     Don't actually modify any files, just show what would happen
+            --debug                      Run with debugging options (use with caution)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `gem install make_release`. To release a new version, update the version number in `globals.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dyoung522/make_release
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "make_release"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/mkrelease

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby -w
+
+$LOAD_PATH.unshift('./lib')
+require 'make_release'
+
+MakeRelease.run!

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/make_release/git.rb

@@ -0,0 +1,17 @@
+require 'open3'
+
+module MakeRelease
+  module Git
+
+    def self.log(dir, branch)
+      cmd = "git log --no-merges --pretty='%H|%s' #{branch}"
+      Open3.popen3(cmd, chdir: dir) do |i,o,e,t|
+        if t.value != 0
+          raise RuntimeError, "Unable to obtain gitlog for #{branch} in #{dir}"
+        end
+        o.read.split("\n")
+      end
+    end
+
+  end
+end

data/lib/make_release/globals.rb

@@ -0,0 +1,16 @@
+module MakeRelease
+  module Globals
+    require 'yaml'
+
+    VERSION       = '0.1.1'
+    IDENT         = 'make_release'
+    BINIDENT      = 'mkrelease'
+    AUTHOR        = 'Donovan C. Young'
+    AEMAIL        = 'dyoung522@gmail.com'
+    SUMMARY       = %q{Creates a release candidate}
+    DESCRIPTION   = %q{Merges a list of JIRA stories from multiple branches into a release candidate}
+    HOMEPAGE      = "https://github.com/dyoung522/#{IDENT}"
+    LICENSE       = 'MIT'
+    VSTRING       = "#{IDENT} v.#{VERSION} - #{AUTHOR}, 2015"
+  end
+end

data/lib/make_release/options.rb

@@ -0,0 +1,95 @@
+require 'ostruct'
+require 'optparse'
+
+module MakeRelease
+  class Options
+
+    def self.default_options
+      {
+        directory: '.',
+        master:    'master',
+        source:    [],
+        release:   nil,
+        diff:      false,
+        dryrun:    false,
+        verbose:   true,
+        debug:     false,
+        stories:   nil
+      }
+    end
+
+    def self.defaults
+      Struct.new( *Options.default_options.keys ).new( *Options.default_options.values )
+    end
+
+    def self.parse( argv_opts = [] )
+      options = self.defaults
+
+      opt_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{Globals::BINIDENT} [options]"
+        opts.separator ''
+        opts.separator 'Common Options:'
+
+        opts.on('-d', '--directory DIR', 'Use DIR as our source directory') do |dir|
+          dir = File.expand_path(dir.strip)
+          if Dir.exist?(dir)
+            options.directory = dir
+          else
+            puts "Whoops: '#{dir}' is not a valid directory."
+            exit 2
+          end
+        end
+
+        opts.on('-m', '--master BRANCH', 'Specify a master branch (default: master)') do |master|
+          options.master = master
+        end
+
+        opts.on('-r', '--release-version VER', 'Specify the release version (REQUIRED)') do |rver|
+          options.release = rver
+        end
+
+        opts.on('-s', '--source BRANCH',
+                'Use BRANCH as our starting branch to compare against (may be used more than once)') do |branch|
+          options.source << branch unless options.source.include?(branch)
+        end
+
+        opts.separator ''
+        opts.separator 'Additional Options:'
+
+        opts.on('-q', '--silent', 'Run quietly (same as --no-verbose)') { options.verbose = false }
+        opts.on('-v', '--[no-]verbose', 'Run verbosely (default)') { |v| options.verbose = v }
+
+        opts.separator ''
+        opts.separator 'Informational:'
+
+        opts.on('-h', '--help', 'Show this message') { puts Globals::VSTRING + "\n\n"; puts opts;  exit 255; }
+        opts.on('-V', '--version', 'Show version (and exit)') { puts Globals::VSTRING;  exit 255; }
+        opts.on('--diff', "Display a list of stories from all sources which haven't been merged into master") { options.diff = true }
+        opts.on('--dryrun', %q{Don't actually modify any files, just show what would happen}) { options.dryrun = true }
+        opts.on('--debug', 'Run with debugging options (use with caution)') { options.debug = true }
+      end
+
+      opt_parser.parse!(argv_opts)
+
+      validate_options(options)
+    end
+
+    def self.validate_options(opts)
+      # raise OptionParser::MissingArgument, 'A release version (-r) is required' if opts.release.nil?
+
+      if opts.release && opts.release !~ /^v?(\d+\.)?(\d+\.)?(\*|\d+)/
+        raise RuntimeError, 'Release version must follow semantic versioning'
+      end
+
+      if opts.source.include?(opts.master)
+        raise RuntimeError, 'Source branches cannot include the master branch'
+      end
+
+      opts.source = ['develop'] if opts.source.empty?
+      opts.master = 'master' if opts.master.nil? || opts.master.strip == ''
+
+      opts
+    end
+
+  end
+end

data/lib/make_release/stories.rb

@@ -0,0 +1,104 @@
+require 'make_release/story'
+require 'make_release/git'
+
+module MakeRelease
+  class Stories
+
+    def initialize( opts = Options.defaults )
+      @options   = opts
+      @stories   = opts[:stories]   || {}
+      @directory = opts[:directory] || '.'
+      @branches  = _get_branches(opts[:master], opts[:source])
+
+      get_stories if @stories == {}
+    end
+
+    attr_accessor :branches, :directory
+    attr_reader :stories
+    alias dir directory
+
+    def each
+      @stories.values.each do |stories|
+        stories.each { |story| yield story }
+      end
+    end
+
+    def to_s
+      @stories.each do |branch, stories|
+        puts "#{branch.capitalize} -->"
+        stories.each { |s| puts s.to_s }
+      end
+    end
+
+    def source
+      @branches[1, @branches.size]
+    end
+
+    def master
+      @branches[0]
+    end
+
+    def master=(new_master)
+      @stories[master] = []
+      @branches[0] = new_master
+      get_stories(new_master)
+    end
+
+    def shas
+      source.map do |branch|
+        stories[branch].map { |s| s.sha }
+      end.flatten
+    end
+
+    def source_stories
+      story_index = {}
+
+      source.each do |branch|
+        stories[branch].each { |s| story_index[s.sha] = s }
+      end
+
+      story_index.values
+    end
+
+    def add_story( branch, story )
+      (@stories[branch] ||= []).push story
+    end
+
+    def find( branch, sha )
+      raise ArgumentError, "Invalid environment #{branch}" unless @branches.include?(branch)
+      @stories[branch].each { |story| return true if story.sha == sha }
+      false
+    end
+
+    def diff
+      stories = []
+      opts = @options
+
+      source_stories.each do |story|
+        stories << story unless find(master, story.sha)
+      end
+
+      opts.source = ['diff']
+      opts.stories = {'diff' => stories.flatten}
+      Stories.new opts
+    end
+
+    private
+
+    def _get_branches(master, sources)
+      branches = [] << (master.nil? ? 'master' : master)
+      branches << (sources.empty? ? ['develop'] : sources)
+      branches.flatten
+    end
+
+    def get_stories(branches = @branches)
+      branches.to_a.each do |branch|
+        Git.log(@directory, branch).each do |line|
+          add_story branch, Story.new(line)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/make_release/story.rb

@@ -0,0 +1,53 @@
+module MakeRelease
+
+  class Story
+    def initialize( story )
+      unless story =~ /\S+|\S+/
+        raise ArgumentError, "story must follow 'SHA|description' format"
+      end
+
+      @sha, @description = story.split('|')
+
+      raise ArgumentError if @sha.nil? || @description.nil?
+    end
+    attr_reader :sha
+
+    def split_story( description = @description )
+      raise RuntimeError 'description cannot be blank' unless description
+
+      stories = []
+      story_pattern = /\[?(((SRMPRT|OSMCLOUD)\-\d+)|NO-JIRA)\]?[,:\-\s]+\s*(.*)$/
+      line = description.match(story_pattern)
+
+      if line.nil? # did not find a JIRA ticket pattern
+        stories.push 'NO-JIRA'
+        desc = description.strip
+      else
+        stories.push line.captures[0]
+        desc = line.captures[3].strip
+      end
+
+      # Perform recursion if there are multiple tickets in the description
+      if desc =~ story_pattern
+        new_story, new_desc = split_story desc
+        stories.push new_story
+        desc = new_desc
+      end
+
+      [stories.flatten, desc]
+    end
+
+    def tickets
+      (split_story)[0]
+    end
+
+    def desc
+      (split_story)[1]
+    end
+
+    def to_s
+      '[%07.07s] %s - %s' % [sha, tickets.join(', '), desc]
+    end
+
+  end
+end

data/lib/make_release.rb

@@ -0,0 +1,56 @@
+require 'make_release/globals'
+require 'make_release/options'
+require 'make_release/stories'
+
+module MakeRelease
+  def self.not_implemented( feature )
+    puts "Sorry, #{feature} has not yet been implemented"
+    exit 2
+  end
+
+  def self.run!
+    begin
+      opts = Options.parse ARGV
+    rescue => error
+      puts error
+      exit 1
+    end
+
+    puts opts.inspect if opts.debug
+
+    stories = Stories.new(opts)
+
+    puts stories.inspect if opts.debug
+
+    if opts.diff
+
+      if opts.verbose
+        puts "From #{stories.directory}"
+        puts "-> All stories from #{stories.source.join(', ')}"
+        puts "-> Which are not in #{stories.master}"
+        stories.diff.each do |story|
+          puts "%-120.120s" % story.to_s
+        end
+      else
+        puts stories.diff.shas
+      end
+
+    else
+
+      if opts.verbose
+        puts "All stories from #{stories.directory}"
+        stories.branches.each do |branch|
+          puts "\n#{branch.capitalize}\n\n"
+          stories.stories[branch].each do |story|
+            puts "%-120.120s" % story.to_s
+          end
+        end
+      else
+        not_implemented('--silent')
+      end
+
+    end
+
+  end
+end
+

data/make_release.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'make_release/globals'
+
+Gem::Specification.new do |spec|
+  spec.name          = MakeRelease::Globals::IDENT
+  spec.version       = MakeRelease::Globals::VERSION
+  spec.authors       = [MakeRelease::Globals::AUTHOR]
+  spec.email         = [MakeRelease::Globals::AEMAIL]
+
+  spec.summary       = MakeRelease::Globals::SUMMARY
+  spec.description   = MakeRelease::Globals::DESCRIPTION
+  spec.homepage      = MakeRelease::Globals::HOMEPAGE
+  spec.license       = MakeRelease::Globals::LICENSE
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = ['mkrelease']
+  spec.require_paths = ['./lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end
+

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: make_release
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Donovan C. Young
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Merges a list of JIRA stories from multiple branches into a release candidate
+email:
+- dyoung522@gmail.com
+executables:
+- mkrelease
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/mkrelease
+- bin/setup
+- lib/make_release.rb
+- lib/make_release/git.rb
+- lib/make_release/globals.rb
+- lib/make_release/options.rb
+- lib/make_release/stories.rb
+- lib/make_release/story.rb
+- make_release.gemspec
+homepage: https://github.com/dyoung522/make_release
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Creates a release candidate
+test_files: []