Customization for RAC.

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jazzy (0.7.5)
+    jazzy (0.7.5.pre.reactivecocoa)
       cocoapods (~> 1.0)
       mustache (~> 0.99)
       open4
@@ -15,9 +15,8 @@ GEM
   remote: https://rubygems.org/
   specs:
     CFPropertyList (2.3.5)
-    activesupport (4.2.7.1)
+    activesupport (4.2.8)
       i18n (~> 0.7)
-      json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
       thread_safe (~> 0.3, >= 0.3.4)
       tzinfo (~> 1.1)
@@ -33,26 +32,26 @@ GEM
     clintegracon (0.7.0)
       colored (~> 1.2)
       diffy
-    cocoapods (1.2.0)
+    cocoapods (1.2.1)
       activesupport (>= 4.0.2, < 5)
       claide (>= 1.0.1, < 2.0)
-      cocoapods-core (= 1.2.0)
+      cocoapods-core (= 1.2.1)
       cocoapods-deintegrate (>= 1.0.1, < 2.0)
       cocoapods-downloader (>= 1.1.3, < 2.0)
       cocoapods-plugins (>= 1.0.0, < 2.0)
       cocoapods-search (>= 1.0.0, < 2.0)
       cocoapods-stats (>= 1.0.0, < 2.0)
-      cocoapods-trunk (>= 1.1.2, < 2.0)
+      cocoapods-trunk (>= 1.2.0, < 2.0)
       cocoapods-try (>= 1.1.0, < 2.0)
-      colored (~> 1.2)
+      colored2 (~> 3.1)
       escape (~> 0.0.4)
       fourflusher (~> 2.0.1)
       gh_inspector (~> 1.0)
-      molinillo (~> 0.5.5)
+      molinillo (~> 0.5.7)
       nap (~> 1.0)
-      ruby-macho (~> 0.2.5)
-      xcodeproj (>= 1.4.1, < 2.0)
-    cocoapods-core (1.2.0)
+      ruby-macho (~> 1.1)
+      xcodeproj (>= 1.4.4, < 2.0)
+    cocoapods-core (1.2.1)
       activesupport (>= 4.0.2, < 5)
       fuzzy_match (~> 2.0.4)
       nap (~> 1.0)
@@ -62,11 +61,12 @@ GEM
       nap
     cocoapods-search (1.0.0)
     cocoapods-stats (1.0.0)
-    cocoapods-trunk (1.1.2)
+    cocoapods-trunk (1.2.0)
       nap (>= 0.8, < 2.0)
       netrc (= 0.7.8)
     cocoapods-try (1.1.0)
     colored (1.2)
+    colored2 (3.1.2)
     cork (0.2.0)
       colored (~> 1.2)
     crack (0.4.3)
@@ -93,8 +93,7 @@ GEM
     gh_inspector (1.0.3)
     git (1.3.0)
     hashdiff (0.3.0)
-    i18n (0.8.0)
-    json (1.8.6)
+    i18n (0.8.1)
     kramdown (1.13.1)
     liferaft (0.0.6)
     metaclass (0.0.4)
@@ -103,7 +102,7 @@ GEM
       metaclass (~> 0.0.1)
     mocha-on-bacon (0.2.2)
       mocha (>= 0.13.0)
-    molinillo (0.5.6)
+    molinillo (0.5.7)
     multipart-post (2.0.0)
     mustache (0.99.8)
     nanaimo (0.2.3)
@@ -128,7 +127,7 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
-    ruby-macho (0.2.6)
+    ruby-macho (1.1.0)
     ruby-progressbar (1.8.1)
     safe_yaml (1.0.4)
     sass (3.4.23)
@@ -137,8 +136,8 @@ GEM
       faraday (~> 0.8, < 1.0)
     sqlite3 (1.3.13)
     terminal-table (1.6.0)
