yard-blame 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yard-blame.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yard-blame.rb

@@ -0,0 +1,3 @@
+require "yard-blame/version"
+
+YARD::Templates::Engine.register_template_path File.join(File.dirname(__FILE__), "../template")

data/lib/yard-blame/version.rb

@@ -0,0 +1,5 @@
+module Yard
+  module Blame
+    VERSION = "0.0.1"
+  end
+end

data/template/default/fulldoc/html/css/blame.css

@@ -0,0 +1,11 @@
+.blame caption {
+  text-align: left;
+}
+
+.blame .summary {
+  display: none;
+}
+
+.blame .code {
+  margin: 0;
+}

data/template/default/layout/html/setup.rb

@@ -0,0 +1,3 @@
+def stylesheets
+ super + %w(css/blame.css)
+end

data/template/default/method_details/html/blame.erb

@@ -0,0 +1,25 @@
+<table class="source_code blame">
+  <caption><span class="info file"># File '<%= h object.file %>'<% if object.line %>, line <%= object.line %><% end %></span></caption>
+  <tr>
+    <td>
+      <table>
+      <% blames = git_blame(object.file)%>
+      <% html_syntax_highlight(object.source).split("\n").each_with_index do |source_line, num| %>
+        <% blame = blames[object.line + num] %>
+        <tr>
+        <% if blame.author %>
+          <td class="author"><a href="mailto:<%= blame.mail %>"><%= h blame.author %></a></td>
+        <% else %>
+          <td class="author">No committed</td>
+        <% end%>
+          <td class="date"><%= h blame.time.strftime("%Y-%m-%d %H:%M:%S") %></td>
+          <td class="commit"><a title="<%= h blame.summary %>"><%= h blame.sha.slice(0,8) %></a><td>
+          <td class="lines"><%= object.line + num %></td>
+          <td><pre class="code"><%= source_line %></pre></td>
+        </tr>
+      <% end %>
+      </table>
+    </td>
+    <td>
+  </tr>
+</table>

data/template/default/method_details/html/setup.rb

@@ -0,0 +1,35 @@
+def init
+  super
+  sections.last.delete(:source)
+  sections.last.push(:blame)
+end
+
+def git_blame(file)
+  git_bin = "git" # TODO: configurability?
+  cmd = "#{git_bin} blame -p #{file}"
+  puts cmd
+  output = %x{#{cmd}}
+  commits = {}
+  blames = []
+  output.split("\n").each do |line|
+    if md = line.match(/^([0-9a-f]{39,40})\s\d+\s(\d+).*/)
+      line_no = md[2].to_i
+      sha = md[1].match(/^0+$/) ? "-" : md[1]
+
+      commits[sha] ||= Commit.new(sha)
+      blames[line_no - 1] = commits[sha]
+    elsif line =~ /^author (.*)/
+      blames.last.author = $1 unless $1 == "Not Committed Yet"
+    elsif line =~ /^author-mail (.*)/
+      blames.last.mail = $1 unless $1 == "<not.committed.yet>"
+    elsif line =~ /^author-time (\d*)/
+      blames.last.time = Time.at($1.to_i)
+    elsif line =~ /^summary (.*)/
+      blames.last.summary = $1
+    end
+  end
+  blames
+end
+
+class Commit < Struct.new(:sha, :author, :mail, :time, :summary)
+end

data/yard-blame.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yard-blame/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yard-blame"
+  s.version     = Yard::Blame::VERSION
+  s.authors     = ["Andrew O'Brien"]
+  s.email       = ["obrien.andrew@gmail.com"]
+  s.homepage    = "http://github.com/AndrewO/yard-blame"
+  s.summary     = %q{Adds git-blame output to YARD docs}
+  s.description = %q{Who wrote that code? When? Why? Theses are all things we often ask when reading documentation. yard-blame makes it easy to ask.}
+
+  s.rubyforge_project = "yard-blame"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  s.add_runtime_dependency "yard"
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: yard-blame
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Andrew O'Brien
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-09-20 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Who wrote that code? When? Why? Theses are all things we often ask when reading documentation. yard-blame makes it easy to ask.
+email: 
+- obrien.andrew@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- lib/yard-blame.rb
+- lib/yard-blame/version.rb
+- template/default/fulldoc/html/css/blame.css
+- template/default/layout/html/setup.rb
+- template/default/method_details/html/blame.erb
+- template/default/method_details/html/setup.rb
+- yard-blame.gemspec
+homepage: http://github.com/AndrewO/yard-blame
+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: "0"
+requirements: []
+
+rubyforge_project: yard-blame
+rubygems_version: 1.8.8
+signing_key: 
+specification_version: 3
+summary: Adds git-blame output to YARD docs
+test_files: []
+