jsduck 3.9.1 → 3.10.0

data/README.md

@@ -126,8 +126,10 @@ Thanks to [Ondřej Jirman](https://github.com/megous),
 [Ed Spencer](https://github.com/edspencer),
 [atian25](https://github.com/atian25),
 Katherine Chu,
-[Rob Dougan](https://github.com/rdougan) and many-many others who
-reported bugs, submitted patches, and provided a lot of useful input.
+[Rob Dougan](https://github.com/rdougan),
+[Dave Thompson](https://github.com/limscoder),
+and many-many others who reported bugs, submitted patches, and
+provided a lot of useful input.
 
 
 Changelog

data/Rakefile

@@ -19,20 +19,14 @@ def load_sdk_vars
     puts
     puts "Please create file sdk-vars.rb and define in it:"
     puts
-    puts "    # path to Ext JS 4 build"
-    puts "    EXT_BUILD='/path/to/ext-4.0.7'"
-    puts "    # path to Touch 2 build"
-    puts "    TOUCH_BUILD='/path/to/touch-2.0.0'"
     puts "    # where to output the docs"
     puts "    OUT_DIR='/path/to/ouput/dir'"
+    puts "    # path to Ext JS 4 build"
+    puts "    EXT_BUILD='/path/to/ext-4'"
+    puts "    # path to Touch 2 build"
+    puts "    TOUCH_BUILD='/path/to/touch-2'"
     puts "    # path to SDK (for developers at Sencha)"
     puts "    SDK_DIR='/path/to/SDK'"
-    puts "    # paths to other projects (for developers at Sencha)"
-    puts "    ANIMATOR_DIR='/path/to/Animator'"
-    puts "    ARCHITECT_DIR='/path/to/Architect'"
-    puts "    SENCHAIO_DIR='/path/to/IO'"
-    puts "    EXT3_DIR='/path/to/ext3'"
-    puts "    EXT2_DIR='/path/to/ext2'"
     exit 1
   end
 end
@@ -147,7 +141,7 @@ class JsDuckRunner
     load_sdk_vars
   end
 
-  def add_options(options)
+  def add_options(*options)
     @options += options
   end
 
@@ -167,25 +161,13 @@ class JsDuckRunner
     EOHTML
   end
 
-  # For export of ExtJS, reference extjs from the parent dir
-  def make_extjs_path_relative
-    ["#{OUT_DIR}/index.html"].each do |file|
-      out = []
-      IO.read(file).each_line do |line|
-        out << line.sub(/(src|href)="extjs\//, '\1="../')
-      end
-      File.open(file, 'w') {|f| f.write(out) }
-    end
-    system "rm -rf #{OUT_DIR}/extjs"
-  end
-
   def add_ext4
     @options += [
       "--title", "Sencha Docs - Ext JS 4.0",
       "--footer", "Ext JS 4.0 Docs - Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> {VERSION}." +
                   " <a href='http://www.sencha.com/legal/terms-of-use/'>Terms of Use</a>",
       "--ignore-global",
-      "--no-warnings",
+      "--warnings", "-all",
       "--images", "#{EXT_BUILD}/docs/doc-resources",
       "--local-storage-db", "ext-4",
       "--output", "#{OUT_DIR}",
@@ -193,14 +175,6 @@ class JsDuckRunner
     ]
   end
 
-  def add_phone_redirect
-    @options += ["--body-html", <<-EOHTML]
-      <script type="text/javascript">
-        if (Ext.is.Phone) { window.location = "../examples/"; }
-      </script>
-    EOHTML
-  end
-
   def add_debug
     @options += [
       "--extjs-path", "extjs/ext-all-debug.js",
@@ -209,121 +183,6 @@ class JsDuckRunner
     ]
   end
 
-  def add_seo
-    @options += [
-      "--seo",
-    ]
-  end
-
-  def add_export_notice path
-    @options += [
-      "--body-html", <<-EOHTML
-      <div id="notice-text" style="display: none">
-        Use <a href="http://docs.sencha.com/#{path}">http://docs.sencha.com/#{path}</a> for up to date documentation and features
-      </div>
-      EOHTML
-    ]
-  end
-
-  def add_google_analytics
-    @options += [
-      "--body-html", <<-EOHTML
-      <script type="text/javascript">
-        var _gaq = _gaq || [];
-        _gaq.push(['_setAccount', 'UA-1396058-10']);
-        _gaq.push(['_trackPageview']);
-        (function() {
-          var ga = document.createElement('script');
-          ga.type = 'text/javascript';
-          ga.async = true;
-          ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
-          var s = document.getElementsByTagName('script')[0];
-          s.parentNode.insertBefore(ga, s);
-        })();
-
-        Docs.initEventTracking = function() {
-            Docs.App.getController('Classes').addListener({
-                showClass: function(cls) {
-                    _gaq.push(['_trackEvent', 'Classes', 'Show', cls]);
-                },
-                showMember: function(cls, anchor) {
-                    _gaq.push(['_trackEvent', 'Classes', 'Member', cls + ' - ' + anchor]);
-                }
-            });
-            Docs.App.getController('Guides').addListener({
-                showGuide: function(guide) {
-                    _gaq.push(['_trackEvent', 'Guides', 'Show', guide]);
-                }
-            });
-            Docs.App.getController('Videos').addListener({
-                showVideo: function(video) {
-                    _gaq.push(['_trackEvent', 'Video', 'Show', video]);
-                }
-            });
-            Docs.App.getController('Examples').addListener({
-                showExample: function(example) {
-                    _gaq.push(['_trackEvent', 'Example', 'Show', example]);
-                }
-            });
-        }
-
-        Docs.otherProducts = [
-          {
-              text: 'Ext JS 4.1',
-              href: 'http://docs.sencha.com/ext-js/4-1'
-          },
-          {
-              text: 'Ext JS 4.0',
-              href: 'http://docs.sencha.com/ext-js/4-0'
-          },
-          {
-              text: 'Ext JS 3',
-              href: 'http://docs.sencha.com/ext-js/3-4'
-          },
-          {
-              text: 'Ext JS 2',
-              href: 'http://docs.sencha.com/ext-js/2-3'
-          },
-          {
-              text: 'Sencha Touch 2',
-              href: 'http://docs.sencha.com/touch/2-0'
-          },
-          {
-              text: 'Sencha Touch 1',
-              href: 'http://docs.sencha.com/touch/1-1'
-          },
-          {
-              text: 'Touch Charts',
-              href: 'http://docs.sencha.com/touch-charts/1-0'
-          },
-          {
-              text: 'Sencha Animator',
-              href: 'http://docs.sencha.com/animator/1-0'
-          },
-          {
-              text: 'Sencha Architect',
-              href: 'http://docs.sencha.com/arhitect/2-0'
-          },
-          {
-              text: 'Sencha.io',
-              href: 'http://docs.sencha.com/io/1-0'
-          }
-        ];
-      </script>
-    EOHTML
-    ]
-
-  end
-
-  def copy_extjs_build
-    system "cp -r #{EXT_BUILD} #{OUT_DIR}/extjs-build"
-  end
-
-  # Copy over Sencha Touch
-  def copy_touch2_build
-    system "cp -r #{TOUCH_BUILD} #{OUT_DIR}/touch"
-  end
-
   def run
     # Pass multiple arguments to system, so we'll take advantage of the built-in escaping
     system(*["ruby", "bin/jsduck"].concat(@options))
@@ -335,226 +194,68 @@ task :sass do
   system "compass compile --quiet template/resources/sass"
 end
 
-desc "Run JSDuck on Ext JS SDK (for internal use at Sencha)\n" +
-     "sdk         - creates debug/development version\n" +
-     "sdk[export] - creates export version\n" +
-     "sdk[live]   - create live version for deployment\n"
-task :sdk, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export", "live"].include?(mode)
-  compress if mode == "export" || mode == "live"
-
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{SDK_DIR}/extjs/docs/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_export_notice("ext-js/4-0") if mode == "export"
-  runner.add_google_analytics if mode == "live"
-  runner.add_comments('ext-js', '4') if mode == "debug" || mode == "live"
-  if mode == "export"
-    runner.add_options ["--eg-iframe", "#{SDK_DIR}/extjs/docs/eg-iframe-build.html"]
-    runner.add_options ["--examples-base-url", "../examples/"]
-  else
-    runner.add_options ["--examples-base-url", "extjs-build/examples/"]
-  end
-  runner.run
-
-  if mode == "export"
-    runner.make_extjs_path_relative
-  else
-    runner.copy_extjs_build
-  end
+desc "Build JSDuck gem"
+task :gem => :sass do
+  compress
+  system "gem build jsduck.gemspec"
 end
 
 desc "Run JSDuck on Docs app itself"
 task :docs do
   runner = JsDuckRunner.new
   runner.add_ext4
-  runner.add_options([
+  runner.add_options(
     "--builtin-classes",
     "template/app"
-  ])
+  )
   runner.add_debug
-  runner.add_seo
   runner.run
 end
 
-desc "Run JSDuck on official Ext JS 4.0.2a build\n" +
-     "ext4             - creates debug/development version\n" +
-     "ext4[export]     - creates export/deployable version\n"
-task :ext4, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export"].include?(mode)
-  compress if mode == "export"
-
+desc "Run JSDuck on official Ext JS 4 build"
+task :ext4 => :sass do
   runner = JsDuckRunner.new
   runner.add_ext4
-  runner.add_debug if mode == "debug"
-  runner.add_seo
-  runner.run
-end
-
-desc "Run JSDuck on official Ext JS 3.4 build\n" +
-     "ext3             - creates debug/development version\n" +
-     "ext3[export]     - creates export/deployable version\n"
-     "ext3[live]       - creates live version for deployment\n"
-task :ext3, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export", "live"].include?(mode)
-  compress if mode == "export"
-
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{EXT3_DIR}/src/doc-config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "live"
-  runner.add_google_analytics if mode == "live"
-  runner.run
-end
-
-desc "Run JSDuck on official Ext JS 2.3 build\n" +
-     "ext2             - creates debug/development version\n" +
-     "ext2[export]     - creates export/deployable version\n"
-     "ext2[live]       - creates live version for deployment\n"
-task :ext2, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export", "live"].include?(mode)
-  compress if mode == "export"
-
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{EXT2_DIR}/doc-config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "live"
-  runner.add_google_analytics if mode == "live"
+  runner.add_debug
+  runner.add_options("--tests")
   runner.run
-end
-
-desc "Run JSDuck on Sencha Touch (for internal use at Sencha)\n" +
-     "touch       - creates debug/development version\n" +
-     "touch[live] - create live version for deployment\n"
-task :touch, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "live"].include?(mode)
-  compress if mode == "live"
 
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{SDK_DIR}/touch/doc-resources/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_google_analytics if mode == "live"
-  runner.run
+  system("cp -r #{EXT_BUILD} #{OUT_DIR}/extjs-build")
 end
 
-desc "Run JSDuck on Sencha Touch 2 (for internal use at Sencha)\n" +
-     "touch2         - creates debug/development version\n" +
-     "touch2[export] - creates export version\n" +
-     "touch2[live]   - create live version for deployment\n"
-task :touch2, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export", "live"].include?(mode)
-  compress if mode == "live" || mode == "export"
-
+desc "Run JSDuck on Ext JS from SDK repo (for internal use at Sencha)"
+task :sdk => :sass do
   runner = JsDuckRunner.new
-  runner.add_options [
+  runner.add_options(
     "--output", OUT_DIR,
-    "--config", "#{SDK_DIR}/touch/docs/config.json"
-  ]
-
-  if mode == "export"
-    runner.add_export_notice("touch/2-0")
-    runner.add_phone_redirect
-    # override settings in config.json
-    runner.add_options [
-      "--welcome", "#{SDK_DIR}/touch/docs/build-welcome.html",
-      "--eg-iframe", "#{SDK_DIR}/touch/docs/build-eg-iframe.html",
-      "--examples-base-url", "../examples/",
-    ]
-  else
-    runner.add_options ["--examples-base-url", "touch/examples/production/"]
-  end
-
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_google_analytics if mode == "live"
-  runner.add_comments('touch', '2') if mode == "debug" || mode == "live"
-  runner.run
-
-  runner.copy_touch2_build if mode != "export"
-end
-
-desc "Run JSDuck on Sencha Touch Charts (for internal use at Sencha)\n" +
-     "charts         - creates debug/development version\n" +
-     "charts[export] - create live version for deployment\n"
-     "charts[live]   - create live version for deployment\n"
-task :charts, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export", "live"].include?(mode)
-  compress if mode == "live"
-
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{SDK_DIR}/charts/docs/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_google_analytics if mode == "live"
+    "--config", "#{SDK_DIR}/extjs/docs/config.json",
+    "--examples-base-url", "extjs-build/examples/",
+    "--seo",
+    "--tests"
+  )
+  runner.add_debug
+  runner.add_comments('ext-js', '4')
   runner.run
-end
-
-desc "Run JSDuck on Sencha.IO Sync (for internal use at Sencha)\n" +
-     "senchaio         - creates debug/development version\n" +
-     "senchaio[export] - create live version for deployment\n"
-     "senchaio[live]   - create live version for deployment\n"
-task :senchaio, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "export", "live"].include?(mode)
-  compress if mode == "live"
 
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{SENCHAIO_DIR}/docs/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_google_analytics if mode == "live"
-  runner.run
+  system("cp -r #{EXT_BUILD} #{OUT_DIR}/extjs-build")
 end
 
-desc "Run JSDuck on Sencha Animator (for internal use at Sencha)\n" +
-     "animator         - creates debug/development version\n" +
-     "animator[export] - create live version for deployment\n"
-     "animator[live]   - create live version for deployment\n"
-task :animator, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "live", "export"].include?(mode)
-  compress if mode == "live"
-
+desc "Run JSDuck on Sencha Touch 2 repo (for internal use at Sencha)"
+task :touch2 => :sass do
   runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{ANIMATOR_DIR}/docs/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_google_analytics if mode == "live"
-  runner.add_comments('animator', '1') if mode == "debug" || mode == "live"
-  runner.run
-end
-
-desc "Run JSDuck on Sencha Architect (for internal use at Sencha)\n" +
-     "architect         - creates debug/development version\n" +
-     "architect[export] - create live version for deployment\n"
-     "architect[live]   - create live version for deployment\n"
-task :architect, [:mode] => :sass do |t, args|
-  mode = args[:mode] || "debug"
-  throw "Unknown mode #{mode}" unless ["debug", "live", "export"].include?(mode)
-  compress if mode == "live"
+  runner.add_options(
+    "--output", OUT_DIR,
+    "--config", "#{SDK_DIR}/touch/docs/config.json",
+    "--examples-base-url", "touch/examples/production/",
+    "--seo",
+    "--tests"
+  )
 
-  runner = JsDuckRunner.new
-  runner.add_options ["--output", OUT_DIR, "--config", "#{ARCHITECT_DIR}/docs/config.json"]
-  runner.add_debug if mode == "debug"
-  runner.add_seo if mode == "debug" || mode == "live"
-  runner.add_google_analytics if mode == "live"
-  runner.add_comments('architect', '2') if mode == "debug" || mode == "live"
+  runner.add_debug
+  runner.add_comments('touch', '2')
   runner.run
-end
 
-desc "Build JSDuck gem"
-task :gem => :sass do
-  compress
-  system "gem build jsduck.gemspec"
+  system("cp -r #{TOUCH_BUILD} #{OUT_DIR}/touch")
 end
 
 task :default => :spec

data/jsduck.gemspec

@@ -2,8 +2,8 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = ">= 1.3.5"
 
   s.name = 'jsduck'
-  s.version = '3.9.1'
-  s.date = '2012-04-25'
+  s.version = '3.10.0'
+  s.date = '2012-05-04'
   s.summary = "Simple JavaScript Duckumentation generator"
   s.description = "Documentation generator for Sencha JS frameworks"
   s.homepage = "https://github.com/senchalabs/jsduck"

data/lib/jsduck/api_exporter.rb

@@ -19,7 +19,7 @@ module JsDuck
   # }
   #
   class ApiExporter
-    def initialize(relations)
+    def initialize(relations, opts)
       # All params ignored, they're present to be compatible with
       # other exporters.
     end

data/lib/jsduck/app.rb

@@ -20,6 +20,10 @@ require 'jsduck/index_html'
 require 'jsduck/api_exporter'
 require 'jsduck/full_exporter'
 require 'jsduck/app_exporter'
+require 'jsduck/examples_exporter'
+require 'jsduck/inline_examples'
+require 'jsduck/guide_writer'
+require 'jsduck/stdout'
 require 'fileutils'
 
 module JsDuck
@@ -53,9 +57,18 @@ module JsDuck
       if @opts.export
         format_classes
         FileUtils.rm_rf(@opts.output_dir) unless @opts.output_dir == :stdout
-        exporters = {:full => FullExporter, :api => ApiExporter}
+        exporters = {
+          :full => FullExporter,
+          :api => ApiExporter,
+          :examples => ExamplesExporter,
+        }
         cw = ClassWriter.new(exporters[@opts.export], @relations, @opts)
         cw.write(@opts.output_dir, ".json")
+        if @opts.export == :examples
+          gw = GuideWriter.new(exporters[@opts.export], @assets.guides, @opts)
+          gw.write(@opts.output_dir, ".json")
+        end
+        Stdout.instance.flush
       else
         FileUtils.rm_rf(@opts.output_dir)
         TemplateDir.new(@opts).write
@@ -67,10 +80,19 @@ module JsDuck
         # class-formatting is done in parallel which breaks the links
         # between source files and classes. Therefore it MUST to be done
         # after writing sources which needs the links to work.
-        source_writer = SourceWriter.new(parsed_files, @parallel)
-        source_writer.write(@opts.output_dir + "/source")
+        if @opts.source
+          source_writer = SourceWriter.new(parsed_files, @parallel)
+          source_writer.write(@opts.output_dir + "/source")
+        end
         format_classes
 
+        if @opts.tests
+          examples = InlineExamples.new
+          examples.add_classes(@relations)
+          examples.add_guides(@assets.guides)
+          examples.write(@opts.output_dir+"/inline-examples.js")
+        end
+
         cw = ClassWriter.new(AppExporter, @relations, @opts)
         cw.write(@opts.output_dir+"/output", ".js")
 

data/lib/jsduck/app_data.rb

@@ -24,10 +24,12 @@ module JsDuck
           :examples => @assets.examples.to_array,
           :search => SearchData.new.create(@relations.classes, @assets),
           :stats => @opts.stats ? Stats.new.create(@relations.classes) : [],
+          :tests => @opts.tests,
           :signatures => MetaTagRegistry.instance.signatures,
           :localStorageDb => @opts.local_storage_db,
           :showPrintButton => @opts.seo,
           :touchExamplesUi => @opts.touch_examples_ui,
+          :source => @opts.source,
         }
       }) + ";\n"
       File.open(filename, 'w') {|f| f.write(js) }

data/lib/jsduck/app_exporter.rb

@@ -6,9 +6,9 @@ module JsDuck
 
   # Exports data for Docs app.
   class AppExporter < FullExporter
-    def initialize(relations)
-      super(relations)
-      @renderer = Renderer.new
+    def initialize(relations, opts)
+      super(relations, opts)
+      @renderer = Renderer.new(opts)
     end
 
     # Returns compacted class data hash which contains an additional

data/lib/jsduck/class_writer.rb

@@ -1,6 +1,6 @@
 require 'jsduck/parallel_wrap'
 require 'jsduck/logger'
-require 'jsduck/json_duck'
+require 'jsduck/stdout'
 require 'fileutils'
 
 module JsDuck
@@ -9,7 +9,7 @@ module JsDuck
   class ClassWriter
     def initialize(exporter_class, relations, opts)
       @relations = relations
-      @exporter = exporter_class.new(relations)
+      @exporter = exporter_class.new(relations, opts)
       @parallel = ParallelWrap.new(:in_processes => opts.processes)
     end
 
@@ -24,8 +24,8 @@ module JsDuck
     private
 
     def write_stdout
-      json = @parallel.map(@relations.classes) {|cls| @exporter.export(cls) }
-      puts JsonDuck.generate(json)
+      json = @parallel.map(@relations.classes) {|cls| @exporter.export(cls) }.compact
+      Stdout.instance.add(json)
     end
 
     def write_dir(dir, extension)
@@ -34,12 +34,15 @@ module JsDuck
         filename = dir + "/" + cls[:name] + extension
         Logger.instance.log("Writing docs", filename)
         json = @exporter.export(cls)
-        if extension == ".json"
-          JsonDuck.write_json(filename, json)
-        elsif extension == ".js"
-          JsonDuck.write_jsonp(filename, cls[:name].gsub(/\./, "_"), json)
-        else
-          throw "Unexpected file extension: #{extension}"
+        # skip file if exporter returned nil
+        if json
+          if extension == ".json"
+            JsonDuck.write_json(filename, json)
+          elsif extension == ".js"
+            JsonDuck.write_jsonp(filename, cls[:name].gsub(/\./, "_"), json)
+          else
+            throw "Unexpected file extension: #{extension}"
+          end
         end
       end
     end

data/lib/jsduck/examples_exporter.rb

@@ -0,0 +1,56 @@
+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

@@ -4,8 +4,9 @@ module JsDuck
 
   # Exporter for all the class docs.
   class FullExporter
-    def initialize(relations)
+    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.

data/lib/jsduck/guide_writer.rb

@@ -0,0 +1,58 @@
+require 'jsduck/parallel_wrap'
+require 'jsduck/logger'
+require 'jsduck/stdout'
+require 'fileutils'
+
+module JsDuck
+
+  # Writes guide data into files in JSON or JSONP format or to STDOUT.
+  class GuideWriter
+    def initialize(exporter_class, guides, opts)
+      @guides = guides
+      @exporter = exporter_class.new(guides, opts)
+      @parallel = ParallelWrap.new(:in_processes => opts.processes)
+    end
+
+    # Writes guide data into given directory or STDOUT when dir == :stdout.
+    #
+    # Extension is either ".json" for normal JSON output
+    # or ".js" for JsonP output.
+    def write(dir, extension)
+      dir == :stdout ? write_stdout : write_dir(dir, extension)
+    end
+
+    private
+
+    def write_stdout
+      json = @parallel.map(all_guides) {|guide| @exporter.export_guide(guide) }.compact
+      Stdout.instance.add(json)
+    end
+
+    def write_dir(dir, extension)
+      FileUtils.mkdir(dir) unless File.exists?(dir)
+      @parallel.each(all_guides) do |guide|
+        filename = dir + "/" + guide["name"] + extension
+        Logger.instance.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)
+          elsif extension == ".js"
+            JsonDuck.write_jsonp(filename, guide["name"], json)
+          else
+            throw "Unexpected file extension: #{extension}"
+          end
+        end
+      end
+    end
+
+    def all_guides
+      arr = []
+      @guides.each_item {|g| arr << g }
+      arr
+    end
+
+  end
+
+end

