jazzy 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70f00685fae336565bfc9917dae9bfaf0634a811
-  data.tar.gz: 57d370af3a76c3c215e91a83390fce948a33779a
+  metadata.gz: debc2610dfdacc28a580056ac62cfffdb0819402
+  data.tar.gz: 4a2d884071430d1581dbd971bd17ca43b51fa3df
 SHA512:
-  metadata.gz: 148bc0db32b0da87f0f344721de0ef6827f0e5759a7e1e19151bc66063ac55222308d76f5d38425a52006b2b99f1739b4adcbb42ec30d617b904e9c10e64e0a5
-  data.tar.gz: 550ae9482cef0f1c8e0ae0834d9f157c01075d26e4c250888e7385fd284babe5963e9c45589b5ca254b27680955382bc261bdf19e168ccb047f20f5ecbd8c705
+  metadata.gz: 4ef4bcac8aa9ec3a757ccd5c6b3c7b50fa5b29ca2b0e960e0084fa1233780af3605dc39064a51f516612afed4cca24b046e52bee09ae44bfb9bdf1865bf9ae77
+  data.tar.gz: f4a8965fc8c61270f9e156c431d0ad6ba600fc0c91f753c3964f3f9a5b8bbc8bacc3c0961987c8a5f899f75517f8e0c0f9163f505e97aac051745c95b6720c08

data/README.md

@@ -1,4 +1,4 @@
-## :musical_note: :saxophone: jazzy :trumpet: :musical_note:
+## jazzy <sup>♪♫</sup>
 **a soulful way to generate docs for Swift & Objective-C**
 
 jazzy is a command-line utility that generates documentation for your Swift or Objective-C projects.

data/bin/jazzy

@@ -6,7 +6,8 @@ require 'optparse'
 
 options = {
   input: File.expand_path('.'),
-  output: File.expand_path('docs')
+  output: File.expand_path('docs'),
+  excludes: []
 }
 
 opt_parser = OptionParser.new do |opt|
@@ -22,6 +23,10 @@ opt_parser = OptionParser.new do |opt|
     options[:output] = File.expand_path(output)
   end
 
+  opt.on("-e", "--exclude filepath1,filepath2,…filepathN", Array, "Exclude specific files") do |e|
+    options[:excludes] = e # path will be expanded after we’re sure the input has been stored
+  end
+
   opt.on("-h","--help","help") do
     puts opt_parser
   end
@@ -29,7 +34,9 @@ end
 
 opt_parser.parse!
 
-paths = Jazzy.headers(options[:input])
+options[:excludes] = options[:excludes].map { |p| File.expand_path(File.join(options[:input], p)) }
+
+paths = Jazzy.headers(options[:input]) - options[:excludes]
 
 FileUtils.rm_r options[:output] if File.directory?(options[:output]); Dir.mkdir options[:output]
 

data/jazzy.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 module Jazzy
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end
 
 Gem::Specification.new do |spec|

data/lib/jazzy.rb

@@ -15,85 +15,118 @@ class Jazzy
 		klass = Jazzy::Klass.new
 
 		string = `#{bin_path}/SwiftHeader #{path}`
