gitgut 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94dc47b7fdf0914947313f8a19c3c14e3b79c2f2
+  data.tar.gz: cdc09a9fbb53282f8888e20c7f113dc8828115aa
+SHA512:
+  metadata.gz: ffa8a129a1fbf84d70f0e695143e8076697ab9d20f6de3ae89f4836e8c915b8681d2cc26f44d687e385c24f647d231c66bdf54d9cac71bfab95b439c7e591e41
+  data.tar.gz: 3a2dc0fe09932f8f6eadd34211ae404ceeccbeec2cbb17927fff1aaef212902f3ddf4c6264b9805a3595d79e4322b059048c1c0da43ab68e894a12cb1e5fdcb3

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+*.swp

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Benoit Dinocourt
+
+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,76 @@
+# Gitgut
+
+Display PR and JIRA tickets info about the branches that are currently checked out on your git repository.
+
+## Disclaimer
+
+This gem is tailored for the JobTeaser.com development workflow and is probably not suited for anything else at this time.
+
+Use only for inspiration purpose.
+
+## Expected features
+
+* Show how many commits are not merged in staging/develop
+* Show all commits for the branch only
+* Allow to checkout a branch from the jira number
+* Show if branch has one or more PR and the state of the PR
+* Categorize branches by JIRA/NO JIRA, developer/reviewer, JIRA status
+* Automatically delete branches that are merged in develop
+* Display time retrieving various info
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gitgut'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gitgut
+
+## Usage
+
+Add a .gitgut file to the working directory of your application
+
+    # .gitgut
+    jira:
+      username: first_name.last_name
+      password: 'p@$$W0rd'
+      endpoint: https://[companyname].atlassian.net/rest/api/2/search
+
+    github:
+      login: username
+      password: 'p@$$W0rd'
+      repo:
+        name: name_of_the_repository
+        owner: repo_owner_username
+
+And then run gitgut from the same directory
+
+    $ gitgut
+
+### Interactive console
+
+    $ bin/console
+
+## 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`. To release a new version, update the version number in `version.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/Ghrind/gitgut.
+
+
+## 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,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 "gitgut"
+
+# 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/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/exe/gitgut

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+
+t1 = Time.now
+
+lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+$LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
+
+require 'gitgut'
+
+require 'colorize'
+
+headings = ['Branch name', 'Develop', 'Staging', 'PR', 'JIRA', 'Suggestion']
+
+def present_commit_count(count, error = false)
+  return count.to_s.colorize(:red) if error
+  return '-' if count.zero?
+  count.to_s
+end
+
+print 'Retrieving info: '
+data = []
+
+branches = []
+`git branch`.each_line do |l|
+  branch = Gitgut::Branch.new(l)
+
+  next if %w(develop master staging).include? branch.name
+
+  branches << branch
+end
+
+require 'parallel'
+branches = Parallel.map(branches) do |branch|
+  branch.preload!.tap do
+    print '.'.colorize(:green)
+  end
+end
+
+branches.each do |branch|
+  row = [
+    branch.name.colorize(branch.color),
+    present_commit_count(branch.to_develop),
+    present_commit_count(branch.to_staging, branch.develop_is_ahead_of_staging? || branch.merge_in_staging_required_by_ticket_status?),
+    branch.pull_requests.map { |pr| pr.number.colorize(pr.color) }.join(' '),
+    (branch.ticket ? branch.ticket.key.colorize(branch.ticket.color) : ''),
+    #(branch.ticket ? branch.ticket.assignee_initials : ''),
+    #(branch.ticket ? branch.ticket.status : '')
+    branch.action_suggestion
+  ]
+
+  data << row
+end
+puts
+puts
+
+require 'terminal-table'
+table = Terminal::Table.new headings: headings, rows: data
+
+puts table
+
+puts
+puts "Rendered in #{(Time.now - t1).round(1)}s"

data/gitgut.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitgut/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "gitgut"
+  spec.version       = Gitgut::VERSION
+  spec.authors       = ["Benoit Dinocourt"]
+  spec.email         = ["ghrind@gmail.com"]
+
+  spec.summary       = %q{See your branches, Github PRs and JIRA tickets in one glance!}
+  spec.description   = %q{Display PR and JIRA tickets info about the branches that are currently checked out on your git repository.}
+  spec.homepage      = "https://github.com/Ghrind/gitgut"
+  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"]
+
+  # TODO: Add required versions
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'httparty'
+  spec.add_dependency 'parallel'
+  spec.add_dependency 'terminal-table'
+  spec.add_dependency 'octokit'
+  spec.add_dependency 'settingslogic'
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'simplecov'
+  # spec.add_development_dependency 'pry-byebug'
+end