data/lib/jsduck/guides.rb

@@ -34,14 +34,48 @@ module JsDuck
       each_item {|guide| write_guide(guide, dir) }
     end
 
-    def write_guide(guide, dir)
+    # Modified each_item that also loads HTML for each guide
+    def each_item(&block)
+      unless @loaded
+        super do |guide|
+          guide[:html] = load_guide(guide)
+        end
+        @loaded = true
+      end
+
+      super(&block)
+    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| g.select {|k, v| k != :html } }
+        }
+      end
+    end
+
+    def load_guide(guide)
       in_dir = @path + "/guides/" + guide["name"]
-      out_dir = dir + "/" + guide["name"]
       return Logger.instance.warn(:guide, "Guide #{in_dir} not found") unless File.exists?(in_dir)
 
       guide_file = in_dir + "/README.md"
       return Logger.instance.warn(:guide, "README.md not found in #{in_dir}") unless File.exists?(guide_file)
 
+      @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)))
+    end
+
+    def write_guide(guide, dir)
+      return unless guide[:html]
+
+      in_dir = @path + "/guides/" + guide["name"]
+      out_dir = dir + "/" + guide["name"]
+
       Logger.instance.log("Writing guide", out_dir)
       # Copy the whole guide dir over
       FileUtils.cp_r(in_dir, out_dir)
