jazzy 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b3cc2b3e13ef93280c2e11e9b9548da39d8e40bb
-  data.tar.gz: 937ed6490fdea1d878db269434c06ed59ff99e30
+  metadata.gz: 19c85014e711d310498a311bb30099ee0a6c9bbb
+  data.tar.gz: d6c589b0ef0551de858cfc471da17108fe762972
 SHA512:
-  metadata.gz: 816b616754d2f7536dce72710ee0678395e105f5df4e2bbcc44c8c7ad531db8e52b32d10eb69cec34634dca07177da1f78ea9212e42ba7228f9a4b9e48b9d247
-  data.tar.gz: feccf1fa4d0bc838694a924aeefb0baa999b88d721dba4dbe6a92e55806f6a4b042b04cca9b2acf63319acd0cabcc393cdf40b28cdeaf6568400b5c44f001184
+  metadata.gz: 78fdb1e5bb33da47b03ec512f448873fa1bfc46a08cd96cb633080c4b6ed81593f14c6269710c3da2291825c0a938e0aeca47be2b88de7d6175d68689f196647
+  data.tar.gz: 3d27a0e9fbcab0e860873c9e00594c6e43d533ad710cc0fc562c146adfd180e5841d18c2c17370fbdfe758901ab8951279c1d87ae397d146ff23dc03d7ebecbc

data/.travis.yml

@@ -0,0 +1,16 @@
+language: objective-c
+osx_image: beta-xcode6.3
+cache: bundler
+branches:
+  only:
+    - master
+rvm:
+  - system
+before_install:
+  - sudo gem install bundler
+  - git submodule update --init --recursive
+script:
+  - bundle exec rake spec
+notifications:
+  email: false
+  slack: realmio:vPdpsG9NLDo2DNlbqtcMAQuE

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.2.2
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Added support for custom templates: use the `-t`/`--template-directory`
+  argument to jazzy.  
+  [JP Simard](https://github.com/jpsim)
+  [#20](https://github.com/realm/jazzy/issues/20)
+
+##### Bug Fixes
+
+* None.
+
+
 ## 0.2.1
 
 ##### Breaking

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.2.1)
+    jazzy (0.2.2)
       cocoapods (~> 0.37)
       mustache (~> 0.99)
       open4
@@ -13,7 +13,7 @@ PATH
 GEM
   remote: http://rubygems.org/
   specs:
-    activesupport (4.2.1)
+    activesupport (4.2.3)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -24,34 +24,34 @@ GEM
     astrolabe (1.3.0)
       parser (>= 2.2.0.pre.3, < 3.0)
     bacon (1.2.0)
-    claide (0.8.1)
+    claide (0.8.2)
     clintegracon (0.5.3)
       colored (~> 1.2)
       diffy
-    cocoapods (0.37.0)
+    cocoapods (0.37.2)
       activesupport (>= 3.2.15)
       claide (~> 0.8.1)
-      cocoapods-core (= 0.37.0)
+      cocoapods-core (= 0.37.2)
       cocoapods-downloader (~> 0.9.0)
       cocoapods-plugins (~> 0.4.2)
-      cocoapods-trunk (~> 0.6.0)
-      cocoapods-try (~> 0.4.3)
+      cocoapods-trunk (~> 0.6.1)
+      cocoapods-try (~> 0.4.5)
       colored (~> 1.2)
       escape (~> 0.0.4)
       molinillo (~> 0.2.3)
       nap (~> 0.8)
-      xcodeproj (~> 0.24.1)
-    cocoapods-core (0.37.0)
+      xcodeproj (~> 0.24.2)
+    cocoapods-core (0.37.2)
       activesupport (>= 3.2.15)
       fuzzy_match (~> 2.0.4)
       nap (~> 0.8.0)
-    cocoapods-downloader (0.9.0)
+    cocoapods-downloader (0.9.1)
     cocoapods-plugins (0.4.2)
       nap
-    cocoapods-trunk (0.6.0)
+    cocoapods-trunk (0.6.1)
       nap (>= 0.8)
       netrc (= 0.7.8)
-    cocoapods-try (0.4.3)
+    cocoapods-try (0.4.5)
     colored (1.2)
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
@@ -59,9 +59,9 @@ GEM
     escape (0.0.4)
     fuzzy_match (2.0.4)
     i18n (0.7.0)
-    json (1.8.2)
+    json (1.8.3)
     metaclass (0.0.4)
-    minitest (5.6.1)
+    minitest (5.7.0)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
@@ -79,8 +79,8 @@ GEM
       bacon (~> 1.2)
     rainbow (2.0.0)
     rake (10.3.2)
-    redcarpet (3.2.3)
-    rouge (1.8.0)
+    redcarpet (3.3.2)
+    rouge (1.9.0)
     rubocop (0.26.1)
       astrolabe (~> 1.3)
       parser (>= 2.2.0.pre.4, < 3.0)
@@ -89,7 +89,7 @@ GEM
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.6.0)
     safe_yaml (1.0.4)
