devtools-jdiff 1.0.0

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.13.5

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :test do
+  gem "simplecov"
+  gem "codeclimate-test-reporter", "~> 1.0.0"
+end
+
+# Specify your gem's dependencies in ora-dev-tools.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Donovan Young
+
+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,34 @@
+[![Build Status](https://travis-ci.org/dyoung522/devtools-jdiff.svg?branch=master)](https://travis-ci.org/dyoung522/devtools-jdiff)
+[![Code Climate](https://codeclimate.com/github/dyoung522/devtools-jdiff/badges/gpa.svg)](https://codeclimate.com/github/dyoung522/devtools-jdiff)
+[![Test Coverage](https://codeclimate.com/github/dyoung522/devtools-jdiff/badges/coverage.svg)](https://codeclimate.com/github/dyoung522/devtools-jdiff/coverage)
+
+# JIRADiff
+
+Compares JIRA stories from two git branches, displaying the difference
+
+## Installation
+
+Install it from the command line
+
+    $ gem install devtools-jdiff
+
+## Usage
+
+Once installed, this gem provides the `jdiff` command line utility.
+
+Please run `jdiff --help` for more information.
+
+## 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 `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on [our GitHub page](https://github.com/dyoung522/devtools)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::Task[:build].enhance [:spec]
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jira_diff"
+
+# 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 "pry"
+Pry.start
+

data/bin/setup

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

data/devtools-jdiff.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "jira_diff/globals"
+
+Gem::Specification.new do |spec|
+  spec.name    = "devtools-jdiff"
+  spec.version = JIRADiff::VERSION
+  spec.authors = ["Donovan Young"]
+  spec.email   = ["dyoung522@gmail.com"]
+
+  spec.summary     = %q{Compares git branches, searching for JIRA stories}
+  spec.description = %q{Looks for JIRA stories within the commits in a git repository} +
+                     %q{and compares branches to find stories included in one branch} +
+                     %q{but not another}
+  spec.homepage    = "https://github.com/dyoung522/devtools-jdiff"
+  spec.license     = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "config", "~> 1.3"
+  spec.add_dependency "octokit", "~> 4.0"
+  spec.add_dependency "devtools-base", "~> 2.0"
+
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.4"
+  spec.add_development_dependency "factory_girl", "~> 4.0"
+end

data/exe/jdiff

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+lib = File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "jira_diff"
+
+JIRADiff.run!

data/lib/jira_diff.rb

@@ -0,0 +1,44 @@
+require "devtools"
+require "jira_diff/globals"
+require "jira_diff/options"
+require "jira_diff/stories"
+
+module JIRADiff
+  def self.not_implemented(feature)
+    puts "Sorry, #{feature} has not yet been implemented"
+    exit 2
+  end
+
+  def self.run!
+    begin
+      opts = OptParse.parse ARGV
+    rescue => error
+      puts error
+      exit 1
+    end
+
+    puts opts.inspect if opts.debug
+
+    begin
+      puts 'Searching for stories...' if opts.verbose
+      stories = Stories.new(opts)
+    rescue RuntimeError => error
+      puts error
+      exit 1
+    end
+
+    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
+
+  end
+
+end
+

data/lib/jira_diff/git.rb

@@ -0,0 +1,30 @@
+require 'open3'
+
+module JIRADiff
+  class Git
+
+    def initialize(dir = '.')
+      raise StandardError, "Directory '#{dir}' is not valid" unless Dir.exist?(dir)
+      raise RuntimeError, "Doesn't look like '#{dir}' is a Git repository" unless Dir.exist?(File.join(dir, '.git'))
+
+      @working_dir = dir
+    end
+
+    def log(branch)
+      raise RuntimeError, "Invalid branch: #{branch}" unless branch_valid? branch
+      run_command("\\git --no-pager log --no-merges --pretty='%H|%s' #{branch}")
+    end
+
+    def branch_valid?(branch)
+      run_command("\\git branch --all --list #{branch}")[0] =~ /#{branch}/
+    end
+
+    private
+
+    def run_command(cmd)
+      Open3.popen3(cmd, chdir: @working_dir) do |_i, o, _e, _t|
+        o.read.split("\n")
+      end
+    end
+  end
+end

data/lib/jira_diff/globals.rb

@@ -0,0 +1,4 @@
+module JIRADiff
+  PROGRAM_NAME = "JIRADiff"
+  VERSION      = "1.0.0"
+end

data/lib/jira_diff/options.rb

@@ -0,0 +1,68 @@
+require "devtools"
+
+module JIRADiff
+  class OptParse
+
+    def self.default_options
+      {
+        debug:     false,
+        directory: ".",
+        dryrun:    false,
+        master:    "master",
+        source:    [],
+        verbose:   true
+      }
+    end
+
+    def self.parse(argv_opts = [], unit_testing = false)
+      opt_parse = DevTools::OptParse.new({ name:     PROGRAM_NAME,
+                                           version:  VERSION,
+                                           testing:  unit_testing,
+                                           defaults: default_options })
+
+      parser = opt_parse.parser
+
+      parser.banner = "Usage: #{DevTools::PROGRAM} [OPTIONS]"
+
+      parser.separator ""
+      parser.separator "[OPTIONS]"
+
+      parser.separator ""
+      parser.separator "Specific Options:"
+
+      parser.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
+          raise ArgumentError, "ENOEXIST: Directory does not exist -> #{dir}"
+        end
+      end
+
+      parser.on("-m", "--master BRANCH", "Specify a master branch (default: master)") { |m| Options.master = m }
+      parser.on("-s", "--source BRANCH",
+                "Use BRANCH as the source to compare against (may be used more than once)") do |branch|
+        Options.source << branch unless Options.source.include?(branch)
+      end
+
+      parser.separator ""
+      parser.separator "Common Options:"
+
+      parser.parse!(argv_opts)
+
+      validate_options(Options)
+    end
+
+    def self.validate_options(opts)
+      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/jira_diff/stories.rb

@@ -0,0 +1,122 @@
+require 'jira_diff/story'
+require 'jira_diff/git'
+
+module JIRADiff
+  class Stories
+
+    def initialize(opts = Options.defaults)
+      @branches = _get_branches(opts[:master], opts[:source])
+      @directory = opts[:directory] || '.'
+      @includes = _get_includes(opts.includes)
+      @options = opts
+      @stories = opts[:stories] || {}
+
+      _get_stories if @stories == {}
+    end
+
+    attr_accessor :branches, :directory
+    attr_reader :stories, :includes
+
+    alias dir directory
+
+    def each
+      @stories.values.each do |stories|
+        stories.each { |story| yield story }
+      end
+    end
+
+    def source
+      @branches[1, @branches.size]
+    end
+
+    def add_include(story)
+      @includes << story
+    end
+
+    def includes=(file)
+      @includes = _get_includes(file)
+    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.reverse
+    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_includes(includes_file)
+      lines = []
+      if includes_file && File.exist?(includes_file)
+        File.open(includes_file, 'r') do |f|
+          f.each_line { |line| lines << $1 if line =~ /(\w+\-\d+)/ }
+        end
+      end
+      lines
+    end
+
+    def _get_stories(branches = @branches)
+      git = Git.new(@directory)
+
+      branches.to_a.each do |branch|
+        puts "checking #{branch}" if @options.debug
+        git.log(branch).each do |line|
+          add_story branch, Story.new(line)
+        end
+      end
+    end
+
+  end
+end
+

data/lib/jira_diff/story.rb

@@ -0,0 +1,53 @@
+module JIRADiff
+
+  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