jsduck 4.0.1 → 4.1.1

data/lib/jsduck/welcome.rb

@@ -1,5 +1,5 @@
-require 'jsduck/null_object'
-require 'jsduck/io'
+require 'jsduck/util/null_object'
+require 'jsduck/util/io'
 
 module JsDuck
 
@@ -9,18 +9,18 @@ module JsDuck
       if filename
         Welcome.new(filename)
       else
-        NullObject.new(:to_html => "")
+        Util::NullObject.new(:to_html => "")
       end
     end
 
     # Parses welcome HTML file with content for welcome page.
     def initialize(filename)
-      @html = JsDuck::IO.read(filename)
+      @html = Util::IO.read(filename)
     end
 
     # Returns the HTML
-    def to_html
-      "<div id='welcome-content' style='display:none'>#{@html}</div>"
+    def to_html(style="")
+      "<div id='welcome-content' style='#{style}'>#{@html}</div>"
     end
 
   end

data/spec/class_factory.rb

@@ -0,0 +1,20 @@
+require "jsduck/class"
+
+# A helper for easy creation of classes in tests
+#
+# Allows simplified members hashes to be used.
+module Helper
+  class ClassFactory
+    def self.create(cfg)
+      cfg[:members].each do |m|
+        m[:tagname] = :property unless m[:tagname]
+        m[:owner] = cfg[:name]
+        m[:meta] = {} unless m[:meta]
+        m[:meta][:static] = true if m[:static]
+        m[:id] = JsDuck::Class.member_id(m)
+      end
+
+      JsDuck::Class.new(cfg)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2012-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -150,17 +150,18 @@ files:
 - jsduck.gemspec
 - lib/jsduck/accessors.rb
 - lib/jsduck/aggregator.rb
-- lib/jsduck/api_exporter.rb
 - lib/jsduck/app.rb
 - lib/jsduck/app_data.rb
-- lib/jsduck/app_exporter.rb
 - lib/jsduck/assets.rb
 - lib/jsduck/ast.rb
 - lib/jsduck/auto_categories.rb
+- lib/jsduck/batch_formatter.rb
+- lib/jsduck/batch_parser.rb
 - lib/jsduck/categories.rb
 - lib/jsduck/class.rb
 - lib/jsduck/class_doc_expander.rb
 - lib/jsduck/class_formatter.rb
+- lib/jsduck/class_name.rb
 - lib/jsduck/class_writer.rb
 - lib/jsduck/css_lexer.rb
 - lib/jsduck/css_parser.rb
@@ -172,48 +173,47 @@ files:
 - lib/jsduck/esprima.rb
 - lib/jsduck/evaluator.rb
 - lib/jsduck/examples.rb
-- lib/jsduck/examples_exporter.rb
+- lib/jsduck/export_writer.rb
+- lib/jsduck/exporter/app.rb
+- lib/jsduck/exporter/examples.rb
+- lib/jsduck/exporter/full.rb
 - lib/jsduck/file_categories.rb
-- lib/jsduck/full_exporter.rb
+- lib/jsduck/function_ast.rb
 - lib/jsduck/grouped_asset.rb
 - lib/jsduck/guide_writer.rb
 - lib/jsduck/guides.rb
-- lib/jsduck/html.rb
 - lib/jsduck/icons.rb
 - lib/jsduck/images.rb
 - lib/jsduck/importer.rb
 - lib/jsduck/index_html.rb
 - lib/jsduck/inherit_doc.rb
+- lib/jsduck/inline/example.rb
+- lib/jsduck/inline/img.rb
+- lib/jsduck/inline/link.rb
+- lib/jsduck/inline/video.rb
 - lib/jsduck/inline_examples.rb
-- lib/jsduck/inline_img.rb
-- lib/jsduck/inline_video.rb
-- lib/jsduck/io.rb
 - lib/jsduck/js_parser.rb
-- lib/jsduck/json_duck.rb
-- lib/jsduck/lexer.rb
 - lib/jsduck/lint.rb
 - lib/jsduck/logger.rb
+- lib/jsduck/members_index.rb
 - lib/jsduck/merger.rb
 - 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
-- lib/jsduck/os.rb
 - lib/jsduck/override.rb
-- lib/jsduck/parallel_wrap.rb
 - lib/jsduck/relations.rb
 - lib/jsduck/renderer.rb
+- lib/jsduck/return_values.rb
 - lib/jsduck/search_data.rb
 - lib/jsduck/serializer.rb
+- lib/jsduck/shortener.rb
 - lib/jsduck/signature_renderer.rb
