jazzy 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 407cbe5270841f8ec4c1f0bce108b166a11dbf20
-  data.tar.gz: 5e36875d2c77dae45f19aeb501b5db4ef6b9c1b7
+  metadata.gz: d5fffd12cb7f8be3f0c8324d58223c473d448f08
+  data.tar.gz: 6d0f919efaff11797da75225f4f2b0e4c5b1465a
 SHA512:
-  metadata.gz: 3b39e6b6c7039637d51ab118ff1d2d53e4fff1fe2ca4106d261d75d437f0fbce26430c81b46a0a13d984566d98b1a95403243d271d08453f2e1dfdaea57f79ed
-  data.tar.gz: f76fe47dd5d5c91b556a7265e72a37cc38aa8f561282db1c9455aa981b36081ccafc839ce5b5c76b60df111ed7138ba1eaf79d9905a9c974012b179ae16af13b
+  metadata.gz: 3042eece94b7af43d07cb2282c5571a78729566bc6b42ef4abce1aad65fc58d3345b8067007ec4ac2dd08cea24fc27a67ffe53b11a893a3f5597a389535f06f7
+  data.tar.gz: dc9e5769d1f755f176e7d9bd7600fa1f2a12f679ecd4c4c9ef77db7c15dcba7970ca3ceb7b064e827438c20e4baa5fabedeb69aa6e733e35ea38f64f2c922e0e

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## 0.7.2
+
+##### Breaking
+
+* None.
+
+##### Enhancements
+
+* None.
+
+##### Bug Fixes
+
+* Declarations marked `@available(..., unavailable, ...)` are no longer
+  documented.  
+  [JP Simard](https://github.com/jpsim)
+  [#654](https://github.com/realm/jazzy/issues/654)
+
+* Treat the `open` ACL as more public than `public`.  
+  [JP Simard](https://github.com/jpsim)
+
 ## 0.7.1
 
 ##### Breaking

data/Gemfile.lock

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

data/lib/jazzy/gem_version.rb

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

data/lib/jazzy/source_declaration/access_control_level.rb

@@ -82,8 +82,8 @@ module Jazzy
         private: 0,
         fileprivate: 1,
         internal: 2,
-        open: 3,
-        public: 4,
+        public: 3,
+        open: 4,
       }.freeze
 
       def <=>(other)

data/lib/jazzy/sourcekitten.rb

@@ -162,12 +162,27 @@ module Jazzy
       doc['key.substructure'].any? { |child| documented_child?(child) }
     end
 
+    def self.availability_attribute?(doc)
+      return false unless doc['key.attributes']
+      !doc['key.attributes'].select do |attribute|
+        attribute.values.first == 'source.decl.attribute.available'
+      end.empty?
+    end
+
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
     def self.should_document?(doc)
       return false if doc['key.doc.comment'].to_s.include?(':nodoc:')
 
       # Always document Objective-C declarations.
       return true if Config.instance.objc_mode
 
+      # Don't document @available declarations with no USR, since it means
+      # they're unavailable.
+      if availability_attribute?(doc) && !doc['key.usr']
+        return false
+      end
+
       # Document extensions & enum elements, since we can't tell their ACL.
       type = SourceDeclaration::Type.new(doc['key.kind'])
       return true if type.swift_enum_element?
@@ -180,6 +195,8 @@ module Jazzy
 
       SourceDeclaration::AccessControlLevel.from_doc(doc) >= @min_acl
     end
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
 
     def self.process_undocumented_token(doc, declaration)
       source_directory = Config.instance.source_directory.to_s

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - JP Simard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-13 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocoapods