jsduck 5.3.4 → 6.0.0beta

data/lib/jsduck/exporter/full.rb

@@ -1,11 +1,13 @@
-require 'jsduck/tag_registry'
+require 'jsduck/class'
+require 'jsduck/member_registry'
+require 'ostruct'
 
 module JsDuck
   module Exporter
 
     # Exporter for all the class docs.
     class Full
-      def initialize(relations, opts={})
+      def initialize(relations, opts=OpenStruct.new)
         # parameters are just for compatibility with other exporters
       end
 
@@ -27,7 +29,7 @@ module JsDuck
       # Generates flat list of all members
       def export_members(cls)
         groups = []
-        TagRegistry.member_type_names.each do |tagname|
+        MemberRegistry.names.each do |tagname|
           groups << export_members_group(cls, {:tagname => tagname, :static => false})
           groups << export_members_group(cls, {:tagname => tagname, :static => true})
         end

data/lib/jsduck/external_classes.rb

@@ -3,17 +3,27 @@ module JsDuck
   # Handles patterns of external classes.
   #
   # A pattern can be a simple classname or a one with a wildcard "*".
+  #
+  # Also one can use a special keyword "@browser" to include all
+  # common browser web API class names.
   class ExternalClasses
 
     def initialize(classnames = [])
       @class_names = {}
       @patterns = []
-      classnames.each do |name|
-        if name =~ /\*/
-          @patterns << make_pattern(name)
-        else
-          @class_names[name] = true
+      classnames.each {|name| add(name) }
+    end
+
+    # Adds a classname or pattern to list of external classes.
+    def add(name)
+      if name =~ /\*/
+        @patterns << make_pattern(name)
+      elsif name =~ /^@browser$/i
+        WEB_APIS.each do |cls|
+          @class_names[cls] = true
         end
+      else
+        @class_names[name] = true
       end
     end
 
@@ -22,9 +32,331 @@ module JsDuck
       @class_names[classname] || @patterns.any? {|p| classname =~ p }
     end
 
+    private
+
     def make_pattern(pattern)
       Regexp.new("^" + pattern.split(/\*/, -1).map {|s| Regexp.escape(s) }.join(".*") + "$")
     end
