jazzy 0.0.15 → 0.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7cb0dbb4a6f3cd950cce91c753acf09742ae0912
-  data.tar.gz: be7cdc331cb23ad0fe1d8bc16f8f37c4fc61ea50
+  metadata.gz: 91c1b5381e39fcf3979fcdf3f441a9afa3c6346f
+  data.tar.gz: 65736a28e4fc270646fdf7cd9be491953339634e
 SHA512:
-  metadata.gz: 511a552ddd739da369ce55affe2b4bac8afe8fc21b0e83c9fee2e928ed2f22b64245a60691c93ffbb5f016d240dac18a9b7b2433df2ec3d50807ad893f33c568
-  data.tar.gz: f7ab8a26bc341ea31cb5d0e4d17f32c5e34eada4f699feb2bfa0a2c09b84e64a45ca5636ab4ac806fcce82e22fc4fd61f3ef87207837dd298031dc88f6ebe852
+  metadata.gz: cd122d28d2e16768fe6165f099998c8c1afadcf02798278d00300151762b7b43d4c17ac6f6cf56f553a0cc3cfaf0ae42211bb31d224626096c6b0b66879e03fc
+  data.tar.gz: dd4a094146d32a3a7c61c571ededa504acdaf58df5fcfbc6546321d3291d73d6c997c039d78cb55258e64a35cad0ab5a195720a44ccaf15ba0cd1f576a53cd4d

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    jazzy (0.0.15)
+    jazzy (0.0.16)
       activesupport (~> 4.1)
       mustache (~> 0.99)
       nokogiri (~> 1.6)
       redcarpet (~> 3.2)
       rouge (~> 1.5)
       sass (~> 3.4)
+      sqlite3 (~> 1.3)
 
 GEM
   remote: http://rubygems.org/
@@ -40,7 +41,7 @@ GEM
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
     mustache (0.99.7)
-    nokogiri (1.6.4.1)
+    nokogiri (1.6.5)
       mini_portile (~> 0.6.0)
     parser (2.2.0.pre.5)
       ast (>= 1.1, < 3.0)
@@ -50,8 +51,8 @@ GEM
       bacon (~> 1.2)
     rainbow (2.0.0)
     rake (10.3.2)
-    redcarpet (3.2.0)
-    rouge (1.7.3)
+    redcarpet (3.2.1)
+    rouge (1.7.4)
     rubocop (0.26.1)
       astrolabe (~> 1.3)
       parser (>= 2.2.0.pre.4, < 3.0)
@@ -60,8 +61,9 @@ GEM
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.6.0)
     safe_yaml (1.0.4)
-    sass (3.4.8)
+    sass (3.4.9)
     slop (3.6.0)
+    sqlite3 (1.3.10)
     thread_safe (0.3.4)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)

data/Rakefile

@@ -52,6 +52,8 @@ begin
     files_to_delete = FileList[files_glob]
       .exclude('spec/integration_specs/*/after/docs',
                'spec/integration_specs/*/after/execution_output.txt')
+      .include('**/*.dsidx')
+      .include('**/*.tgz')
     files_to_delete.each do |file_to_delete|
       sh "rm -rf '#{file_to_delete}'"
     end

data/bin/jazzy

@@ -12,4 +12,4 @@ end
 
 require 'jazzy'
 
-Jazzy::DocBuilder.build(Jazzy::Config.parse!)
+Jazzy::DocBuilder.build(Jazzy::Config.instance = Jazzy::Config.parse!)

data/jazzy.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'nokogiri', '~> 1.6'
   spec.add_runtime_dependency 'sass', '~> 3.4'
   spec.add_runtime_dependency 'rouge', '~> 1.5'
+  spec.add_runtime_dependency 'sqlite3', '~> 1.3'
 
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.3'

data/lib/jazzy.rb

@@ -1 +1,2 @@
+require 'jazzy/config'
 require 'jazzy/doc_builder'

data/lib/jazzy/assets/css/highlight.css.scss

