jazzy 0.7.4 → 0.7.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ca696c264b7d1fb8815ad306c4d00a38b590762
-  data.tar.gz: ae530a97b56831e98b9ddd84b5cc5d48f927f86e
+  metadata.gz: a9754b8ad015ab378ddfb5ab40c230511104d3bc
+  data.tar.gz: 3f0c52c2516d07f1bf88836b61ef2f820ff715fc
 SHA512:
-  metadata.gz: 7f8be594e771a90d3a82e353c0ba070d927a09ebd566466d0677ed09ba50c728411812aea9a58be0abe8494efea3ee0490a2f227f7bf88c36c854a037db237a9
-  data.tar.gz: c8fd9cd72d6aeb4de45c35992af945fb85cf5940d32461da6d63af0ba64e0d63e39cf4c7fb7dbb27dadaffb77d8c80811b6f1a3de49ace84ba6a428c14cbbf6c
+  metadata.gz: 84f40dafc121c96a64eb76a6054a6da077aef3156eca4e9519c31556d98311408e19c5cb39c23bae5328f017e942f28d468a90e19a38eb602275f4e9c63242ff
+  data.tar.gz: a03ffdcbb9c68338019cbb784cd9ad6c8cc971a48e05c58f889b460b7961974058e71600eb12a23595c76e0d366acad6fd4b3bc965010f3f3264677d04aa1e96

data/CHANGELOG.md

@@ -1,3 +1,28 @@
+## 0.7.5
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Fix issue where using a custom theme would crash jazzy when using Ruby 2.4.  
+  [Jason Wray](https://github.com/friedbunny)
+  [#752](https://github.com/realm/jazzy/issues/752)
+
+* Fix support for Ruby 2.0.0.  
+  [Jason Wray](https://github.com/friedbunny)
+  [#747](https://github.com/realm/jazzy/issues/747)
+
+* Fix issue where header files are not found if inside subdirectories of the
+  framework_root specified folder.  
+  [Christopher Gretzki](https://github.com/gretzki)
+  [#518](https://github.com/realm/jazzy/issues/518)
+
 ## 0.7.4
 
 ##### Breaking
@@ -147,7 +172,7 @@
   [Shmuel Kallner](https://github.com/shmuelk)
   [#645](https://github.com/realm/jazzy/issues/645)
   [#646](https://github.com/realm/jazzy/issues/646)
- 
+
 ##### Bug Fixes
 
 * Fix issue where jazzy could not be installed from Gemfile due to

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.7.4)
+    jazzy (0.7.5)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4

data/lib/jazzy/config.rb

@@ -295,8 +295,11 @@ module Jazzy
                    'other assets for a custom theme.',
       default: 'apple',
       parse: ->(t) do
-        return expand_path(t) unless t == 'apple' || t == 'fullwidth'
-        Pathname(__FILE__).parent + 'themes' + t
+        if t == 'apple' || t == 'fullwidth'
+          Pathname(__FILE__).parent + 'themes' + t
+        else
+          expand_path(t)
+        end
       end
 
     config_attr :use_safe_filenames,
@@ -428,7 +431,14 @@ module Jazzy
     def read_config_file(file)
       case File.extname(file)
         when '.json'         then JSON.parse(File.read(file))
-        when '.yaml', '.yml' then YAML.safe_load(File.read(file))
+        when '.yaml', '.yml' then
+          if YAML.respond_to?('safe_load') # ruby >= 2.1.0
+            YAML.safe_load(File.read(file))
+          else
+            # rubocop:disable Security/YAMLLoad
+            YAML.load(File.read(file))
+            # rubocop:enable Security/YAMLLoad
+          end
         else raise "Config file must be .yaml or .json, but got #{file.inspect}"
       end
     end

data/lib/jazzy/gem_version.rb

@@ -1,3 +1,3 @@
 module Jazzy
-  VERSION = '0.7.4'.freeze unless defined? Jazzy::VERSION
+  VERSION = '0.7.5'.freeze unless defined? Jazzy::VERSION
 end

data/lib/jazzy/sourcekitten.rb

@@ -161,22 +161,45 @@ module Jazzy
       end
     end
 
+    # returns all subdirectories of specified path
+    def self.rec_path(path)
+      path.children.collect do |child|
+        if child.directory?
+          rec_path(child) + [child]
+        end
+      end.select { |x| x }.flatten(1)
+    end
+
     # Builds SourceKitten arguments based on Jazzy options
     def self.arguments_from_options(options)
       arguments = ['doc']
-      if options.objc_mode
-        if options.xcodebuild_arguments.empty?
-          arguments += ['--objc', options.umbrella_header.to_s, '--', '-x',
-                        'objective-c', '-isysroot',
-                        `xcrun --show-sdk-path --sdk #{options.sdk}`.chomp,
-                        '-I', options.framework_root.to_s]
+      arguments += if options.objc_mode
+                     objc_arguments_from_options(options)
+                   elsif !options.module_name.empty?
+                     ['--module-name', options.module_name, '--']
+                   else
+                     ['--']
+                   end
+      arguments + options.xcodebuild_arguments
+    end
+
+    def self.objc_arguments_from_options(options)
+      arguments = []
+      if options.xcodebuild_arguments.empty?
+        arguments += ['--objc', options.umbrella_header.to_s, '--', '-x',
+                      'objective-c', '-isysroot',
+                      `xcrun --show-sdk-path --sdk #{options.sdk}`.chomp,
+                      '-I', options.framework_root.to_s]
+      end
+      # add additional -I arguments for each subdirectory of framework_root
+      unless options.framework_root.nil?
+        rec_path(Pathname.new(options.framework_root.to_s)).collect do |child|
+          if child.directory?
+            arguments += ['-I', child.to_s]
+          end
         end
-      elsif !options.module_name.empty?
-        arguments += ['--module-name', options.module_name, '--']
-      else
-        arguments += ['--']
       end
-      arguments + options.xcodebuild_arguments
+      arguments
     end
 
     # Run sourcekitten with given arguments and return STDOUT

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods
@@ -181,27 +181,18 @@ files:
 - images/screenshot.jpg
 - jazzy.gemspec
 - lib/jazzy.rb
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Commandant
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/A/Resources/Info.plist
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/A/Result
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/A/SWXMLHash
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/A/Yams
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCore.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftCoreGraphics.dylib
@@ -212,7 +203,6 @@ files:
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/libswiftObjectiveC.dylib
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Resources/Info.plist
 - lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/SourceKittenFramework
-- lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current
 - lib/jazzy/SourceKitten/Rakefile
 - lib/jazzy/SourceKitten/bin/sourcekitten
 - lib/jazzy/config.rb
@@ -291,7 +281,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Soulful docs for Swift & Objective-C.

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Resources

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/Resources

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/SourceKittenFramework

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current/SourceKittenFrame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Commandant

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Resources

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.framework/Versions/Current

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Commandant.f

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Resources

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Result

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.framework/Versions/Current

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Result.frame

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Resources

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/SWXMLHash

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.framework/Versions/Current

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/SWXMLHash.fr

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Resources

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Versions/Current

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framework/Yams

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A/Frameworks/Yams.framewo

data/lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/Current

@@ -1 +0,0 @@
-lib/jazzy/SourceKitten/Frameworks/SourceKittenFramework.framework/Versions/A