jsduck 4.0.0 → 4.0.1

data/README.md

@@ -37,6 +37,10 @@ install the header files for compiling extension modules for Ruby 1.9.
 For Debian systems you'll need the `ruby1.9-dev` package.  For Red Hat
 / CentOS / Fedora use the `ruby-devel` package.
 
+In **OSX Mountain Lion** the compilation of `therubyracer` dependency
+often fails for so far unknown reasons.  Most users have found a
+solution in upgrading to Ruby 1.9 using [RVM][].
+
 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][].
@@ -57,6 +61,7 @@ most sensible place to put it). Now you're ready to install JSDuck:
 
     > gem install jsduck
 
+[RVM]: https://rvm.io/
 [download page]: https://github.com/senchalabs/jsduck/downloads
 [libs download]: https://github.com/stereobooster/therubyracer/downloads
 

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.0.0'
-  s.date = '2012-08-09'
+  s.version = '4.0.1'
+  s.date = '2012-08-21'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/aggregator.rb

@@ -232,9 +232,15 @@ module JsDuck
       Enum.new(@classes).process_all!
     end
 
-    # Processes all overrides
+    # Processes all overrides.
+    # Returns list of override classes.
     def process_overrides
-      Override.new(@classes, @documentation).process_all!
+      Override.new(@classes).process_all!.map do |cls|
+        # discard each override class
+        @classes.delete(cls[:name])
+        @documentation.delete(cls)
+        cls
+      end
     end
 
     # Are we dealing with ExtJS 4?

data/lib/jsduck/app.rb

@@ -130,7 +130,8 @@ module JsDuck
         agr.append_ext4_event_options
       end
       agr.process_enums
-      agr.process_overrides
+      # Ignore override classes after applying them to actual classes
+      @opts.external_classes += agr.process_overrides.map {|o| o[:name] }
       agr.result
     end
 

data/lib/jsduck/doc_type.rb

@@ -33,6 +33,8 @@ module JsDuck
         :cfg
       elsif doc_map[:constructor]
         :method
+      elsif doc_map[:param] || doc_map[:return]
+        :method
       else
         code[:tagname]
       end

data/lib/jsduck/meta_tag.rb

@@ -17,6 +17,8 @@ module JsDuck
     #
     #     {:long => "something", :short => "SOM"}
     #
+    # Additionally the hash can contain a :tooltip which is the text
+    # to be shown when the signature bubble is hovered over in docs.
     attr_reader :signature
 
     # True to include all lines up to next @tag as part of this meta-tag

data/lib/jsduck/meta_tag_renderer.rb

@@ -0,0 +1,34 @@
+require 'jsduck/meta_tag_registry'
+
+module JsDuck
+
+  # Performs the rendering of meta tags.
+  class MetaTagRenderer
+
+    # Renders full meta tags of a particular section.
+    #
+    # Returns array of rendered HTML or nil if no meta data.
+    def self.render(meta_data, position)
+      return if meta_data.size == 0
+
+      MetaTagRegistry.instance.tags(position).map do |tag|
+        meta_data[tag.key]
+      end
+    end
+
+    # Renders the meta-tag signatures for a class member.
+    # Returns a string.
+    def self.render_signature(member)
+      html = []
+      MetaTagRegistry.instance.signatures.each do |s|
+        if member[:meta][s[:key]]
+          title = s[:tooltip] ? "title='#{s[:tooltip]}'" : ""
+          html << "<strong class='#{s[:key]} signature' #{title}>#{s[:long]}</strong>"
+        end
+      end
+      html.join
+    end
+
+  end
+
+end

data/lib/jsduck/options.rb

@@ -79,7 +79,7 @@ module JsDuck
       @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "4.0.0"
+      @version = "4.0.1"
 
       # Customizing output
       @title = "Documentation - JSDuck"
@@ -138,6 +138,7 @@ module JsDuck
 
       reg = MetaTagRegistry.new
       reg.load([:builtins] + @meta_tag_paths)
+      reg[:new].create_tooltip!(@imports, @new_since)
       MetaTagRegistry.instance = reg
     end
 

data/lib/jsduck/override.rb

@@ -1,27 +1,23 @@
 module JsDuck
 
   class Override
-    def initialize(classes_hash, classes_array)
+    def initialize(classes_hash)
       @classes_hash = classes_hash
-      @classes_array = classes_array
     end
 
     # Applies all override classes to target classes
+    # Returns all the processed override classes.
     def process_all!
       overrides = []
 
-      @classes_array.each do |cls|
+      @classes_hash.each_value do |cls|
         if cls[:override]
           process(cls)
           overrides << cls
         end
       end
 
-      # Discard override classes
-      overrides.each do |cls|
-        @classes_hash.delete(cls[:name])
-        @classes_array.delete(cls)
-      end
+      overrides
     end
 
     private

data/lib/jsduck/renderer.rb

@@ -1,5 +1,6 @@
-require 'jsduck/meta_tag_registry'
 require 'jsduck/html'
+require 'jsduck/meta_tag_renderer'
+require 'jsduck/signature_renderer'
 
 module JsDuck
 
@@ -12,6 +13,7 @@ module JsDuck
 
     def render(cls)
         @cls = cls