-- lib/jsduck/source_file.rb
-- lib/jsduck/source_file_parser.rb
-- lib/jsduck/source_writer.rb
-- lib/jsduck/stats.rb
-- lib/jsduck/stdout.rb
+- lib/jsduck/source/file.rb
+- lib/jsduck/source/file_parser.rb
+- lib/jsduck/source/writer.rb
 - lib/jsduck/tag/abstract.rb
 - lib/jsduck/tag/aside.rb
 - lib/jsduck/tag/author.rb
@@ -235,10 +235,22 @@ files:
 - lib/jsduck/tag/template.rb
 - lib/jsduck/template_dir.rb
 - lib/jsduck/type_parser.rb
+- lib/jsduck/util/html.rb
+- lib/jsduck/util/io.rb
+- lib/jsduck/util/json.rb
+- lib/jsduck/util/null_object.rb
+- lib/jsduck/util/os.rb
+- lib/jsduck/util/parallel.rb
+- lib/jsduck/util/singleton.rb
+- lib/jsduck/util/stdout.rb
 - lib/jsduck/videos.rb
+- lib/jsduck/web_writer.rb
 - lib/jsduck/welcome.rb
+- spec/class_factory.rb
 - template-min/README.md
+- template-min/Mobile_Detect.php
 - template-min/template.html
+- template-min/index-template.html
 - template-min/eg-iframe.html
 - template-min/resources/images/component-m.png
 - template-min/resources/images/expandcollapse.png

data/lib/jsduck/api_exporter.rb

@@ -1,48 +0,0 @@
-require 'jsduck/json_duck'
-require 'jsduck/class'
-
-module JsDuck
-
-  # Exporter for simple JSON format listing only class name and names
-  # of all of its members.
-  #
-  # It produces the following structure:
-  #
-  # {
-  #   :name => "Panel",
-  #   :members => {
-  #     :cfg => ["width", "height", "title"],
-  #     :method => ["getWidth", "setWidth"],
-  #     ...
-  #   },
-  #   :statics => { ... }
-  # }
-  #
-  class ApiExporter
-    def initialize(relations, opts)
-      # All params ignored, they're present to be compatible with
-      # other exporters.
-    end
-
-    # Returns hash of class name and member names
-    def export(cls)
-      {
-        :name => cls[:name],
-        :members => export_members(cls, :members),
-        :statics => export_members(cls, :statics),
-      }
-    end
-
-    private
-
-    def export_members(cls, context)
-      h = {}
-      Class.default_members_hash.each_key do |type|
-        h[type] = cls.members(type, context).map {|m| m[:name] }
-      end
-      h
-    end
-
-  end
-
-end

data/lib/jsduck/app_exporter.rb

@@ -1,60 +0,0 @@
-require 'jsduck/full_exporter'
-require 'jsduck/renderer'
-require 'jsduck/doc_formatter'
-
-module JsDuck
-
-  # Exports data for Docs app.
-  class AppExporter < FullExporter
-    def initialize(relations, opts)
-      super(relations, opts)
-      @renderer = Renderer.new(opts)
-    end
-
-    # Returns compacted class data hash which contains an additional
-    # :html field with full HTML to show on class overview page.
-    def export(cls)
-      data = super(cls)
-      data[:html] = @renderer.render(data)
-      return compact(data)
-    end
-
-    private
-
-    # removes extra data from export
-    def compact(cls)
-      cls.delete(:doc)
-      cls[:members] = compact_members_group(cls[:members])
-      cls[:statics] = compact_members_group(cls[:statics])
-      cls[:files] = compact_files(cls[:files])
-      cls
-    end
-
-    def compact_members_group(group)
-      c_group = {}
-      group.each_pair do |type, members|
-        c_group[type] = members.map {|m| compact_member(m) }
-      end
-      c_group
-    end
-
-    def compact_member(m)
-      m_copy = {}
-      [:name, :tagname, :owner, :meta, :id].each do |key|
-        m_copy[key] = m[key]
-      end
-      m_copy
-    end
-
-    # Remove full path from filename for privacy considerations as the
-    # path can reveal information about the system where JSDuck was
-    # run.  The docs app doesn't need to have this information.
-    def compact_files(files)
-      files.map do |f|
-        {:filename => File.basename(f[:filename]), :href => f[:href]}
-      end
-    end
-
-  end
-
-end

data/lib/jsduck/examples_exporter.rb

