RubyGems - jazzy - Versions diffs - 0.0.14 → 0.0.15 - Mend

jazzy 0.0.14 → 0.0.15

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (44) hide show

data/lib/jazzy/config.rb CHANGED

@@ -13,6 +13,7 @@ module Jazzy
     attr_accessor :dash_url
     attr_accessor :sourcekitten_sourcefile
     attr_accessor :clean
+    attr_accessor :readme_path
     def initialize
       self.output = Pathname('docs')

data/lib/jazzy/doc.mustache CHANGED

@@ -3,6 +3,7 @@
   <head>
     <title>{{name}} {{kind}} Reference</title>
     <link rel="stylesheet" type="text/css" href="{{path_to_root}}css/jazzy.css" />
+    <link rel="stylesheet" type="text/css" href="{{path_to_root}}css/github_syntax_highlighting.css" />
     <meta charset='utf-8'>
     <script src="{{path_to_root}}js/jquery.min.js" defer></script>
     <script src="{{path_to_root}}js/jazzy.js" defer></script>

data/lib/jazzy/doc_builder.rb CHANGED

@@ -7,6 +7,7 @@ require 'sass'
 require 'jazzy/config'
 require 'jazzy/doc'
 require 'jazzy/jazzy_markdown'
+require 'jazzy/readme_generator'
 require 'jazzy/source_declaration'
 require 'jazzy/source_module'
 require 'jazzy/sourcekitten'
@@ -125,10 +126,7 @@ module Jazzy
     def self.document_index(source_module, path_to_root)
       doc = Doc.new # Mustache model instance
       doc[:name] = source_module.name
-      doc[:overview] = Jazzy.markdown.render(
-        "This is the index page for #{source_module.name} docs. " \
-        'Navigate using the links on the left.',
-      )
+      doc[:overview] = ReadmeGenerator.generate(source_module)
       doc[:doc_coverage] = source_module.doc_coverage
       doc[:structure] = source_module.doc_structure
       doc[:module_name] = source_module.name
@@ -165,31 +163,41 @@ module Jazzy
         usr: item.usr,
       }
       gh_token_url = gh_token_url(item, source_module)
-      item_render[:github_token_url] = gh_token_url if gh_token_url
+      item_render[:github_token_url] = gh_token_url
       item_render[:return] = Jazzy.markdown.render(item.return) if item.return
-      item_render[:parameters] = item.parameters if item.parameters.length > 0
-      item_render
+      item_render[:parameters] = item.parameters if item.parameters.any?
+      item_render[:url] = item.url if item.children.any?
+      item_render.reject { |_, v| v.nil? }
+    end
+    def self.make_task(mark, uid, items)
+      {
+        name: mark.name,
+        uid: URI.encode(uid),
+        items: items,
+        pre_separator: mark.has_start_dash,
+        post_separator: mark.has_end_dash,
+      }
     end
     # Render tasks for Mustache document
     # @param [Config] options Build options
     # @param [Hash] doc_model Parsed doc. @see SourceKitten.parse
-    def self.render_tasks(source_module, doc_model)
-      tasks = []
-      # @todo parse mark-style comments and use as task names
-      tasknames = ['Children']
-      tasknames.each do |taskname|
-        items = []
-        doc_model.children.each do |item|
-          items << render_item(item, source_module)
+    def self.render_tasks(source_module, children)
+      marks = children.map(&:mark).uniq
+      mark_names_counts = {}
+      marks.map do |mark|
+        mark_children = children.select { |child| child.mark == mark }
+        items = mark_children.map { |child| render_item(child, source_module) }
+        uid = "#{mark.name || 'Unnamed'}"
+        if mark_names_counts.key?(uid)
+          mark_names_counts[uid] += 1
+          uid += "#{mark_names_counts[uid]}"
+        else
+          mark_names_counts[uid] = 1
         end
-        tasks << {
-          name: '',
-          uid: URI.encode(taskname),
-          items: items,
-        }
+        make_task(mark, uid, items)
       end
-      tasks
     end
     # Build Mustache document from single parsed doc
