Merge branch 'master' into esprima-parser (a2233047) · Commits · extjs / jsduck

README.md

+4 −2

Original line number	Diff line number	Diff line
		@@ -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

Rakefile

+44 −327

Original line number	Diff line number	Diff line
		@@ -19,16 +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 " # path to Animator (for developers at Sencha)"
		puts " ANIMATOR_DIR='/path/to/Animator'"
		exit 1
		end
		end
		@@ -36,7 +34,7 @@ end
		# Compress JS/CSS file in-place
		# Using a hackish way to access yui-compressor
		def yui_compress(fname)
		system "java -jar $(dirname $(which sencha))/../jsbuilder/ycompressor/ycompressor.jar -o #{fname} #{fname}"
		system "java -jar $(dirname $(which sencha))/bin/yuicompressor.jar -o #{fname} #{fname}"
		end

		# Reads in all CSS files referenced between BEGIN CSS and END CSS markers.
		@@ -99,6 +97,7 @@ def compress
		system("sencha", "create", "jsb", "-a", "#{dir}/build-js.html", "-p", "#{dir}/app.jsb3")
		# Concatenate files listed in JSB3 file
		system("sencha", "build", "-p", "#{dir}/app.jsb3", "-d", dir)

		# Remove intermediate build files
		system("rm", "#{dir}/app.jsb3")
		system("rm", "#{dir}/all-classes.js")
		@@ -142,7 +141,7 @@ class JsDuckRunner
		load_sdk_vars
		end

		def add_options(options)
		def add_options(*options)
		@options += options
		end

		@@ -162,24 +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>",
		"--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}",
		@@ -187,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",
		@@ -203,113 +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',
		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.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))
		@@ -321,224 +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", "#{SDK_DIR}/../ext-3.4.0/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", "#{SDK_DIR}/../ext-2-source/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/",
		]
		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", "#{SDK_DIR}/../client-framework/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 Designer (for internal use at Sencha)\n" +
		"designer - creates debug/development version\n" +
		"designer[export] - create live version for deployment\n"
		"designer[live] - create live version for deployment\n"
		task :designer, [: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", "#{DESIGNER_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('designer', '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

jsduck.gemspec

+2 −2

Original line number	Diff line number	Diff line
		@@ -2,8 +2,8 @@ Gem::Specification.new do \|s\|
		s.required_rubygems_version = ">= 1.3.5"

		s.name = 'jsduck'
		s.version = '3.9.0'
		s.date = '2012-04-17'
		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"

lib/jsduck/api_exporter.rb

+1 −1

Original line number	Diff line number	Diff line
		@@ -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

lib/jsduck/app.rb

+25 −3

Original line number	Diff line number	Diff line
		@@ -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.
		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")