git-lead-time 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccefd21676389ce1ced4444101580df84a07abee
-  data.tar.gz: 9bb2ce0498ad5a2f184af9a1da719a7129fca87e
+  metadata.gz: ca4d1acb0055545b95803f223fe78bfe42504173
+  data.tar.gz: e09ac3a073fb2796a6569f2d72a2c7f4e97121f6
 SHA512:
-  metadata.gz: e63a9c45d4d1e96faeef0dc27c9916cfa8a47349aa0b0c8335ceb2013a67bf17f495a1ae288a7875b31fcadf68356b90120862cf4dace9e0a98b2def1d2f5083
-  data.tar.gz: 98a1a09d173806a421160d3a1c429d123bd2b3c23f71d0e32027c360612a41e88f535f2bcf9d91a7bda470912f72c277021b8cfe8e92c3d0ceee9173eb02e104
+  metadata.gz: cfc91dafae1c5447a630ee6e4658d33bf0265bb4eaa628c655144378beedbe3a0aa692b0529414634992ab5f5362cfbf28d38b673f4903ab11e685629f40b13b
+  data.tar.gz: 5fdd4a18bf65d7daebcf75b0514db48eda07c325e03c2bd1bd6e524a5b65aada316e298453f6669b09fcdf3fc68defa8a10de372131271c084fd096d2dedc7ad

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## 0.0.2
+
+* Take nights and weekends into account when calculating lead time.
+
+## 0.0.1
+
+* Initial Release, `git lead-time` shows lead time for last 10 merges.

data/README.md

@@ -1,4 +1,4 @@
-# git lead-time
+# git lead-time [![Gem Version](https://badge.fury.io/rb/git-lead-time.png)](http://badge.fury.io/rb/git-lead-time) [![Code Climate](https://codeclimate.com/github/aaronjensen/git-lead-time.png)](https://codeclimate.com/github/aaronjensen/git-lead-time) [![Build Status](https://travis-ci.org/aaronjensen/git-lead-time.svg?branch=master)](https://travis-ci.org/aaronjensen/git-lead-time)
 
 Show the lead time of branches merged into the current branch. Currently an
 early proof of concept.

data/git-lead-time.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "business_time", "~>0.7.2"
+
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~>3.0.0.beta2"

data/lib/git_lead_time.rb

@@ -1,7 +1,14 @@
+require 'business_time'
+
 require_relative 'git_lead_time/lead_time_command'
+require_relative 'git_lead_time/calculator'
 
 module GitLeadTime
   def self.run
     puts LeadTimeCommand.new.run
   end
+
+  def self.calculator
+    @calculator ||= Calculator.new
+  end
 end

data/lib/git_lead_time/branch.rb

@@ -0,0 +1,21 @@
+require_relative 'merge_enumerator'
+require_relative 'merge_information'
+
+module GitLeadTime
+  class Branch
+    attr_reader :ref, :merge_information
+
+    def initialize(ref)
+      @ref = ref
+      @merge_information = MergeInformation.new(ref)
+    end
+
+    def each_merge
+      return to_enum(__method__) unless block_given?
+
+      MergeEnumerator.new(ref).each do |merge|
+        yield merge_information.info_for(merge)
+      end
+    end
+  end
+end

data/lib/git_lead_time/calculator.rb

@@ -0,0 +1,7 @@
+module GitLeadTime
+  class Calculator
+    def lead_time(start_date:, end_date:)
+      start_date.business_time_until(end_date) / 60 / 60 / 8
+    end
+  end
+end

data/lib/git_lead_time/first_commit_finder.rb

@@ -9,7 +9,7 @@ module GitLeadTime
 
     def first_commit(ref)
       first_commit = ref
-      first_parents(ref).each do |parent|
+      first_parents(ref) do |parent|
         break if target_refs.include? parent
         first_commit = parent
       end

data/lib/git_lead_time/git.rb

