gulpfile.js

'use strict'

var browserSync = require('browser-sync').create()
var childProcess = require('child_process')
var log = require('fancy-log')
var del = require('del')
var ghPages = require('gh-pages')
var gulp = require('gulp')
var path = require('path')
var fs = require('fs')
var sequence = require('run-sequence')
var dev = false

// load gulp plugins
var $ = require('gulp-load-plugins')()

var paths = {
  assets: './app/_assets/',
  modules: './node_modules/',
  dist: './dist/'
}

// Sources
var sources = {
  content: 'app/**/*.{markdown,md,html,txt,yml,yaml}',
  styles: paths.assets + 'stylesheets/**/*',
  js: [
    paths.assets + 'javascripts/jquery.2.1.3.min.js',
    paths.assets + 'javascripts/app.js',
    paths.modules + 'bootstrap/js/dropdown.js',
    paths.modules + 'bootstrap/js/affix.js'
  ],
  images: paths.assets + 'images/**/*',
  fonts: [
    paths.modules + 'font-awesome/fonts/**/*.*',
    paths.assets + 'fonts/*.*'
  ]
}

// Destinations
var dest = {
  html: paths.dist + '**/*.html',
  js: paths.dist + 'assets/app.js'
}

gulp.task('copycss', function () {
  gulp.src(paths.assets + 'css/*.css')
    .pipe(gulp.dest(paths.dist + 'assets'))
})

gulp.task('styles', function () {
  return gulp.src(paths.assets + 'stylesheets/index.less')
    .pipe($.plumber())
    .pipe($.if(dev, $.sourcemaps.init()))
    .pipe($.less())
    .pipe($.autoprefixer())
    .pipe($.purifycss([dest.html], {
      whitelist: [
        '.affix',
        '.alert',
        '.close',
        '.collaps',
        '.fade',
        '.has',
        '.help',
        '.in',
        '.modal',
        '.open',
        '.popover',
        '.tooltip'
      ]
    }))
    .pipe($.cleanCss({ compatibility: 'ie8' }))
    .pipe($.rename('styles.css'))
    .pipe($.if(dev, $.sourcemaps.write()))
    .pipe(gulp.dest(paths.dist + 'assets'))
    .pipe($.size())
    .pipe(browserSync.stream())
})

gulp.task('javascripts', function () {
  return gulp.src(sources.js)
    .pipe($.plumber())
    .pipe($.if(dev, $.sourcemaps.init()))
    .pipe($.minify({
      noSource: true,
      ext: {
        min: '.js'
      }
    }))
    .pipe($.concat('app.js'))
    .pipe($.if(dev, $.sourcemaps.write()))
    .pipe(gulp.dest('dist/assets'))
    .pipe($.size())
    .pipe(browserSync.stream())
})

gulp.task('images', function () {
  return gulp.src(sources.images)
    .pipe($.plumber())
    .pipe($.imagemin())
    .pipe(gulp.dest(paths.dist + 'assets/images'))
    .pipe($.size())
})

gulp.task('fonts', function () {
  return gulp.src(sources.fonts)
    .pipe($.plumber())
    .pipe(gulp.dest(paths.dist + 'assets/fonts'))
    .pipe($.size())
    .pipe(browserSync.stream())
})

gulp.task('jekyll', function (cb) {
  var command = 'bundle exec jekyll build --config jekyll.yml --destination ' + paths.dist

  childProcess.exec(command, function (err, stdout, stderr) {
    log(stdout)
    log(stderr)
    cb(err)
  })
})

gulp.task('html', ['jekyll'], function () {
  return gulp.src(paths.dist + '/**/*.html')
    .pipe($.plumber())
    // Prefetch static assets
    // .pipe($.resourceHints())
    .pipe(gulp.dest(paths.dist))
    .pipe($.size())
})