-    thread_safe (0.3.5)
-    tzinfo (1.2.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
       thread_safe (~> 0.1)
     unicode-display_width (1.1.3)
     webmock (1.24.2)
@@ -147,11 +146,10 @@ GEM
       hashdiff
     xcinvoke (0.3.0)
       liferaft (~> 0.0.6)
-    xcodeproj (1.4.2)
+    xcodeproj (1.4.4)
       CFPropertyList (~> 2.3.3)
-      activesupport (>= 3)
       claide (>= 1.0.1, < 2.0)
-      colored (~> 1.2)
+      colored2 (~> 3.1)
       nanaimo (~> 0.2.3)
 
 PLATFORMS
@@ -172,4 +170,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   1.14.3
+   1.14.6

lib/jazzy/config.rb

@@ -246,6 +246,26 @@ def expand_path(path)
                    'https://github.com/realm/realm-cocoa/tree/v0.87.1)'
 
     # ──────── Doc generation options ────────
+    config_attr :extension_constraints_as_mark,
+      command_line: '--extension-constraints',
+      description: 'Treat extension constraints as `MARK: `.',
+      default: true
+
+    config_attr :collapse_extensions,
+      command_line: '--collapse-extensions',
+      description: 'Collapse consecutive extensions of the same constraint.',
+      default: true
+
+    config_attr :specialize_reactive_extensions,
+      command_line: '--reactive-extensions',
+      description: 'Specialize reactive extensions, instead of having an umbrella `Reactive` entry.',
+      default: true
+
+    config_attr :collapse_signal_protocols,
+      command_line: '--collapse-signal-protocols',
+      description: 'Collapse `SignalProtocol` and `SignalProducerProtocol` into the concrete types.',
+      default: true
+
     config_attr :disable_search,
       command_line: '--disable-search',
       description: ['Avoid generating a search index. '\

lib/jazzy/doc_builder.rb

@@ -340,20 +340,91 @@ def self.make_task(mark, uid, items)
     # @param [Config] options Build options
     # @param [Hash] doc_model Parsed doc. @see SourceKitten.parse
     def self.render_tasks(source_module, children)
-      marks = children.map(&:mark).uniq.compact
-      mark_names_counts = {}
-      marks.map do |mark|
-        mark_children = children.select { |child| child.mark == mark }
-        items = mark_children.map { |child| render_item(child, source_module) }
-        uid = (mark.name || 'Unnamed').to_s
-        if mark_names_counts.key?(uid)
-          mark_names_counts[uid] += 1
-          uid += (mark_names_counts[uid]).to_s
+      #marks = children.map(&:mark).uniq { |mark| mark.name == mark.name else child.mark == mark end }.compact
+      ordered_tokens = children.map { |child| child.mark.nil? ? nil : [child.file, child.mark] }.uniq.compact
+      grouped_tokens = {}
+      group_ids = []
+
+      # group id: (filepath, extension_constraint)
+      current_group_id = nil
+      current_group = []
+
+      ordered_tokens.map do |token|
+        unless current_group_id
+          current_group_id = token[0].to_s + ':ext:' + token[1].name.to_s
+          group_ids.push(current_group_id)
+        end
+
+        # Unconstrained extensions also emit extension constraint marks.
+        if !current_group.empty? && token[1].is_extension_constraint
+          if grouped_tokens.key?(current_group_id)
+            grouped_tokens[current_group_id].concat(current_group)
+          else
+            grouped_tokens[current_group_id] = Array(current_group)
+          end
+
+          current_group = []
+          current_group_id = token[0].to_s + ':ext:' + token[1].name.to_s
+          group_ids.push(current_group_id)
+        end
+
+        current_group.push(token[1])
+      end
+
+      if !current_group.empty?
+        if grouped_tokens.key?(current_group_id)
+          grouped_tokens[current_group_id].concat(current_group)
         else
-          mark_names_counts[uid] = 1
+          grouped_tokens[current_group_id] = Array(current_group)
         end
-        make_task(mark, uid, items)
       end
+
+      mark_names_counts = {}
+
+      # Collapse groups by extension constraints.
+      supergroups = {}
+
+      group_ids.uniq.map { |id|
+        matches = /(.+)\:ext\:(.+)/.match(id)  
+        key = if !matches.nil? then matches[2].strip else '' end
+        supergroups[key] = Array.new unless supergroups.key?(key)
+        supergroups[key].push(id)
+      }
+
+      collapsed_group_ids = []
+
+      supergroups.map { |key, groups|
+        first_id = groups.first
+        groups[1..-1].map { |id|
+          grouped_tokens[first_id].concat(grouped_tokens[id])
+          grouped_tokens.delete(id)
+        }
+        collapsed_group_ids.push(first_id)
+      }
+
+      tasks = []
+
+      collapsed_group_ids.map { |group_id|
+        grouped_tokens[group_id].map do |mark|          
+          mark_children = children.select { |child| child.mark == mark }
+          items = mark_children.map { |child| render_item(child, source_module) }
+          uid = (mark.name || 'Unnamed').to_s
+          if mark_names_counts.key?(uid)
+            mark_names_counts[uid] += 1
+            uid += (mark_names_counts[uid]).to_s
+          else
+            mark_names_counts[uid] = 1
+          end
+
+          if !tasks.empty? && tasks.last[:name] == mark.name
+            tasks.last[:items].concat(items)
+          else
+            tasks.push(make_task(mark, uid, items))
+          end
+        end
+      }
+
+      return tasks
     end
 
     # rubocop:disable Metrics/MethodLength

lib/jazzy/gem_version.rb

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

lib/jazzy/source_declaration/type.rb

@@ -87,7 +87,11 @@ def swift_extensible?
       def swift_protocol?
         kind == 'source.lang.swift.decl.protocol'
       end
-
+
+      def reactivecocoa_extension?
+        kind == 'source.lang.swift.decl.reactivecocoaextension'
+      end
+
       def param?
         # SourceKit strangely categorizes initializer parameters as local
         # variables, so both kinds represent a parameter in jazzy.
@@ -342,6 +346,10 @@ def ==(other)
           jazzy: 'Associated Type',
           dash: 'Alias',
         }.freeze,
+        'source.lang.swift.decl.reactivecocoaextension' => {
+          jazzy: 'Reactive Extension',
+          dash: 'Extension',
+        }.freeze,
       }.freeze
     end
     # rubocop:enable Metrics/ClassLength

