jsduck 4.0.1 → 4.1.1

data/lib/jsduck/grouped_asset.rb

@@ -10,20 +10,10 @@ module JsDuck
   class GroupedAsset
     # Should be called from constructor after @groups have been read in,
     # and after it's been ensured that all items in groupes have names.
-    #
-    # Prints warning when there is a duplicate item within a group.
-    # The warning message should say something like "duplicate <asset type>"
-    def build_map_by_name(warning_msg, filename)
+    def build_map_by_name
       @map_by_name = {}
-      @groups.each do |group|
-        group_map = {}
-        group["items"].each do |item|
-          if group_map[item["name"]]
-            Logger.instance.warn(:dup_asset, "#{warning_msg} '#{item['name']}'", filename)
-          end
-          @map_by_name[item["name"]] = item
-          group_map[item["name"]] = item
-        end
+      each_item do |item|
+        @map_by_name[item["name"]] = item
       end
     end
 
@@ -33,9 +23,30 @@ module JsDuck
     end
 
     # Iterates over all items in all groups
-    def each_item
-      @groups.each do |group|
-        group["items"].each {|item| yield item }
+    def each_item(group=nil, &block)
+      group = group || @groups
+
+      group.each do |item|
+        if item["items"]
+          each_item(item["items"], &block)
+        else
+          block.call(item)
+        end
+      end
+    end
+
+    def map_items(group=nil, &block)
+      group = group || @groups
+
+      group.map do |item|
+        if item["items"]
+          {
+            "title" => item["title"],
+            "items" => map_items(item["items"], &block)
+          }
+        else
+          block.call(item)
+        end
       end
     end
 

data/lib/jsduck/guide_writer.rb

@@ -1,6 +1,7 @@
-require 'jsduck/parallel_wrap'
+require 'jsduck/util/parallel'
+require 'jsduck/util/stdout'
+require 'jsduck/util/json'
 require 'jsduck/logger'
-require 'jsduck/stdout'
 require 'fileutils'
 
 module JsDuck
@@ -24,21 +25,21 @@ module JsDuck
 
     def write_stdout
       json = ParallelWrap.map(all_guides) {|guide| @exporter.export_guide(guide) }.compact
-      Stdout.instance.add(json)
+      Util::Stdout.add(json)
     end
 
     def write_dir(dir, extension)
       FileUtils.mkdir(dir) unless File.exists?(dir)
-      ParallelWrap.each(all_guides) do |guide|
+      Util::Parallel.each(all_guides) do |guide|
         filename = dir + "/" + guide["name"] + extension
-        Logger.instance.log("Writing guide", filename)
+        Logger.log("Writing guide", filename)
         json = @exporter.export_guide(guide)
         # skip file if exporter returned nil
         if json
           if extension == ".json"
-            JsonDuck.write_json(filename, json)
+            Util::Json.write_json(filename, json)
           elsif extension == ".js"
-            JsonDuck.write_jsonp(filename, guide["name"], json)
+            Util::Json.write_jsonp(filename, guide["name"], json)
           else
             throw "Unexpected file extension: #{extension}"
           end

data/lib/jsduck/guides.rb

@@ -1,10 +1,10 @@
 require 'jsduck/logger'
-require 'jsduck/json_duck'
-require 'jsduck/io'
-require 'jsduck/null_object'
+require 'jsduck/util/json'
+require 'jsduck/util/io'
+require 'jsduck/util/null_object'
 require 'jsduck/logger'
 require 'jsduck/grouped_asset'
-require 'jsduck/html'
+require 'jsduck/util/html'
 require 'fileutils'
 
 module JsDuck
@@ -16,17 +16,18 @@ module JsDuck
       if filename
         Guides.new(filename, formatter, opts)
       else
-        NullObject.new(:to_array => [], :to_html => "", :[] => nil)
+        Util::NullObject.new(:to_array => [], :to_html => "", :[] => nil)
       end
     end
 
     # Parses guides config file
     def initialize(filename, formatter, opts)
       @path = File.dirname(filename)
-      @groups = JsonDuck.read(filename)
-      build_map_by_name("Two guides have the same name", filename)
+      @groups = Util::Json.read(filename)
       @formatter = formatter
       @opts = opts