@@ -0,0 +1,63 @@
+/* Credit to https://gist.github.com/wataru420/2048287 */
+
+.highlight {
+  .c { color: #999988; font-style: italic } /* Comment */
+  .err { color: #a61717; background-color: #e3d2d2 } /* Error */
+  .k { color: #000000; font-weight: bold } /* Keyword */
+  .o { color: #000000; font-weight: bold } /* Operator */
+  .cm { color: #999988; font-style: italic } /* Comment.Multiline */
+  .cp { color: #999999; font-weight: bold } /* Comment.Preproc */
+  .c1 { color: #999988; font-style: italic } /* Comment.Single */
+  .cs { color: #999999; font-weight: bold; font-style: italic } /* Comment.Special */
+  .gd { color: #000000; background-color: #ffdddd } /* Generic.Deleted */
+  .gd .x { color: #000000; background-color: #ffaaaa } /* Generic.Deleted.Specific */
+  .ge { color: #000000; font-style: italic } /* Generic.Emph */
+  .gr { color: #aa0000 } /* Generic.Error */
+  .gh { color: #999999 } /* Generic.Heading */
+  .gi { color: #000000; background-color: #ddffdd } /* Generic.Inserted */
+  .gi .x { color: #000000; background-color: #aaffaa } /* Generic.Inserted.Specific */
+  .go { color: #888888 } /* Generic.Output */
+  .gp { color: #555555 } /* Generic.Prompt */
+  .gs { font-weight: bold } /* Generic.Strong */
+  .gu { color: #aaaaaa } /* Generic.Subheading */
+  .gt { color: #aa0000 } /* Generic.Traceback */
+  .kc { color: #000000; font-weight: bold } /* Keyword.Constant */
+  .kd { color: #000000; font-weight: bold } /* Keyword.Declaration */
+  .kp { color: #000000; font-weight: bold } /* Keyword.Pseudo */
+  .kr { color: #000000; font-weight: bold } /* Keyword.Reserved */
+  .kt { color: #445588; font-weight: bold } /* Keyword.Type */
+  .m { color: #009999 } /* Literal.Number */
+  .s { color: #d14 } /* Literal.String */
+  .na { color: #008080 } /* Name.Attribute */
+  .nb { color: #0086B3 } /* Name.Builtin */
+  .nc { color: #445588; font-weight: bold } /* Name.Class */
+  .no { color: #008080 } /* Name.Constant */
+  .ni { color: #800080 } /* Name.Entity */
+  .ne { color: #990000; font-weight: bold } /* Name.Exception */
+  .nf { color: #990000; font-weight: bold } /* Name.Function */
+  .nn { color: #555555 } /* Name.Namespace */
+  .nt { color: #000080 } /* Name.Tag */
+  .nv { color: #008080 } /* Name.Variable */
+  .ow { color: #000000; font-weight: bold } /* Operator.Word */
+  .w { color: #bbbbbb } /* Text.Whitespace */
+  .mf { color: #009999 } /* Literal.Number.Float */
+  .mh { color: #009999 } /* Literal.Number.Hex */
+  .mi { color: #009999 } /* Literal.Number.Integer */
+  .mo { color: #009999 } /* Literal.Number.Oct */
+  .sb { color: #d14 } /* Literal.String.Backtick */
+  .sc { color: #d14 } /* Literal.String.Char */
+  .sd { color: #d14 } /* Literal.String.Doc */
+  .s2 { color: #d14 } /* Literal.String.Double */
+  .se { color: #d14 } /* Literal.String.Escape */
+  .sh { color: #d14 } /* Literal.String.Heredoc */
+  .si { color: #d14 } /* Literal.String.Interpol */
+  .sx { color: #d14 } /* Literal.String.Other */
+  .sr { color: #009926 } /* Literal.String.Regex */
+  .s1 { color: #d14 } /* Literal.String.Single */
+  .ss { color: #990073 } /* Literal.String.Symbol */
+  .bp { color: #999999 } /* Name.Builtin.Pseudo */
+  .vc { color: #008080 } /* Name.Variable.Class */
+  .vg { color: #008080 } /* Name.Variable.Global */
+  .vi { color: #008080 } /* Name.Variable.Instance */
+  .il { color: #009999 } /* Literal.Number.Integer.Long */
+}

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

@@ -1,4 +1,5 @@
 $doc_coverage_color: #999;
+$content_wrapper_width: 980px;
 
 html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr, td {
   background: transparent;
@@ -11,6 +12,12 @@ html, body, div, span, h1, h3, h4, p, a, code, em, img, ul, li, table, tbody, tr
 }
 
 #reference {
+  .declaration .Swift pre {
+    // Ensure that declarations wrap, as they're a single line
+    white-space: pre-wrap;
+    font-size: 140%;
+  }
+
   .x-instance-method.Swift {
     margin-left: 15px;
   }
@@ -233,7 +240,7 @@ a[name] {
 .content-wrapper {
   background-color: rgba(242, 242, 242, 1);
   margin: 0 auto;
-  width: 980px;
+  width: $content_wrapper_width;
 }
 
 .pixel-line {
@@ -848,3 +855,22 @@ td {
     }
   }
 }
+
+html.dash {
+  .book-parts {
+    display: none;
+    width: 0;
+  }
+  .chapter {
+    width: $content_wrapper_width;
+    margin-left: 0;
+  }
+  #reference {
+    .height-container {
+      display: block;
+    }
+    .x-instance-method {
+      margin-left: 0;
+    }
+  }
+}

data/lib/jazzy/assets/js/jazzy.js

@@ -1,10 +1,16 @@
 // On doc load, toggle the URL hash discussion if present
 $(document).ready(function() {
-  var linkToHash = $('a[href="' + window.location.hash +'"]');
-  linkToHash.trigger("click");
+  if (!window.jazzy.docset) {
+    var linkToHash = $('a[href="' + window.location.hash +'"]');
+    linkToHash.trigger("click");
+  }
 });
+
 // On x-instance-method click, toggle its discussion and animate token.marginLeft
 $(".x-instance-method").click(function() {
+  if (window.jazzy.docset) {
+    return;
+  }
   var link = $(this);
   var animationDuration = 300;
   var tokenOffset = "15px";

data/lib/jazzy/config.rb

@@ -14,6 +14,7 @@ module Jazzy
     attr_accessor :sourcekitten_sourcefile
     attr_accessor :clean
     attr_accessor :readme_path
+    attr_accessor :docset_platform
 
     def initialize
       self.output = Pathname('docs')
@@ -26,6 +27,7 @@ module Jazzy
       self.dash_url = nil
       self.sourcekitten_sourcefile = nil
       self.clean = false
+      self.docset_platform = 'jazzy'
     end
 
     # rubocop:disable Metrics/MethodLength
@@ -103,5 +105,35 @@ module Jazzy
 
       config
     end
+
+    #-------------------------------------------------------------------------#
+
+    # @!group Singleton
+
+    # @return [Config] the current config instance creating one if needed.
+    #
+    def self.instance
+      @instance ||= new
+    end
+
+    # Sets the current config instance. If set to nil the config will be
+    # recreated when needed.
+    #
+    # @param  [Config, Nil] the instance.
+    #
+    # @return [void]
+    #
+    class << self
+      attr_writer :instance
+    end
+
+    # Provides support for accessing the configuration instance in other
+    # scopes.
+    #
+    module Mixin
+      def config
+        Config.instance
+      end
+    end
   end
 end

data/lib/jazzy/doc.mustache

@@ -3,12 +3,26 @@
   <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" />
+    <link rel="stylesheet" type="text/css" href="{{path_to_root}}css/highlight.css" />
     <meta charset='utf-8'>
+    <script type="text/javascript">
+    window.jazzy = {'docset': false}
+    if (typeof window.dash != 'undefined') {
+      document.documentElement.className += ' dash'
+      window.jazzy.docset = true
+    }
+    if (navigator.userAgent.match(/xcode/i)) {
+      document.documentElement.className += ' xcode'
+      window.jazzy.docset = true
+    }
+    </script>
     <script src="{{path_to_root}}js/jquery.min.js" defer></script>
     <script src="{{path_to_root}}js/jazzy.js" defer></script>
   </head>
   <body id="reference" class="Swift">
+    {{#dash_type}}
+    <a name="//apple_ref/swift/{{dash_type}}/{{name}}" class="dashAnchor"></a>
+    {{/dash_type}}
     <a title="{{name}} {{kind}} Reference"></a>
     <header>
       <div class="content-wrapper">

data/lib/jazzy/doc_builder.rb

@@ -6,6 +6,7 @@ require 'sass'
 
 require 'jazzy/config'
 require 'jazzy/doc'
+require 'jazzy/docset_builder'
 require 'jazzy/jazzy_markdown'
 require 'jazzy/readme_generator'
 require 'jazzy/source_declaration'
@@ -63,24 +64,28 @@ module Jazzy
     # @param [String] output_dir Root directory to write docs
     # @param [Array] docs Array of structured docs
     # @param [Config] options Build options
-    # @param [Integer] depth Number of parents. Used to calculate path_to_root
-    #        for web.
     # @param [Array] doc_structure @see #doc_structure_for_docs
-    def self.build_docs(output_dir, docs, source_module, depth)
-      docs.each do |doc|
-        next if doc.name != 'index' && doc.children.count == 0
-        prepare_output_dir(output_dir, false)
-        path = output_dir + "#{doc.name}.html"
+    def self.build_docs(output_dir, docs, source_module)
+      each_doc(output_dir, docs) do |doc, path, depth|
+        prepare_output_dir(path.parent, false)
         path_to_root = ['../'].cycle(depth).to_a.join('')
         path.open('w') do |file|
           file.write(document(source_module, doc, path_to_root))
         end
+      end
+    end
+
+    def self.each_doc(output_dir, docs, depth = 0, &block)
+      docs.each do |doc|
+        next if doc.name != 'index' && doc.children.count == 0
+        path = output_dir + "#{doc.name}.html"
+        block.call(doc, path, depth)
         next if doc.name == 'index'
-        build_docs(
+        each_doc(
           output_dir + doc.name,
           doc.children,
-          source_module,
           depth + 1,
+          &block
         )
       end
     end
@@ -96,13 +101,18 @@ module Jazzy
 
       structure = doc_structure_for_docs(docs)
 
-      docs << SourceDeclaration.new.tap { |sd| sd.name = 'index' }
+      docs << SourceDeclaration.new.tap do |sd|
+        sd.name = 'index'
+        sd.children = []
+      end
 
       source_module = SourceModule.new(options, docs, structure, coverage)
-      build_docs(output_dir, source_module.docs, source_module, 0)
+      build_docs(output_dir, source_module.docs, source_module)
 
       copy_assets(output_dir)
 
+      DocsetBuilder.new(output_dir, source_module).build!
+
       puts "jam out ♪♫ to your fresh new docs in `#{output_dir}`"
     end
 
@@ -161,6 +171,7 @@ module Jazzy
         abstract: Jazzy.markdown.render(abstract),
         declaration: item.declaration,
         usr: item.usr,
+        dash_type: item.type.dash_type,
       }
       gh_token_url = gh_token_url(item, source_module)
       item_render[:github_token_url] = gh_token_url
@@ -215,7 +226,8 @@ module Jazzy
       doc = Doc.new # Mustache model instance
       doc[:doc_coverage] = source_module.doc_coverage
       doc[:name] = doc_model.name
-      doc[:kind] = doc_model.kindName
+      doc[:kind] = doc_model.type.name
+      doc[:dash_type] = doc_model.type.dash_type
       doc[:overview] = Jazzy.markdown.render(doc_model.abstract || '')
       doc[:structure] = source_module.doc_structure
       doc[:tasks] = render_tasks(source_module, doc_model.children)

data/lib/jazzy/docset_builder.rb

@@ -0,0 +1,77 @@
+require 'mustache'
+require 'sqlite3'
+
+module Jazzy
+  module DocBuilder
+    # Follows the instructions found at http://kapeli.com/docsets#dashDocset.
+    class DocsetBuilder
+      include Config::Mixin
+
+      attr_reader :output_dir
+      attr_reader :source_module
+      attr_reader :docset_dir
+      attr_reader :documents_dir
+
+      def initialize(output_dir, source_module)
+        @output_dir = output_dir
+        @source_module = source_module
+        @docset_dir = output_dir + "#{source_module.name}.docset"
+        @documents_dir = docset_dir + 'Contents/Resources/Documents/'
+      end
+
+      def build!
+        docset_dir.rmtree if docset_dir.exist?
+        copy_docs
+        write_plist
+        create_index
+        create_archive
+      end
+
+      private
+
+      def write_plist
+        info_plist_path = docset_dir + 'Contents/Info.plist'
+        info_plist_path.open('w') do |plist|
+          template = Pathname(__dir__) + 'docset_builder/info_plist.mustache'
+          plist << Mustache.render(
+            template.read,
+            bundle_identifier: source_module.name.downcase,
+            name: source_module.name,
+            platform_family: config.docset_platform,
+          )
+        end
+      end
+
+      def create_archive
+        target  = "#{source_module.name}.tgz"
+        source  = docset_dir.basename.to_s
+        options = {
+          chdir: output_dir.to_s,
+          [1, 2] => '/dev/null', # silence all output from `tar`
+        }
+        system('tar', "--exclude='.DS_Store'", '-cvzf', target, source, options)
+      end
+
+      def copy_docs
+        files_to_copy = Dir.glob(output_dir + '**/*')
+
+        FileUtils.mkdir_p documents_dir
+        FileUtils.cp_r files_to_copy, documents_dir
+      end
+
+      def create_index
+        search_index_path = docset_dir + 'Contents/Resources/docSet.dsidx'
+        SQLite3::Database.new(search_index_path.to_s) do |db|
+          db.execute('CREATE TABLE searchIndex(' \
+            'id INTEGER PRIMARY KEY, name TEXT, type TEXT, path TEXT);')
+          db.execute('CREATE UNIQUE INDEX anchor ON ' \
+            'searchIndex (name, type, path);')
+          source_module.all_declarations.select(&:type).each do |doc|
+            db.execute('INSERT OR IGNORE INTO searchIndex(name, type, path) ' \
+              'VALUES (?, ?, ?);', [doc.name, doc.type.dash_type, doc.url])
+          end
+        end
+      end
+    end
+  end
+end