@@ -49,12 +83,7 @@ module JsDuck
       # Ensure the guide has an icon
       fix_icon(out_dir)
 
-      @formatter.doc_context = {:filename => guide_file, :linenr => 0}
-      name = File.basename(in_dir)
-      @formatter.img_path = "guides/#{name}"
-      html = add_toc(guide, @formatter.format(JsDuck::IO.read(guide_file)))
-
-      JsonDuck.write_jsonp(out_dir+"/README.js", name, {:guide => html, :title => guide["title"]})
+      JsonDuck.write_jsonp(out_dir+"/README.js", guide["name"], {:guide => guide[:html], :title => guide["title"]})
     end
 
     # Ensures the guide dir contains icon.png.

data/lib/jsduck/inline_examples.rb

@@ -0,0 +1,97 @@
+require 'jsduck/json_duck'
+require 'cgi'
+
+module JsDuck
+
+  # Extracts inline examples from formatted docs and writes to file
+  class InlineExamples
+    def initialize
+      @begin_example_re = /<pre class='inline-example ([^']*)'><code>/
+      @end_example_re = /<\/code><\/pre>/
+      @examples = []
+    end
+
+    # Extracts inline examples from classes
+    def add_classes(relations)
+      relations.each do |cls|
+        extract(cls[:doc]).each_with_index do |ex, i|
+          @examples << {
+            :id => cls.full_name + "-" + i.to_s,
+            :name => cls.full_name + " example #" + (i+1).to_s,
+            :href => '#!/api/' + cls.full_name,
+            :code => ex[:code],
+            :options => ex[:options],
+          }
+        end
+      end
+
+      self
+    end
+
+    # Extracts inline examples from guides
+    def add_guides(guides)
+      guides.each_item do |guide|
+        extract(guide[:html]).each_with_index do |ex, i|
+          @examples << {
+            :id => guide["name"] + "-" + i.to_s,
+            :name => guide["title"] + " example #" + (i+1).to_s,
+            :href => '#!/guide/' + guide["name"],
+            :code => ex[:code],
+            :options => ex[:options],
+          }
+        end
+      end
+
+      self
+    end
+
+    # Writes all found examples to .js file
+    def write(filename)
+      JsonDuck.write_jsonp(filename, "__inline_examples__", @examples)
+    end
+
+    # Extracts inline examples from HTML
+    def extract(html)
+      examples = []
+
+      s = StringScanner.new(html)
+      while !s.eos? do
+        if s.check(/</)
+          if s.check(@begin_example_re)
+
+            s.scan(@begin_example_re) =~ @begin_example_re
+            options = build_options_hash($1)
+
+            ex = s.scan_until(@end_example_re).sub(@end_example_re, '')
+
+            examples << {
+              :code => CGI.unescapeHTML(strip_tags(ex)),
+              :options => options,
+            }
+          else
+            s.skip(/</)
+          end
+        else
+          s.skip(/[^<]+/)
+        end
+      end
+
+      examples
+    end
+
+    private
+
+    def build_options_hash(css_classes)
+      hash = {}
+      css_classes.split(/ +/).each do |k|
+        hash[k] = true
+      end
+      hash
+    end
+
+    def strip_tags(str)
+      str.gsub(/<.*?>/, "")
+    end
+  end
+
+end