+        @signature = SignatureRenderer.new(cls)
 
         return [
           "<div>",
@@ -60,9 +62,7 @@ module JsDuck
     end
 
     def render_meta_data(meta_data, position)
-      return if meta_data.size == 0
-
-      MetaTagRegistry.instance.tags(position).map {|tag| meta_data[tag.key] }
+      MetaTagRenderer.render(meta_data, position)
     end
 
     def render_sidebar
@@ -241,43 +241,7 @@ module JsDuck
     end
 
     def render_signature(m)
-      expandable = m[:shortDoc] ? "expandable" : "not-expandable"
-
-      name = m[:name]
-      before = ""
-      if m[:tagname] == :method && m[:name] == "constructor"
-        before = "<strong class='new-keyword'>new</strong>"
-        name = @cls[:name]
-      end
-
-      if m[:tagname] == :cfg || m[:tagname] == :property || m[:tagname] == :css_var
-        params = "<span> : #{m[:html_type]}</span>"
-      else
-        ps = m[:params].map {|p| render_short_param(p) }.join(", ")
-        params = "( <span class='pre'>#{ps}</span> )"
-        if m[:tagname] == :method && m[:return][:type] != "undefined"
-          params += " : " + m[:return][:html_type]
-        end
-      end
-
-      after = ""
-      MetaTagRegistry.instance.signatures.each do |s|
-        after += "<strong class='#{s[:key]} signature'>#{s[:long]}</strong>" if m[:meta][s[:key]]
-      end
-
-      uri = "#!/api/#{m[:owner]}-#{m[:id]}"
-
-      return [
-        before,
-        "<a href='#{uri}' class='name #{expandable}'>#{name}</a>",
-        params,
-        after
-      ]
-    end
-
-    def render_short_param(param)
-      p = param[:html_type] + " " + param[:name]
-      return param[:optional] ? "["+p+"]" : p
+      @signature.render(m)
     end
 
     def render_long_doc(m)

data/lib/jsduck/signature_renderer.rb

@@ -0,0 +1,92 @@
+require 'jsduck/meta_tag_renderer'
+
+module JsDuck
+
+  # Performs the rendering of member signatures.
+  class SignatureRenderer
+    # Initializes the renderer for rendering members of the given
+    # class.
+    def initialize(cls)
+      @cls = cls
+    end
+
+    # Renders signature of the given member.
+    def render(member)
+      # Keep the code simpler by not passing around the member hash
+      @m = member
+
+      return [
+        render_new,
+        render_link,
+        render_type,
+        render_meta,
+      ]
+    end
+
+    private
+
+    def render_new
+      constructor? ? "<strong class='new-keyword'>new</strong>" : ""
+    end
+
+    def render_link
+      "<a href='#{render_url}' class='name #{render_expandable}'>#{render_name}</a>"
+    end
+
+    def render_url
+      "#!/api/#{@m[:owner]}-#{@m[:id]}"
+    end
+
+    def render_expandable
+      @m[:shortDoc] ? "expandable" : "not-expandable"
+    end
+
+    def render_name
+      constructor? ? @cls[:name] : @m[:name]
+    end
+
+    def constructor?
+      @m[:tagname] == :method && @m[:name] == "constructor"
+    end
+
+    def render_type
+      if like_property?
+        render_property_type
+      else
+        render_params + render_return
+      end
+    end
+
+    def like_property?
+      @m[:tagname] == :cfg || @m[:tagname] == :property || @m[:tagname] == :css_var
+    end
+
+    def render_property_type
+      "<span> : #{@m[:html_type]}</span>"
+    end
+
+    def render_params
+      ps = @m[:params].map {|p| render_single_param(p) }.join(", ")
+      "( <span class='pre'>#{ps}</span> )"
+    end
+
+    def render_single_param(param)
+      p = param[:html_type] + " " + param[:name]
+      param[:optional] ? "["+p+"]" : p
+    end
+
+    def render_return
+      method_with_return? ? (" : " + @m[:return][:html_type]) : ""
+    end
+
+    def method_with_return?
+      @m[:tagname] == :method && @m[:return][:type] != "undefined"
+    end
+
+    def render_meta
+      MetaTagRenderer.render_signature(@m)
+    end
+
+  end
+
+end

data/lib/jsduck/tag/new.rb

@@ -11,6 +11,19 @@ module JsDuck::Tag
       @boolean = true
     end
 
+    # Initializes the tooltip text.
+    #
+    # HACK: This is a special method that's only called for the @new
+    # tag. It doesn't fit well into the current meta-tags system.  But
+    # until we rework the meta-tags system, this will have to do.
+    def create_tooltip!(imports, new_since)
+      if new_since
+        @signature[:tooltip] = "New since #{new_since}"
+      elsif imports.length > 0
+        @signature[:tooltip] = "New since #{imports.last[:version]}"
+      end
+    end
+
     def to_value(contents)
       true
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-09 00:00:00.000000000 Z
+date: 2012-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -197,6 +197,7 @@ files:
 - lib/jsduck/meta_tag.rb
 - lib/jsduck/meta_tag_loader.rb
 - lib/jsduck/meta_tag_registry.rb
+- lib/jsduck/meta_tag_renderer.rb
 - lib/jsduck/null_object.rb
 - lib/jsduck/option_parser.rb
 - lib/jsduck/options.rb
@@ -207,6 +208,7 @@ files:
 - lib/jsduck/renderer.rb
 - lib/jsduck/search_data.rb
 - lib/jsduck/serializer.rb
+- lib/jsduck/signature_renderer.rb
 - lib/jsduck/source_file.rb
 - lib/jsduck/source_file_parser.rb
 - lib/jsduck/source_writer.rb