Merge pull request #208 from realm/jp-gh-line-ranges

[DocBuilder] "Show on GitHub" links now link to line-ranges

CHANGELOG.md

@@ -14,6 +14,10 @@
   [JP Simard](https://github.com/jpsim)
   [#95](https://github.com/realm/jazzy/issues/95)
 
+* "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.  
@@ -42,6 +46,10 @@
   resolved.  
   [JP Simard](https://github.com/jpsim)
 
+* Allow using a version of Xcode that is symlinked to
+  `/Applications/Xcode.app`.  
+  [Samuel Giddins](https://github.com/segiddins)
+
 
 ## 0.1.4
 

lib/jazzy/assets/css/jazzy.css.scss

@@ -297,6 +297,14 @@ header {
   padding-top: 8px;
   width: 100%;
   list-style-type: none;
+  a[name] {
+    &:before {
+      content: "";
+      display: block;
+      padding-top: $content_top_offset;
+      margin: -$content_top_offset 0 0;
+    }
+  }
   code {
     background-color: transparent;
     padding: 0;

lib/jazzy/doc_builder.rb

@@ -18,8 +18,6 @@ module Jazzy
   # This module handles HTML generation, file writing, asset copying,
   # and generally building docs given sourcekitten output
   module DocBuilder
-    DEVELOPER_DIR = `xcode-select -p`.chomp
-
     # mkdir -p output directory and clean if option is set
     def self.prepare_output_dir(output_dir, clean)
       FileUtils.rm_r output_dir if clean && output_dir.directory?
@@ -195,7 +193,9 @@ def self.document_index(source_module, path_to_root)
     end
 
     def self.should_link_to_github(file)
-      !file.start_with?(DEVELOPER_DIR) if file
+      developer_directory = SourceKitten.xcode_developer_directory
+      return unless developer_directory && file
+      !file.start_with?(developer_directory.realpath.to_s)
     end
 
     # Construct Github token URL
@@ -204,7 +204,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
@@ -227,6 +231,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

@@ -64,7 +64,7 @@ def self.assert_xcode_location
 
     def self.xcode_developer_directory
       dir = Pathname(`xcode-select -p`.chomp)
-      dir.directory? ? dir.realpath : nil
+      dir.directory? ? dir.expand_path : nil
     end
 
     def self.assert_swift_version
@@ -215,6 +215,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)