jsduck 4.9.0 → 4.10.0

data/Rakefile

@@ -159,6 +159,11 @@ class JsDuckRunner
     add_options("--comments-domain", db_name+"/"+version)
   end
 
+  def add_search(product, version)
+    add_options("--search-url", "http://support-test.sencha.com:8080/docsearch/search")
+    add_options("--search-domain", product+"/"+version)
+  end
+
   def add_ext4
     @options += [
       "--title", "Sencha Docs - Ext JS 4.0",
@@ -261,6 +266,7 @@ task :sdk => :sass do
   )
   runner.add_debug
   runner.add_comments('ext-js', '4')
+  runner.add_search('Ext JS', '4.2.0')
   runner.run
 
   system("ln -s #{EXT_BUILD} #{OUT_DIR}/extjs-build")

data/jsduck.gemspec

@@ -2,7 +2,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'jsduck'
-  s.version = '4.9.0'
+  s.version = '4.10.0'
   s.date = Time.new.strftime('%Y-%m-%d')
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"

data/lib/jsduck/app_data.rb

@@ -21,7 +21,8 @@ module JsDuck
           :guides => @assets.guides.to_array,
           :videos => @assets.videos.to_array,
           :examples => @assets.examples.to_array,
-          :search => SearchData.new.create(@relations.classes, @assets),
+          :search => SearchData.new.create(@relations.classes, @assets, @opts),
+          :guideSearch => @opts.search,
           :tests => @opts.tests,
           :signatures => MetaTagRegistry.instance.signatures,
           :localStorageDb => @opts.local_storage_db,

data/lib/jsduck/guide_anchors.rb