gulp.task('pdk-docs', function (cb) {
  var KONG_PATH, KONG_VERSION,
    navFilepath, doc, pdkRegex, newNav, newDoc,
    cmd, obj, errLog,
    refDir, modules,
    gitSha1, confFilepath

  // 0 Obtain "env-var params"
  KONG_PATH = process.env.KONG_PATH
  if (KONG_PATH === undefined) {
    return cb('No KONG_PATH environment variable set')
  }

  KONG_VERSION = process.env.KONG_VERSION
  if (KONG_VERSION === undefined) {
    return cb('No KONG_VERSION environment variable set. Example: 0.14.x')
  }

  // 1. Update nav file
  // 1.1 Check that nav file exists
  navFilepath = './app/_data/docs_nav_' + KONG_VERSION + '.yml'
  try {
    doc = fs.readFileSync(navFilepath, 'utf8')
  } catch (err) {
    return cb('Could not find the file ' + navFilepath + '. Err: ' + err)
  }

  // 1.2 Check that nav file has the correct yaml entry
  pdkRegex = /[ ]+- text: Plugin Development Kit[\s\S]+\n-/gm
  if (!doc.match(pdkRegex)) {
    return cb('Could not find the appropriate section in ' + navFilepath)
  }

  // 1.3 Generate new yaml using ldoc
  cmd = 'LUA_PATH="$LUA_PATH;./?.lua" ' +
        'ldoc -q -i --filter ldoc/filters.nav ' +
        KONG_PATH + '/kong/pdk'
  obj = childProcess.spawnSync(cmd, { shell: true })
  // ignore "unkwnown tag" errors
  errLog = obj.stderr.toString().replace(/.*unknown tag.*\n/g, '')
  if (errLog.length > 0) {
    return cb(errLog)
  }

  // 1.4 Replace existing yaml with generated one
  newNav = obj.stdout.toString()
  newDoc = doc.replace(pdkRegex, newNav + '\n-')
  fs.writeFileSync(navFilepath, newDoc)
  log('Updated contents of ' + navFilepath + ' with new navigation items')

  // 2. Generate markdown docs using custom ldoc templates
  // 2.1 Prepare ref folder
  refDir = 'app/' + KONG_VERSION + '/pdk'
  cmd = 'rm -rf ' + refDir + ' && mkdir ' + refDir
  obj = childProcess.spawnSync(cmd, { shell: true })
  errLog = obj.stderr.toString()
  if (errLog.length > 0) {
    return cb(errLog)
  }

  // 2.2 Obtain the list of modules in json form & parse it
  cmd = 'LUA_PATH="$LUA_PATH;./?.lua" ' +
        'ldoc -q -i --filter ldoc/filters.json ' +
        KONG_PATH + '/kong/pdk'
  obj = childProcess.spawnSync(cmd, { shell: true })
  // ignore "unkwnown tag" errors
  errLog = obj.stderr.toString().replace(/.*unknown tag.*\n/g, '')
  if (errLog.length > 0) {
    return cb(errLog)
  }
  modules = JSON.parse(obj.stdout.toString())

  // 2.3 For each module, generate its docs in markdown
  for (let module of modules) {
    cmd = 'LUA_PATH="$LUA_PATH;./?.lua" ' +
          'ldoc -q -c ldoc/config.ld ' +
          module.file + ' && ' +
          'mv ./' + module.generated_name + '.md ' + refDir + '/' +
          module.name + '.md'
    obj = childProcess.spawnSync(cmd, { shell: true })
    errLog = obj.stderr.toString()
    if (errLog.length > 0) {
      return cb(errLog)
    }
  }
  log('Re-generated PDK docs in ' + refDir)

  // 3 Write pdk_info yaml file
  // 3.1 Obtain git sha-1 hash of the current git log
  cmd = 'pushd ' + KONG_PATH + ' > /dev/null; git rev-parse HEAD; popd > /dev/null'
  obj = childProcess.spawnSync(cmd, { shell: true })
  errLog = obj.stderr.toString()
  if (errLog.length > 0) {
    return cb(errLog)
  }
  gitSha1 = obj.stdout.toString().trim()

  // 3.2 Write it into file
  confFilepath = 'app/_data/pdk_info.yml'
  fs.writeFileSync(confFilepath, 'sha1: ' + gitSha1 + '\n')
  log('git SHA-1 (' + gitSha1 + ') written to ' + confFilepath)
})