@@ -0,0 +1,13 @@
+module GitLeadTime
+  module Git
+    def self.status(ref, *fields)
+      format = {
+        subject: "%s",
+        abbreviated_hash: "%h",
+        date: "%cd",
+      }.values_at(*fields).join("\n")
+
+      `git show -s --format='#{format}' #{ref}`.lines.map(&:strip)
+    end
+  end
+end

data/lib/git_lead_time/lead_time_command.rb

@@ -1,62 +1,20 @@
 require 'time'
-require_relative 'first_commit_finder'
+require_relative 'branch'
+require_relative 'lead_time_format'
 
 module GitLeadTime
   class LeadTimeCommand
-    attr_reader :first_commit_finder
+    attr_reader :branch, :ref
     def initialize(ref="HEAD")
-      @first_commit_finder = FirstCommitFinder.new(ref)
+      @branch = Branch.new(ref)
     end
 
     def run
-      merges.map { |merge| format_merge(merge) }
-    end
-
-    def merges
-      `git rev-list --merges --first-parent HEAD | head -10`.lines.map(&:chomp)
+      branch.each_merge.map { |merge| format_merge(merge) }
     end
 
     def format_merge(merge)
-      Format.new(Merge.new(merge, first_commit_finder)).to_s
-    end
-
-    class Merge
-      attr_reader *%i[merge_commit first_commit message end_date start_date]
-
-      def initialize(sha, first_commit_finder)
-        first_sha = first_commit_finder.first_commit("#{sha}^2")
-        @merge_commit, @message, @end_date = status("%h\n%s\n%cd", sha)
-        @first_commit, @start_date = status("%h\n%cd", first_sha)
-      end
-
-      def status(format, ref)
-        `git show -s --format='#{format}' #{ref}`.lines.map(&:strip)
-      end
-
-      def lead_time
-        (Time.parse(end_date) - start_date) / 60 / 60 / 24
-      end
-
-      def start_date
-        Time.parse `git show -s --format=%cd #{first_commit}`
-      end
-    end
-
-    class Format
-      attr_reader :merge
-
-      def initialize(merge)
-        @merge = merge
-      end
-
-      def to_s
-        "#{format_lead_time(merge.lead_time)} #{merge.first_commit}..#{merge.merge_commit} #{merge.message}"
-      end
-
-      def format_lead_time(lead_time)
-        time = ("%5.1f" % lead_time)
-        "#{time} day#{"s" unless time == "1.0"}"
-      end
+      LeadTimeFormat.new(merge).to_s
     end
   end
 end

data/lib/git_lead_time/lead_time_format.rb

@@ -0,0 +1,18 @@
+module GitLeadTime
+  class LeadTimeFormat
+    attr_reader :merge
+
+    def initialize(merge)
+      @merge = merge
+    end
+
+    def to_s
+      "#{format_lead_time(merge.lead_time)} #{merge.first_commit}..#{merge.merge_commit} #{merge.message}"
+    end
+
+    def format_lead_time(lead_time)
+      time = ("%5.1f" % lead_time)
+      "#{time} day#{"s" unless time == "1.0"}"
+    end
+  end
+end

data/lib/git_lead_time/merge.rb

@@ -0,0 +1,25 @@
+require_relative 'git'
+
+module GitLeadTime
+  class Merge
+    attr_reader *%i[
+      merge_commit first_commit message end_date start_date calculator
+    ]
+
+    def initialize(first_sha:, merge_sha:, calculator: GitLeadTime.calculator)
+      @calculator = calculator
+
+      @merge_commit, @message, @end_date =
+        Git.status(merge_sha, :abbreviated_hash, :subject, :date)
+      @first_commit, @start_date =
+        Git.status(first_sha, :abbreviated_hash, :date)
+
+      @end_date = Time.parse(@end_date)
+      @start_date = Time.parse(@start_date)
+    end
+
+    def lead_time
+      calculator.lead_time(start_date: start_date, end_date: end_date)
+    end
+  end
+end

