jsduck 5.0.0.beta2 → 5.0.0.beta3

data/lib/jsduck/tag/property.rb

@@ -1,17 +1,16 @@
-require "jsduck/tag/tag"
+require "jsduck/tag/member_tag"
 require "jsduck/doc/subproperties"
 
 module JsDuck::Tag
-  class Property < Tag
+  class Property < MemberTag
     def initialize
       @pattern = "property"
       @tagname = :property
       @repeatable = true
       @member_type = {
-        :name => :property,
-        :category => :property_like,
         :title => "Properties",
         :position => MEMBER_POS_PROPERTY,
+        :icon => File.dirname(__FILE__) + "/icons/property.png",
         :subsections => [
           {:title => "Instance properties", :filter => {:static => false}, :default => true},
           {:title => "Static properties", :filter => {:static => true}},
@@ -21,7 +20,13 @@ module JsDuck::Tag
 
     # @property {Type} [name=default] ...
     def parse_doc(p, pos)
-      tag = p.standard_tag({:tagname => :property, :type => true, :name => true})
+      tag = p.standard_tag({
+          :tagname => :property,
+          :type => true,
+          :name => true,
+          :default => true,
+          :optional => true
+        })
       tag[:doc] = :multiline
       tag
     end
@@ -39,5 +44,23 @@ module JsDuck::Tag
       h[:properties] = nested[:properties]
       h[:name] = nested[:name]
     end
+
+    def process_code(code)
+      h = super(code)
+      h[:type] = code[:type]
+      h[:default] = code[:default]
+      h
+    end
+
+    # Do the merging of :type field
+    def merge(h, docs, code)
+      if h[:type] == nil
+        h[:type] = code[:tagname] == :method ? "Function" : "Object"
+      end
+    end
+
+    def to_html(property, cls)
+      member_link(property) + " : " + property[:html_type]
+    end
   end
 end

data/lib/jsduck/tag/tag.rb

@@ -47,59 +47,6 @@ module JsDuck::Tag
     def process_doc(hash, docs, position)
     end
 
-    # Defines a class member type and specifies a name and several
-    # other settings.  For example:
-    #
-    #     {
-    #       :name => :event,
-    #       :category => :method_like,
-    #       :title => "Events",
-    #       :position => MEMBER_POS_EVENT,
-    #       # The following are optional
-    #       :toolbar_title => "Events",
-    #       :subsections => [
-    #         {:title => "Static events",
-    #          :filter => {:static => false},
-    #          :default => true},
-    #         {:title => "Instance events",
-    #          :filter => {:static => true}},
-    #       ]
-    #     }
-    #
-    # The category must be either :property_like or :method_like.
-    #
-    # Position defines the ordering of member section in final HTML
-    # output.
-    #
-    # Title is shown at the top of each such section and also as a
-    # label on Docs app toolbar button unless :toolbar_title is
-    # specified.
-    #
-    # Subsections allows splitting the list of members to several
-    # subgroups.  For example methods get split into static and
-    # instance methods.
-    #
-    # - The :filter field defines how to filter out the members for
-    #   this subcategory.  :static=>true filters out all members that
-    #   have a :static field with a truthy value.  Conversely,
-    #   :static=>false filters out members not having a :static field
-    #   or having it with a falsy value.
-    #
-    # - Setting :default=>true will hide the subsection title when all
-    #   the members end up in that subsection.  For example when there
-    #   are only instance methods, the docs will only contain the
-    #   section title "Methods", as by default one should assume all
-    #   methods are instance methods if not stated otherwise.
-    #
-    attr_reader :member_type
-
-    MEMBER_POS_CFG = 1
-    MEMBER_POS_PROPERTY = 2
-    MEMBER_POS_METHOD = 3
-    MEMBER_POS_EVENT = 4
-    MEMBER_POS_CSS_VAR = 5
-    MEMBER_POS_CSS_MIXIN = 6
-
     # The text to display in member signature.  Must be a hash
     # defining the short and long versions of the signature text:
     #
@@ -126,27 +73,6 @@ module JsDuck::Tag
     def parse_ext_define(cls, ast)
     end
 
-    # In the context of which members or classes invoke the #merge
-    # method.  This can be either a single tagname like :class,
-    # :method, :cfg or an array of these.
-    #
-    # Additionally a few special symbols can be used to register a
-    # merger for a set of member types:
-    #
-    #   - :member - all members.
-    #   - :method_like - members like :method, :event, :css_mixin
-    #   - :property_like - members like :cfg, :property, :css_var
-    #
-    # For example to register a merger for everyting:
-    #
-    #     @merge_context = [:class, :member]
-    #
-    attr_reader :merge_context
-
-    # Merges documentation and code hashes into the result hash.
-    def merge(hash, docs, code)
-    end
-
     # The position for outputting the HTML for the tag in final
     # documentation.
     #
@@ -182,7 +108,8 @@ module JsDuck::Tag
     POS_SUBPROPERTIES = 12
     POS_RETURN = 13
     POS_THROWS = 14
-    POS_OVERRIDES = 15
+    POS_FIRES = 15
+    POS_OVERRIDES = 16
 
     # Called before #to_html to allow rendering of Markdown content.
     # For this an instance of DocFormatter is passed in, on which one
@@ -195,6 +122,7 @@ module JsDuck::Tag
     #
     # It gets passed the full class/member hash. It should return an
     # HTML string to inject into document.
+    #
     def to_html(context)
     end
 

data/lib/jsduck/tag/type.rb

@@ -1,12 +1,10 @@
 require "jsduck/tag/tag"
-require "jsduck/docs_code_comparer"
 
 module JsDuck::Tag
   class Type < Tag
     def initialize
       @pattern = "type"
       @tagname = :type
-      @merge_context = :property_like
 
       # We don't really care about the position as we don't output any
       # HTML. We just need to set this up to do the formatting.
@@ -19,7 +17,7 @@ module JsDuck::Tag
     # ext-doc allows type name to be either inside curly braces or
     # without them at all.
     def parse_doc(p, pos)
-      tag = p.standard_tag({:tagname => :type, :type => true})
+      tag = p.standard_tag({:tagname => :type, :type => true, :optional => true})
       tag[:type] = curlyless_type(p) unless tag[:type]
       tag
     end
@@ -32,14 +30,6 @@ module JsDuck::Tag
       h[:type] = tags[0][:type] unless h[:type]
     end
 
-    # Do the merging of :type field
-    def merge(h, docs, code)
-      JsDuck::DocsCodeComparer.merge_if_matches(h, :type, docs, code)
-      if h[:type] == nil
-        h[:type] = code[:tagname] == :method ? "Function" : "Object"
-      end
-    end
-
     def format(m, formatter)
       m[:html_type] = formatter.format_type(m[:type])
     end

data/lib/jsduck/tag_registry.rb

@@ -27,7 +27,6 @@ module JsDuck
       @ext_define_patterns = {}
       @ext_define_defaults = {}
       @tagnames = {}
-      @mergers = {}
       @signatures = []
       @html_renderers = []
       @html_renderers_sorted = false
@@ -58,12 +57,8 @@ module JsDuck
           @tagnames[tag.tagname] = tag
         end
 
-        Array(tag.merge_context).each do |context|
-          @mergers[context] = [] unless @mergers[context]
-          @mergers[context] << tag
-        end
-
-        if tag.member_type
+        if tag.respond_to?(:member_type) && tag.member_type
+          tag.member_type[:name] = tag.tagname
           @member_types << tag.member_type
         end
 
@@ -94,26 +89,19 @@ module JsDuck
     attr_reader :signatures
 
     # Same as #member_types, but returns just the names of member types.
-    def member_type_names(category=:member)
-      member_types(category).map {|mt| mt[:name] }
+    def member_type_names
+      member_types.map {|mt| mt[:name] }
     end
 
     # Returns array of available member types.
     # Sorted in the order defined by :position.
-    #
-    # An optional category argument can be given to limit the returned
-    # members to just :method_like or :property_like.
-    def member_types(category=:member)
+    def member_types
       if !@member_types_sorted
         @member_types.sort! {|a, b| a[:position] <=> b[:position] }
         @member_types_sorted = true
       end
 
-      if category == :member
-        @member_types
-      else
-        @member_types.find_all {|mt| mt[:category] == category }
-      end
+      @member_types
     end
 
     # Regex for matching member type name in member reference.
@@ -126,14 +114,6 @@ module JsDuck
       @member_type_regex = Regexp.new("(?:(" + member_type_names.join("|") + ")-)")
     end
 
-    # Returns tags for doing the merging in a particular context.
-    # See Tag::Tag#merge_context for details.
-    def mergers(context)
-      expand_merge_contexts unless @mergers_expanded
-
-      @mergers[context] || []
-    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.
@@ -171,28 +151,6 @@ module JsDuck
       @tagnames[name]
     end
 
-    private
-
-    # Takes mergers registered under :member, :method_like or
-    # :property_like context and adds them to the contexts all of the
-    # detected suitable member types.
-    def expand_merge_contexts
-      expand_merger(:member)
-      expand_merger(:method_like)
-      expand_merger(:property_like)
-      @mergers_expanded = true
-    end
-
-    def expand_merger(type_name)
-      Array(@mergers[type_name]).each do |tag|
-        member_type_names(type_name).each do |tagname|
-          @mergers[tagname] = [] unless @mergers[tagname]
-          @mergers[tagname] << tag
-        end
-      end
-      @mergers.delete(type_name)
-    end
-
   end
 
 end

data/lib/jsduck/web/css.rb

@@ -1,5 +1,6 @@
 require 'jsduck/tag_registry'
 require 'jsduck/util/md5'
+require 'jsduck/web/member_icons'
 
 module JsDuck
   module Web
@@ -13,9 +14,15 @@ module JsDuck
       end
 
       def write(filename)
-        File.open(filename, 'w') {|f| f.write(TagRegistry.css + @opts.css) }
+        File.open(filename, 'w') {|f| f.write(all_css) }
         Util::MD5.rename(filename)
       end
+
+      private
+
+      def all_css
+        TagRegistry.css + Web::MemberIcons.css + @opts.css
+      end
     end
 
   end

data/lib/jsduck/web/data.rb

@@ -25,7 +25,8 @@ module JsDuck
             :guides => @assets.guides.to_array,
             :videos => @assets.videos.to_array,
             :examples => @assets.examples.to_array,
-            :search => Web::Search.new.create(@relations.classes, @assets),
+            :search => Web::Search.new.create(@relations.classes, @assets, @opts),
+            :guideSearch => @opts.search,
             :tests => @opts.tests,
             :signatures => TagRegistry.signatures,
             :memberTypes => TagRegistry.member_types,

data/lib/jsduck/web/index_html.rb

@@ -41,6 +41,7 @@ module JsDuck
           "{css_path}" => File.basename(@paths[:css]),
           "{welcome}" => @assets.welcome.to_html("display:none"),
           "{categories}" => @assets.categories.to_html("display:none"),
+          "{news}" => @assets.news.to_html("display:none"),
           "{guides}" => @assets.guides.to_html("display:none"),
           "{head_html}" => @opts.head_html,
           "{body_html}" => @opts.body_html,

data/lib/jsduck/web/member_icons.rb

@@ -0,0 +1,43 @@
+require 'jsduck/tag_registry'
+require 'fileutils'
+
+module JsDuck
+  module Web
+
+    # Manages member icons.
+    # Generating CSS for them and coping the image files over to output dir.
+    class MemberIcons
+      # Generates CSS for member icons
+      def self.css
+        css = []
+        members_with_icons.each do |m|
+          name = m[:name]
+          rule = ".icon-#{name} { background-image: url(member-icons/#{name}.png); background-repeat: no-repeat; }"
+          css << "#search-dropdown #{rule}"
+          css << ".members .members-section #{rule}"
+          css << ".members .comments-section #{rule}"
+          css << ".class-overview .x-toolbar.member-links #{rule}"
+        end
+        css.join("\n")
+      end
+
+      # Copies all member icons to given destination dir.
+      def self.write(dir)
+        FileUtils.mkdir(dir)
+
+        members_with_icons.each do |m|
+          if File.exists?(m[:icon])
+            FileUtils.cp(m[:icon], "#{dir}/#{m[:name]}.png")
+          else
+            Logger.warn(nil, "Member icon file not found", m[:icon])
+          end
+        end
+      end
+
+      def self.members_with_icons
+        TagRegistry.member_types.find_all {|m| m[:icon] }
+      end
+    end
+
+  end
+end

data/lib/jsduck/web/search.rb

@@ -10,7 +10,7 @@ module JsDuck
     class Search
       # Given list of classes and other assets, returns an array of
       # hashes describing the search data.
-      def create(classes, assets)
+      def create(classes, assets, opts)
         list = []
 
         classes.each do |cls|
@@ -32,7 +32,8 @@ module JsDuck
           end
         end
 
-        assets.guides.each_item {|g| list << guide_node(g) }
+        # Don't include guides data when separate guides search engine is provided
+        assets.guides.each_item {|g| list << guide_node(g) } unless opts.search[:url]
 
         assets.videos.each_item {|v| list << video_node(v) }
 

data/lib/jsduck/web/writer.rb

@@ -7,6 +7,7 @@ require 'jsduck/web/index_html'
 require 'jsduck/web/data'
 require 'jsduck/web/css'
 require 'jsduck/web/source'
+require 'jsduck/web/member_icons'
 require 'fileutils'
 
 module JsDuck
@@ -24,6 +25,8 @@ module JsDuck
       def write
         write_template_files
 
+        write_member_icons
+
         write_html_files
 
         # class-formatting is done in parallel which breaks the links
@@ -45,6 +48,11 @@ module JsDuck
         Web::Template.new(@opts).write
       end
 
+      # Copy over member icons
+      def write_member_icons
+        Web::MemberIcons.write(@opts.output_dir+"/member-icons")
+      end
+
       # Generate data.js and styles.css.
       # Then generate HTML files, linking to the data.js and styles.css from them.
       def write_html_files

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: jsduck
 version: !ruby/object:Gem::Version 
-  hash: -3591488346
+  hash: -3863910600
   prerelease: 6
   segments: 
   - 5
   - 0
   - 0
   - beta
-  - 2
-  version: 5.0.0.beta2
+  - 3
+  version: 5.0.0.beta3
 platform: ruby
 authors: 
 - Rene Saarsoo
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-04-03 00:00:00 Z
+date: 2013-05-28 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rdiscount
@@ -90,14 +90,6 @@ dependencies:
         - 10
         - 0
         version: 0.10.0
-    - - <
-      - !ruby/object:Gem::Version 
-        hash: 51
-        segments: 
-        - 0
-        - 11
-        - 0
-        version: 0.11.0
   type: :runtime
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
@@ -196,16 +188,17 @@ files:
 - lib/jsduck/class_doc_expander.rb
 - lib/jsduck/class_name.rb
 - lib/jsduck/class_writer.rb
+- lib/jsduck/columns.rb
 - lib/jsduck/css/lexer.rb
 - lib/jsduck/css/parser.rb
 - lib/jsduck/doc/comment.rb
+- lib/jsduck/doc/delimited_parser.rb
 - lib/jsduck/doc/map.rb
 - lib/jsduck/doc/parser.rb
 - lib/jsduck/doc/processor.rb
 - lib/jsduck/doc/scanner.rb
 - lib/jsduck/doc/standard_tag_parser.rb
 - lib/jsduck/doc/subproperties.rb
-- lib/jsduck/docs_code_comparer.rb
 - lib/jsduck/examples.rb
 - lib/jsduck/export_writer.rb
 - lib/jsduck/exporter/app.rb
@@ -219,6 +212,8 @@ files:
 - lib/jsduck/format/shortener.rb
 - lib/jsduck/format/subproperties.rb
 - lib/jsduck/grouped_asset.rb
+- lib/jsduck/guide_anchors.rb
+- lib/jsduck/guide_toc.rb
 - lib/jsduck/guide_writer.rb
 - lib/jsduck/guides.rb
 - lib/jsduck/img/dir.rb
@@ -232,26 +227,36 @@ files:
 - lib/jsduck/inline/video.rb
 - lib/jsduck/inline_examples.rb
 - lib/jsduck/js/ast.rb
+- lib/jsduck/js/class.rb
 - lib/jsduck/js/esprima.rb
 - lib/jsduck/js/esprima/esprima.js
 - lib/jsduck/js/evaluator.rb
+- lib/jsduck/js/event.rb
 - lib/jsduck/js/ext_patterns.rb
-- lib/jsduck/js/function.rb
+- lib/jsduck/js/fires.rb
+- lib/jsduck/js/method.rb
+- lib/jsduck/js/method_calls.rb
 - lib/jsduck/js/node.rb
 - lib/jsduck/js/node_array.rb
 - lib/jsduck/js/parser.rb
+- lib/jsduck/js/property.rb
+- lib/jsduck/js/returns.rb
+- lib/jsduck/js/scoped_traverser.rb
 - lib/jsduck/js/serializer.rb
 - lib/jsduck/js/utils.rb
 - lib/jsduck/logger.rb
 - lib/jsduck/members_index.rb
 - lib/jsduck/merger.rb
+- lib/jsduck/news.rb
 - lib/jsduck/option_parser.rb
 - lib/jsduck/options.rb
+- lib/jsduck/params_merger.rb
 - lib/jsduck/parser.rb
 - lib/jsduck/process/accessors.rb
 - lib/jsduck/process/circular_deps.rb
 - lib/jsduck/process/enums.rb
 - lib/jsduck/process/ext4_events.rb
+- lib/jsduck/process/fires.rb
 - lib/jsduck/process/global_members.rb
 - lib/jsduck/process/ignored_classes.rb
 - lib/jsduck/process/importer.rb
@@ -265,7 +270,7 @@ files:
 - lib/jsduck/relations.rb
 - lib/jsduck/render/class.rb
 - lib/jsduck/render/sidebar.rb
-- lib/jsduck/render/signature.rb
+- lib/jsduck/render/signature_util.rb
 - lib/jsduck/render/subproperties.rb
 - lib/jsduck/render/tags.rb
 - lib/jsduck/source/file.rb
@@ -275,7 +280,6 @@ files:
 - lib/jsduck/tag/alternate_class_names.rb
 - lib/jsduck/tag/aside.rb
 - lib/jsduck/tag/author.rb
-- lib/jsduck/tag/autodetected.rb
 - lib/jsduck/tag/boolean_tag.rb
 - lib/jsduck/tag/cfg.rb
 - lib/jsduck/tag/chainable.rb
@@ -293,17 +297,24 @@ files:
 - lib/jsduck/tag/event.rb
 - lib/jsduck/tag/evented.rb
 - lib/jsduck/tag/extends.rb
+- lib/jsduck/tag/fires.rb
 - lib/jsduck/tag/ftype.rb
 - lib/jsduck/tag/hide.rb
+- lib/jsduck/tag/icons/cfg.png
+- lib/jsduck/tag/icons/css_mixin.png
+- lib/jsduck/tag/icons/css_var.png
+- lib/jsduck/tag/icons/event.png
+- lib/jsduck/tag/icons/method.png
+- lib/jsduck/tag/icons/property.png
 - lib/jsduck/tag/ignore.rb
 - lib/jsduck/tag/inheritable.rb
 - lib/jsduck/tag/inheritdoc.rb
 - lib/jsduck/tag/localdoc.rb
 - lib/jsduck/tag/markdown.rb
 - lib/jsduck/tag/member.rb
+- lib/jsduck/tag/member_tag.rb
 - lib/jsduck/tag/method.rb
 - lib/jsduck/tag/mixins.rb
-- lib/jsduck/tag/name.rb
 - lib/jsduck/tag/new.rb
 - lib/jsduck/tag/override.rb
 - lib/jsduck/tag/overrides.rb
@@ -345,6 +356,7 @@ files:
 - lib/jsduck/web/data.rb
 - lib/jsduck/web/icons.rb
 - lib/jsduck/web/index_html.rb
+- lib/jsduck/web/member_icons.rb
 - lib/jsduck/web/search.rb
 - lib/jsduck/web/source.rb
 - lib/jsduck/web/template.rb
@@ -726,20 +738,18 @@ files:
 - template-min/extjs/resources/themes/images/default/btn-group/btn-group-default-framed-sides.gif
 - template-min/index-template.html
 - template-min/README.md
+- template-min/app-47d780a08807256b051d4f50850fface.js
 - template-min/eg-iframe.html
-- template-min/app-53d511d3c1fdd3f59e98c711b0cd8d09.js
 - template-min/index.php
-- template-min/resources/css/app-0f2069573328c567a9a80772dbcb26f1.css
+- template-min/resources/css/app-b35792cfe6686887f720936b33191682.css
 - template-min/resources/images/link-green-standard.png
 - template-min/resources/images/class-m.png
 - template-min/resources/images/singleton-m.png
-- template-min/resources/images/version-tabs.png
 - template-min/resources/images/down-arr.png
 - template-min/resources/images/x.png
 - template-min/resources/images/vote-arrows.png
 - template-min/resources/images/ajax-loader.gif
 - template-min/resources/images/x12.png
-- template-min/resources/images/x122.png
 - template-min/resources/images/member-expanded.gif
 - template-min/resources/images/tablet-l.jpg
 - template-min/resources/images/tablet-p.jpg
@@ -750,27 +760,21 @@ files:
 - template-min/resources/images/member-hover.gif
 - template-min/resources/images/default-guide.png
 - template-min/resources/images/doc-m.png
-- template-min/resources/images/preview.png
 - template-min/resources/images/sample-over.gif
 - template-min/resources/images/more.png
-- template-min/resources/images/link-arrow-next.png
 - template-min/resources/images/comment-bubble.png
 - template-min/resources/images/tabs.png
 - template-min/resources/images/expandcollapse.png
 - template-min/resources/images/component-m.png
-- template-min/resources/images/guides.png
 - template-min/resources/images/elbow-end.gif
 - template-min/resources/images/example-icons.png
 - template-min/resources/images/logo-screen-noglow.png
-- template-min/resources/images/sencha-stamp.png
 - template-min/resources/images/link-green-standard-over.png
 - template-min/resources/images/arrows.png
 - template-min/resources/images/icons.png
 - template-min/resources/images/logo.png
-- template-min/resources/images/guide-icon.png
 - template-min/resources/images/comment.png
 - template-min/resources/images/loading.gif
-- template-min/resources/images/gettingstarted.jpg
 - template-min/resources/images/welcome-bg-js4.gif
 - template-min/resources/images/header.png
 - template-min/resources/images/search-box.png