data/lib/jsduck/options.rb

@@ -25,6 +25,7 @@ module JsDuck
     attr_accessor :examples
     attr_accessor :stats
     attr_accessor :categories_path
+    attr_accessor :source
     attr_accessor :pretty_json
     attr_accessor :images
     attr_accessor :link_tpl
@@ -33,6 +34,7 @@ module JsDuck
     attr_accessor :seo
     attr_accessor :eg_iframe
     attr_accessor :examples_base_url
+    attr_accessor :tests
 
     # Debugging
     attr_accessor :processes
@@ -73,7 +75,7 @@ module JsDuck
       ]
       @meta_tag_paths = []
 
-      @version = "3.9.1"
+      @version = "3.10.0"
 
       # Customizing output
       @title = "Sencha Docs - Ext JS"
@@ -87,6 +89,7 @@ module JsDuck
       @examples = nil
       @stats = false
       @categories_path = nil
+      @source = true
       @pretty_json = false
       @images = []
       @link_tpl = '<a href="#!/api/%c%-%m" rel="%c%-%m" class="docClass">%a</a>'
@@ -97,6 +100,7 @@ module JsDuck
       @seo = false
       @eg_iframe = nil
       @examples_base_url = "extjs-build/examples/"
+      @tests = false
 
       # Debugging
       # Turn multiprocessing off by default in Windows
