[DocBuilder] "Show on GitHub" links now link to line-ranges (fixes #198)

CHANGELOG.md

@@ -10,6 +10,10 @@
   [segiddins](https://github.com/segiddins)
   [#196](https://github.com/realm/jazzy/issues/196)
 
+* "Show on GitHub" links now link to line-ranges for multi-line definitions.  
+  [JP Simard](https://github.com/jpsim)
+  [#198](https://github.com/realm/jazzy/issues/198)
+
 ##### Bug Fixes
 
 * Fixed issue where docset would contain duplicate files.  

lib/jazzy/config.rb

@@ -107,7 +107,7 @@ def self.parse!
         end
 
         opt.on('-s', '--sourcekitten-sourcefile FILEPATH',
-               'XML doc file generated from sourcekitten to parse') do |s|
+               'File generated from sourcekitten output to parse') do |s|
           config.sourcekitten_sourcefile = Pathname(s)
         end
 

lib/jazzy/doc_builder.rb

@@ -30,16 +30,14 @@ def self.prepare_output_dir(output_dir, clean)
     # @return [Array] doc structure comprised of
     #                     section names & child names & URLs
     def self.doc_structure_for_docs(docs)
-      structure = []
-      docs.each do |doc|
-        structure << {
+      docs.map do |doc|
+        {
           section: doc.name,
           children: doc.children.sort_by(&:name).map do |child|
             { name: child.name, url: child.url }
           end,
         }
       end
-      structure
     end
 
     # Build documentation from the given options
@@ -205,7 +203,11 @@ def self.should_link_to_github(file)
     def self.gh_token_url(item, source_module)
       if source_module.github_file_prefix && should_link_to_github(item.file)
         relative_file_path = item.file.gsub(`pwd`.strip, '')
-        gh_line = "#L#{item.line}"
+        if item.start_line && (item.start_line != item.end_line)
+          gh_line = "#L#{item.start_line}-L#{item.end_line}"
+        else
+          gh_line = "#L#{item.line}"
+        end
         source_module.github_file_prefix + relative_file_path + gh_line
       end
     end
@@ -228,6 +230,8 @@ def self.render_item(item, source_module)
       item_render[:return] = Jazzy.markdown.render(item.return) if item.return
       item_render[:parameters] = item.parameters if item.parameters.any?
       item_render[:url] = item.url if item.children.any?
+      item_render[:start_line] = item.start_line
+      item_render[:end_line] = item.end_line
       item_render.reject { |_, v| v.nil? }
     end
 

lib/jazzy/source_declaration.rb

@@ -18,6 +18,8 @@ class SourceDeclaration
     attr_accessor :url
     attr_accessor :mark
     attr_accessor :access_control_level
+    attr_accessor :start_line
+    attr_accessor :end_line
 
     def overview
       "#{abstract}\n\n#{discussion}".strip

lib/jazzy/sourcekitten.rb

@@ -196,6 +196,8 @@ def self.make_source_declarations(docs)
           doc['key.annotated_decl'],
         )
         declaration.access_control_level = acl
+        declaration.start_line = doc['key.parsed_scope.start']
+        declaration.end_line = doc['key.parsed_scope.end']
 
         next unless make_doc_info(doc, declaration)
         make_substructure(doc, declaration)