jsduck 4.5.0 → 4.5.1

data/Rakefile

@@ -257,6 +257,8 @@ task :sdk => :sass do
     "--output", OUT_DIR,
     "--config", "#{SDK_DIR}/extjs/docs/config.json",
     "--examples-base-url", "extjs-build/examples/",
+    "--import", "Ext 4.1.3:#{SDK_DIR}/../docs.sencha.com/exports/extjs-4.1.3",
+    "--import", "Ext 4.2.0",
     "--seo"
   )
   runner.add_debug

data/jsduck.gemspec

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

data/lib/jsduck/categories.rb

@@ -1,6 +1,7 @@
 require 'jsduck/logger'
 require 'jsduck/file_categories'
 require 'jsduck/auto_categories'
+require 'jsduck/categories_class_name'
 
 module JsDuck
 
@@ -17,8 +18,7 @@ module JsDuck
 
     def initialize(categories, doc_formatter, relations={})
       @categories = categories
-      @doc_formatter = doc_formatter
-      @relations = relations
+      @class_name = CategoriesClassName.new(doc_formatter, relations)
     end
 
     # Returns HTML listing of classes divided into categories
@@ -58,7 +58,7 @@ module JsDuck
         [
           "<h3>#{g['name']}</h3>",
           "<ul class='links'>",
-          g["classes"].map {|cls| "<li>" + (@relations[cls] ? @doc_formatter.link(cls, nil, cls) : cls) + "</li>" },
+          g["classes"].map {|cls| "<li>" + @class_name.render(cls) + "</li>" },
           "</ul>",
         ]
       end

data/lib/jsduck/categories_class_name.rb

@@ -0,0 +1,61 @@
+module JsDuck
+
+  # Renders class names for class categories page.
+  class CategoriesClassName
+    def initialize(doc_formatter, relations={})
+      @doc_formatter = doc_formatter
+      @relations = relations
+    end
+
+    # Renders the class name as a link or plain text.
+    #
+    # For new classes appends a star behind class name.  For classes
+    # with new members appends list n small stars behind class name
+    # (reflecting the number of new members).
+    def render(name)
+      cls = @relations[name]
+      if cls
+        @doc_formatter.link(name, nil, name) + render_new_label(cls)
+      else
+        name
+      end
+    end
+
+    private
+
+    # Adds small star to new classes in the current version.
+    def render_new_label(cls)
+      if cls[:meta][:new]
+        "&nbsp;<span class='new-class' title='New class'>#{stars(1)}</span>"
+      else
+        n = new_members_count(cls)
+        if n > 0
+          title = "#{n} new member#{(n>1) ? 's' : ''}"
+          "&nbsp;<span class='new-members' title='#{title}'>#{stars(n)}</span>"
+        else
+          ""
+        end
+      end
+    end
+
+    # Produces string of n stars.
+    # First 3 stars are rendered as "<unicode-star>", the following as "+".
+    # At max 15 stars are rendered.
+    def stars(n)
+      if n > 15
+        stars(3) + ("+" * (15-3))
+      elsif n > 3
+        stars(3) + ("+" * (n-3))
+      else
+        "&#9733;" * n
+      end
+    end
+
+    # Returns number of new members the class has in the current version
+    def new_members_count(cls)
+      cls.find_members(:local => true).find_all {|m| m[:meta][:new] && !m[:private] }.length
+    end
+
+  end
+
+end

data/lib/jsduck/doc_ast.rb

@@ -292,7 +292,7 @@ module JsDuck
     # Combines :doc-s of most tags
     # Ignores tags that have doc comment themselves and subproperty tags
     def detect_doc(docs)
-      ignore_tags = [:param, :return, :meta]
+      ignore_tags = [:param, :return, :throws, :meta]
       doc_tags = docs.find_all { |tag| !ignore_tags.include?(tag[:tagname]) && !subproperty?(tag) }
       doc_tags.map { |tag| tag[:doc] }.compact.join(" ")
     end

data/lib/jsduck/options.rb

@@ -90,7 +90,7 @@ module JsDuck
       @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "4.5.0"
+      @version = "4.5.1"
 
       # Customizing output
       @title = "Documentation - JSDuck"
@@ -444,7 +444,11 @@ module JsDuck
           "when used in type definitions or inherited from.",
           "",
           "Multiple classes can be given in comma-separated list,",
-          "or by using the option repeatedly.") do |classes|
+          "or by using the option repeatedly.",
+          "",
+          "The wildcard '*' can be used to match a set of classes",
+          "e.g. to ignore all classes of a particular namespace:",
+          "--external='Foo.*'") do |classes|
           @external_classes += classes
         end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.5.0
+  version: 4.5.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-06 00:00:00.000000000 Z
+date: 2012-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -158,6 +158,7 @@ files:
 - lib/jsduck/batch_formatter.rb
 - lib/jsduck/batch_parser.rb
 - lib/jsduck/categories.rb
+- lib/jsduck/categories_class_name.rb
 - lib/jsduck/circular_deps.rb
 - lib/jsduck/class.rb
 - lib/jsduck/class_doc_expander.rb
@@ -251,7 +252,7 @@ files:
 - lib/jsduck/videos.rb
 - lib/jsduck/web_writer.rb
 - lib/jsduck/welcome.rb
-- template-min/app-7574bba7233cfaa4a67c0f9f5e139cc6.js
+- template-min/app-c6fdef5b424714d909c92c47a65b7a8f.js
 - template-min/eg-iframe.html
 - template-min/extjs/ext-all.js
 - template-min/extjs/resources/themes/images/default/boundlist/trigger-arrow.png
@@ -630,7 +631,7 @@ files:
 - template-min/mobile-redirect.js
 - template-min/print-template.html
 - template-min/README.md
-- template-min/resources/css/app-b0e40cf7e8fb751f924fb29f733d5bae.css
+- template-min/resources/css/app-1dec1b800f7fee208bc8260fa2fd1d22.css
 - template-min/resources/css/reset.css
 - template-min/resources/css/scrollbars.css
 - template-min/resources/css/welcome.css