@@ -0,0 +1,32 @@
+module JsDuck
+
+  # Transforms in-page links so they won't break docs app #!-navigation.
+  #
+  # For example a link to "#automation" in testing guide will be
+  # replaced with "#!/guide/testing-section-automation" and the link
+  # target ID will be transformed into "testing-section-automation".
+  class GuideAnchors
+
+    def self.transform(html, guide_name)
+      html.gsub(/(<a\s+(?:[^<>]*\s+)?href=['"]#)([^!].*?)(['"])/i) do |m|
+        "#{$1}!/guide/#{guide_name}-section-#{$2}#{$3}"
+
+      end.gsub(/(<a\s+(?:[^<>]*\s+)?name=['"])(.*?)(['"])/i) do |m|
+        $1 + transform_id($2, guide_name) + $3
+
+      end.gsub(/(<\w+\s+(?:[^<>]*\s+)?id=['"])(.*?)(['"])/i) do |m|
+        $1 + transform_id($2, guide_name) + $3
+      end
+    end
+
+    def self.transform_id(id, guide_name)
+      if id =~ /^#{guide_name}-section-/
+        id
+      else
+        "#{guide_name}-section-#{id}"
+      end
+    end
+
+  end
+
+end

data/lib/jsduck/guide_toc.rb

@@ -0,0 +1,49 @@
+require 'jsduck/util/html'
+
+module JsDuck
+
+  # Adds Table of Contents section to guide HTML.
+  class GuideToc
+
+    # Inserts table of contents at the top of guide HTML by looking
+    # for <h2> elements.
+    def self.inject(html, guide_name)
+      toc = []
+      new_html = []
+
+      html.each_line do |line|
+        if line =~ /^\s*<(h[1-6])>(.*?)<\/h[1-6]>$/
+          tag = $1
+          text = Util::HTML.strip_tags($2)
+          id = guide_name + "-section-" + title_to_id(text)
+          if tag == "h2"
+            toc << "<li><a href='#!/guide/#{id}'>#{text}</a></li>\n"
+          end
+          new_html << "<#{tag} id='#{id}'>#{text}</#{tag}>\n"
+        else
+          new_html << line
+        end
+      end
+
+      # Inject TOC below first heading if at least 2 items in TOC
+      if toc.length >= 2
+        new_html.insert(1, [
+            "<div class='toc'>\n",
+            "<p><strong>Contents</strong></p>\n",
+            "<ol>\n",
+            toc,
+            "</ol>\n",
+            "</div>\n",
+        ])
+      end
+
+      new_html.flatten.join
+    end
+
+    def self.title_to_id(title)
+      title.downcase.gsub(/[^\w]+/, "-")
+    end
+
+  end
+
+end

data/lib/jsduck/guides.rb

@@ -4,7 +4,8 @@ require 'jsduck/util/io'
 require 'jsduck/util/null_object'
 require 'jsduck/logger'
 require 'jsduck/grouped_asset'
-require 'jsduck/util/html'
+require 'jsduck/guide_toc'
+require 'jsduck/guide_anchors'
 require 'jsduck/img/dir'
 require 'fileutils'
 
@@ -67,7 +68,9 @@ module JsDuck
     def format_guide(guide)
       @formatter.doc_context = {:filename => guide[:filename], :linenr => 0}
       @formatter.images = Img::Dir.new(guide["url"], "guides/#{guide["name"]}")
-      html = add_toc(guide, @formatter.format(Util::IO.read(guide[:filename])))
+      html = @formatter.format(Util::IO.read(guide[:filename]))
+      html = GuideToc.inject(html, guide['name'])
+      html = GuideAnchors.transform(html, guide['name'])
 
       # Report unused images (but ignore the icon files)
       @formatter.images.get("icon.png")
@@ -115,36 +118,6 @@ module JsDuck
       end
     end
 
-    # Creates table of contents at the top of guide by looking for <h2> elements in HTML.
-    def add_toc(guide, html)
-      toc = [
-        "<div class='toc'>\n",
-        "<p><strong>Contents</strong></p>\n",
-        "<ol>\n",
-      ]
-      new_html = []
-      i = 0
-      html.each_line do |line|
-        if line =~ /^<h2>(.*)<\/h2>$/
-          i += 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
-          new_html << line
-        end
-      end
-      toc << "</ol>\n"
-      toc << "</div>\n"
-      # Inject TOC at below first heading if at least 2 items in TOC
-      if i >= 2
-        new_html.insert(1, toc)
-        new_html.flatten.join
-      else
-        html
-      end
-    end
-
     # Returns HTML listing of guides
     def to_html(style="")
       html = @groups.map do |group|

data/lib/jsduck/options.rb

@@ -40,6 +40,7 @@ module JsDuck
     attr_accessor :tests
     attr_accessor :comments_url
     attr_accessor :comments_domain
+    attr_accessor :search
     attr_accessor :ignore_html
 
     # Debugging
@@ -93,7 +94,7 @@ module JsDuck
       @ext4_events = nil
       @meta_tag_paths = []
 
-      @version = "4.9.0"
+      @version = "4.10.0"
 
       # Customizing output
       @title = "Documentation - JSDuck"
@@ -120,6 +121,7 @@ module JsDuck
       @tests = false
       @comments_url = nil
       @comments_domain = nil
+      @search = {}
       @ignore_html = {}
 
       # Debugging
@@ -426,6 +428,8 @@ module JsDuck
         end
 
         opts.on('--comments-domain=STRING',
+          "A name identifying the subset of comments.",
+          "",
           "A string consisting of <name>/<version>.",
           "",
           "For example: ext-js/4",
@@ -434,6 +438,37 @@ module JsDuck
           @comments_domain = domain
         end
 
+        opts.on('--search-url=URL',
+          "Address of guides search server.",
+          "",
+          "When supplied, the search for guides is performed through this",
+          "external service and the results merged together with API search.",
+          "The search server must respond to JSONP requests.",
+          "",
+          "For example: http://sencha.com/docsearch",
+          "",
+          "Must be used together with --search-domain option.",
+          "",
+          "This option is EXPERIMENTAL.") do |url|
+          @search[:url] = url
+        end
+
+        opts.on('--search-domain=STRING',
+          "A name identifying the subset to search from.",
+          "",
+          "A string consisting of <name>/<version>.",
+          "",
+          "Tells the search engine which product and version",
+          "to include into search.",
+          "",
+          "For example: Ext JS/4.2.0",
+          "",
+          "Must be used together with --search-url option.",
+          "",
+          "This option is EXPERIMENTAL.") do |domain|
+          @search[:product], @search[:version] = domain.split(/\//)
+        end
+
         opts.separator ""
         opts.separator "Tweaking:"
         opts.separator ""

data/lib/jsduck/search_data.rb

@@ -8,7 +8,7 @@ module JsDuck
   class SearchData
     # 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|
@@ -30,7 +30,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) }
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 4.9.0
+  version: 4.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-03 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
@@ -224,6 +224,8 @@ files:
 - lib/jsduck/file_categories.rb
 - lib/jsduck/function_ast.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/html_stack.rb
@@ -673,10 +675,10 @@ 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-0b00cb36fe5624b12d5a495c4289e5d9.js
 - template-min/eg-iframe.html
-- template-min/app-baf1b533a51447e178d66adecf5e85d4.js
 - template-min/index.php
-- template-min/resources/css/app-44f34022ca84128086b28c375ab02185.css
+- template-min/resources/css/app-c8e1f59f40e720cb5379f7041379119a.css
 - template-min/resources/images/link-green-standard.png
 - template-min/resources/images/class-m.png
 - template-min/resources/images/singleton-m.png