data/lib/gitgut/branch.rb

@@ -0,0 +1,109 @@
+module Gitgut
+  # A local git branch
+  class Branch
+    def initialize(name)
+      @raw_name = name
+    end
+
+    # TODO: Sanitization should be done elsewhere
+    def name
+      return @name if @name
+      match_data = /[ *]+(?<branch>[^\s]*)/.match @raw_name
+      @name = match_data[:branch]
+    end
+
+    def to_develop
+      Gitgut::Git.missing_commits_count('develop', name)
+    end
+
+    def from_develop
+      Gitgut::Git.missing_commits_count(name, 'develop')
+    end
+
+    def to_staging
+      Gitgut::Git.missing_commits_count('staging', name)
+    end
+
+    def from_staging
+      Gitgut::Git.missing_commits_count(name, 'staging')
+    end
+
+    def pull_requests
+      @pull_requests ||= Gitgut::Github.client.pull_requests("#{Settings.github.repo.owner}/#{Settings.github.repo.name}", state: 'all', head: "#{Settings.github.repo.owner}:#{name}").map { |pr| Gitgut::Github::PullRequest.new(pr) }
+    end
+
+    def jira_ticket_number
+      matches = name.match(/^jt-(?<id>\d+)/i)
+      return 'JT-' + matches[:id] if matches
+    end
+
+    def ticket
+      return @ticket if defined?(@ticket)
+      if jira_ticket_number
+        payload = Gitgut::Jira.request 'id=' + jira_ticket_number
+        return @ticket = nil if payload['issues'].empty?
+        @ticket = Gitgut::Jira::Ticket.new(payload['issues'].first)
+      else
+        @ticket = nil
+      end
+    end
+
+    def color
+      return :red unless valid?
+      if has_pull_requests? && all_pull_requests_merged?
+        :green
+      else
+        :white
+      end
+    end
+
+    def all_pull_requests_merged?
+      pull_requests.all?(&:merged?)
+    end
+
+    def has_pull_requests?
+      !pull_requests.empty?
+    end
+
+    def valid?
+      return false if develop_is_ahead_of_staging?
+      return false if merge_in_staging_required_by_ticket_status?
+      true
+    end
+
+    def develop_is_ahead_of_staging?
+      to_develop > 0 && to_develop < to_staging
+    end
+
+    def merge_in_staging_required_by_ticket_status?
+      return false unless ticket
+      if ['In Functional Review', 'In Review', 'Ready for Release'].include?(ticket.status) && to_staging > 0
+        return true
+      end
+      false
+    end
+
+    def merged_everywhere?
+      to_staging.zero? && to_develop.zero?
+    end
+
+    def action_suggestion
+      return 'Review the PR' if ticket && ticket.assigned_to_me? && ticket.in_review?
+      return 'Merge into staging' if merge_in_staging_required_by_ticket_status?
+      return 'Merge into staging or update your staging branch' if develop_is_ahead_of_staging?
+      if ticket
+        return 'Do some code' if ticket.assigned_to_me?
+        return 'Assign the ticket to me (and start the development)' if ticket.assignee.nil? && !ticket.done?
+      end
+      return 'Delete the local branch' if (merged_everywhere? && (!ticket || ticket.done?)) || (ticket && ticket.closed?)
+    end
+
+    def preload!
+      ticket
+      pull_requests
+      to_staging
+      to_develop
+      self
+    end
+  end
+end

data/lib/gitgut/git.rb

@@ -0,0 +1,11 @@
+module Gitgut
+  # Wrapper around git commands
+  #
+  # Show commits only on this branch
+  # git log --no-merges HEAD --not develop --pretty=oneline
+  module Git
+    def self.missing_commits_count(from, to)
+      `git rev-list #{from}..#{to} --count`.to_i
+    end
+  end
+end

data/lib/gitgut/github.rb

@@ -0,0 +1,37 @@
+require 'octokit'
+
+module Gitgut
+  # A wrapper around an octokit client
+  module Github
+    def self.client
+      @client ||= Octokit::Client.new(login: Settings.github.login, password: Settings.github.password)
+    end
+
+    # A Github pull request
+    class PullRequest
+      attr_reader :number, :state, :merged_at
+
+      def initialize(payload)
+        @number = payload[:number].to_s
+        @state = payload[:state]
+        # @url = payload[:url]
+        # @title = payload[:title]
+        @merged_at = payload[:merged_at]
+        # @closed_at = payload[:closed_at]
+      end
+
+      def color
+        case state
+        when 'open'
+          :white
+        when 'closed'
+          merged? ? :green : :light_black
+        end
+      end
+
+      def merged?
+        !@merged_at.nil?
+      end
+    end
+  end
+end

