git_spelunk 0.1.2

data/bin/git-spelunk

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+require 'git_spelunk'
+
+file_context = GitSpelunk::FileContext.new(ARGV[0], {:sha => ARGV[1], :line_number => ARGV[2]})
+ui = GitSpelunk::UI.new(file_context)
+ui.run

data/lib/git_spelunk/file.rb

@@ -0,0 +1,25 @@
+require 'grit'
+
+module GitSpelunk
+  class File
+    def initialize(filename, sha, line=1)
+      @filename = filename
+      @sha = sha
+      @line = line
+    end
+
+    def blame
+      [
+        ["abcdef", "content"],
+        ["abcdef", "content"],
+        ["abcdef", "content"],
+        ["abcdef", "content"],
+        ["abcdef", "content"]
+        ["abcdef", "content"]
+        ["abcdef", "content"]
+        ["abcdef", "content"]
+        ["abcdef", "content"]
+      ]
+    end
+  end
+end

data/lib/git_spelunk/file_context.rb

@@ -0,0 +1,83 @@
+require 'grit'
+require 'fileutils'
+
+module GitSpelunk
+  class FileContext
+    attr_accessor :line_number
+    attr_reader :repo
+
+    def initialize(file, options = {})
+      @sha = options[:sha] || 'HEAD'
+      @line_number = options[:line_number] || 1
+
+      @repo = options.fetch(:repo) do
+        repo_directory = find_repo_from_file(file)
+        @file = file.sub(%r{^#{repo_directory}/}, '')
+        Grit::Repo.new(repo_directory)
+      end
+
+      @file ||= options.fetch(:file)
+      @commit_cache = {}
+    end
+
+
+    def clone_for_parent_sha(line_number)
+      new_sha = sha_for_line(line_number) + "~1"
+      GitSpelunk::FileContext.new(@file, {:sha => new_sha, :repo => @repo, :file => @file})
+    end
+
+    def get_line_for_sha_parent(line_number)
+      o = GitSpelunk::Offset.new(@repo, @file, sha_for_line(line_number))
+      o.line_number_to_parent(@new_to_old[line_number])
+    end
+
+    def find_repo_from_file(file)
+      file = './' + file unless file.start_with?('/')
+      targets = file.split('/')
+      targets.pop
+      while !File.directory?(targets.join("/") + "/.git")
+        targets.pop
+      end
+
+      if targets.empty?
+        nil
+      else
+        targets.join("/")
+      end
+    end
+
+    def get_blame
+      @blame_data ||= begin
+        @new_to_old = {}
+        @line_to_sha = {}
+        blame = Grit::Blame.new(@repo, @file, @sha)
+        blame.lines.map do |line|
+          @new_to_old[line.lineno] = line.oldlineno
+          [line.commit.id_abbrev, line.line]
+        end
+      end
+      @blame_data
+    end
+
+    def sha_for_line(line)
+      @blame_data[line - 1][0]
+    end
+
+    def get_line_commit_info(line)
+      get_blame
+      abbrev = sha_for_line(line)
+      commit = (@commit_cache[abbrev] ||= @repo.commit(abbrev))
+      return nil unless commit
+
+      author_info = commit.author_string.split(" ")
+      tz = author_info.pop
+      utc = Time.at(author_info.pop.to_i)
+      [
+        "commit " + commit.id,
+        "Author: " + author_info.join(" "),
+        "Date: " + utc.to_s
+      ].join("\n") + "\n\n" + "     " + commit.short_message
+    end
+  end
+end
+

data/lib/git_spelunk/offset.rb

@@ -0,0 +1,142 @@
+# Given a sha and a line_number in this sha, this module calculates the corresponding line number in sha's parent.
+# 1. It uses git diff for the sha & its parent to get all the diff chunks.
+# 2. It then calculates which chunk given line_number belongs to.
+# 3. Once found the target chunk, it then goes to the sha's line_number in the diff
+# 4. It then calculate parent's line number by ignoring changes for sha in the diff
+#
+# git diff 6d405155..379120f
+# --- a/app/assets/javascripts/lib/user_assume/chat_extension.module.js
+# +++ b/app/assets/javascripts/lib/user_assume/chat_extension.module.js
+# @@ -1,7 +1,6 @@
+# -/*globals ChatLotus*/
+#  module.exports = Em.Object.extend({
+# -  chatService: ChatLotus.Service,
+# -  hasChatEnabled: Em.computed.oneWay('chatService.hasChatEnabled'),
+# +  ChatService: ChatLotus.Service,
+# +  hasChatEnabled: Em.computed.oneWay('ChatService.hasChatEnabled'),
+#    previousAvailablity: false,
+#
+#    detach: function() {
+# @@ -19,10 +18,10 @@ module.exports = Em.Object.extend({
+#    },
+#
+#    _isChatAvailable: function() {
+# -    return this.get('chatService.Availability.available');
+# +    return this.getPath('ChatService.Availability.available');
+#    },
+#
+#    _toggleChatAvailability: function() {
+# -    this.get('chatService.Availability').toggleAvailability();
+# +    this.getPath('ChatService.Availability').toggleAvailability();
+#    }
+#  });
+
+
+module GitSpelunk
+  require 'grit'
+
+  class Offset
+    attr_reader :repo, :file_name, :sha, :chunks
+
+    def initialize(repo, file_name, sha)
+      @repo = repo
+      @file_name = file_name
+      @sha = sha
+      parent_sha = @repo.commits(@sha)[0].parents[0].id
+      @chunks = diff_chunks(@repo.diff(parent_sha, @sha, @file_name))
+    end
+
+    def diff_chunks(diffs)
+      return nil if diffs.empty?
+      # split it into chunks: [["@@ -10,13 +10,18 @@", diffs], ["@@ -20,13 +20,18 @@", diffs, diff]]
+      multiple_chunks = diffs[0].diff.split(/(@@.*?@@.*?\n)/)
+      # Discard file name line
+      multiple_chunks[1..multiple_chunks.length].each_slice(2).to_a
+    end
+
+    def line_number_to_parent(src_line_number)
+      return nil unless @chunks
+      chunk = target_chunk(src_line_number)
+      chunk_starting_line, chunk_total_lines = src_start_and_total(stats_line(chunk))
+      parent_starting_line = parent_start_and_total(stats_line(chunk))[0]
+      parent_line_offset = find_parent_line_number(diff_lines(chunk), src_line_number, chunk_starting_line, chunk_total_lines)
+      parent_starting_line + parent_line_offset
+    end
+
+    private
+
+    def target_chunk(line_number)
+      chunks.select {|chunk| has_line?(chunk, line_number)}[0]
+    end
+
+    def has_line?(chunk, line_number)
+      starting_line, total_lines = src_start_and_total(stats_line(chunk))
+      starting_line + total_lines >= line_number
+    end
+
+    def src_start_and_total(line)
+      # Get the offset and line number where lines were added
+      # @@ -3,10 +3,17 @@ optionally a line\n   unchnaged_line_1\n-    deleted_line_1\n+    new_line_1"
+      line.scan(/\+(.*)@@/)[0][0].split(",").map {|str| str.to_i}
+    end
+
+    def parent_start_and_total(line)
+      line.scan(/\-(.*)\+/)[0][0].split(",").map {|str| str.to_i}
+    end
+
+    def find_parent_line_number(lines, src_line_number, src_starting_line, src_number_of_lines)
+      target_line_offset = src_line_number - src_starting_line
+      current_line_offset = parent_line_offset = diff_index = 0
+
+      lines.each do |line|
+        break if current_line_offset == target_line_offset
+
+        if src_line?(line)
+          current_line_offset += 1
+        end
+
+        if parent_line?(line)
+          parent_line_offset += 1
+        end
+
+        diff_index += 1
+      end
+      # find last contiguous bit of diff
+      line = lines[diff_index]
+      removals = additions = 0
+
+      while ["-", "+"].include?(line[0])
+        if parent_line?(line)
+          removals += 1
+        else
+          additions += 1
+        end
+
+        diff_index -= 1
+        line = lines[diff_index]
+      end
+
+      forward_push = current_line_offset - additions
+      forward_push = removals if forward_push > removals # clamp line matching
+      parent_line_offset - removals + forward_push
+    end
+
+    def src_line?(line)
+      # Src line will either have a "+" or will be an unchanged line
+      line[0] != '-'
+    end
+
+    def parent_line?(line)
+      # Src line will either have a "-" or will be an unchanged line
+      line[0] != '+'
+    end
+
+    def stats_line(chunk)
+      chunk[0]
+    end
+
+    def diff_lines(chunk)
+      chunk[1].split("\n")
+    end
+  end
+end

data/lib/git_spelunk/ui/pager.rb

@@ -0,0 +1,153 @@
+require 'curses'
+
+ACTIVE_SHA_COLOR=1
+module GitSpelunk
+  class UI
+    class PagerWindow < Window
+      def initialize(height)
+        @window = Curses::Window.new(height, Curses.cols, 0, 0)
+        @height = height
+        @cursor = 1
+        @top = 1
+        @highlight_sha = true
+      end
+
+      attr_accessor :data, :highlight_sha
+      attr_reader :cursor, :top
+
+      def draw
+        @window.clear
+        @window.setpos(0,0)
+        line_number_width = (data.size + 1).to_s.size
+
+        active_sha = data[@cursor - 1][0]
+
+        data[@top - 1,@height].each_with_index do |b, i|
+          sha, content = *b
+          line_number = i + @top
+
+          if sha == active_sha && highlight_sha
+            @window.attron(Curses::color_pair(ACTIVE_SHA_COLOR))
+          end
+
+          if @cursor == line_number
+            with_highlighting { @window.addstr(sha) }
+          else
+            @window.addstr(sha)
+          end
+
+          @window.addstr(" %*s " % [line_number_width, line_number])
+          if @search_term
+            content.split(/(#{@search_term})/).each do |t|
+              if t == @search_term
+                @window.attron(Curses::A_STANDOUT)
+              end
+              @window.addstr(t[0,line_remainder])
+              @window.attroff(Curses::A_STANDOUT)
+            end
+          else
+            @window.addstr(content[0,line_remainder])
+          end
+          @window.addstr("\n")
+          @window.attroff(Curses::color_pair(ACTIVE_SHA_COLOR))
+        end
+        @window.refresh
+        @window.setpos(0,0)
+      end
+
+      attr_accessor :top
+
+      def search(term, skip_current_line)
+        @search_term = term
+        return unless term
+        save_cursor = @cursor
+        search_data = data.map { |d| d[1] }
+        initial_position = save_cursor - (skip_current_line ? 0 : 1)
+        search_data[initial_position..-1].each_with_index do |d, i|
+          if d =~ /#{term}/
+            go_to(initial_position + i + 1)
+            return
+          end
+        end
+
+        search_data[0..initial_position].each_with_index do |d, i|
+          if d =~ /#{term}/
+            go_to(i + 1)
+            return
+          end
+        end
+      end
+
+      def bufbottom
+        @top + (@height - 1)
+      end
+
+      def cursorup
+        return if @cursor == 1
+        @cursor -= 1
+        adjust_top!
+      end
+
+      def cursordown
+        return if @cursor >= data.size
+        @cursor += 1
+        adjust_top!
+      end
+
+      def pageup
+        previous_offset = @cursor - @top
+        @cursor -= @height / 2
+        if @cursor < 1
+          @cursor = 1
+        end
+
+        @top = @cursor - previous_offset
+        adjust_top!
+      end
+
+      def pagedown
+        previous_offset = @cursor - @top
+        @cursor += @height / 2
+        if @cursor > data.size
+          @cursor = data.size
+        end
+
+        @top = @cursor - previous_offset
+        adjust_top!
+      end
+
+      def go_top
+        @top = @cursor = 1
+      end
+
+      def go_to(l)
+        previous_offset = @cursor - @top
+        @cursor = l
+        @top = @cursor - previous_offset
+        adjust_top!
+      end
+
+
+      def go_bottom
+        @cursor = data.size
+        @top = data.size - (@height - 1)
+      end
+
+      def adjust_top!
+        if @top < 1
+          @top = 1
+        end
+
+        if @top > @cursor
+          @top = @cursor
+        end
+
+        while @cursor > bufbottom
+          @top += 1
+        end
+      end
+
+    end
+  end
+end
+

data/lib/git_spelunk/ui/repo.rb

@@ -0,0 +1,56 @@
+module GitSpelunk
+  class UI
+    class RepoWindow < Window
+      def initialize(height, offset)
+        @window = Curses::Window.new(height, Curses.cols, offset, 0)
+        @offset = offset
+        @height = height
+        @command_mode = false
+        @command_buffer = ""
+        @content = ""
+      end
+
+      attr_accessor :content, :command_mode, :command_buffer
+
+      def exit_command_mode!
+        self.command_buffer = ""
+        self.command_mode = false
+      end
+
+      def draw
+        @window.setpos(0,0)
+        draw_status_line
+        @window.addstr(@content + "\n") if content
+        @window.addstr("\n" * (@height - @content.split("\n").size - 2))
+
+        draw_bottom_line
+        @window.refresh
+        set_cursor
+      end
+
+      def set_cursor
+        Curses::stdscr.setpos(@offset + @height - 1, command_buffer.size + 1)
+      end
+
+      def draw_status_line
+        with_highlighting do
+          @window.addstr("navigation: j k CTRL-D CTRL-U ")
+          @window.addstr("history: [ ] ")
+          @window.addstr("search: / ")
+          @window.addstr(" " * line_remainder + "\n")
+        end
+      end
+
+      def draw_bottom_line
+        if command_mode
+          @window.addstr(":" + command_buffer)
+          @window.addstr(" " * line_remainder)
+        else
+          with_highlighting do
+            @window.addstr(" " * line_remainder + "\n")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/git_spelunk/ui/window.rb

@@ -0,0 +1,19 @@
+require 'curses'
+
+module GitSpelunk
+  class UI
+    class Window
+      def with_highlighting
+        @window.attron(Curses::A_STANDOUT)
+        yield
+      ensure
+        @window.attroff(Curses::A_STANDOUT)
+      end
+
+      def line_remainder
+        Curses.cols - @window.curx - 1
+      end
+    end
+  end
+end
+

data/lib/git_spelunk/ui.rb

@@ -0,0 +1,158 @@
+require 'git_spelunk/ui/window'
+require 'git_spelunk/ui/pager'
+require 'git_spelunk/ui/repo'
+require 'curses'
+
+module GitSpelunk
+  class UI
+
+    def initialize(file_context)
+      Curses.init_screen
+      Curses.start_color
+      Curses.raw
+      Curses.nonl
+      Curses.curs_set(2)
+      screen = Curses.stdscr
+      screen.refresh
+      screen.keypad(1)
+      Curses.init_pair(ACTIVE_SHA_COLOR, Curses::COLOR_GREEN, Curses::COLOR_BLACK)
+
+      calculate_heights!
+      @file_context = file_context
+      @history = [file_context]
+      @pager = PagerWindow.new(@pager_height)
+      @pager.data = @file_context.get_blame
+
+      @repo = RepoWindow.new(@repo_height, @pager_height)
+    end
+
+    def calculate_heights!
+      @repo_height = (Curses.lines.to_f * 0.20).to_i
+      @pager_height = Curses.lines  - @repo_height
+    end
+
+    def run
+      @repo.content = @file_context.get_line_commit_info(@pager.cursor)
+      pause_thread
+      begin
+        @pager.draw
+        @repo.draw
+        @repo.set_cursor
+        handle_key(Curses.getch)
+      end while true
+    end
+
+    def pause_thread
+      Thread.abort_on_exception = true
+      Thread.new do
+        while true
+          if heartbeat_expired? && @last_line != @pager.cursor
+            current_line = @pager.cursor
+            content = @file_context.get_line_commit_info(current_line)
+            if heartbeat_expired? && @pager.cursor == current_line
+              @repo.content = content
+              @repo.draw
+              @last_line = current_line
+            else
+              @heartbeat = Time.now
+            end
+          end
+          sleep 0.05
+        end
+      end
+    end
+
+    def heartbeat_expired?
+      @heartbeat && (Time.now - @heartbeat).to_f > 0.30
+    end
+
+    def after_navigation
+      @pager.highlight_sha = true
+      @repo.exit_command_mode!
+    end
+
+    def handle_key(key)
+      @heartbeat = Time.now
+      case key
+      when Curses::KEY_DOWN, 'j'
+        @pager.cursordown
+        after_navigation
+      when Curses::KEY_UP, '-', 'k'
+        @pager.cursorup
+        after_navigation
+      when Curses::KEY_CTRL_D, ' '
+        @pager.pagedown
+        after_navigation
+      when Curses::KEY_CTRL_U
+        @pager.pageup
+        after_navigation
+      when *(0..9).to_a.map(&:to_s)
+        @repo.command_mode = true
+        @repo.command_buffer += key
+      when Curses::KEY_CTRL_M
+        if @repo.command_buffer != ''
+          @pager.go_to(@repo.command_buffer.to_i)
+        end
+        after_navigation
+      when 'G'
+        if @repo.command_buffer != ''
+          @pager.go_to(@repo.command_buffer.to_i)
+        else
+          @pager.go_bottom
+        end
+        after_navigation
+      when '['
+        goto = @file_context.get_line_for_sha_parent(@pager.cursor)
+        if goto
+          @file_context.line_number = @pager.cursor
+          @history.push(@file_context)
+
+          @file_context = @file_context.clone_for_parent_sha(@pager.cursor)
+          @pager.data = @file_context.get_blame
+          @pager.go_to(goto)
+
+          # force commit info update
+          @last_line = nil
+        end
+      when ']'
+        if @history.last
+          @file_context = @history.pop
+          @pager.data = @file_context.get_blame
+          @pager.go_to(@file_context.line_number)
+          @pager.draw
+
+          # force commit info update
+          @last_line = nil
+        end
+      when 's'
+        @heartbeat = nil
+        sha = @file_context.sha_for_line(@pager.cursor)
+        Curses.close_screen
+        system("git -p --git-dir='#{@file_context.repo.path}' show #{sha} | less")
+        Curses.stdscr.refresh
+        @pager.draw
+        @repo.draw
+        @pager.highlight_sha = true
+      when '/'
+        @repo.command_mode = true
+        @repo.command_buffer = '/'
+        @repo.draw
+        @repo.set_cursor
+        begin
+          line = Curses.getstr
+        rescue Interrupt
+          @repo.exit_command_mode!
+        end
+        @search_string = line
+        @pager.search(@search_string, false)
+        @repo.exit_command_mode!
+      when 'n'
+        @pager.search(@search_string, true)
+        after_navigation
+      when 'q'
+        exit
+      end
+    end
+  end
+end
+

data/lib/git_spelunk.rb

@@ -0,0 +1,4 @@
+require 'debugger'
+require 'git_spelunk/ui'
+require 'git_spelunk/file_context'
+require 'git_spelunk/offset'

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: git_spelunk
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Ben Osheroff
+- Saroj Yadav
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grit
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- ben@zendesk.com
+- saroj@zendesk.com
+executables:
+- git-spelunk
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/git_spelunk/file.rb
+- lib/git_spelunk/file_context.rb
+- lib/git_spelunk/offset.rb
+- lib/git_spelunk/ui/pager.rb
+- lib/git_spelunk/ui/repo.rb
+- lib/git_spelunk/ui/window.rb
+- lib/git_spelunk/ui.rb
+- lib/git_spelunk.rb
+- bin/git-spelunk
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []
+has_rdoc: