Merge pull request #270 from jonathanhefner/banner-prefer-badge_version

Prefer `ENV["HORO_BADGE_VERSION"]` version in banner

Author: jonathanhefner

lib/rdoc/generator/template/rails/class.rhtml

@@ -20,7 +20,10 @@
 
     <div class="banner">
         <% if project_name %>
-            <div><%= project_name %> <%= project_version %></div>
+            <div>
+                <%= project_name %>
+                <span title="<%= project_git_head %>"><%= badge_version || project_version %></span>
+            </div>
         <% end %>
 
         <h2>

lib/rdoc/generator/template/rails/file.rhtml

@@ -17,7 +17,10 @@
 
     <div class="banner">
         <% if project_name %>
-            <div><%= project_name %> <%= project_version %></div>
+            <div>
+                <%= project_name %>
+                <span title="<%= project_git_head %>"><%= badge_version || project_version %></span>
+            </div>
         <% end %>
 
         <h2>

lib/rdoc/generator/template/rails/index.rhtml

@@ -15,7 +15,10 @@
 
     <div class="banner">
         <% if project_name %>
-            <div><%= project_name %> <%= project_version %></div>
+            <div>
+                <%= project_name %>
+                <span title="<%= project_git_head %>"><%= badge_version || project_version %></span>
+            </div>
         <% end %>
 
         <h2>

lib/sdoc/helpers.rb

@@ -41,6 +41,10 @@ def badge_version
     h(ENV["HORO_BADGE_VERSION"]) if ENV["HORO_BADGE_VERSION"]
   end
 
+  def project_git_head
+    h "#{git_head_branch}@#{git_head_sha1[0, 12]}" if git?
+  end
+
   def page_title(title = nil)
     h [title, @options.title].compact.join(" - ")
   end

lib/sdoc/helpers/git.rb

@@ -20,6 +20,12 @@ def git_command(command)
     Dir.chdir(@options.root) { `git #{command}`.chomp } if git?
   end
 
+  attr_writer :git_head_branch
+
+  def git_head_branch
+    @git_head_branch ||= git_command("rev-parse --abbrev-ref HEAD")
+  end
+
   attr_writer :git_head_sha1
 
   def git_head_sha1

spec/helpers_spec.rb

@@ -229,6 +229,26 @@ module Foo; module Bar; module Qux; end; end; end
     end
   end
 
+  describe "#project_git_head" do
+    it "returns the branch name and abbreviated SHA1 of the most recent commit in HEAD" do
+      @helpers.git_bin_path = "path/to/git"
+      @helpers.git_head_branch = "1-0-stable"
+      @helpers.git_head_sha1 = "1337c0d3d00d" * 3
+
+      _(@helpers.project_git_head).must_equal "1-0-stable@1337c0d3d00d"
+    end
+
+    it "returns the branch name and abbreviated SHA1 of the most recent commit in HEAD (smoke test)" do
+      _(@helpers.project_git_head).must_match %r"\A.+@[[:xdigit:]]{12}\z"
+    end
+
+    it "returns nil when git is not installed" do
+      @helpers.git_bin_path = ""
+
+      _(@helpers.project_git_head).must_be_nil
+    end
+  end
+
   describe "#page_title" do
     it "includes options.title" do
       @helpers.options.title = "My Docs"