+
+    # List taken from: https://developer.mozilla.org/en-US/docs/Web/API
+    # Excluding experimental, obsolete, deprecated and non-standardized APIs.
+    WEB_APIS = %w(
+      AbstractWorker
+      ArrayBuffer
+      ArrayBufferView
+      Attr
+
+      BatteryManager
+      Blob
+      BluetoothAdapter
+      BluetoothManager
+
+      CanvasGradient
+      CanvasImageSource
+      CanvasPattern
+      CanvasRenderingContext2D
+      CharacterData
+      CloseEvent
+      Comment
+      CompositionEvent
+      ContactManager
+      Coordinates
+      CSS
+      CSSConditionRule
+      CSSGroupingRule
+      CSSMediaRule
+      CSSPageRule
+      CSSRule
+      CSSRuleList
+      CSSStyleDeclaration
+      CSSStyleRule
+      CSSStyleSheet
+      CSSSupportsRule
+      CustomEvent
+
+      DataTransfer
+      DataView
+      DedicatedWorkerGlobalScope
+      Document
+      DocumentFragment
+      DocumentTouch
+      DocumentType
+      DOMError
+      DOMException
+      DOMHighResTimeStamp
+      DOMImplementation
+      DOMImplementationRegistry
+      DOMString
+      DOMStringList
+      DOMStringMap
+      DOMTimeStamp
+      DOMTokenList
+
+      Element
+      ErrorEvent
+      Event
+      EventListener
+      EventSource
+      EventTarget
+      Extensions
+
+      File
+      FileHandle
+      FileList
+      FileReader
+      FileReaderSync
+      FileRequest
+      Float32Array
+      Float64Array
+      FormData
+
+      Geolocation
+      GlobalEventHandlers
+
+      History
+      HTMLAnchorElement
+      HTMLAreaElement
+      HTMLAudioElement
+      HTMLBaseElement
+      HTMLBodyElement
+      HTMLBRElement
+      HTMLButtonElement
+      HTMLCanvasElement
+      HTMLCollection
+      HTMLDataElement
+      HTMLDataListElement
+      HTMLDivElement
+      HTMLDListElement
+      HTMLDocument
+      HTMLElement
+      HTMLEmbedElement
+      HTMLFieldSetElement
+      HTMLFormControlsCollection
+      HTMLFormElement
+      HTMLHeadElement
+      HTMLHeadingElement
+      HTMLHRElement
+      HTMLHtmlElement
+      HTMLIFrameElement
+      HTMLImageElement
+      HTMLInputElement
+      HTMLKeygenElement
+      HTMLLabelElement
+      HTMLLegendElement
+      HTMLLIElement
+      HTMLLinkElement
+      HTMLMapElement
+      HTMLMediaElement
+      HTMLMetaElement
+      HTMLMeterElement
+      HTMLModElement
+      HTMLObjectElement
+      HTMLOListElement
+      HTMLOptGroupElement
+      HTMLOptionElement
+      HTMLOptionsCollection
+      HTMLOutputElement
+      HTMLParagraphElement
+      HTMLParamElement
+      HTMLPreElement
+      HTMLProgressElement
+      HTMLQuoteElement
+      HTMLScriptElement
+      HTMLSelectElement
+      HTMLSourceElement
+      HTMLSpanElement
+      HTMLStyleElement
+      HTMLTableCaptionElement
+      HTMLTableCellElement
+      HTMLTableColElement
+      HTMLTableDataCellElement
+      HTMLTableElement
+      HTMLTableHeaderCellElement
+      HTMLTableRowElement
+      HTMLTableSectionElement
+      HTMLTextAreaElement
+      HTMLTimeElement
+      HTMLTitleElement
+      HTMLTrackElement
+      HTMLUListElement
+      HTMLUnknownElement
+      HTMLVideoElement
+
+      IDBCursor
+      IDBCursorSync
+      IDBCursorWithValue
+      IDBDatabase
+      IDBDatabaseSync
+      IDBEnvironment
+      IDBEnvironmentSync
+      IDBFactory
+      IDBFactorySync
+      IDBIndex
+      IDBIndexSync
+      IDBKeyRange
+      IDBObjectStore
+      IDBObjectStoreSync
+      IDBOpenDBRequest
+      IDBRequest
+      IDBTransaction
+      IDBTransactionSync
+      IDBVersionChangeEvent
+      IDBVersionChangeRequest
+      ImageData
+      Int16Array
+      Int32Array
+      Int8Array
+
+      KeyboardEvent
+
+      LinkStyle
+      Location
+      LockedFile
+
+      MessageEvent
+      MouseEvent
+
+      Navigator
+      NavigatorGeolocation
+      NavigatorID
+      NavigatorLanguage
+      NavigatorOnLine
+      Node
+      NodeFilter
+      NodeIterator
+      NodeList
+      Notification
+      NotifyAudioAvailableEvent
+
+      Performance
+      PerformanceNavigation
+      PerformanceTiming
+      PermissionSettings
+      Plugin
+      Position
+      PositionError
+      PositionOptions
+      ProcessingInstruction
+      ProgressEvent
+
+      Range
+      RTCPeerConnection
+
+      SharedWorker
+      StorageEvent
+      StyleSheet
+      StyleSheetList
+      SVGAElement
+      SVGAngle
+      SVGAnimateColorElement
+      SVGAnimatedAngle
+      SVGAnimatedBoolean
+      SVGAnimatedEnumeration
+      SVGAnimatedInteger
+      SVGAnimatedLength
+      SVGAnimatedLengthList
+      SVGAnimatedNumber
+      SVGAnimatedNumberList
+      SVGAnimatedPoints
+      SVGAnimatedPreserveAspectRatio
+      SVGAnimatedRect
+      SVGAnimatedString
+      SVGAnimatedTransformList
+      SVGAnimateElement
+      SVGAnimateMotionElement
+      SVGAnimateTransformElement
+      SVGAnimationElement
+      SVGCircleElement
+      SVGClipPathElement
+      SVGCursorElement
+      SVGDefsElement
+      SVGDescElement
+      SVGElement
+      SVGEllipseElement
+      SVGFilterElement
+      SVGFontElement
+      SVGFontFaceElement
+      SVGFontFaceFormatElement
+      SVGFontFaceNameElement
+      SVGFontFaceSrcElement
+      SVGFontFaceUriElement
+      SVGForeignObjectElement
+      SVGGElement
+      SVGGlyphElement
+      SVGGradientElement
+      SVGHKernElement
+      SVGImageElement
+      SVGLength
+      SVGLengthList
+      SVGLinearGradientElement
+      SVGLineElement
+      SVGMaskElement
+      SVGMatrix
+      SVGMissingGlyphElement
+      SVGMPathElement
+      SVGNumber
+      SVGNumberList
+      SVGPathElement
+      SVGPatternElement
+      SVGPoint
+      SVGPolygonElement
+      SVGPolylineElement
+      SVGPreserveAspectRatio
+      SVGRadialGradientElement
+      SVGRect
+      SVGRectElement
+      SVGScriptElement
+      SVGSetElement
+      SVGStopElement
+      SVGStringList
+      SVGStylable
+      SVGStyleElement
+      SVGSVGElement
+      SVGSwitchElement
+      SVGSymbolElement
+      SVGTests
+      SVGTextElement
+      SVGTextPositioningElement
+      SVGTitleElement
+      SVGTransform
+      SVGTransformable
+      SVGTransformList
+      SVGTRefElement
+      SVGTSpanElement
+      SVGUseElement
+      SVGViewElement
+      SVGVKernElement
+
+      TCPServerSocket
+      Text
+      TextMetrics
+      TimeRanges
+      Touch
+      TouchEvent
+      TouchList
+      Transferable
+      TreeWalker
+
+      UIEvent
+      Uint16Array
+      Uint32Array
+      Uint8Array
+      Uint8ClampedArray
+
+      ValidityState
+
+      WebGLRenderingContext
+      WebSocket
+      WheelEvent
+      Window
+      Worker
+      WorkerLocation
+      WorkerNavigator
+
+      XMLHttpRequest
+      XMLHttpRequestEventTarget
+    )
+
   end
 
 end