data/lib/git_lead_time/merge_enumerator.rb

@@ -0,0 +1,16 @@
+module GitLeadTime
+  class MergeEnumerator
+    include Enumerable
+
+    attr_reader :ref
+    def initialize(ref = "HEAD")
+      @ref = ref
+    end
+
+    def each
+      `git rev-list --merges --first-parent HEAD | head -10`.each_line do |rev|
+        yield rev.strip
+      end
+    end
+  end
+end

data/lib/git_lead_time/merge_information.rb

@@ -0,0 +1,18 @@
+require_relative 'first_commit_finder'
+require_relative 'merge'
+
+module GitLeadTime
+  class MergeInformation
+    attr_reader :first_commit_finder
+
+    def initialize(ref, first_commit_finder: FirstCommitFinder.new(ref))
+      @first_commit_finder = first_commit_finder
+    end
+
+    def info_for(merge_sha)
+      # TODO: deal w/ octopus merges
+      first_sha = first_commit_finder.first_commit("#{merge_sha}^2")
+      Merge.new(first_sha: first_sha, merge_sha: merge_sha)
+    end
+  end
+end

data/lib/git_lead_time/version.rb

@@ -1,3 +1,3 @@
 module GitLeadTime
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/features/lead_time_spec.rb

@@ -10,7 +10,7 @@ describe "git lead-time", :git do
     git :checkout, "master"
     merge_commit = git_merge "topic", on("thursday 9am")
     # Example: [master 160a500] Merge branch 'topic'
-    sha, message = merge_commit.chomp.match(/^\[\S+ ([^\]]+)\] (.*)$/)[1,2]
+    sha, message = parse_merge_result(merge_commit)
 
     git "log", "--graph"
     output = git "lead-time"
@@ -18,4 +18,26 @@ describe "git lead-time", :git do
       "  2.0 days #{first_commit}..#{sha} #{message}"
     ]
   end
+
+  it "does not count weekends in lead time" do
+    git_commit "Initial commit", on("last thursday 9am")
+    git :checkout, "-b", "topic"
+    git_commit "Topic commit A", on("last friday 9am")
+    first_commit = git_head(:abbreviated)
+    git_commit "Topic commit B", on("last friday 10am")
+    git :checkout, "master"
+    merge_commit = git_merge "topic", on("monday 9am")
+    # Example: [master 160a500] Merge branch 'topic'
+    sha, message = parse_merge_result(merge_commit)
+
+    git "log", "--graph"
+    output = git "lead-time"
+    expect(output.lines.map(&:chomp)).to eq [
+      "  1.0 days #{first_commit}..#{sha} #{message}"
+    ]
+  end
+
+  def parse_merge_result(result)
+    result.chomp.match(/^\[\S+ ([^\]]+)\] (.*)$/)[1,2]
+  end
 end

data/spec/lib/git_lead_time/calculator_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'git_lead_time/calculator'
+
+module GitLeadTime
+  describe Calculator, "#lead_time" do
+    subject(:calculator) { Calculator.new }
+
+    it "should calculate the number of days between two times" do
+      lead_time = calculator.lead_time(
+        start_date: date("monday 9am"),
+        end_date: date("tuesday 9am")
+      )
+
+      expect(lead_time).to eq 1.0
+    end
+
+    it "should not count weekends" do
+      lead_time = calculator.lead_time(
+        start_date: date("last friday 9am"),
+        end_date: date("monday 9am")
+      )
+
+      expect(lead_time).to eq 1.0
+    end
+
+    it "should not count evenings" do
+      lead_time = calculator.lead_time(
+        start_date: date("monday 5pm"),
+        end_date: date("tuesday 10am")
+      )
+
+      expect(lead_time).to eq 1.0 / 8.0
+    end
+  end
+end

data/spec/lib/git_lead_time/first_commit_finder_spec.rb