@@ -219,16 +223,16 @@ module JsDuck
           @examples = canonical(path)
         end
 
-        opts.on('--stats',
-          "Creates page with all kinds of statistics. Experimental!", " ") do
-          @stats = true
-        end
-
         opts.on('--categories=PATH',
           "Path to JSON file which defines categories for classes.", " ") do |path|
           @categories_path = canonical(path)
         end
 
+        opts.on('--no-source',
+          "Turns off the output of source files.", " ") do
+          @source = false
+        end
+
         opts.on('--pretty-json', "Turn on pretty-printing of JSON.", " ") do
           @pretty_json = true
         end
@@ -264,8 +268,9 @@ module JsDuck
 
         opts.on('--export=TYPE',
           "Exports docs in JSON.  TYPE is one of:",
-          "* full - full class docs.",
-          "* api  - only class- and member names.", " ") do |format|
+          "* full     - full class docs.",
+          "* api      - only class- and member names.",
+          "* examples - extracts inline examples from classes.", " ") do |format|
           @export = format.to_sym
         end
 
@@ -284,6 +289,15 @@ module JsDuck
           @examples_base_url = path
         end
 
+        opts.on('--tests', "Creates page for testing inline examples.", " ") do
+          @tests = true
+        end
+
+        opts.on('--stats',
+          "Creates page with all kinds of statistics. Experimental!", " ") do
+          @stats = true
+        end
+
         opts.separator "Debugging:"
         opts.separator ""
 
