Newer
Older
require 'rubygems'
require 'rake'
$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
require 'rspec'
require 'rspec/core/rake_task'
RSpec::Core::RakeTask.new(:spec) do |spec|
spec.rspec_opts = ["--color"]
spec.pattern = "spec/**/*_spec.rb"
if File.exists?("sdk-vars.rb")
require "sdk-vars.rb"
else
puts "Error: sdk-vars.rb not found."
puts
puts "Please create file sdk-vars.rb and define constants SDK_DIR and OUT_DIR in it."
puts
puts "For example:"
puts
puts " SDK_DIR='/path/to/SDK'"
puts " OUT_DIR='/path/to/ouput/dir'"
# 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}"
end
# Reads in all CSS files referenced between BEGIN CSS and END CSS markers.
# Deletes those input CSS files and writes out concatenated CSS to
# resources/css/app.css
# Finally replaces the CSS section with <link> to that one CSS file.
def combine_css(html, dir, opts = :write)
css_section_re = /<!-- BEGIN CSS -->.*<!-- END CSS -->/m
css = []
css_section_re.match(html)[0].each_line do |line|
if line =~ /<link rel="stylesheet" href="(.*?)"/
file = $1
css << IO.read(dir + "/" + file)
system("rm", dir + "/" + file) if opts == :write
fname = "#{dir}/resources/css/app.css"
File.open(fname, 'w') {|f| f.write(css.join("\n")) }
yui_compress(fname)
end
html.sub(css_section_re, '<link rel="stylesheet" href="resources/css/app.css" type="text/css" />')
end
# Same thing for JavaScript, result is written to: app.js
js_section_re = /<!-- BEGIN JS -->.*<!-- END JS -->/m
js = []
js_section_re.match(html)[0].each_line do |line|
if line =~ /<script .* src="(.*)">/
file = $1
if file !~ /ext\.js/
elsif line =~ /<script .*>(.*)<\/script>/
js << $1
end
end
File.open(fname, 'w') {|f| f.write(js.join("\n")) }
yui_compress(fname)
html.sub(js_section_re, '<script type="text/javascript" src="app.js"></script>')
# Compress JavaScript and CSS files of JSDuck
def compress
# Clean up template-min/ left over from previous compress task
system("rm", "-rf", "template-min")
# Copy template/ files to template-min/
system("cp", "-r", "template", "template-min")
# Now do everything that follows in template-min/ dir
dir = "template-min"
# Create JSB3 file for Docs app
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")
system("mv", "#{dir}/app-all.js", "#{dir}/app.js")
# Remove the entire app/ dir
system("rm", "-r", "#{dir}/app")
# Concatenate CSS in print-template.html file
print_template = "#{dir}/print-template.html";
html = IO.read(print_template);
# Just modify HTML to link app.css, don't write files.
html = combine_css(html, dir, :replace_html_only)
File.open(print_template, 'w') {|f| f.write(html) }
# Concatenate CSS and JS files referenced in template.html file
template_html = "#{dir}/template.html"
html = IO.read(template_html)
html = combine_css(html, dir)
html = combine_js(html, dir)
File.open(template_html, 'w') {|f| f.write(html) }
# (But keep prettify lib, which is needed for source files)
system "rm -rf #{dir}/resources/sass"
system "rm -rf #{dir}/resources/codemirror"
system "rm -rf #{dir}/resources/.sass-cache"
# Empty the extjs dir, leave only the main JS files, CSS and images
system "rm -rf #{dir}/extjs"
system "mkdir #{dir}/extjs"
system "cp #{EXT_DIR}/ext-all.js #{dir}/extjs"
system "cp #{EXT_DIR}/ext-all-debug.js #{dir}/extjs"
system "cp #{EXT_DIR}/bootstrap.js #{dir}/extjs"
system "mkdir -p #{dir}/extjs/resources/css"
system "cp #{EXT_DIR}/resources/css/ext-all.css #{dir}/extjs/resources/css"
system "mkdir -p #{dir}/extjs/resources/themes/images"
system "cp -r #{EXT_DIR}/resources/themes/images/default #{dir}/extjs/resources/themes/images"
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
class JsDuckRunner
def initialize
@options = []
load_sdk_vars
@sdk_dir = SDK_DIR
@out_dir = OUT_DIR
@ext_dir = EXT_DIR
end
def add_options(options)
@options += options
end
def add_sdk
rev = `git rev-parse HEAD`.slice(0, 7)
head_html = <<-EOHTML
<link rel="canonical" href="http://docs.sencha.com/ext-js/4-0/" />
<meta name="description" content="Ext JS 4.0 API Documentation from Sencha. Class documentation, Guides and Videos on how to create Javascript applications with Ext JS 4">
EOHTML
@options += [
]
@options += [
"--title", "Sencha Docs - Ext JS 4.0",
"--head-html", head_html,
"--footer", "Ext JS 4.0.6 Docs - Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> rev #{rev}",
"--welcome", "template/welcome.html",
"--guides", "#{@sdk_dir}/guides/guides.json",
"--videos", "#{@sdk_dir}/guides/videos.json",
"--examples", "#{@sdk_dir}/extjs/examples/examples.json",
"--inline-examples", "#{@sdk_dir}/extjs/doc-resources",
"--categories", "#{@sdk_dir}/extjs/doc-resources/categories.json",
"--output", "#{@out_dir}",
"#{@sdk_dir}/extjs/src",
"#{@sdk_dir}/platform/src",
"#{@sdk_dir}/platform/core/src",
]
end
def add_touch
rev = `git rev-parse HEAD`.slice(0, 7)
head_html = <<-EOHTML
<link rel="canonical" href="http://docs.sencha.com/touch/1-0/" />
<meta name="description" content="Sencha Touch 1.0 API Documentation from Sencha. Documentation on how to create Javascript applications with Sencha Touch">
EOHTML
@options += [
"--title", "Sencha Docs - Touch 1.0",
"--head-html", head_html,
"--footer", "Sencha Touch 1.0 Docs - Generated with <a href='https://github.com/senchalabs/jsduck'>JSDuck</a> revison #{rev}",
"--categories", "#{@sdk_dir}/touch/doc-resources/categories.json",
"--videos", "#{@sdk_dir}/touch/doc-resources/videos.json",
"--output", "#{@out_dir}",
"#{@sdk_dir}/touch/src/core",
"#{@sdk_dir}/touch/src/data",
"#{@sdk_dir}/touch/src/gestures",
"#{@sdk_dir}/touch/src/layout",
"#{@sdk_dir}/touch/src/plugins",
"#{@sdk_dir}/touch/src/util",
"#{@sdk_dir}/touch/src/widgets",
"#{@sdk_dir}/touch/src/platform/src",
"#{@sdk_dir}/touch/resources/themes/stylesheets/sencha-touch/default",
]
end
def add_debug
@options += [
"--extjs-path", "extjs/ext-all-debug.js",
"--template-links",
"--template", "template",
]
end
def add_seo
@options += [
"--seo",
]
end
def add_sdk_export_notice
@options += [
"--body-html", <<-EOHTML
<div id="notice-text" style="display: none">
Use <a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</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]);
}
});
}
</script>
EOHTML
]
end
# Copy over the images that SDK documentation links to
def copy_sdk_images
system "cp -r #{@sdk_dir}/extjs/doc-resources #{@out_dir}/doc-resources"
system "cp -r #{@sdk_dir}/platform/doc-resources/* #{@out_dir}/doc-resources"
end
# Copy over the images that Sencha Touch documentation links to.
def copy_touch_images
system "cp -r #{@sdk_dir}/touch/doc-resources #{@out_dir}/doc-resources"
end
# Copy over SDK examples
def copy_sdk_examples
system "mkdir #{@out_dir}/extjs/builds"
system "cp #{@ext_dir}/builds/ext-core.js #{@out_dir}/extjs/builds/ext-core.js"
system "cp #{@ext_dir}/release-notes.html #{@out_dir}/extjs"
system "cp -r #{@ext_dir}/examples #{@out_dir}/extjs"
system "cp -r #{@ext_dir}/welcome #{@out_dir}/extjs"
end
def run
# Pass multiple arguments to system, so we'll take advantage of the built-in escaping
system(*["ruby", "bin/jsduck"].concat(@options))
end
# Run compass to generate CSS files
task :sass do
system "compass compile --quiet template/resources/sass"
end
desc "Run JSDuck on Ext JS SDK\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_sdk
runner.add_debug if mode == "debug"
runner.add_seo if mode == "debug" || mode == "live"
runner.add_export_notice if mode == "export"
runner.add_google_analytics if mode == "live"
runner.run
runner.copy_sdk_images
runner.copy_sdk_examples if mode == "export" || mode == "live"
end
desc "Run JSDuck on Sencha Touch\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_touch
runner.add_debug if mode == "debug"
runner.add_seo if mode == "debug" || mode == "live"
runner.run
runner.copy_touch_images
end
desc "Build JSDuck gem"
task :gem => :sass do
compress
system "gem build jsduck.gemspec"
end