data/lib/jsduck/format/class.rb

@@ -1,4 +1,4 @@
-require 'jsduck/tag_registry'
+require 'jsduck/render/tags'
 
 module JsDuck
   module Format
@@ -42,14 +42,14 @@ module JsDuck
       def format_member(m)
         @formatter.doc_context = m[:files][0]
 
-        # Turn off type parsing for CSS vars and mixins
+        # Turn off type parsing for SCSS vars and mixins
         @formatter.skip_type_parsing = [:css_var, :css_mixin].include?(m[:tagname])
 
         format_tags(m)
       end
 
       def format_tags(context)
-        TagRegistry.html_renderers.each do |tag|
+        Render::Tags.renderers.each do |tag|
           if context[tag.tagname]
             tag.format(context, @formatter)
           end

data/lib/jsduck/format/doc.rb

@@ -8,6 +8,7 @@ require 'jsduck/inline/link_renderer'
 require 'jsduck/inline/img'
 require 'jsduck/inline/video'
 require 'jsduck/inline/example'
+require 'ostruct'
 
 module JsDuck
   module Format
@@ -18,7 +19,7 @@ module JsDuck
       # Creates a formatter configured with options originating from
       # command line.  For the actual effect of the options see
       # Inline::* classes.
-      def initialize(relations={}, opts={})
+      def initialize(relations={}, opts=OpenStruct.new)
         @relations = relations
         @opts = opts
         @subproperties = Format::Subproperties.new(self)
@@ -88,9 +89,9 @@ module JsDuck
       # recognized classnames.
       #
       # Replaces {@link Class#member link text} in given string with
-      # HTML from @link_tpl.
+      # HTML from --link.
       #
-      # Replaces {@img path/to/image.jpg Alt text} with HTML from @img_tpl.
+      # Replaces {@img path/to/image.jpg Alt text} with HTML from --img.
       #
       # Adds 'inline-example' class to code examples beginning with @example.
       #
@@ -104,7 +105,7 @@ module JsDuck
         # Keep track of open HTML tags. We're not auto-detecting class
         # names when inside <a>. Also we want to close down the unclosed
         # tags.
-        tags = Format::HtmlStack.new(@opts[:ignore_html] || {}, @doc_context)
+        tags = Format::HtmlStack.new(@opts.ignore_html || {}, @doc_context)
 
         while !s.eos? do
           if substitute = @inline_link.replace(s)
@@ -147,7 +148,7 @@ module JsDuck
 
       # Turns type parsing on or off.
       #
-      # Used to skipping parsing of CSS var and mixin types.
+      # Used to skipping parsing of SCSS var and mixin types.
       def skip_type_parsing=(skip)
         @subproperties.skip_type_parsing = skip
       end