Updates to show GitHub source url (#5)

* Remove `SDoc::GitHub` module

* Create `SDoc::Helpers::Git` module

* Add `SDoc::Helpers#method_source_code_and_url`

Author: toshimaru

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

@@ -170,33 +170,22 @@
             </div>
           <% end %>
 
-          <% if method.token_stream %>
-            <% markup = method.markup_code %>
-            <div class="sourcecode">
-              <%
-                # generate github link
-                github = if options.github
-                  if markup =~ /File\s(\S+), line (\d+)/
-                    path = $1
-                    line = $2.to_i
-                  end
-                  path && github_url(path)
-                else
-                  false
-                end
-              %>
-              <p class="source-link">
-                Source:
-                <% if github %>
-                  <a href="<%= "#{github}#L#{line}" %>" target="_blank" class="github_url">on GitHub</a>
-                <% end %>
-              </p>
-              <div id="<%= method.aref %>_source">
-                <pre><code class="ruby"><%= markup %></code></pre>
-              </div>
-            </div>
-            <% end %>
-          </div>
+          <% source_code, source_url = method_source_code_and_url(method) %>
+          <% if source_code %>
+            <details class="method__source">
+              <summary>
+                <span class="label">Source code</span>
+              </summary>
+
+              <pre><code class="ruby"><%= source_code %></code></pre>
+              <% if source_url %>
+                <a href="<%= source_url %>" target="_blank" class="github_url">See on GitHub</a>
+              <% end %>
+            </details>
+          <% elsif source_url %>
+            <a href="<%= source_url %>" target="_blank" class="github_url">See on GitHub</a>
+          <% end %>
+        </div>
         <% end %><%# methods.each %>
       <% end %><%# visibilities.each %>
     <% end %><%# context.methods_by_type %>

lib/sdoc/generator.rb

@@ -3,7 +3,6 @@
 require 'fileutils'
 require 'json'
 
-require 'sdoc/github'
 require 'sdoc/templatable'
 require 'sdoc/helpers'
 require 'sdoc/version'
@@ -28,7 +27,6 @@ class RDoc::Generator::SDoc
   DESCRIPTION = 'Searchable HTML documentation'
 
   include ERB::Util
-  include SDoc::GitHub
   include SDoc::Templatable
   include SDoc::Helpers
 
@@ -55,13 +53,16 @@ def self.setup_options(options)
     opt = options.option_parser
     opt.separator nil
     opt.separator "SDoc generator options:"
+
+    # FIXME: Use options
+    # options.github = true
     opt.separator nil
     opt.on("--github", "-g",
             "Generate links to github.") do |value|
       options.github = true
     end
-    opt.separator nil
 
+    opt.separator nil
     opt.on("--version", "-v", "Output current version") do
       puts SDoc::VERSION
       exit
@@ -109,7 +110,7 @@ def file_dir
     FILE_DIR
   end
 
-  private 
+  private
 
   ### Output progress information if debugging is enabled
   def debug_msg( *msg )

lib/sdoc/github.rb

@@ -1,4 +1,7 @@
 module SDoc::Helpers
+  require_relative "helpers/git"
+  include ::SDoc::Helpers::Git
+
   # Strips out HTML tags from a given string.
   #
   # Example:
@@ -21,12 +24,13 @@ def truncate(text, options = {})
     end
   end
 
-protected
-  def group_name name
-    if match = name.match(/^([a-z])/i)
-      match[1].upcase
-    else
-      '#'
+  def method_source_code_and_url(rdoc_method)
+    source_code = rdoc_method.tokens_to_s if rdoc_method.token_stream
+
+    if source_code&.match(/File\s(\S+), line (\d+)/)
+      source_url = github_url(Regexp.last_match(1), line: Regexp.last_match(2))
     end
+
+    [rdoc_method.instance_of?(RDoc::GhostMethod) ? nil : source_code, source_url]
   end
 end

lib/sdoc/helpers.rb

@@ -0,0 +1,51 @@
+module SDoc::Helpers::Git
+  def github_url(relative_path, line: nil)
+    return unless github?
+    line = "#L#{line}" if line
+    "https://github.com/#{github_repository}/blob/#{git_head_sha1}/#{relative_path}#{line}"
+  end
+
+  def github?
+    @options.github && git? && github_repository
+  end
+
+  attr_writer :git_repo_path
+
+  def git?
+    @git_repo_path ||= Dir.chdir(@options.root) { `git rev-parse --show-toplevel 2> /dev/null`.chomp }
+    !@git_repo_path.empty?
+  end
+
+  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
+    @git_head_sha1 ||= git_command("rev-parse HEAD")
+  end
+
+  attr_writer :git_head_timestamp
+
+  def git_head_timestamp
+    @git_head_timestamp ||= git_command("show -s --format=%cI HEAD")
+  end
+
+  attr_writer :git_origin_url
+
+  def git_origin_url
+    @git_origin_url ||= git_command("config --get remote.origin.url")
+  end
+
+  def github_repository
+    return @github_repository if defined?(@github_repository)
+    @github_repository = git_origin_url.chomp(".git")[%r"github\.com[/:](.+)", 1]
+  end
+end