gitra 0.0.1

data/README.md

@@ -0,0 +1,66 @@
+## Git repository analyser
+
+(The too-soon version)
+
+[![Build Status](https://travis-ci.org/sldblog/gitra.png?branch=master)](https://travis-ci.org/sldblog/gitra)
+
+### Usage
+
+```
+Usage: gitra [options]
+    -a, --analyse [BRANCH]           Analyze the repository in relation the the specified branch (defaults to master).
+    -l, --log SINCE_REV              Shows the stories and bugs committed since the specified revision.
+```
+
+### Sample use case
+
+Given the following git repository:
+
+```
+$ git log --oneline --graph --all --decorate
+* 0fbdc16 (HEAD, master) master #3
+*   08a0df3 Merge branch 'test'
+|\
+* | 23e7058 master #2
+* | b4c12ca master #1
+| | * 08e7339 (test) test #3
+| |/
+| * af75469 test #2
+| * de14754 test #1
+|/
+* 6530d98 first
+```
+
+You can analyse the ahead/behind information using `gitra`.
+
+By default, it analyses the active branch in the repository it is in (you have to be physically in the repo directory for now):
+
+```
+$ git branch
+* master
+  test
+```
+
+```
+$ gitra -a
+---- Analyzing branches in relation to master ----
+Analysing 2 branches: ..
+master merged
+  test 1 ahead (unmerged), (but 2 behind)
+```
+
+You can specify any branches as part of the command line:
+
+```
+$ gitra -a test
+---- Analyzing branches in relation to test ----
+Analysing 2 branches: ..
+  test merged
+master 2 ahead (unmerged), (but 1 behind)
+```
+
+As you can see, the reported information is in line compared to the repository graph displayed above:
+- `master` is indeed ahead by 2 commits (`08a0df3`, `0fbdc16`), but missing 1 (`08e7339`), when viewed from `test` branch
+- the other way around if viewed from the `master` branch
+
+This kind of analysis really helps our current team to get on top of the current branching strategy we inherited.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec/support'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end

data/bin/gitra

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+$:.unshift(File.dirname(__FILE__) + '/../lib') unless $:.include?(File.dirname(__FILE__) + '/../lib')
+
+require 'gitra'
+require 'optparse'
+require 'ostruct'
+require 'term/ansicolor'
+
+class String; include Term::ANSIColor; end
+
+options = OpenStruct.new
+parser = OptionParser.new do |opts|
+  opts.banner = "Usage: gitra [options]"
+
+  opts.on("-a [BRANCH]", "--analyse [BRANCH]", "Analyze the repository in relation the the specified branch (defaults to master).") do |branch|
+    options.command = :analyze
+    options.parameter = branch || 'master'
+  end
+  opts.on("-l SINCE_REV", "--log SINCE_REV", "Shows the stories and bugs committed since the specified revision.") do |since_rev|
+    options.command = :history
+    options.parameter = since_rev
+  end
+end
+
+begin
+  parser.parse!
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+  $stderr.puts e.to_s.red
+end
+
+if options.command
+  cli = Gitra::CLI.new
+  cli.send(options.command, options.parameter)
+else
+  puts parser
+end

data/lib/gitra.rb

@@ -0,0 +1,4 @@
+require 'gitra/tracker'
+require 'gitra/cli'
+require 'gitra/git_patches'
+require 'gitra/parser'

data/lib/gitra/cli.rb

@@ -0,0 +1,64 @@
+require 'term/ansicolor'
+
+class String
+  include Term::ANSIColor
+end
+
+module Gitra
+
+  class CLI
+    def initialize
+      @tracker = Tracker.new '.'
+    end
+
+    def analyze(reference_branch)
+      reference_branch ||= @tracker.current_branch
+
+      $stdout.puts "---- Analyzing branches in relation to #{reference_branch.yellow} ----"
+      branches = ([reference_branch] + @tracker.branches).uniq!
+
+      $stdout.print "Analysing #{branches.size} branches: "
+      branch_analysis = branches.map do |branch|
+        $stdout.print '.'
+        $stdout.flush
+        unmerged = @tracker.branch(branch).commits_since(reference_branch).collect { |c| c.sha }
+        behind = @tracker.branch(reference_branch).commits_since(branch).collect { |c| c.sha }
+        {:name => branch, :behind => behind.size, :unmerged => unmerged.size}
+      end
+      $stdout.puts
+
+      name_max_size = branch_analysis.map { |item| item[:name].size }.sort.last
+      branch_analysis.each do |item|
+        state = []
+        state << "#{item[:unmerged]} ahead (unmerged)".red if item[:unmerged] > 0
+        state << "(but #{item[:behind]} behind)" if item[:unmerged] > 0 and item[:behind] > 0
+        state << 'merged'.green if state.empty?
+        $stdout.puts "%#{name_max_size}s %s" % [item[:name], state.join(', ')]
+      end
+    end
+
+    def history(since_revision)
+      current = @tracker.current_branch
+
+      $stdout.puts "---- Analyzing commit history from #{since_revision.yellow} to #{current.yellow} ----"
+      commits = @tracker.branch(current).commits_since(since_revision)
+
+      $stdout.print "Analysing #{commits.size} commits: "
+      commit_parser = Gitra::Parser.new('.gitra-rules.yml')
+      commits.each do |commit|
+        $stdout.print '.'
+        $stdout.flush
+        commit_parser.use(commit)
+      end
+      $stdout.puts
+
+      commit_parser.result.each_pair do |type, ids|
+        ids.sort.each do |id, commits|
+          description = commits.map { |c| c.sha.slice(0..10) }.join(', ')
+          $stdout.puts "%28s - %s" % ["#{type.to_s} #{id.to_s}".yellow, description]
+        end
+      end
+    end
+  end
+
+end

data/lib/gitra/git_patches.rb

@@ -0,0 +1,27 @@
+require 'git'
+
+module Git
+  class Base
+    def merge_base(commit1, commit2)
+      self.lib.merge_base(commit1, commit2)
+    end
+
+    def log_ancestry(from, to)
+      self.lib.log_ancestry(from, to).map { |c| Git::Object::Commit.new(self, c['sha'], c) }
+    end
+  end
+
+  class Lib
+    def merge_base(commit1, commit2)
+      command('merge-base', [commit1, commit2])
+    end
+
+    def log_ancestry(from, to)
+      arr_opts = ['--pretty=raw']
+      arr_opts << "#{from.to_s}..#{to.to_s}"
+      arr_opts << '--ancestry-path'
+      full_log = command_lines('log', arr_opts, true)
+      process_commit_data(full_log)
+    end
+  end
+end

data/lib/gitra/parser.rb

@@ -0,0 +1,32 @@
+require 'yaml'
+
+module Gitra
+  class Parser
+    def initialize(rule_file)
+      rule_file ||= '.gitra-rules.yml'
+      @rules = YAML.load_file(rule_file)
+
+      @uses = {}
+      @rules.each_pair do |name, patterns|
+        @uses[name] = {}
+        patterns.map! { |p| Regexp.new p }
+      end
+    end
+
+    def use(commit)
+      @rules.each_pair do |name, patterns|
+        patterns.each do |pattern|
+          match = pattern.match commit.message
+          next unless match
+
+          id = match[1].to_i
+          (@uses[name][id] ||= []) << commit
+        end
+      end
+    end
+
+    def result
+      @uses
+    end
+  end
+end

data/lib/gitra/tracker.rb

@@ -0,0 +1,51 @@
+require 'git'
+
+module Gitra
+
+  class Tracker
+    def initialize(repository)
+      @git = Git.open(repository)
+    end
+
+    def current_branch
+      @git.current_branch
+    end
+
+    def branches
+      @git.branches.select do |branch|
+        name = branch.full.gsub(%r{^remotes/}, '')
+        next if name =~ / -> /
+        block_given? ? yield(name) : true
+      end.map { |branch| branch.full.gsub(%r{^remotes/}, '') }
+    end
+
+    def branch(branch)
+      TrackedBranch.new(@git, branch)
+    end
+
+    def method_missing(name, *args, &block)
+      raise NoMethodError, "method `#{name}' should be used as `<tracker>.branch(reference).#{name}(<args>)'" if TrackedBranch.method_defined? name
+      super
+    end
+  end
+
+  private
+
+  class TrackedBranch
+    def initialize(git, branch)
+      @git = git
+      @branch = branch.to_s
+    end
+
+    def commits_since(reference, options = {:ancestry => true})
+      since = @git.object(reference.to_s)
+      base = @git.merge_base(@branch, since)
+      if options[:ancestry]
+        @git.log_ancestry(base, @branch).reverse
+      else
+        @git.log(2**16).between(base, @branch).to_a.reverse
+      end
+    end
+  end
+
+end

data/lib/gitra/version.rb

@@ -0,0 +1,3 @@
+module Gitra
+  VERSION = '0.0.1'
+end

data/spec/support/git_helper.rb

@@ -0,0 +1,71 @@
+require 'git'
+require 'fileutils'
+
+class GitHelper
+
+  def initialize
+    path = File.join(Dir.tmpdir, "#{Time.now.to_i}_#{rand(1000)}")
+    FileUtils.mkdir_p path
+    Dir.chdir path do
+      @git = Git.init
+      @git.config('user.name', 'John Testable')
+      @git.config('user.email', 'john.testable@testing.it')
+
+      File.new(".gitignore", "w")
+      @git.add(".gitignore")
+      @git.commit "Initial commit."
+    end
+  end
+
+  def path
+    @git.dir.path
+  end
+
+  def cleanup
+    FileUtils.rm_rf(path, :secure => true)
+  end
+
+  def commit_to(branch_sym, parent_sym = :master)
+    branch = branch_sym.to_s
+    parent = parent_sym.to_s
+
+    @git.checkout parent
+    @git.branch(branch).create
+    @git.checkout branch
+    file = File.new(File.join(path, "file_of_#{branch}"), "a+")
+    file.puts("additional line")
+    file.close
+    @git.add file.path
+    @git.commit "Update #{branch}"
+    @git.checkout 'master'
+
+    @git.object(branch).sha
+  end
+
+  def branch_off(branch_hash)
+    branch_hash.collect do |branch_sym, into_sym|
+      branch = branch_sym.to_s
+      into = into_sym.to_s
+
+      @git.checkout branch
+      @git.branch(into).create
+      @git.checkout 'master'
+
+      @git.object(into).sha
+    end
+  end
+
+  def merge(merge_hash)
+    merge_hash.collect do |branch_sym, into_sym|
+      branch = branch_sym.to_s
+      into = into_sym.to_s
+
+      @git.checkout into
+      @git.merge branch, "Merge #{branch}"
+      @git.checkout 'master'
+
+      @git.object(into).sha
+    end
+  end
+
+end

data/spec/support/minitest_helper.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'gitra'
+require 'git_helper'

data/spec/tracker_spec.rb

@@ -0,0 +1,80 @@
+require 'minitest_helper'
+require 'git'
+
+describe Gitra::Tracker do
+  let(:git) { GitHelper.new }
+  let(:tracker) { Gitra::Tracker.new(git.path) }
+
+  after do
+    git.cleanup
+  end
+
+  describe 'Selects branches' do
+    it 'should list all branches without block' do
+      git.commit_to :b1
+      git.commit_to :b2
+      tracker.branches.sort.must_equal %w{master b1 b2}.sort
+    end
+
+    it 'should list matching branches with block' do
+      git.commit_to :b1
+      git.commit_to :b2
+      tracker.branches { |name| name =~ /^b/ }.sort.must_equal %w{b1 b2}.sort
+    end
+  end
+
+  describe 'Shows commits from merge base' do
+    it 'should contain all commits from branching point' do
+      git.commit_to :master
+      git.branch_off :master => :release
+      git.commit_to :release
+      after_branch_off_commits = [
+          git.commit_to(:master),
+          git.commit_to(:master)
+      ]
+      tracker.branch(:master).commits_since(:release).map { |c| c.sha }.must_equal after_branch_off_commits
+    end
+
+    it 'should only contain commits with real ancestry' do
+      git.commit_to :master
+      git.branch_off :master => :release
+      2.times { git.commit_to :release }
+      2.times { git.commit_to :master }
+
+      only_on_master = []
+      only_on_master += git.merge(:release => :master)
+      only_on_master << git.commit_to(:master)
+      git.commit_to :release
+
+      tracker.branch(:master).commits_since(:release).map { |c| c.sha }.must_equal only_on_master
+    end
+
+    it 'should be able to show more than the default log limit (30)' do
+      git.commit_to :master
+      git.branch_off :master => :release
+
+      limit = 40
+      limit.times { git.commit_to :release }
+      tracker.branch(:release).commits_since(:master).size.must_equal limit
+    end
+
+    it 'should fail if "since" branch is not resolvable' do
+      proc { tracker.branch(:master).commits_since(:new_branch) }.must_raise Git::GitExecuteError
+    end
+
+    it 'should fail if "from" branch is not resolvable' do
+      proc { tracker.branch(:neverwhere).commits_since(:master) }.must_raise Git::GitExecuteError
+    end
+  end
+
+  describe 'Shows unmerged commits between two branches' do
+    it 'should contain all unmerged commits' do
+      git.commit_to :master
+      git.branch_off :master => :release
+      missing_commit = git.commit_to :release
+
+      tracker.branch(:release).commits_since(:master).map { |c| c.sha }.must_equal [missing_commit]
+    end
+  end
+
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: gitra
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Lantos
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-07-16 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: git
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: term-ansicolor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: Analyze branches and continuity in a git repository.
+email: 
+- david.lantos@gmail.com
+executables: 
+- gitra
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- bin/gitra
+- lib/gitra/cli.rb
+- lib/gitra/git_patches.rb
+- lib/gitra/parser.rb
+- lib/gitra/tracker.rb
+- lib/gitra/version.rb
+- lib/gitra.rb
+- spec/support/git_helper.rb
+- spec/support/minitest_helper.rb
+- spec/tracker_spec.rb
+- README.md
+homepage: http://github.com/sldblog/gitra
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Git Repository Analyzer
+test_files: 
+- spec/support/git_helper.rb
+- spec/support/minitest_helper.rb
+- spec/tracker_spec.rb