data/lib/gitgut/jira.rb

@@ -0,0 +1,110 @@
+require 'httparty'
+
+module Gitgut
+  # Namespace around Atlassian/JIRA objects
+  module Jira
+    # A JIRA ticket
+    class Ticket
+      attr_reader :key, :assignee, :status
+
+      def initialize(payload)
+        @key = payload['key']
+        # TODO: use Mash?
+        if payload['fields']['assignee']
+          @assignee = payload['fields']['assignee']['name']
+          @assignee_display_name = payload['fields']['assignee']['displayName']
+        end
+
+        if payload['fields']['status']
+          @status = payload['fields']['status']['name']
+        end
+      end
+
+      def assigned_to_me?
+        assignee == Settings.jira.username
+      end
+
+      def assignee_initials
+        return '' unless assignee
+        words = @assignee_display_name.split(/ +/)
+        "#{words.first} #{words.last[0]}."
+      end
+
+      def ready_for_release?
+        status == 'Ready for Release'
+      end
+
+      def in_review?
+        status == 'In Review'
+      end
+
+      def done?
+        ready_for_release? || released? || closed?
+      end
+
+      def closed?
+        status == 'Closed'
+      end
+
+      def released?
+        status == 'Released'
+      end
+
+      def color
+        return :light_blue if assigned_to_me?
+        case status
+        when 'In Functional Review', 'In Review'
+          :white
+        when 'In Development', 'Open'
+          :light_blue
+        when 'Ready for Release', 'Released'
+          :green
+        when 'Closed'
+          :light_black
+        else
+          :white
+        end
+      end
+    end
+
+    def self.request(query)
+      response = Request.new(query).perform!
+      JSON.parse(response.body)
+    end
+
+    # Wrapper around a JQL query for JIR
+    class Request
+      DEFAULT_OPTIONS = {
+        headers: { 'Content-Type' => 'application/json' }
+      }.freeze
+
+      JQL_PARAM_NAME = 'jql'.freeze
+
+      def initialize(query)
+        @query = query
+      end
+
+      # TODO: Maybe use a flag like performed? and store the response in an
+      # attr_reader
+      def perform!
+        options = DEFAULT_OPTIONS.merge(
+          basic_auth: auth_options
+        )
+        HTTParty.get(url, options)
+      end
+
+      def url
+        url = URI.parse(Settings.jira.endpoint)
+        url.query = "#{JQL_PARAM_NAME}=#{URI.escape(@query)}"
+        url
+      end
+
+      def auth_options
+        {
+          username: Settings.jira.username,
+          password: Settings.jira.password
+        }
+      end
+    end
+  end
+end

data/lib/gitgut/settings.rb

@@ -0,0 +1,10 @@
+require 'settingslogic'
+
+module Gitgut
+  # Application-wide settings accessor
+  #
+  # It reads the .gitgut in the runtime directory
+  class Settings < Settingslogic
+    source '.gitgut'
+  end
+end

data/lib/gitgut/version.rb

@@ -0,0 +1,3 @@
+module Gitgut
+  VERSION = '0.1.1'.freeze
+end

data/lib/gitgut.rb

@@ -0,0 +1,10 @@
+require "gitgut/version"
+require 'gitgut/jira'
+require 'gitgut/branch'
+require 'gitgut/github'
+require 'gitgut/git'
+require 'gitgut/settings'
+
+module Gitgut
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: gitgut
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Benoit Dinocourt
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  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: httparty
+  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: parallel
+  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: terminal-table
+  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: octokit
+  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: settingslogic
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: simplecov
+  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: Display PR and JIRA tickets info about the branches that are currently
+  checked out on your git repository.
+email:
+- ghrind@gmail.com
+executables:
+- gitgut
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/gitgut
+- gitgut.gemspec
+- lib/gitgut.rb
+- lib/gitgut/branch.rb
+- lib/gitgut/git.rb
+- lib/gitgut/github.rb
+- lib/gitgut/jira.rb
+- lib/gitgut/settings.rb
+- lib/gitgut/version.rb
+homepage: https://github.com/Ghrind/gitgut
+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: See your branches, Github PRs and JIRA tickets in one glance!
+test_files: []