@@ -4,19 +4,38 @@ require 'git_lead_time/first_commit_finder'
 module GitLeadTime
   describe FirstCommitFinder, :git do
     it "finds the first commit of a new branch" do
-      git_commit "Initial commit"
+      # Make a nasty graph complete with back merge
+      # *   ca4080f - (HEAD, master) Merge branch 'topic' (0 seconds ago) <Aaron Jensen>
+      # |\
+      # | * d6b8382 - (topic) Topic C (0 seconds ago) <Aaron Jensen>
+      # | *   d8d405a - Merge branch 'master' into topic (0 seconds ago) <Aaron Jensen>
+      # | |\
+      # | |/
+      # |/|
+      # * | 70a1894 - Master B (0 seconds ago) <Aaron Jensen>
+      # | * 627ed43 - Topic B (0 seconds ago) <Aaron Jensen>
+      # | * dd3be46 - Topic A (0 seconds ago) <Aaron Jensen>
+      # |/
+      # * bfd3a2b - Master A (0 seconds ago) <Aaron Jensen>
+      git_commit "Master A"
 
       git "checkout", "-b", "topic"
       git_commit "Topic A"
       first_commit = git_head
       git_commit "Topic B"
+
+      git "checkout", "master"
+      git_commit "Master B"
+
+      git "checkout", "topic"
+      git_merge "master"
+
       git_commit "Topic C"
 
       git "checkout", "master"
       git_merge "topic"
       git "branch", "-D", "topic"
 
-
       finder = FirstCommitFinder.new("master")
       expect(finder.first_commit("master^2")).to eq(first_commit)
     end

data/spec/lib/git_lead_time/git_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+require 'git_lead_time/git'
+
+module GitLeadTime
+  describe Git, ".status", :git do
+    before do
+      commit = git_commit "My subject", on("monday")
+      @hash = commit[/ ([0-9a-f]*)\]/, 1]
+    end
+
+    it "should return the subject" do
+      subject = Git.status("HEAD", :subject).first
+      expect(subject).to eq "My subject"
+    end
+
+    it "should return the date" do
+      date = Git.status("HEAD", :date).first
+      expect(date).to eq git_date("monday")
+    end
+
+    it "should return the abbreviated hash" do
+      hash = Git.status("HEAD", :abbreviated_hash).first
+      expect(hash).to eq @hash
+    end
+
+    it "should return everything at once" do
+      hash, subject, date =
+        Git.status("HEAD", :abbreviated_hash, :subject, :date)
+
+      expect(hash).to eq @hash
+      expect(subject).to eq "My subject"
+      expect(date).to eq git_date("monday")
+    end
+  end
+end

data/spec/lib/git_lead_time/merge_enumerator_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'git_lead_time/merge_enumerator'
+
+module GitLeadTime
+  describe MergeEnumerator, :git do
+    it "enumerates merges" do
+      git_commit "Initial commit"
+      merges = 3.times.map do
+        git :checkout, "-b", "topic"
+        git_commit "Topic commit"
+        git :checkout, "master"
+        git_merge "topic"
+        git :branch, "-D", "topic"
+        git_head
+      end
+
+      enum = MergeEnumerator.new("master")
+
+      expect(enum.to_a).to eq merges.reverse
+    end
+  end
+end

