aboutsummaryrefslogtreecommitdiffstats
path: root/tasks/docsite.js
blob: b5f9cad42debec65ecacb887b2b69984a17d3403 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
var bower =  require('gulp-bower');
var config = require('./config');
var common = require('./common');
var gulp = require('gulp');
var fs = require('fs-extra');
var replace = require('gulp-replace');
var rsync = require('gulp-rsync');
var gutil = require('gulp-util');
var zip = require('gulp-zip');
var args = require('yargs').argv;
var addsrc = require('gulp-add-src');

var stagingBasePath = config.paths.staging.cdn;
var docPath = config.paths.staging.doc;
var version = config.version;
var host = config.toolsHost;
var permalink = config.permalink;
var stagingPath = stagingBasePath + '/' + version;
var modify = require('gulp-modify');
var rootZip = 'target/';
var fileZip = 'docsite.zip'

gulp.task('cdn:docsite:clean', function() {
  fs.removeSync(docPath);
  fs.removeSync(rootZip + fileZip);
});

gulp.task('cdn:docsite:bower_components', ['cdn:stage-bower_components'], function() {
  gutil.log('Copying bower components from ' + stagingPath + ' to ' + docPath + '/bower_components');
  return gulp.src([stagingPath + '/**'])
    // Temporary patch until #180 is fixed:
    // https://github.com/webcomponents/webcomponentsjs/issues/180
    .pipe(modify({
      fileModifier: function(file, contents) {
        if (/webcomponents-lite.*js/.test(file.path)) {
          contents = contents.replace(/(if ?\()(\w+\.log)(\))/mg, '$1$2 && $2.split$3')
        }
        return contents;
      }
    }))
    .pipe(gulp.dest(docPath + '/bower_components'));
});

gulp.task('cdn:docsite:components', function() {
  return gulp.src('doc/*')
    .pipe(gulp.dest(docPath));
});

var doctasks = ['cdn:docsite:components'];
config.components.forEach(function (n) {
  var task = 'cdn:docsite:' + n;
  doctasks.push(task);
  gulp.task(task, ['cdn:docsite:bower_components'], function(done) {
    var componentDocsite = docPath + '/' + n;
    var componentDemo = stagingPath + '/' + n + '/demo/**';

    gutil.log('Generating site documentation from '  + componentDemo + ' into ' + componentDocsite);
    fs.mkdirsSync(componentDocsite);
    return gulp.src([componentDemo, '!**/*-embed.html'])
      // Remove bad tags
      .pipe(replace(/^.*<(!doctype|\/?html|\/?head|\/?body|meta|title).*>.*\n/img, ''))
      // Uncomment metainfo, and enclose all the example in {% raw %} ... {% endraw %} to avoid liquid conflicts
      // We use gulp-modify instead of replace in order to handle the github url for this file
      .pipe(modify({
        fileModifier: function(file, contents) {
          var re = new RegExp(".*/" + n + "/");
          var gh = 'https://github.com/vaadin/' + n + '/edit/master/' + file.path.replace(re, '');
          return contents.replace(/^.*<!--[ \n]+([\s\S]*?title:[\s\S]*?)[ \n]+-->.*\n([\s\S]*)/img,
              '---\n$1\nsourceurl: ' + gh + '\n---\n{% raw %}\n$2\n{% endraw %}');
        }
      }))
      .pipe(replace(/^.*<section>[\s\S]*?table-of-contents[\s\S]*?<\/section>.*\n/im, ''))
      // Add ids to headers, so as site configures permalinks
      .pipe(replace(/<h(\d+)>(.*)(<\/h\d+>)/img, function($0, $1, $2, $3){
        var id = $2.trim().toLowerCase().replace(/[^\w]+/g,'_');
        return '<h' + $1 + ' id="' + id + '">' + $2 + $3;
      }))
      // Remove webcomponents polyfill since it's added at top of the site
      .pipe(replace(/^.*<script.*?\/webcomponents.*\.js[\"'].*?<\/script>\s*?\n?/img, ''))
      // embed files are displayed as iframe, we don't remove above fragments like body or polyfill
      .pipe(addsrc(componentDemo + '/*-embed.html'))
      // Remove Analytics
      .pipe(replace(/^.*<script.*?ga\.js[\"'].*?<\/script>\s*?\n?/img, ''))
      // Adjust bowerComponents variable in common.html
      .pipe(replace(/(bowerComponents *= *)'..\/..\/'/, "$1'../bower_components/'"))
      // Adjust location of the current component in bower_components (..)
      .pipe(replace(/(src|href)=("|')\.\.(\/\w)/mg, '$1=$2../bower_components/' + n + '$3'))
      // Adjust location of dependencies in bower_components (../..)
      .pipe(replace(/(src|href)=("|')(.*?)\.\.\/\.\.\//mg, '$1=$2../bower_components/'))
      // Remove references to demo.css file
      .pipe(replace(/^.*<link.*demo.css.*\n/im, ''))
      // Remove table of contents
      .pipe(replace(/^.*table-of-contents.html.*\n/im, ''))
      .pipe(gulp.dest(componentDocsite));
  });
});

gulp.task('cdn:docsite:zip', doctasks, function() {
  var src = docPath + '/**/*';
  gutil.log("Creating docsite zip " + docPath + " -> " + rootZip +  fileZip);
  return gulp.src(src)
    .pipe(zip(fileZip))
    .pipe(gulp.dest(rootZip));
});

gulp.task('cdn:docsite:upload', ['cdn:docsite:clean', 'cdn:docsite:zip'], function(done) {
  common.checkArguments(['cdnUsername', 'cdnDestination']);

  gutil.log('Uploading docsite (scp): ' + rootZip + fileZip + ' -> ' + args.cdnUsername + '@' + host + ':' + args.cdnDestination + version);

  require('scp2').scp(rootZip + fileZip, {
    host: host,
    username: args.cdnUsername,
    privateKey: config.paths.privateKey(),
    path: args.cdnDestination + version
  }, function(err) {
    done(err);
  })
});

gulp.task('cdn:docsite', ['cdn:docsite:upload']);