-		a = string.split(/^\[/); swift = a[0]; map = "[\n"+a[-1]
+		a = string.split(/^\[/); swift = a[0]; rawmap = "[\n"+a[-1]
 
-		map.gsub!(/(key.\w+):/,'"\1":')
-		map.gsub!(/(source..+),/,'"\1",')
+		rawmap.gsub!(/(key.\w+):/,'"\1":')
+		rawmap.gsub!(/(source..+),/,'"\1",')
 
-		#print map
-		#gets
-
-		map = JSON.parse(map)[0]
-
-		swiftmap = {}
-
-		map["key.entities"].each do |e|
-			swiftmap[e["key.usr"]] = {}
-			swiftmap[e["key.usr"]]["declaration"] = swift.byteslice(e["key.offset"], e["key.length"])
-			swiftmap[e["key.usr"]]["name"] = e["key.name"]
-		end
 
 		xml = `#{bin_path}/ASTDump #{path}`
 
 		doc = Nokogiri::XML(xml)
 
+		results = doc.xpath("//*[@file='#{path}']")
+
+		#results = doc.find_all { |node| node.attribute("file") && node.attribute("file").strip.chomp == path.strip.chomp }
 		# Fill in Overview
-		doc.xpath("//Other[1]").each do |e|
-			klass[:name] = e.xpath("Name").text
-			klass[:usr] = e.xpath("USR").text
-			klass[:declaration] = {}
-			klass[:declaration][:objc] = e.xpath("Declaration").text.strip
-			klass[:abstract] = e.xpath("Abstract/Para").text.strip
-			paras = []; e.xpath("./Discussion/Para").each {|p| paras << p.text.strip }
-			klass[:discussion] = paras.join("\n\n")
+		top = results.first
+			#next if e.attribute("file") && e.attribute("file").text != path
+		#print top
+		#exit
+		klass[:name] = top.xpath("Name").text
+		klass[:usr] = top.xpath("USR").text
+		klass[:declaration] = {}
+		klass[:declaration][:objc] = top.xpath("Declaration").text.strip
+		klass[:abstract] = top.xpath("Abstract/Para").text.strip
+		paras = []; top.xpath("./Discussion/Para").each {|p| paras << p.text.strip }
+		klass[:discussion] = paras.join("\n\n")
+
+		# Only usable if Swift Header can be correctly generated
+		unless rawmap.include? "<<NULL>>"
+
+			swiftmap = {}
+			map = {}
+
+			JSON.parse(rawmap).each do |element|
+
+				next unless element["key.name"].downcase == klass[:name].downcase
+
+				# more than one matching element?
+
+				element["key.entities"].each do |e|
+					swiftmap[e["key.usr"]] = {}
+					swiftmap[e["key.usr"]]["declaration"] = swift.byteslice(e["key.offset"], e["key.length"])
+					swiftmap[e["key.usr"]]["name"] = e["key.name"]
+				end
+
+				# Inherits
+				klass[:inherits] = [] 
+				element["key.inherits"].each { |i| klass[:inherits] << { usr: i["key.usr"], name: i["key.name"] } } unless map["key.inherits"].nil?
+
+				# Conforms to
+				klass[:conforms] = []
+				element["key.conforms"].each { |c| klass[:conforms] << { usr: c["key.usr"], name: c["key.name"] } } unless map["key.conforms"].nil?
+			end
 		end
 
-		# Inherits
-		klass[:inherits] = []
-		map["key.inherits"].each do |i|
-			klass[:inherits] << { usr: i["key.usr"], name: i["key.name"] }
-		end
 
-		# Conforms to
-		klass[:conforms] = []
-		map["key.conforms"].each do |c|
-			klass[:conforms] << { usr: c["key.usr"], name: c["key.name"] }
-		end
+
 
 		# Import
 		klass[:import] = swift.split("\n")[0].chomp.gsub('import ', '')
 		
 		# Fill in Properties
 		klass[:properties] = []
-		doc.xpath("//Other[position()>1]").each do |e|
+
+		results[1..-1].each do |e|
+			next unless e.name == "Other"
 			property = {}
 			property[:usr] = e.xpath("USR").text
 			property[:name] = {}
 			property[:name][:objc] = e.xpath("Name").text
-			property[:name][:swift] = swiftmap[property[:usr]]["name"]
+			if !swiftmap.nil? && swiftmap[property[:usr]]
+				property[:name][:swift] = swiftmap[property[:usr]]["name"]
+			else
+				property[:name][:swift] = "Could not be generated"
+			end
 			property[:term] = property[:usr]
 			property[:declaration] = {}
 			property[:declaration][:objc] = e.xpath("Declaration").text.strip
-			property[:declaration][:swift] = swiftmap[property[:usr]]["declaration"]
+			if !swiftmap.nil? && swiftmap[property[:usr]]
+				property[:declaration][:swift] = swiftmap.nil?
+			else
+				property[:declaration][:swift] = "Could not be generated"
+			end
 			property[:abstract] = e.xpath("Abstract/Para").text.strip
 			paras = []; e.xpath("Discussion/Para").each {|p| paras << p.text.strip }
 			property[:discussion] = paras.join("\n\n") unless paras.length == 0
 			klass[:properties] << property
 		end
 
+		#puts klass[:properties]
+
 		# Fill in Methods
 		klass[:methods] = []
-		doc.xpath("//Function").each do |e|
+		results[1..-1].each do |e|
+			next unless e.name == "Function"
 			method = {}
 			method[:usr] = e.xpath("USR").text
 			method[:name] = {}
 			method[:name][:objc] = e.xpath("Name").text
-			method[:name][:swift] = swiftmap[method[:usr]]["name"]			
+			if !swiftmap.nil? && swiftmap[method[:usr]]
+				method[:name][:swift] = swiftmap[method[:usr]]["name"]
+			else
+				method[:name][:swift] = "Could not be generated"
+			end
 			next if method[:usr].include?('(py)')
 			method[:term] = method[:usr].split(')')[-1]
 			method[:declaration] = {}
 			method[:declaration][:objc] = e.xpath("Declaration").text
-			method[:declaration][:swift] = swiftmap[method[:usr]]["declaration"]
+			if !swiftmap.nil? && swiftmap[method[:usr]]
+				method[:declaration][:swift] = swiftmap[method[:usr]]["declaration"]
+			else
+				method[:declaration][:swift] = "Could not be generated"
+			end
 			method[:abstract] = e.xpath("Abstract/Para").text.strip
 			paras = []; e.xpath("Discussion/Para").each {|p| paras << p.text.strip }
 			method[:discussion] = paras.join("\n\n") unless paras.length == 0

data/lib/jazzy/klass.rb

@@ -14,7 +14,7 @@ class Jazzy::Klass < Mustache
   end
 
   def rendered_abstract_for_overview
-    self[:abstract].chop! + ' <a class="overview-bulk-toggle">More...</a>'
+    $markdown.render( self[:abstract].chop! + ' <a class="overview-bulk-toggle">More...</a>' )
   end
 
   def date

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jazzy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - JP Simard, Tim Anglade
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-08 00:00:00.000000000 Z
+date: 2014-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mustache