@@ -210,7 +218,7 @@ module Jazzy
       doc[:kind] = doc_model.kindName
       doc[:overview] = Jazzy.markdown.render(doc_model.abstract || '')
       doc[:structure] = source_module.doc_structure
-      doc[:tasks] = render_tasks(source_module, doc_model)
+      doc[:tasks] = render_tasks(source_module, doc_model.children)
       doc[:module_name] = source_module.name
       doc[:author_name] = source_module.author_name
       doc[:author_website] = source_module.author_url

data/lib/jazzy/gem_version.rb CHANGED

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.0.14' unless defined? Jazzy::VERSION
+  VERSION = '0.0.15' unless defined? Jazzy::VERSION
 end

data/lib/jazzy/jazzy_markdown.rb CHANGED

@@ -1,13 +1,39 @@
 require 'redcarpet'
+require 'rouge'
+require 'rouge/plugins/redcarpet'
 module Jazzy
   class JazzyHTML < Redcarpet::Render::HTML
+    include Redcarpet::Render::SmartyPants
+    include Rouge::Plugins::Redcarpet
     def paragraph(text)
       "<p class=\"para\">#{text}</p>"
     end
+    def header(text, header_level)
+      text_slug = text.gsub(/[^a-zA-Z0-9]+/, '_')
+        .downcase
+        .sub(/^_/, '')
+        .sub(/_$/, '')
+      "<a href='##{text_slug}' class='anchor' aria-hidden=true>" \
+        '<span class="header-anchor"></span>' \
+      '</a>' \
+      "<h#{header_level} id='#{text_slug}'>#{text}</h#{header_level}>\n"
+    end
+    OPTIONS = {
+      autolink: true,
+      fenced_code_blocks: true,
+      no_intra_emphasis: true,
+      quote: true,
+      strikethrough: true,
+      space_after_headers: true,
+    }.freeze
   end
   def self.markdown
-    @markdown ||= Redcarpet::Markdown.new(JazzyHTML, autolink: true)
+    @markdown ||= Redcarpet::Markdown.new(JazzyHTML,  JazzyHTML::OPTIONS)
   end
 end

data/lib/jazzy/partials/task.mustache CHANGED

@@ -1,9 +1,13 @@
 <div class="task-group">
   <div class="task-name-container">