gulp.task('admin-api-docs', function (cb) {
  var KONG_PATH, KONG_VERSION, cmd, obj, errLog

  // 0 Obtain "env-var params"
  KONG_PATH = process.env.KONG_PATH
  if (KONG_PATH === undefined) {
    return cb('No KONG_PATH environment variable set')
  }

  KONG_VERSION = process.env.KONG_VERSION
  if (KONG_VERSION === undefined) {
    return cb('No KONG_VERSION environment variable set. Example: 0.14.x')
  }

  // 1 Generate admin-api.md
  cmd = 'resty autodoc-admin-api/run.lua'
  obj = childProcess.spawnSync(cmd, { shell: true })
  errLog = obj.stderr.toString()
  if (errLog.length > 0) {
    return cb(errLog)
  }

  log('Re-generated Admin API docs for ' + KONG_VERSION)
})

gulp.task('cli-docs', function (cb) {
  var KONG_PATH, KONG_VERSION, cmd, obj, errLog

  // 0 Obtain "env-var params"
  KONG_PATH = process.env.KONG_PATH
  if (KONG_PATH === undefined) {
    return cb('No KONG_PATH environment variable set')
  }

  KONG_VERSION = process.env.KONG_VERSION
  if (KONG_VERSION === undefined) {
    return cb('No KONG_VERSION environment variable set. Example: 1.0.x')
  }

  // 1 Generate cli.md
  cmd = 'luajit autodoc-cli/run.lua'
  obj = childProcess.spawnSync(cmd, { shell: true })
  errLog = obj.stderr.toString()
  if (errLog.length > 0) {
    return cb(errLog)
  }

  log('Re-generated CLI docs for ' + KONG_VERSION)
})

gulp.task('conf-docs', function (cb) {
  var KONG_PATH, KONG_VERSION, cmd, obj, errLog

  // 0 Obtain "env-var params"
  KONG_PATH = process.env.KONG_PATH
  if (KONG_PATH === undefined) {
    return cb('No KONG_PATH environment variable set')
  }

  KONG_VERSION = process.env.KONG_VERSION
  if (KONG_VERSION === undefined) {
    return cb('No KONG_VERSION environment variable set. Example: 1.0.x')
  }

  // Generate configuration.md
  cmd = 'luajit autodoc-conf/run.lua'
  obj = childProcess.spawnSync(cmd, { shell: true })
  errLog = obj.stderr.toString()
  if (errLog.length > 0) {
    return cb(errLog)
  }

  log('Re-generated Conf docs for ' + KONG_VERSION)
})

gulp.task('clean', function () {
  ghPages.clean()
  return del(['dist', '.gh-pages'])
})

gulp.task('build', ['javascripts', 'images', 'fonts', 'copycss'], function (cb) {
  sequence('html', 'styles', cb)
})

gulp.task('browser-sync', function () {
  browserSync.init({
    logPrefix: ' ▶ ',
    minify: false,
    notify: false,
    server: 'dist',
    open: false
  })
})

gulp.task('gh-pages', function (cb) {
  var cmd = 'git rev-parse --short HEAD'

  childProcess.exec(cmd, function (err, stdout, stderr) {
    if (err) {
      cb(err)
    }

    ghPages.publish(path.join(__dirname, paths.dist), {
      message: 'Deploying ' + stdout + '(' + new Date().toISOString() + ')'
    }, cb)
  })
})

gulp.task('cloudflare', function (cb) {
  // configure cloudflare
  var cloudflare = require('cloudflare').createClient({
    email: process.env.MASHAPE_CLOUDFLARE_EMAIL,
    token: process.env.MASHAPE_CLOUDFLARE_TOKEN
  })

  cloudflare.clearCache('docs.getkong.com', function (err) {
    if (err) {
      log(err.message)
    }

    cb()
  })
})

gulp.task('deploy', function (cb) {
  sequence('build', 'gh-pages', cb)
})

gulp.task('watch', function () {
  gulp.watch(sources.content, ['html-watch'])
  gulp.watch(sources.styles, ['styles'])
  gulp.watch(sources.images, ['images-watch'])
  gulp.watch(sources.js, ['javascripts'])
  gulp.watch(paths.assets + 'css/hub.css', ['copycss'])
})

gulp.task('html-watch', ['html'], function (cb) {
  browserSync.reload()
  cb()
})

gulp.task('images-watch', ['images'], function (cb) {
  browserSync.reload()
  cb()
})

gulp.task('default', ['clean'], function (cb) {
  sequence('build', 'browser-sync', 'copycss', 'watch', cb)
})

gulp.task('setdev', function (cb) {
  dev = true
  cb()
})

gulp.task('dev', ['setdev'], function (cb) {
  sequence('default', cb)
})