+      build_map_by_name
+      load_all_guides
     end
 
     # Writes all guides to given dir in JsonP format
@@ -35,43 +36,36 @@ module JsDuck
       each_item {|guide| write_guide(guide, dir) }
     end
 
-    # Modified each_item that also loads HTML for each guide
-    def each_item
-      super do |guide|
-        # Load the guide if not loaded
-        guide[:html] = load_guide(guide) if guide[:html] == nil
-        # Pass guide to block if it was successfully loaded.
-        yield guide if guide[:html]
+    def load_all_guides
+      each_item do |guide|
+        guide[:html] = load_guide(guide)
       end
     end
 
     # Modified to_array that excludes the :html from guide nodes
     def to_array
-      @groups.map do |group|
-        {
-          "title" => group["title"],
-          "items" => group["items"].map {|g| Hash[g.select {|k, v| k != :html }] }
-        }
+      map_items do |item|
+        Hash[item.select {|k, v| k != :html }]
       end
     end
 
     def load_guide(guide)
       in_dir = @path + "/guides/" + guide["name"]
 
-      return Logger.instance.warn(:guide, "Guide not found", in_dir) unless File.exists?(in_dir)
+      return Logger.warn(:guide, "Guide not found", in_dir) unless File.exists?(in_dir)
 
       guide_file = in_dir + "/README.md"
 
-      return Logger.instance.warn(:guide, "Guide not found", guide_file) unless File.exists?(guide_file)
+      return Logger.warn(:guide, "Guide not found", guide_file) unless File.exists?(guide_file)
 
       begin
         @formatter.doc_context = {:filename => guide_file, :linenr => 0}
         name = File.basename(in_dir)
         @formatter.img_path = "guides/#{name}"
 
-        return add_toc(guide, @formatter.format(JsDuck::IO.read(guide_file)))
+        return add_toc(guide, @formatter.format(Util::IO.read(guide_file)))
       rescue
-        Logger.instance.fatal_backtrace("Error while reading/formatting guide #{in_dir}", $!)
+        Logger.fatal_backtrace("Error while reading/formatting guide #{in_dir}", $!)
         exit(1)
       end
     end
@@ -82,14 +76,14 @@ module JsDuck
       in_dir = @path + "/guides/" + guide["name"]
       out_dir = dir + "/" + guide["name"]
 
-      Logger.instance.log("Writing guide", out_dir)
+      Logger.log("Writing guide", out_dir)
       # Copy the whole guide dir over
       FileUtils.cp_r(in_dir, out_dir)
 
       # Ensure the guide has an icon
       fix_icon(out_dir)
 
-      JsonDuck.write_jsonp(out_dir+"/README.js", guide["name"], {:guide => guide[:html], :title => guide["title"]})
+      Util::Json.write_jsonp(out_dir+"/README.js", guide["name"], {:guide => guide[:html], :title => guide["title"]})
     end
 
     # Ensures the guide dir contains icon.png.
@@ -117,7 +111,7 @@ module JsDuck
       html.each_line do |line|
         if line =~ /^<h2>(.*)<\/h2>$/
           i += 1
-          text = HTML.strip_tags($1)
+          text = Util::HTML.strip_tags($1)
           toc << "<li><a href='#!/guide/#{guide['name']}-section-#{i}'>#{text}</a></li>\n"
           new_html << "<h2 id='#{guide['name']}-section-#{i}'>#{text}</h2>\n"
         else
@@ -136,23 +130,31 @@ module JsDuck
     end
 
     # Returns HTML listing of guides
-    def to_html
+    def to_html(style="")
       html = @groups.map do |group|
         [
           "<h3>#{group['title']}</h3>",
           "<ul>",
-          group["items"].map {|g| "<li><a href='#!/guide/#{g['name']}'>#{g['title']}</a></li>" },
+          flatten_subgroups(group["items"]).map {|g| "<li><a href='#!/guide/#{g['name']}'>#{g['title']}</a></li>" },
           "</ul>",
         ]
       end.flatten.join("\n")
 
       return <<-EOHTML
-        <div id='guides-content' style='display:none'>
+        <div id='guides-content' style='#{style}'>
             #{html}
         </div>
       EOHTML
     end
 
