jazzy 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d06338c65161e748c8e95e6fe8b9270101f5edc6
-  data.tar.gz: 7cc9150d00cb56fd6139df4b3ed0ecd8abe310bd
+  metadata.gz: b3cc2b3e13ef93280c2e11e9b9548da39d8e40bb
+  data.tar.gz: 937ed6490fdea1d878db269434c06ed59ff99e30
 SHA512:
-  metadata.gz: 5de22817988a276354c66ad51274dd0f61e86f2ce8ae3020d4e85313d16d325ecc5e1f941bf846d42dc8819f2644aa213a5e80ab7b2cc69608f499d069e73fe5
-  data.tar.gz: 0f832259dadb561daeebeaf7967114b17e821a5021e04eb012db9a6ba46afbb12c5677bf41bc9a1843411ab70aee77d061dd41cea8f33c8690c88b8c7edd15fd
+  metadata.gz: 816b616754d2f7536dce72710ee0678395e105f5df4e2bbcc44c8c7ad531db8e52b32d10eb69cec34634dca07177da1f78ea9212e42ba7228f9a4b9e48b9d247
+  data.tar.gz: feccf1fa4d0bc838694a924aeefb0baa999b88d721dba4dbe6a92e55806f6a4b042b04cca9b2acf63319acd0cabcc393cdf40b28cdeaf6568400b5c44f001184

data/CHANGELOG.md

