jsduck 5.3.4 → 6.0.0beta

data/lib/jsduck/render/class.rb

@@ -1,6 +1,7 @@
 require 'jsduck/render/tags'
 require 'jsduck/render/sidebar'
 require 'jsduck/tag_registry'
+require 'jsduck/member_registry'
 
 module JsDuck
   module Render
@@ -38,8 +39,8 @@ module JsDuck
       end
 
       def render_all_sections
-        TagRegistry.member_types.map do |member_type|
-          render_section(member_type)
+        MemberRegistry.definitions.map do |member_def|
+          render_section(member_def)
         end
       end
 

data/lib/jsduck/render/subproperties.rb

@@ -1,5 +1,6 @@
 require 'jsduck/util/html'
 require 'jsduck/util/singleton'
+require 'jsduck/tag_registry'
 
 module JsDuck
   module Render
@@ -54,15 +55,32 @@ module JsDuck
             "<span class='pre'>#{p[:name]}</span> : ",
             p[:html_type],
             p[:optional] ? " (optional)" : "",
+            p[:new] ? render_new : "",
             "<div class='sub-desc'>",
               p[:doc],
               p[:default] ? "<p>Defaults to: <code>#{Util::HTML.escape(p[:default])}</code></p>" : "",
+              p[:since] ? render_since(p) : "",
               p[:properties] && p[:properties].length > 0 ? render(p) : "",
             "</div>",
           "</li>",
         ]
       end
 
+      def render_new
+        signature = TagRegistry.get_by_name(:new).signature
+        return [
+          "<span class='signature'>",
+            "<span class='new' title='#{signature[:tooltip]}'>",
+              signature[:long],
+            "</span>",
+          "</span>",
+        ]
+      end
+
+      def render_since(param)
+        TagRegistry.get_by_name(:since).to_html(param)
+      end
+
       def render_return(ret)
         return [
           "<h3 class='pa'>Returns</h3>",

data/lib/jsduck/render/tags.rb

@@ -10,7 +10,7 @@ module JsDuck
       # Takes member or class hash.
       # Returns array of rendered HTML.
       def self.render(member)
-        TagRegistry.html_renderers.map do |tag|
+        renderers.map do |tag|
           if member[tag.tagname]
             tag.to_html(member)
           else
@@ -19,6 +19,18 @@ module JsDuck
         end
       end
 
+      # Returns tags for rendering HTML, sorted in the order they should
+      # appear in final output. Sorting order is determined by the
+      # numeric :html_position field.
+      def self.renderers
+        if !@renderers
+          @renderers = TagRegistry.tags.find_all(&:html_position)
+          @renderers.sort! {|a, b| a.html_position <=> b.html_position }
+        end
+
+        @renderers
+      end
+
       # Renders the signatures for a class member.
       # Returns a string.
       def self.render_signature(member)

data/lib/jsduck/source/file.rb

@@ -3,10 +3,10 @@ require 'jsduck/util/html'
 module JsDuck
   module Source
 
-    # Represents one JavaScript or CSS source file.
+    # Represents one JavaScript or SCSS source file.
     #
     # The filename parameter determines whether it's parsed as
-    # JavaScript (the default) or CSS.
+    # JavaScript (the default) or SCSS.
     class File
       attr_reader :filename
       attr_reader :contents

data/lib/jsduck/tag/class.rb

@@ -5,6 +5,12 @@ module JsDuck::Tag
     def initialize
       @pattern = "class"
       @tagname = :class
+      @class_icon = {
+        :small => File.dirname(__FILE__) + "/icons/class.png",
+        :large => File.dirname(__FILE__) + "/icons/class-large.png",
+        :redirect => File.dirname(__FILE__) + "/icons/class-redirect.png",
+        :priority => PRIORITY_CLASS,
+      }
     end
 
     # @class name

data/lib/jsduck/tag/component.rb

@@ -0,0 +1,19 @@
+require "jsduck/tag/boolean_tag"
+
+module JsDuck::Tag
+  # The @component tag should be rarely used explicitly as it gets
+  # auto-detected by Process::Components for any component inheriting
+  # from Ext.Component.
+  class Component < BooleanTag
+    def initialize
+      @pattern = "component"
+      @class_icon = {
+        :small => File.dirname(__FILE__) + "/icons/component.png",
+        :large => File.dirname(__FILE__) + "/icons/component-large.png",
+        :redirect => File.dirname(__FILE__) + "/icons/component-redirect.png",
+        :priority => PRIORITY_COMPONENT,
+      }
+      super
+    end
+  end
+end

data/lib/jsduck/tag/css_mixin.rb

@@ -14,6 +14,16 @@ module JsDuck::Tag
       }
     end
 