+    {{#pre_separator}}<hr/>{{/pre_separator}}
     <a name="/{{uid}}"></a>
+    {{#name}}
     <a href="#/{{uid}}">
       <h3 class="section-name">{{name}}</h3>
     </a>
+    {{/name}}
+    {{#post_separator}}<hr/>{{/post_separator}}
   </div>
   <ul class="task-group-list">
     {{#items}}
@@ -21,6 +25,9 @@
           {{#abstract}}
           <div class="abstract">
             {{{abstract}}}
+            {{#url}}
+            <a href="{{{url}}}" class="see-more">See more</a>
+            {{/url}}
           </div>
           {{/abstract}}
           {{#declaration}}

data/lib/jazzy/readme_generator.rb ADDED

@@ -0,0 +1,35 @@
+require 'jazzy/jazzy_markdown'
+module Jazzy
+  module ReadmeGenerator
+    def self.generate(source_module)
+      readme = readme_path
+      unless readme && File.exist?(readme) && readme = File.read(readme)
+        readme = generated_readme(source_module)
+      end
+      rendered_readme = Jazzy.markdown.render(readme)
+      "<div class='readme'>#{rendered_readme}</div>"
+    end
+    def self.readme_path
+      %w(README.md README.markdown README.mdown README).each do |potential_name|
+        if File.exist? potential_name
+          return potential_name
+        end
+      end
+      nil
+    end
+    def self.generated_readme(source_module)
+      %(
+# #{ source_module.name }
+### Authors
+#{ source_module.author_name }
+      )
+    end
+  end
+end

data/lib/jazzy/source_declaration.rb CHANGED

@@ -15,5 +15,6 @@ module Jazzy
     attr_accessor :children
     attr_accessor :parameters
     attr_accessor :url
+    attr_accessor :mark
   end
 end

data/lib/jazzy/source_mark.rb ADDED

@@ -0,0 +1,31 @@
+module Jazzy
+  class SourceMark
+    attr_accessor :name
+    attr_accessor :has_start_dash
+    attr_accessor :has_end_dash
+    def initialize(mark_string = nil)
+      return unless mark_string
+      # Format: 'MARK: - NAME -' with dashes optional
+      mark_string.sub!(/^MARK: /, '')
+      if mark_string.length == 0
+        # Empty
+        return
+      elsif mark_string == '-'
+        # Separator
+        self.has_start_dash = true
+        return
+      end
+      self.has_start_dash = mark_string.start_with?('- ')
+      self.has_end_dash = mark_string.end_with?(' -')
+      start_index = has_start_dash ? 2 : 0
+      end_index = has_end_dash ? -3 : -1
+      self.name = mark_string[start_index..end_index]
+    end
+  end
+end

data/lib/jazzy/sourcekitten.rb CHANGED

@@ -4,6 +4,7 @@ require 'pathname'
 require 'jazzy/config'
 require 'jazzy/source_declaration'
+require 'jazzy/source_mark'
 require 'jazzy/xml_helper'
 module Jazzy
@@ -117,6 +118,7 @@ module Jazzy
     # rubocop:disable Metrics/MethodLength
     def self.make_source_declarations(docs)
       declarations = []
+      current_mark = SourceMark.new
       docs.each do |doc|
         if doc.key?('key.diagnostic_stage')
           declarations += make_source_declarations(doc['key.substructure'])
@@ -124,6 +126,10 @@ module Jazzy
         end
         declaration = SourceDeclaration.new
         declaration.kind = doc['key.kind']
+        if declaration.kind == 'source.lang.swift.syntaxtype.comment.mark' &&
+          doc['key.name'].start_with?('MARK: ')
+          current_mark = SourceMark.new(doc['key.name'])
+        end
         next unless declaration.kind =~ /^source\.lang\.swift\.decl\..*/
         unless declaration.kindName = @kinds[declaration.kind]
@@ -136,6 +142,7 @@ module Jazzy
         declaration.file = doc['key.filepath']
         declaration.usr = doc['key.usr']
         declaration.name = doc['key.name']
+        declaration.mark = current_mark
         make_doc_info(doc, declaration)
         make_substructure(doc, declaration)

data/logo.jpg ADDED

Binary file

data/spec/integration_specs/document_alamofire/after/docs/Classes.html CHANGED

@@ -3,6 +3,7 @@
   <head>
     <title>Classes  Reference</title>
     <link rel="stylesheet" type="text/css" href="css/jazzy.css" />
+    <link rel="stylesheet" type="text/css" href="css/github_syntax_highlighting.css" />
     <meta charset='utf-8'>
     <script src="js/jquery.min.js" defer></script>
     <script src="js/jazzy.js" defer></script>
@@ -164,10 +165,9 @@
           <section class="section task-group-section">
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/Children"></a>
-                <a href="#/Children">
-                  <h3 class="section-name"></h3>
-                </a>
+                <hr/>
+                <a name="/Unnamed"></a>
               </div>
               <ul class="task-group-list">
                 <li class="item symbol">
@@ -183,6 +183,7 @@
                       <div class="pointy-thing"></div>
                       <div class="abstract">
                         <p class="para">Responsible for creating and managing <code>Request</code> objects, as well as their underlying <code>NSURLSession</code>.</p>
+                        <a href="Classes/Manager.html" class="see-more">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
@@ -200,6 +201,15 @@
                     </section>
                   </div>
                 </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <hr/>
+                <a name="/Unnamed2"></a>
+              </div>
+              <ul class="task-group-list">
                 <li class="item symbol">
                   <div class="task-group-term">
                     <code>
@@ -213,6 +223,7 @@
                       <div class="pointy-thing"></div>
                       <div class="abstract">
                         <p class="para">Responsible for sending a request and receiving the response and associated data from the server, as well as managing its underlying <code>NSURLSessionTask</code>.</p>
+                        <a href="Classes/Request.html" class="see-more">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>

data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager.html CHANGED

@@ -3,6 +3,7 @@
   <head>
     <title>Manager Class Reference</title>
     <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
+    <link rel="stylesheet" type="text/css" href="../css/github_syntax_highlighting.css" />
     <meta charset='utf-8'>
     <script src="../js/jquery.min.js" defer></script>
     <script src="../js/jazzy.js" defer></script>
@@ -164,10 +165,9 @@
           <section class="section task-group-section">
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/Children"></a>
-                <a href="#/Children">
-                  <h3 class="section-name"></h3>
-                </a>
+                <a name="/Unnamed"></a>
               </div>
               <ul class="task-group-list">
                 <li class="item symbol">
@@ -273,6 +273,7 @@
                       <div class="pointy-thing"></div>
                       <div class="abstract">
+                        <a href="Classes/Manager/init(configuration:).html" class="see-more">See more</a>
                       </div>
                       <div class="declaration">
                         <h4>Declaration</h4>
@@ -309,6 +310,15 @@
                     </section>
                   </div>
                 </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <hr/>
+                <a name="/Unnamed2"></a>
+              </div>
+              <ul class="task-group-list">
                 <li class="item symbol">
                   <div class="task-group-term">
                     <code>

data/spec/integration_specs/document_alamofire/after/docs/Classes/Manager/init(configuration:).html CHANGED

@@ -3,6 +3,7 @@
   <head>
     <title>init(configuration:) Instance Method Reference</title>
     <link rel="stylesheet" type="text/css" href="../../css/jazzy.css" />
+    <link rel="stylesheet" type="text/css" href="../../css/github_syntax_highlighting.css" />
     <meta charset='utf-8'>
     <script src="../../js/jquery.min.js" defer></script>
     <script src="../../js/jazzy.js" defer></script>
@@ -164,10 +165,9 @@
           <section class="section task-group-section">
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/Children"></a>
-                <a href="#/Children">
-                  <h3 class="section-name"></h3>
-                </a>
+                <a name="/Unnamed"></a>
               </div>
               <ul class="task-group-list">
                 <li class="item symbol">

data/spec/integration_specs/document_alamofire/after/docs/Classes/Request.html CHANGED

@@ -3,6 +3,7 @@
   <head>
     <title>Request Class Reference</title>
     <link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
+    <link rel="stylesheet" type="text/css" href="../css/github_syntax_highlighting.css" />
     <meta charset='utf-8'>
     <script src="../js/jquery.min.js" defer></script>
     <script src="../js/jazzy.js" defer></script>
@@ -164,10 +165,9 @@
           <section class="section task-group-section">
             <div class="task-group">
               <div class="task-name-container">
-                <a name="/Children"></a>
-                <a href="#/Children">
-                  <h3 class="section-name"></h3>
-                </a>
+                <a name="/Unnamed"></a>
               </div>
               <ul class="task-group-list">
                 <li class="item symbol">
@@ -350,6 +350,18 @@
                     </section>
                   </div>
                 </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <a name="/Authentication"></a>
+                <a href="#/Authentication">
+                  <h3 class="section-name">Authentication</h3>
+                </a>
+              </div>
+              <ul class="task-group-list">
                 <li class="item symbol">
                   <div class="task-group-term">
                     <code>
@@ -468,6 +480,18 @@
                     </section>
                   </div>
                 </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <a name="/Progress"></a>
+                <a href="#/Progress">
+                  <h3 class="section-name">Progress</h3>
+                </a>
+              </div>
+              <ul class="task-group-list">
                 <li class="item symbol">
                   <div class="task-group-term">
                     <code>
@@ -521,6 +545,18 @@
                     </section>
                   </div>
                 </li>
+              </ul>
+            </div>
+            <div class="task-group">
+              <div class="task-name-container">
+                <a name="/Response"></a>
+                <a href="#/Response">
+                  <h3 class="section-name">Response</h3>
+                </a>
+              </div>
+              <ul class="task-group-list">
                 <li class="item symbol">
                   <div class="task-group-term">
                     <code>