+    def flatten_subgroups(items)
+      result = []
+      each_item(items) do |item|
+        result << item
+      end
+      result
+    end
+
     # Extracts guide icon URL from guide hash
     def icon_url(guide)
       "guides/" + guide["name"] + "/icon.png"

data/lib/jsduck/icons.rb

@@ -9,10 +9,21 @@ module JsDuck
           :name => cls[:name],
           :extends => cls[:extends],
           :private => cls[:private],
-          :icon => cls.icon,
+          :icon => Icons::class_icon(cls),
         }
       end
     end
+
+    # Returns CSS class name for an icon of class
+    def self.class_icon(cls)
+      if cls[:singleton]
+        "icon-singleton"
+      elsif cls.inherits_from?("Ext.Component")
+        "icon-component"
+      else
+        "icon-class"
+      end
+    end
   end
 
 end

data/lib/jsduck/images.rb

@@ -35,7 +35,7 @@ module JsDuck
     def copy(output_dir)
       @images.each_key do |img|
         unless copy_img(img, output_dir)
-          Logger.instance.warn(:image, "Image not found.", img)
+          Logger.warn(:image, "Image not found.", img)
         end
       end
       report_unused
@@ -47,7 +47,7 @@ module JsDuck
         filename = path + "/" + img
         if map.has_key?(filename)
           dest = output_dir + "/" + img
-          Logger.instance.log("Copying image", dest)
+          Logger.log("Copying image", dest)
           FileUtils.makedirs(File.dirname(dest))
           FileUtils.cp(filename, dest)
           # mark file as used.
@@ -62,7 +62,7 @@ module JsDuck
     def report_unused
       @paths.each_pair do |path, map|
         map.each_pair do |img, used|
-          Logger.instance.warn(:image_unused, "Image not used.", img) unless used
+          Logger.warn(:image_unused, "Image not used.", img) unless used
         end
       end
     end

data/lib/jsduck/importer.rb

@@ -1,7 +1,7 @@
-require 'jsduck/json_duck'
-require 'jsduck/null_object'
+require 'jsduck/util/json'
+require 'jsduck/util/null_object'
 require 'jsduck/logger'
-require 'jsduck/parallel_wrap'
+require 'jsduck/util/parallel'
 
 module JsDuck
 
@@ -29,15 +29,15 @@ module JsDuck
     end
 
     def current_version
-      NullObject.new(:[] => NullObject.new(:[] => true))
+      Util::NullObject.new(:[] => Util::NullObject.new(:[] => true))
     end
 
     # Reads in data from all .json files in directory
     def read(ver)
       # Map list of files into pairs of (classname, members-hash)
-      pairs = ParallelWrap.map(Dir[ver[:path] + "/*.json"]) do |filename|
-        JsDuck::Logger.instance.log("Importing #{ver[:version]}", filename)
-        json = JsonDuck.read(filename)
+      pairs = Util::Parallel.map(Dir[ver[:path] + "/*.json"]) do |filename|
+        JsDuck::Logger.log("Importing #{ver[:version]}", filename)
+        json = Util::Json.read(filename)
         [json["name"],  members_id_index(json)]
       end
 

data/lib/jsduck/index_html.rb

@@ -1,5 +1,5 @@
 require 'jsduck/logger'
-require 'jsduck/io'
+require 'jsduck/util/io'
 require 'fileutils'
 
 module JsDuck
@@ -17,8 +17,10 @@ module JsDuck
     def write
       if @opts.seo
         FileUtils.cp(@opts.template_dir+"/index.php", @opts.output_dir+"/index.php")
+        FileUtils.cp(@opts.template_dir+"/Mobile_Detect.php", @opts.output_dir+"/Mobile_Detect.php")
         create_template_html(@opts.template_dir+"/template.html", @opts.output_dir+"/template.html")
         create_print_template_html(@opts.template_dir+"/print-template.html", @opts.output_dir+"/print-template.html")
+        create_index_template_html(@opts.template_dir+"/index-template.html", @opts.output_dir+"/index-template.html")
       else
         create_template_html(@opts.template_dir+"/template.html", @opts.output_dir+"/index.html")
       end
@@ -32,9 +34,9 @@ module JsDuck
         "{header}" => @opts.header,
         "{footer}" => "<div id='footer-content' style='display: none'>#{@opts.footer}</div>",
         "{extjs_path}" => @opts.extjs_path,