+    def process_code(code)
+      h = super(code)
+      h[:params] = code[:params]
+      h
+    end
+
+    def merge(h, docs, code)
+      JsDuck::ParamsMerger.merge(h, docs, code)
+    end
+
     def to_html(mixin, cls)
       member_link(mixin) + member_params(mixin[:params])
     end

data/lib/jsduck/tag/deprecated.rb

@@ -4,7 +4,7 @@ module JsDuck::Tag
   class Deprecated < DeprecatedTag
     def initialize
       @tagname = :deprecated
-      @msg = "This {TAGNAME} has been <strong>deprected</strong>"
+      @msg = "This {TAGNAME} has been <strong>deprecated</strong>"
       @css = <<-EOCSS
         .signature .deprecated {
           background-color: #aa0000;

data/lib/jsduck/tag/inheritdoc.rb

@@ -1,5 +1,5 @@
 require "jsduck/tag/tag"
-require "jsduck/tag_registry"
+require "jsduck/member_registry"
 
 module JsDuck::Tag
   class Inheritdoc < Tag
@@ -31,7 +31,7 @@ module JsDuck::Tag
           tag[:static] = true
           p.match(/static-/)
         end
-        if p.look(JsDuck::TagRegistry.member_type_regex)
+        if p.look(JsDuck::MemberRegistry.regex)
           tag[:type] = p.match(/\w+/).to_sym
           p.match(/-/)
         end

data/lib/jsduck/tag/new.rb

@@ -15,5 +15,18 @@ module JsDuck::Tag
       EOCSS
       super
     end
+
+    # Initializes the tooltip text based on the --new-since and
+    # --import options passed from command line.
+    #
+    # NOTE: This method is explicitly called from JsDuck::Options class.
+    def init_tooltip!(opts)
+      if opts.new_since
+        @signature[:tooltip] = "New since #{opts.new_since}"
+      elsif opts.import.length > 0
+        @signature[:tooltip] = "New since #{opts.import.last[:version]}"
+      end
+    end
+
   end
 end

data/lib/jsduck/tag/since.rb

@@ -1,5 +1,5 @@
 require "jsduck/tag/tag"
-require "jsduck/logger"
+require 'jsduck/util/html'
 
 module JsDuck::Tag
   class Since < Tag
@@ -22,7 +22,7 @@ module JsDuck::Tag
 
     def to_html(context)
       <<-EOHTML
-        <p>Available since: <b>#{context[:since]}</b></p>
+        <p>Available since: <b>#{JsDuck::Util::HTML.escape(context[:since])}</b></p>
       EOHTML
     end
 

data/lib/jsduck/tag/singleton.rb

@@ -5,6 +5,19 @@ module JsDuck::Tag
     def initialize
       @pattern = "singleton"
       @ext_define_pattern = "singleton"
+      @class_icon = {
+        :small => File.dirname(__FILE__) + "/icons/singleton.png",
+        :large => File.dirname(__FILE__) + "/icons/singleton-large.png",
+        :redirect => File.dirname(__FILE__) + "/icons/singleton-redirect.png",
+        :priority => PRIORITY_SINGLETON,
+      }
+      @signature = {:long => "singleton", :short => "single"}
+      @css = <<-EOCSS
+        .signature .singleton {
+          background-color: transparent;
+          color: #929292;
+        }
+      EOCSS
       super
     end
 

data/lib/jsduck/tag/tag.rb

@@ -133,6 +133,25 @@ module JsDuck::Tag
     #
     attr_reader :css
 
+    # Defines custom class icon files.
+    #
+    # It must be a hash with the following keys:
+    #
+    # - :large - the large icon used in class header
+    # - :small - small icon used in class tree and search
+    # - :redirect - redirect icon for alternateClassNames in search.
+    # - :priority - a number to determine which icon gets used when
+    #      a class has several tags that set a custom icon.  An icon
+    #      with a larger priority wins.
+    #
+    # Used by @class tag to define the default icon.
+    # Used by @singleton and @component tags for a different icon.
+    attr_reader :class_icon
+
+    PRIORITY_SINGLETON = 2
+    PRIORITY_COMPONENT = 1
+    PRIORITY_CLASS = 0
+
     # Returns all descendants of JsDuck::Tag::Tag class.
     def self.descendants
       result = []

data/lib/jsduck/tag_registry.rb

@@ -2,7 +2,7 @@ require "jsduck/tag_loader"
 
 module JsDuck
 
-  # Access to builtin @tags
+  # Access to all @tag definitions.
   class TagRegistry
     # Access to the singleton instance (only used internally)
     def self.instance
@@ -10,10 +10,21 @@ module JsDuck
       @instance
     end
 
-    # Reconfigures the registry with additional load paths.
-    # Used in Options class.
-    def self.reconfigure(load_paths)
-      @instance = TagRegistry.new(load_paths)
+    # Configures TagRegistry according to the command line options.
+    def self.configure(opts)
+      if opts.tags.length > 0
+        # Reconfigures the registry with additional load paths.
+        @instance = TagRegistry.new(opts.tags)
+      else
+        # Ensure the TagRegistry get instantiated just once.
+        # Otherwise the parallel processing causes multiple requests
+        # to initialize the TagRegistry, resulting in loading the Tag
+        # definitions multiple times.
+        instance
+      end
+
+      # The tooltip of @new can now be configured.
+      get_by_name(:new).init_tooltip!(opts)
     end
 
     # Redirect calls from TagRegistry.method to TagRegistry.instance.method,
@@ -24,14 +35,9 @@ module JsDuck
 
     def initialize(load_paths=[])
       @patterns = {}
-      @ext_define_patterns = {}
-      @ext_define_defaults = {}
       @tagnames = {}
       @signatures = []
-      @html_renderers = []
-      @html_renderers_sorted = false
-      @member_types = []
-      @css = []
+      @tags = []
 
       instantiate_tags(TagLoader.new(load_paths).load_all)
     end
@@ -45,35 +51,16 @@ module JsDuck
           @patterns[pattern] = tag
         end
 
-        Array(tag.ext_define_pattern).each do |pattern|
-          @ext_define_patterns[pattern] = tag
-        end
-
-        if tag.ext_define_default
-          @ext_define_defaults.merge!(tag.ext_define_default)
-        end
-
         if tag.tagname
           @tagnames[tag.tagname] = tag
         end
 
-        if tag.respond_to?(:member_type) && tag.member_type
-          tag.member_type[:name] = tag.tagname
-          @member_types << tag.member_type
-        end
-
         if tag.signature
           tag.signature[:tagname] = tag.tagname
           @signatures << tag.signature
         end
 
-        if tag.html_position
-          @html_renderers << tag
-        end
-
-        if tag.css
-          @css << tag.css
-        end
+        @tags << tag
       end
     end
 
@@ -81,55 +68,12 @@ module JsDuck
     # Accessors for lists of tags
     #
 
-    # Default values for class config when Ext.define is encountered.
-    attr_reader :ext_define_defaults
-
     # Array of attributes to be shown in member signatures
     # (and in order they should be shown in).
     attr_reader :signatures
 
-    # Same as #member_types, but returns just the names of member types.
-    def member_type_names
-      member_types.map {|mt| mt[:name] }
-    end
-
-    # Returns array of available member types.
-    # Sorted in the order defined by :position.
-    def member_types
-      if !@member_types_sorted
-        @member_types.sort! {|a, b| a[:position] <=> b[:position] }
-        @member_types_sorted = true
-      end
-
-      @member_types
-    end
-
-    # Regex for matching member type name in member reference.
-    #
-    # The regex matches strings like: "method-" or "event-".  It
-    # contains a capture group to capture the actual name of the
-    # member, leaving out the dash "-".
-    def member_type_regex
-      @member_type_regex if @member_type_regex
-      @member_type_regex = Regexp.new("(?:(" + member_type_names.join("|") + ")-)")
-    end
-
-    # Returns tags for rendering HTML, sorted in the order they should
-    # appear in final output. Sorting order is determined by the
-    # numeric :html_position field.
-    def html_renderers
-      if !@html_renderers_sorted
-        @html_renderers.sort! {|a, b| a.html_position <=> b.html_position }
-        @html_renderers_sorted = true
-      end
-
-      @html_renderers
-    end
-
-    # Returns all the CSS gathered from @css attributes of tags.
-    def css
-      @css.join("\n")
-    end
+    # Array of all available tags
+    attr_reader :tags
 
     #
     # Accessors for a single tag
@@ -140,11 +84,6 @@ module JsDuck
       @patterns[name]
     end
 
-    # Accesses tag by Ext.define pattern
-    def get_by_ext_define_pattern(name)
-      @ext_define_patterns[name]
-    end
-
     # Accesses tag by name - the symbol under which the tag data
     # is stored in final hash.
     def get_by_name(name)

data/lib/jsduck/util/io.rb

@@ -13,6 +13,11 @@ module JsDuck
     class IO
       @@encoding = "BOM|UTF-8"
 
+      # Configures the encoding from command line options.
+      def self.configure(opts)
+        encoding = opts.encoding if opts.encoding
+      end
+
       # Sets the external encoding to be used for reading files.
       # When it's different from UTF-8, the input will be converted to UTF-8.
       def self.encoding=(e)