lib/jazzy/source_mark.rb

@@ -3,29 +3,44 @@ class SourceMark
     attr_accessor :name
     attr_accessor :has_start_dash
     attr_accessor :has_end_dash
+    attr_accessor :is_extension_constraint
 
-    def initialize(mark_string = nil)
-      return unless mark_string
+    def initialize(mark_string = nil, is_extension_constraint = false)
+      self.is_extension_constraint = is_extension_constraint
 
-      # Format: 'MARK: - NAME -' with dashes optional
-      mark_string.sub!(/^MARK: /, '')
+      return unless is_extension_constraint || mark_string
 
-      if mark_string.empty?
-        # Empty
-        return
-      elsif mark_string == '-'
-        # Separator
-        self.has_start_dash = true
-        return
+      unless is_extension_constraint
+        # Format: 'MARK: - NAME -' with dashes optional
+        mark_string.sub!(/^MARK: /, '')
       end
 
-      self.has_start_dash = mark_string.start_with?('- ')
-      self.has_end_dash = mark_string.end_with?(' -')
+      if is_extension_constraint
+        mark_string.sub!(/Value\s?\:\s?Signal(Producer)?Protocol\,\s?Error\s?\=\=\s?NoError\,\s?Value\.Error\s?\=\=\s?NoError/, '<U> Value == Signal\1<U, NoError>, Error == NoError')
+        mark_string.sub!(/Value\s?\:\s?Signal(Producer)?Protocol\,\s?Value\.Error\s?\=\=\s?NoError/, '<U> Value == Signal\1<U, NoError>')
+        mark_string.sub!(/Value\s?\:\s?Signal(Producer)?Protocol\,\s?Error\s?\=\=\s?NoError/, '<U, E> Value == Signal\1<U, E>, Error == NoError')
+        mark_string.sub!(/Value\s?\:\s?Signal(Producer)?Protocol\,\s?Error\s?\=\=\s?Value\.Error/, '<U> Value == Signal\1<U, Error>')
+        mark_string.sub!(/Value\s?\:\s?EventProtocol/, '<U, E> Value == Event<U, E>')
+        mark_string.sub!(/Value\s?\:\s?OptionalProtocol/, '<U> Value == U?')
+        self.name = mark_string
+      else
+        if mark_string.empty?
+          # Empty
+          return
+        elsif mark_string == '-'
+          # Separator
+          self.has_start_dash = true
+          return
+        end
 
-      start_index = has_start_dash ? 2 : 0
-      end_index = has_end_dash ? -3 : -1
+        self.has_start_dash = mark_string.start_with?('- ')
+        self.has_end_dash = mark_string.end_with?(' -')
 
-      self.name = mark_string[start_index..end_index]
+        start_index = has_start_dash ? 2 : 0
+        end_index = has_end_dash ? -3 : -1
+
+        self.name = mark_string[start_index..end_index]
+      end
     end
   end
 end