-    sass (3.4.13)
+    sass (3.4.15)
     slop (3.6.0)
     sqlite3 (1.3.10)
     thread_safe (0.3.5)
@@ -98,7 +98,7 @@ GEM
     webmock (1.20.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-    xcodeproj (0.24.1)
+    xcodeproj (0.24.3)
       activesupport (>= 3)
       colored (~> 1.2)
 
@@ -117,3 +117,6 @@ DEPENDENCIES
   rake (~> 10.3)
   rubocop
   webmock
+
+BUNDLED WITH
+   1.10.5

data/README.md

@@ -2,6 +2,8 @@
 
 ![analytics](https://ga-beacon.appspot.com/UA-50247013-2/jazzy/README?pixel)
 
+![Test Status](https://travis-ci.org/realm/jazzy.svg?branch=master)
+
 jazzy is a command-line utility that generates documentation for your Swift or
 Objective-C projects.
 
@@ -19,8 +21,8 @@ documentation, post WWDC 2014.
 
 ### Requirements
 
-* [Xcode 6.1][xcode], installed in `/Applications/Xcode.app`
-* `xcode-select -p` should print Xcode 6.1's path. If it doesn't, run
+* [Xcode 6.3][xcode], installed in `/Applications/Xcode.app`
+* `xcode-select -p` should print Xcode 6.3's path. If it doesn't, run
 `sudo xcode-select -s /Applications/Xcode.app/Contents/Developer`
 
 ### Installing
@@ -32,6 +34,11 @@ To install jazzy, run `[sudo] gem install jazzy` from your command line.
 Run `jazzy` from your command line. Run `jazzy -h` for a list of additional
 options.
 
+### Troubleshooting
+
+#### Only extensions are listed in the documentation.
+By default, jazzy only documents public declarations. To generate documentation for declarations with a lower accessibility level (internal or private), please set the `--min-acl` flag to `internal` or `private`.
+
 ### Development
 
 jazzy is composed of two parts: the parser ([sourcekitten][sourcekitten],

data/lib/jazzy/config.rb

@@ -2,6 +2,7 @@ require 'optparse'
 require 'pathname'
 require 'uri'
 
+require 'jazzy/doc'
 require 'jazzy/podspec_documenter'
 require 'jazzy/source_declaration/access_control_level'
 
@@ -29,6 +30,7 @@ module Jazzy
     attr_accessor :docset_path
     attr_accessor :source_directory
     attr_accessor :excluded_files
+    attr_accessor :template_directory
 
     def initialize
       PodspecDocumenter.configure(self, Dir['*.podspec{,.json}'].first)
@@ -44,12 +46,18 @@ module Jazzy
       self.skip_undocumented = false
       self.source_directory = Pathname.pwd
       self.excluded_files = []
+      self.template_directory = Pathname(__FILE__).parent + 'templates'
     end
 
     def podspec=(podspec)
       @podspec = PodspecDocumenter.configure(self, podspec)
     end
 
+    def template_directory=(template_directory)
+      @template_directory = template_directory
+      Doc.template_path = template_directory
+    end
+
     # rubocop:disable Metrics/MethodLength
     def self.parse!
       config = new
@@ -161,6 +169,11 @@ module Jazzy
           config.source_directory = Pathname(source_directory)
         end
 
+        opt.on('t', '--template-directory DIRPATH', 'The directory that ' \
+               'contains the mustache templates to use') do |template_directory|
+          config.template_directory = Pathname(template_directory)
+        end
+
         opt.on('--readme FILEPATH',
                'The path to a markdown README file') do |readme|
           config.readme_path = Pathname(readme)

data/lib/jazzy/doc.rb

@@ -1,11 +1,12 @@
 require 'date'
 require 'pathname'
+require 'mustache'
 
 require 'jazzy/gem_version'
 
 module Jazzy
   class Doc < Mustache
-    self.template_path = Pathname(__FILE__).parent.parent
+    self.template_name = 'doc'
 
     def date
       # Fake date is used to keep integration tests consistent

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/{doc.mustache → templates/doc.mustache}

@@ -13,7 +13,7 @@
     <a name="//apple_ref/swift/{{dash_type}}/{{name}}" class="dashAnchor"></a>
     {{/dash_type}}
     <a title="{{name}} {{kind}} Reference"></a>
-    {{> jazzy/partials/header}}
+    {{> header}}
     <div class="content-wrapper">
       <p id="breadcrumbs">
         <a href="{{path_to_root}}index.html">{{module_name}} Reference</a>
@@ -22,16 +22,16 @@
       </p>
     </div>
     <div class="content-wrapper">
-      {{> jazzy/partials/nav}}
+      {{> nav}}
       <article class="main-content">
         <section>
           <section class="section">
             {{^hide_name}}<h1>{{name}}</h1>{{/hide_name}}
             {{{overview}}}
           </section>
-          {{> jazzy/partials/tasks}}
+          {{> tasks}}
         </section>
-        {{> jazzy/partials/footer}}
+        {{> footer}}
       </article>
     </div>
   </body>

data/lib/jazzy/{partials → templates}/task.mustache

@@ -45,7 +45,7 @@
             <table class="graybox">
               <tbody>
                 {{#parameters}}
-                {{> jazzy/partials/parameter}}
+                {{> parameter}}
                 {{/parameters}}
               </tbody>
             </table>

data/lib/jazzy/{partials → templates}/tasks.mustache

@@ -1,7 +1,7 @@
 {{#tasks.count}}
 <section class="section task-group-section">
   {{#tasks}}
-  {{> jazzy/partials/task}}
+  {{> task}}
   {{/tasks}}
 </section>
 {{/tasks.count}}

data/spec/integration_spec.rb

@@ -48,6 +48,10 @@ require 'pretty_bacon'
 require 'colored'
 require 'CLIntegracon'
 
+require 'cocoapods'
+Pod::Config.instance.silent = true
+Pod::Command::Setup.invoke
+
 CLIntegracon.configure do |c|
   c.spec_path = ROOT + 'spec/integration_specs'
   c.temp_path = ROOT + 'tmp'
@@ -77,7 +81,7 @@ describe_cli 'jazzy' do
     s.environment_vars = {
       'JAZZY_FAKE_DATE'            => 'YYYY-MM-DD',
       'JAZZY_FAKE_VERSION'         => 'X.X.X',
-      'COCOAPODS_SKIP_NEW_VERSION' => 'TRUE',
+      'COCOAPODS_SKIP_UPDATE_MESSAGE' => 'TRUE',
     }
     s.default_args = []
     s.replace_path ROOT.to_s, 'ROOT'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-06 00:00:00.000000000 Z
+date: 2015-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -151,6 +151,7 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".rubocop.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -192,7 +193,6 @@ files:
 - lib/jazzy/assets/js/jazzy.js
 - lib/jazzy/assets/js/jquery.min.js
 - lib/jazzy/config.rb
-- lib/jazzy/doc.mustache
 - lib/jazzy/doc.rb
 - lib/jazzy/doc_builder.rb
 - lib/jazzy/docset_builder.rb
@@ -201,12 +201,6 @@ files:
 - lib/jazzy/gem_version.rb
 - lib/jazzy/highlighter.rb
 - lib/jazzy/jazzy_markdown.rb
-- lib/jazzy/partials/footer.mustache
-- lib/jazzy/partials/header.mustache
-- lib/jazzy/partials/nav.mustache
-- lib/jazzy/partials/parameter.mustache
-- lib/jazzy/partials/task.mustache
-- lib/jazzy/partials/tasks.mustache
 - lib/jazzy/podspec_documenter.rb
 - lib/jazzy/readme_generator.rb
 - lib/jazzy/source_declaration.rb
@@ -215,6 +209,13 @@ files:
 - lib/jazzy/source_mark.rb
 - lib/jazzy/source_module.rb
 - lib/jazzy/sourcekitten.rb
+- lib/jazzy/templates/doc.mustache
+- lib/jazzy/templates/footer.mustache
+- lib/jazzy/templates/header.mustache
+- lib/jazzy/templates/nav.mustache
+- lib/jazzy/templates/parameter.mustache
+- lib/jazzy/templates/task.mustache
+- lib/jazzy/templates/tasks.mustache
 - logo.jpg
 - logo.sketch
 - screenshot.jpg