@@ -480,7 +494,7 @@ module JsDuck
       elsif @output_dir == :stdout && !@export
         puts "Output to STDOUT only works when using --export option."
         exit(1)
-      elsif ![nil, :full, :api].include?(@export)
+      elsif ![nil, :full, :api, :examples].include?(@export)
         puts "Unknown export format: #{@export}"
         exit(1)
       elsif @output_dir != :stdout

data/lib/jsduck/renderer.rb

@@ -6,6 +6,10 @@ module JsDuck
   # Ruby-side implementation of class docs Renderer.
   # Uses PhantomJS to run Docs.Renderer JavaScript.
   class Renderer
+    def initialize(opts)
+      @opts = opts
+    end
+
     def render(cls)
         @cls = cls
 
@@ -50,7 +54,7 @@ module JsDuck
         render_dependencies(:subclasses, "Subclasses"),
         render_dependencies(:mixedInto, "Mixed into"),
         render_dependencies(:uses, "Uses"),
-        render_files,
+        @opts.source ? render_files : nil,
       ]
       if items.compact.length > 0
         return ['<pre class="hierarchy">', items, '</pre>']
@@ -197,7 +201,7 @@ module JsDuck
               inherited ? "<a href='#!/api/#{owner}' rel='#{owner}' class='defined-in docClass'>#{owner}</a>" :
                           "<span class='defined-in' rel='#{owner}'>#{owner}</span>",
               "<br/>",