-        "{welcome}" => @assets.welcome.to_html,
-        "{categories}" => @assets.categories.to_html,
-        "{guides}" => @assets.guides.to_html,
+        "{welcome}" => @assets.welcome.to_html("display:none"),
+        "{categories}" => @assets.categories.to_html("display:none"),
+        "{guides}" => @assets.guides.to_html("display:none"),
         "{head_html}" => @opts.head_html,
         "{body_html}" => @opts.body_html,
       })
@@ -47,10 +49,22 @@ module JsDuck
       })
     end
 
+    def create_index_template_html(in_file, out_file)
+      categories = @assets.categories.to_html
+      guides = @assets.guides.to_html
+
+      write_template(in_file, out_file, {
+        "{title}" => @opts.title,
+        "{header}" => @opts.header,
+        "{categories}" => categories ? "<h1>API Documentation</h1> #{categories}" : "",
+        "{guides}" => guides ? "<h1>Guides</h1> #{guides}" : "",
+      })
+    end
+
     # Opens in_file, replaces {keys} inside it, writes to out_file
     def write_template(in_file, out_file, replacements)
-      Logger.instance.log("Writing", out_file)
-      html = JsDuck::IO.read(in_file)
+      Logger.log("Writing", out_file)
+      html = Util::IO.read(in_file)
       html.gsub!(/\{\w+\}/) do |key|
         replacements[key] ? replacements[key] : key
       end

data/lib/jsduck/inherit_doc.rb

@@ -20,7 +20,7 @@ module JsDuck
             resolve(member, new_cfgs)
           end
         end
-        move_cfgs(cls, new_cfgs)
+        move_cfgs(cls, new_cfgs) if new_cfgs.length > 0
       end
     end
 
@@ -52,12 +52,9 @@ module JsDuck
     def move_cfgs(cls, members)
       members.each do |m|
         m[:tagname] = :cfg
-        cls[:members][:property].delete(m)
-        cls[:members][:cfg] << m
       end
-      # The members lookup table inside class is no more valid, so
-      # reset it.
-      cls.reset_members_lookup!
+      # Ask class to update its internal caches for these members
+      cls.update_members!(members)
     end
 
     # For auto-detected members/classes (which have @private == :inherit)
@@ -75,6 +72,7 @@ module JsDuck
     #
     # If the parent also has @inheritdoc, continues recursively.
     def find_parent(m)
+
       inherit = m[:inheritdoc] || {}
       if inherit[:cls]
         # @inheritdoc MyClass#member
@@ -120,7 +118,6 @@ module JsDuck
         end
       end
 
-      #pp parent[:doc]
       return parent[:inheritdoc] ? find_parent(parent) : parent
     end
 
@@ -134,8 +131,8 @@ module JsDuck
         # Auto-detected properties can override either a property or a
         # config. So look for both types.
         if tagname == :property
-          cfg = cls.get_members(name, :cfg, static || false)[0]
-          prop = cls.get_members(name, :property, static || false)[0]
+          cfg = cls.find_members(:name => name, :tagname => :cfg, :static => static || false)[0]
+          prop = cls.find_members(:name => name, :tagname => :property, :static => static || false)[0]
 
           if cfg && prop
             prop
@@ -150,10 +147,10 @@ module JsDuck
         else
           # Unless the auto-detected member is detected as static,
           # look only at instance members.
-          cls.get_members(name, tagname, static || false)[0]
+          cls.find_members(:name => name, :tagname => tagname, :static => static || false)[0]
         end
       else
-        cls.get_members(name, tagname, static)[0]
+        cls.find_members(:name => name, :tagname => tagname, :static => static)[0]
       end
     end
 
@@ -185,7 +182,7 @@ module JsDuck
       i_member = item[:inheritdoc][:member]
 
       msg = "@inheritdoc #{item[:inheritdoc][:cls]}"+ (i_member ? "#" + i_member : "") + " - " + msg
-      Logger.instance.warn(:inheritdoc, msg, context[:filename], context[:linenr])
+      Logger.warn(:inheritdoc, msg, context[:filename], context[:linenr])
 
       return nil
     end