data/spec/lib/git_lead_time/merge_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'git_lead_time/merge'
+
+module GitLeadTime
+  describe Merge do
+    let(:calculator) { instance_double "GitLeadTime::Calculator" }
+    subject(:merge) { Merge.new(first_sha: "aa", merge_sha: "bb", calculator: calculator) }
+
+    before do
+      allow(Git).to receive(:status).with("aa", :abbreviated_hash, :date) {
+        [ "a", git_date("monday") ] }
+      allow(Git).to receive(:status).with("bb", :abbreviated_hash, :subject, :date) {
+        [ "b", "subject", git_date("tuesday") ] }
+    end
+
+    it "should get info from git" do
+      expect(merge.message).to eq "subject"
+      expect(merge.start_date).to eq date("monday")
+      expect(merge.end_date).to eq date("tuesday")
+      expect(merge.first_commit).to eq "a"
+      expect(merge.merge_commit).to eq "b"
+    end
+
+    it "should calculate lead time" do
+      allow(calculator).to receive(:lead_time)
+        .with(start_date: date("monday"), end_date: date("tuesday")) { "5" }
+
+      expect(merge.lead_time).to eq "5"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require 'business_time'
+I18n.config.enforce_available_locales = true
+
 Dir['./spec/support/**/*.rb'].map {|f| require f}
 ENV["PATH"] = "#{File.expand_path("../../bin", __FILE__)}:#{ENV['PATH']}"
 

data/spec/support/dates.rb

@@ -0,0 +1,15 @@
+module Support
+  module Dates
+    def date(str)
+      Chronic.parse(str, now: Time.local(2014, 2, 1))
+    end
+
+    def git_date(str)
+      date(str).strftime("%a %b %-e %k:%M:%S %Y %z")
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Support::Dates
+end

data/spec/support/git.rb

@@ -25,11 +25,11 @@ module Support
     end
 
     def git_merge(branch, date: :now)
-       git :merge, "--no-ff", "--no-commit", "topic", date: date
+       git :merge, "--no-ff", "--no-commit", branch, date: date
        git_commit :no_edit, date: date
     end
 
-    def git_head(abbreviated)
+    def git_head(abbreviated=false)
       if abbreviated
         git("show", "-s", "--format=%h").chomp
       else
@@ -52,8 +52,8 @@ module Support
       ENV["GIT_COMMITTER_DATE"] = nil
     end
 
-    def on(date)
-      { date: Chronic.parse(date, now: Time.local(2014, 2, 1)).strftime("%a, %b %d %k:%M %Y %z") }
+    def on(str)
+      { date: git_date(str) }
     end
   end
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: git-lead-time
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Aaron Jensen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-27 00:00:00.000000000 Z
+date: 2014-03-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: business_time
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -76,6 +90,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -84,12 +99,24 @@ files:
 - git-lead-time.gemspec
 - lib/git-lead-time.rb
 - lib/git_lead_time.rb
+- lib/git_lead_time/branch.rb
+- lib/git_lead_time/calculator.rb
 - lib/git_lead_time/first_commit_finder.rb
+- lib/git_lead_time/git.rb
 - lib/git_lead_time/lead_time_command.rb
+- lib/git_lead_time/lead_time_format.rb
+- lib/git_lead_time/merge.rb
+- lib/git_lead_time/merge_enumerator.rb
+- lib/git_lead_time/merge_information.rb
 - lib/git_lead_time/version.rb
 - spec/features/lead_time_spec.rb
+- spec/lib/git_lead_time/calculator_spec.rb
 - spec/lib/git_lead_time/first_commit_finder_spec.rb
+- spec/lib/git_lead_time/git_spec.rb
+- spec/lib/git_lead_time/merge_enumerator_spec.rb
+- spec/lib/git_lead_time/merge_spec.rb
 - spec/spec_helper.rb
+- spec/support/dates.rb
 - spec/support/git.rb
 homepage: ''
 licenses:
@@ -117,6 +144,11 @@ specification_version: 4
 summary: Show the lead time of branches merged into the current branch.
 test_files:
 - spec/features/lead_time_spec.rb
+- spec/lib/git_lead_time/calculator_spec.rb
 - spec/lib/git_lead_time/first_commit_finder_spec.rb
+- spec/lib/git_lead_time/git_spec.rb
+- spec/lib/git_lead_time/merge_enumerator_spec.rb
+- spec/lib/git_lead_time/merge_spec.rb
 - spec/spec_helper.rb
+- spec/support/dates.rb
 - spec/support/git.rb