-              "<a href='source/#{m[:files][0][:href]}' target='_blank' class='view-source'>view source</a>",
+              @opts.source ? "<a href='source/#{m[:files][0][:href]}' target='_blank' class='view-source'>view source</a>" : "",
             "</div>",
             # method params signature or property type signature
             render_signature(m),

data/lib/jsduck/stdout.rb

@@ -0,0 +1,31 @@
+require 'jsduck/json_duck'
+require 'singleton'
+
+module JsDuck
+
+  # Central place for buffering JSON data that's meant to be written to STDOUT
+  class Stdout
+    include Singleton
+
+    def initialize
+      @data = nil
+    end
+
+    # Adds array of new data
+    def add(data)
+      if @data
+        @data += data
+      else
+        @data = data
+      end
+    end
+
+    # Writes data to STDOUT in JSON format,
+    # but only if some data was added.
+    def flush
+      puts JsonDuck.generate(@data) if @data
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jsduck
 version: !ruby/object:Gem::Version
-  version: 3.9.1
+  version: 3.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-25 00:00:00.000000000 Z
+date: 2012-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdiscount
-  requirement: &20844700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20844700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &20842780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20842780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: parallel
-  requirement: &20841760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,7 +54,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20841760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Documentation generator for Sencha JS frameworks
 email: rene.saarsoo@sencha.com
 executables:
@@ -83,14 +98,17 @@ files:
 - lib/jsduck/doc_formatter.rb
 - lib/jsduck/doc_parser.rb
 - lib/jsduck/examples.rb
+- lib/jsduck/examples_exporter.rb
 - lib/jsduck/file_categories.rb
 - lib/jsduck/full_exporter.rb
 - lib/jsduck/grouped_asset.rb
+- lib/jsduck/guide_writer.rb
 - lib/jsduck/guides.rb
 - lib/jsduck/icons.rb
 - lib/jsduck/images.rb
 - lib/jsduck/index_html.rb
 - lib/jsduck/inherit_doc.rb
+- lib/jsduck/inline_examples.rb
 - lib/jsduck/inline_img.rb
 - lib/jsduck/inline_video.rb
 - lib/jsduck/io.rb
@@ -115,6 +133,7 @@ files:
 - lib/jsduck/source_file.rb
 - lib/jsduck/source_writer.rb
 - lib/jsduck/stats.rb
+- lib/jsduck/stdout.rb
 - lib/jsduck/tag/abstract.rb
 - lib/jsduck/tag/aside.rb
 - lib/jsduck/tag/author.rb
@@ -597,7 +616,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: jsduck
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Simple JavaScript Duckumentation generator