jsduck 3.11.0 → 3.11.1

data/README.md

@@ -41,7 +41,10 @@ For **Windows** users out there, you can download the binary version,
 which includes Ruby interpreter and all dependencies bundled in a
 single .exe file.  Grab it from the [download page][].
 
+If you are brave enough: [try out JSDuck 4.0 beta.][beta]
+
 [download page]: https://github.com/senchalabs/jsduck/downloads
+[beta]: https://github.com/senchalabs/jsduck/wiki/4.0-beta
 
 Usage
 -----

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'jsduck'
-  s.version = '3.11.0'
-  s.date = '2012-06-05'
+  s.version = '3.11.1'
+  s.date = '2012-07-26'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/app.rb

@@ -104,7 +104,12 @@ module JsDuck
     def parallel_parse(filenames)
       @parallel.map(filenames) do |fname|
         Logger.instance.log("Parsing", fname)
-        SourceFile.new(JsDuck::IO.read(fname), fname, @opts)
+        begin
+          SourceFile.new(JsDuck::IO.read(fname), fname, @opts)
+        rescue
+          Logger.instance.fatal("Error while parsing #{fname}", $!)
+          exit(1)
+        end
       end
     end
 
@@ -159,10 +164,15 @@ module JsDuck
       # Format all doc-objects in parallel
       formatted_classes = @parallel.map(@relations.classes) do |cls|
         Logger.instance.log("Markdown formatting #{cls[:name]}")
-        {
-          :doc => class_formatter.format(cls.internal_doc),
-          :images => doc_formatter.images
-        }
+        begin
+          {
+            :doc => class_formatter.format(cls.internal_doc),
+            :images => doc_formatter.images
+          }
+        rescue
+          Logger.instance.fatal("Error while formatting #{cls[:name]}", $!)
+          exit(1)
+        end
       end
       # Then merge the data back to classes sequentially
       formatted_classes.each do |cls|

data/lib/jsduck/guides.rb

@@ -36,15 +36,13 @@ module JsDuck
     end
 
     # Modified each_item that also loads HTML for each guide
-    def each_item(&block)
-      unless @loaded
-        super do |guide|
-          guide[:html] = load_guide(guide)
-        end
-        @loaded = true
+    def each_item
+      super do |guide|
+        # Load the guide if not loaded
+        guide[:html] = load_guide(guide) if guide[:html] == nil
+        # Pass guide to block if it was successfully loaded.
+        yield guide if guide[:html]
       end
-
-      super(&block)
     end
 
     # Modified to_array that excludes the :html from guide nodes
@@ -59,16 +57,23 @@ module JsDuck
 
     def load_guide(guide)
       in_dir = @path + "/guides/" + guide["name"]
+
       return Logger.instance.warn(:guide, "Guide #{in_dir} not found") unless File.exists?(in_dir)
 
       guide_file = in_dir + "/README.md"
+
       return Logger.instance.warn(:guide, "README.md not found in #{in_dir}") unless File.exists?(guide_file)
 
-      @formatter.doc_context = {:filename => guide_file, :linenr => 0}
-      name = File.basename(in_dir)
-      @formatter.img_path = "guides/#{name}"
+      begin
+        @formatter.doc_context = {:filename => guide_file, :linenr => 0}
+        name = File.basename(in_dir)
+        @formatter.img_path = "guides/#{name}"
 
-      return add_toc(guide, @formatter.format(JsDuck::IO.read(guide_file)))
+        return add_toc(guide, @formatter.format(JsDuck::IO.read(guide_file)))
+      rescue
+        Logger.instance.fatal("Error while reading/formatting guide #{in_dir}", $!)
+        exit(1)
+      end
     end
 
     def write_guide(guide, dir)

data/lib/jsduck/logger.rb

@@ -101,6 +101,8 @@ module JsDuck
       elsif !@warnings.has_key?(type)
         warn(nil, "Unknown warning type #{type}")
       end
+
+      return false
     end
 
     # Formats filename and line number for output
@@ -114,6 +116,15 @@ module JsDuck
       end
       out
     end
+
+    # Prints fatal error message with backtrace.
+    # The error param should be $! from resque block.
+    def fatal(msg, error)
+      puts "#{msg}: #{error}"
+      puts
+      puts "Here's a full backtrace:"
+      puts error.backtrace
+    end
   end
 
 end

data/lib/jsduck/options.rb

@@ -75,11 +75,11 @@ module JsDuck
       ]
       @meta_tag_paths = []
 
-      @version = "3.11.0"
+      @version = "3.11.1"
 
       # Customizing output
-      @title = "Sencha Docs - Ext JS"
-      @header = "<strong>Sencha Docs</strong> Ext JS"
+      @title = "Ext JS - Sencha Docs"
+      @header = "<strong>Ext JS</strong> Sencha Docs"
       @footer = "Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> #{@version}."
       @head_html = ""
       @body_html = ""
@@ -181,7 +181,7 @@ module JsDuck
 
         opts.on('--title=TEXT',
           "Custom title text for the documentation.",
-          "Defaults to 'Sencha Docs - Ext JS'", " ") do |text|
+          "Defaults to 'Ext JS - Sencha Docs'", " ") do |text|
           @title = text
           @header = text.sub(/^(.*?) +- +/, "<strong>\\1 </strong>")
         end

data/lib/jsduck/source_file.rb

@@ -80,18 +80,10 @@ module JsDuck
 
     # Parses the file depending on filename as JS or CSS
     def parse
-      begin
-        if @filename =~ /\.s?css$/
-          CssParser.new(@contents, @options).parse
-        else
-          JsParser.new(@contents, @options).parse
-        end
-      rescue
-        puts "Error while parsing #{@filename}: #{$!}"
-        puts
-        puts "Here's a full backtrace:"
-        puts $!.backtrace
-        exit(1)
+      if @filename =~ /\.s?css$/
+        CssParser.new(@contents, @options).parse
+      else
+        JsParser.new(@contents, @options).parse
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 3.11.0
+  version: 3.11.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-05 00:00:00.000000000 Z
+date: 2012-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -660,7 +660,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: jsduck
-rubygems_version: 1.8.23
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Simple JavaScript Duckumentation generator