@@ -1,56 +0,0 @@
-require 'jsduck/inline_examples'
-
-module JsDuck
-
-  # Exporter for inline examples.
-  #
-  # It produces the following structure:
-  #
-  # {
-  #   :type => :class,  # can also be :guide
-  #   :name => "Panel",
-  #   :examples => [
-  #     {:code => "bla bla", :options => {}},
-  #     {:code => "bla bla", :options => {"raw" => true}},
-  #     ...
-  #   ]
-  # }
-  #
-  class ExamplesExporter
-    def initialize(relations, opts)
-      # All params ignored, they're present to be compatible with
-      # other exporters.
-      @inline_examples = InlineExamples.new
-    end
-
-    # Returns hash of class name and inline examples
-    def export(cls)
-      examples = @inline_examples.extract(cls[:doc])
-      if examples.length > 0
-        {
-          :type => :class,
-          :name => cls[:name],
-          :examples => examples,
-        }
-      else
-        nil
-      end
-    end
-
-    # Returns hash of guide name and inline examples
-    def export_guide(guide)
-      examples = @inline_examples.extract(guide[:html] || "")
-      if examples.length > 0
-        {
-          :type => :guide,
-          :name => guide["name"],
-          :examples => examples,
-        }
-      else
-        nil
-      end
-    end
-
-  end
-
-end

data/lib/jsduck/full_exporter.rb

@@ -1,35 +0,0 @@
-require 'jsduck/class'
-
-module JsDuck
-
-  # Exporter for all the class docs.
-  class FullExporter
-    def initialize(relations, opts)
-      @relations = relations
-      # opts parameter is here just for compatibility with other exporters
-    end
-
-    # Returns all data in Class object as hash.
-    def export(cls)
-      h = cls.to_hash
-      h[:members] = {}
-      Class.default_members_hash.each_key do |key|
-        h[:members][key] = cls.members(key)
-        h[:statics][key] = cls.members(key, :statics)
-      end
-      h[:component] = cls.inherits_from?("Ext.Component")
-      h[:superclasses] = cls.superclasses.collect {|c| c.full_name }
-      h[:subclasses] = @relations.subclasses(cls).collect {|c| c.full_name }
-      h[:mixedInto] = @relations.mixed_into(cls).collect {|c| c.full_name }
-
-      h[:mixins] = cls.deps(:mixins).collect {|c| c.full_name }
-      h[:parentMixins] = cls.parent_deps(:mixins).collect {|c| c.full_name }
-      h[:requires] = cls.deps(:requires).collect {|c| c.full_name }
-      h[:uses] = cls.deps(:uses).collect {|c| c.full_name }
-
-      h
-    end
-
-  end
-
-end

data/lib/jsduck/html.rb

@@ -1,25 +0,0 @@
-require 'cgi'
-
-module JsDuck
-
-  # Helpers for dealing with HTML
-  class HTML
-
-    # Strips tags from HTML text
-    def self.strip_tags(html)
-      html.gsub(/<.*?>/, "")
-    end
-
-    # Escapes HTML, replacing < with &lt; ...
-    def self.escape(html)
-      CGI.escapeHTML(html)
-    end
-
-    # Unescapes HTML, replacing &lt; with < ...
-    def self.unescape(html)
-      CGI.unescapeHTML(html)
-    end
-
-  end
-
-end

data/lib/jsduck/inline_img.rb

@@ -1,53 +0,0 @@
-require 'jsduck/html'
-require 'jsduck/logger'
-
-module JsDuck
-
-  # Implementation of inline tag {@img}
-  class InlineImg
-    # Base path to prefix images from {@img} tags.
-    # Defaults to no prefix.
-    attr_accessor :base_path
-
-    # This will hold list of all image paths gathered from {@img} tags.
-    attr_accessor :images
-
-    def initialize(opts={})
-      @tpl = opts[:img_tpl] || '<img src="%u" alt="%a"/>'
-
-      @re = /\{@img\s+(\S*?)(?:\s+(.+?))?\}/m
-
-      @base_path = nil
-      @images = []
-    end
-
-    # Takes StringScanner instance.
-    #
-    # Looks for inline tag at the current scan pointer position, when
-    # found, moves scan pointer forward and performs the apporpriate
-    # replacement.
-    def replace(input)
-      if input.check(@re)
-        input.scan(@re).sub(@re) { apply_tpl($1, $2) }
-      else
-        false
-      end
-    end
-
-    # applies the image template
-    def apply_tpl(url, alt_text)
-      @images << url
-      @tpl.gsub(/(%\w)/) do
-        case $1
-        when '%u'
-          @base_path ? (@base_path + "/" + url) : url
-        when '%a'
-          HTML.escape(alt_text||"")
-        else
-          $1
-        end
-      end
-    end
-  end
-
-end