@@ -1,3 +1,21 @@
+## 0.2.1
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* Added the ability to ignore certain files by passing in an `-e`/`--exclude`
+  argument to jazzy.  
+  [JP Simard](https://github.com/jpsim)
+  [#173](https://github.com/realm/jazzy/issues/173)
+
+##### Bug Fixes
+
+* None.
+
+
 ## 0.2.0
 
 ##### Breaking

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    jazzy (0.2.0)
-      cocoapods (~> 0.36.0.rc.1)
+    jazzy (0.2.1)
+      cocoapods (~> 0.37)
       mustache (~> 0.99)
       open4
       redcarpet (~> 3.2)
@@ -28,21 +28,20 @@ GEM
     clintegracon (0.5.3)
       colored (~> 1.2)
       diffy
-    cocoapods (0.36.4)
+    cocoapods (0.37.0)
       activesupport (>= 3.2.15)
       claide (~> 0.8.1)
-      cocoapods-core (= 0.36.4)
+      cocoapods-core (= 0.37.0)
       cocoapods-downloader (~> 0.9.0)
-      cocoapods-plugins (~> 0.4.1)
+      cocoapods-plugins (~> 0.4.2)
       cocoapods-trunk (~> 0.6.0)
       cocoapods-try (~> 0.4.3)
       colored (~> 1.2)
       escape (~> 0.0.4)
-      molinillo (~> 0.2.1)
+      molinillo (~> 0.2.3)
       nap (~> 0.8)
-      open4 (~> 1.3)
-      xcodeproj (~> 0.23.1)
-    cocoapods-core (0.36.4)
+      xcodeproj (~> 0.24.1)
+    cocoapods-core (0.37.0)
       activesupport (>= 3.2.15)
       fuzzy_match (~> 2.0.4)
       nap (~> 0.8.0)
@@ -62,7 +61,7 @@ GEM
     i18n (0.7.0)
     json (1.8.2)
     metaclass (0.0.4)
-    minitest (5.6.0)
+    minitest (5.6.1)
     mocha (1.1.0)
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
@@ -99,7 +98,7 @@ GEM
     webmock (1.20.0)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-    xcodeproj (0.23.1)
+    xcodeproj (0.24.1)
       activesupport (>= 3)
       colored (~> 1.2)
 

data/README.md

@@ -2,8 +2,6 @@
 
 ![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.
 

data/jazzy.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.extensions    = ['lib/jazzy/SourceKitten/Rakefile']
 
-  spec.add_runtime_dependency 'cocoapods', '~> 0.36.0.rc.1'
+  spec.add_runtime_dependency 'cocoapods', '~> 0.37'
   spec.add_runtime_dependency 'mustache', '~> 0.99'
   spec.add_runtime_dependency 'open4'
   spec.add_runtime_dependency 'redcarpet', '~> 3.2'

data/lib/jazzy/SourceKitten/SourceKittenFramework.framework/Versions/A/Resources/Info.plist

@@ -17,7 +17,7 @@
 	<key>CFBundlePackageType</key>
 	<string>FMWK</string>
 	<key>CFBundleShortVersionString</key>
-	<string>0.4.0</string>
+	<string>0.4.1</string>
 	<key>CFBundleSignature</key>
 	<string>????</string>
 	<key>CFBundleVersion</key>

data/lib/jazzy/config.rb

@@ -28,6 +28,7 @@ module Jazzy
     attr_accessor :docset_icon
     attr_accessor :docset_path
     attr_accessor :source_directory
+    attr_accessor :excluded_files
 
     def initialize
       PodspecDocumenter.configure(self, Dir['*.podspec{,.json}'].first)
@@ -42,6 +43,7 @@ module Jazzy
       self.min_acl = SourceDeclaration::AccessControlLevel.public
       self.skip_undocumented = false
       self.source_directory = Pathname.pwd
+      self.excluded_files = []
     end
 
     def podspec=(podspec)
@@ -164,6 +166,11 @@ module Jazzy
           config.readme_path = Pathname(readme)
         end
 
+        opt.on('-e', '--exclude file1,file2,…fileN', Array,
+               'Files to be excluded from documentation') do |files|
+          config.excluded_files = files
+        end
+
         opt.on('-v', '--version', 'Print version number') do
           puts 'jazzy version: ' + Jazzy::VERSION
           exit

data/lib/jazzy/executable.rb

@@ -30,7 +30,7 @@ module Jazzy
         status  = Open4.spawn(bin, *args, options)
         unless status.success?
           full_command = "#{bin.shellescape} #{args.map(&:shellescape)}"
-          output  = stdout.to_s << stderr.to_S
+          output = stdout.to_s << stderr.to_s
           if raise_on_failure
             raise "#{full_command}\n\n#{output}"
           else

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/sourcekitten.rb

@@ -44,9 +44,10 @@ module Jazzy
             id = doc.name || 'unknown'
             warn "`#{id}` has no USR. First make sure all modules used in " \
               'your project have been imported. If all used modules are ' \
-              'imported, please report this by filing an issue at ' \
+              'imported, please report this problem by filing an issue at ' \
               'https://github.com/realm/jazzy/issues along with your Xcode ' \
-              'project.'
+              'project. If this token is declared in an `#if` block, please ' \
+              'ignore this message.'
           end
           doc.url = parents.join('/') + '.html#/' + id
         end
@@ -239,12 +240,20 @@ module Jazzy
       end
     end
 
+    def self.filter_excluded_files(json)
+      excluded_files = Config.instance.excluded_files
+      json.map do |doc|
+        key = doc.keys.first
+        doc[key] unless excluded_files.include?(key)
+      end.compact
+    end
+
     # Parse sourcekitten STDOUT output as JSON
     # @return [Hash] structured docs
     def self.parse(sourcekitten_output, min_acl, skip_undocumented)
       @min_acl = min_acl
       @skip_undocumented = skip_undocumented
-      sourcekitten_json = JSON.parse(sourcekitten_output)
+      sourcekitten_json = filter_excluded_files(JSON.parse(sourcekitten_output))
       docs = make_source_declarations(sourcekitten_json)
       docs = deduplicate_declarations(docs)
       SourceDeclaration::Type.all.each do |type|

data/spec/integration_spec.rb

@@ -75,8 +75,9 @@ describe_cli 'jazzy' do
   subject do |s|
     s.executable = "ruby #{ROOT + 'bin/jazzy'}"
     s.environment_vars = {
-      'JAZZY_FAKE_DATE'    => 'YYYY-MM-DD',
-      'JAZZY_FAKE_VERSION' => 'X.X.X',
+      'JAZZY_FAKE_DATE'            => 'YYYY-MM-DD',
+      'JAZZY_FAKE_VERSION'         => 'X.X.X',
+      'COCOAPODS_SKIP_NEW_VERSION' => '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.0
+  version: 0.2.1
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -18,14 +18,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.36.0.rc.1
+        version: '0.37'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.36.0.rc.1
+        version: '0.37'
 - !ruby/object:Gem::Dependency
   name: mustache
   requirement: !ruby/object:Gem::Requirement
@@ -151,7 +151,6 @@ files:
 - ".gitignore"
 - ".gitmodules"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock

data/.travis.yml

@@ -1,17 +0,0 @@
-language: objective-c
-osx_image: xcode611
-cache: bundler
-rvm:
-  - system
-before_install:
-  - "mkdir -p ~/.cocoapods && echo -e \"---\\nnew_version_message: false\" > ~/.cocoapods/config.yaml"
-  - sudo gem install bundler
-  - git submodule update --init --recursive
-script:
-  - bundle exec rake spec
-notifications:
-  email: false
-  slack: realmio:vPdpsG9NLDo2DNlbqtcMAQuE
-branches:
-  except:
-    - swift1p2