jazzy 0.13.5 → 0.14.1

data/lib/jazzy/source_host.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+module Jazzy
+  # Deal with different source code repositories
+  module SourceHost
+    # Factory to create the right source host
+    def self.create(options)
+      return unless options.source_host_url || options.source_host_files_url
+
+      case options.source_host
+      when :github then GitHub.new
+      when :gitlab then GitLab.new
+      when :bitbucket then BitBucket.new
+      end
+    end
+
+    # Use GitHub as the default behaviour.
+    class GitHub
+      include Config::Mixin
+
+      # Human readable name, appears in UI
+      def name
+        'GitHub'
+      end
+
+      # Jazzy extension with logo
+      def extension
+        name.downcase
+      end
+
+      # Logo image filename within extension
+      def image
+        'gh.png'
+      end
+
+      # URL to link to from logo
+      def url
+        config.source_host_url
+      end
+
+      # URL to link to from a SourceDeclaration.
+      # Compare using `realpath` because `item.file` comes out of
+      # SourceKit/etc.
+      def item_url(item)
+        return unless files_url && item.file
+
+        realpath = item.file.realpath
+        return unless realpath.to_path.start_with?(local_root_realpath)
+
+        path = realpath.relative_path_from(local_root_realpath)
+        fragment =
+          if item.start_line && (item.start_line != item.end_line)
+            item_url_multiline_fragment(item.start_line, item.end_line)
+          else
+            item_url_line_fragment(item.line)
+          end
+
+        "#{files_url}/#{path}##{fragment}"
+      end
+
+      private
+
+      def files_url
+        config.source_host_files_url
+      end
+
+      def local_root_realpath
+        @local_root_realpath ||= config.source_directory.realpath.to_path
+      end
+
+      # Source host's line numbering link scheme
+      def item_url_line_fragment(line)
+        "L#{line}"
+      end
+
+      def item_url_multiline_fragment(start_line, end_line)
+        "L#{start_line}-L#{end_line}"
+      end
+    end
+
+    # GitLab very similar to GitHub
+    class GitLab < GitHub
+      def name
+        'GitLab'
+      end
+
+      def image
+        'gitlab.svg'
+      end
+    end
+
+    # BitBucket has its own line number system
+    class BitBucket < GitHub
+      def name
+        'Bitbucket'
+      end
+
+      def image
+        'bitbucket.svg'
+      end
+
+      def item_url_line_fragment(line)
+        "lines-#{line}"
+      end
+
+      def item_url_multiline_fragment(start_line, end_line)
+        "lines-#{start_line}:#{end_line}"
+      end
+    end
+  end
+end

data/lib/jazzy/source_mark.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Jazzy
   class SourceMark
     attr_accessor :name
@@ -8,24 +10,24 @@ module Jazzy
       return unless mark_string
 
       # Format: 'MARK: - NAME -' with dashes optional
-      mark_string.sub!(/^MARK: /, '')
+      mark_content = mark_string.sub(/^MARK: /, '')
 
-      if mark_string.empty?
+      if mark_content.empty?
         # Empty
         return
-      elsif mark_string == '-'
+      elsif mark_content == '-'
         # Separator
         self.has_start_dash = true
         return
       end
 
-      self.has_start_dash = mark_string.start_with?('- ')
-      self.has_end_dash = mark_string.end_with?(' -')
+      self.has_start_dash = mark_content.start_with?('- ')
+      self.has_end_dash = mark_content.end_with?(' -')
 
       start_index = has_start_dash ? 2 : 0
       end_index = has_end_dash ? -3 : -1
 
-      self.name = mark_string[start_index..end_index]
+      self.name = mark_content[start_index..end_index]
     end
 
     def self.new_generic_requirements(requirements)

data/lib/jazzy/source_module.rb

@@ -1,32 +1,32 @@
+# frozen_string_literal: true
+
 require 'uri'
 
 require 'jazzy/config'
 require 'jazzy/source_declaration'
+require 'jazzy/source_host'
 
 module Jazzy
   class SourceModule
     attr_accessor :name
-    attr_accessor :root_path
     attr_accessor :docs
     attr_accessor :doc_coverage
     attr_accessor :doc_structure
     attr_accessor :author_name
-    attr_accessor :github_url
-    attr_accessor :github_file_prefix
     attr_accessor :author_url
     attr_accessor :dash_url
+    attr_accessor :host
 
     def initialize(options, docs, doc_structure, doc_coverage)
       self.docs = docs
-      self.root_path = options.source_directory
       self.doc_structure = doc_structure
       self.doc_coverage = doc_coverage
       self.name = options.module_name
       self.author_name = options.author_name
-      self.github_url = options.github_url
-      self.github_file_prefix = options.github_file_prefix
       self.author_url = options.author_url
+      self.host = SourceHost.create(options)
       return unless options.dash_url
+
       self.dash_url =
         "dash-feed://#{ERB::Util.url_encode(options.dash_url.to_s)}"
     end