kdf/gulpfile.coffee

KD: a non-document focused UI Framework for web applications.

gulp       = require 'gulp'
gulpif     = require 'gulp-if'
gutil      = require 'gulp-util'
browserify = require 'browserify'
coffeeify  = require 'coffeeify'
rename     = require 'gulp-rename'
uglify     = require 'gulp-uglify'
stylus     = require 'gulp-stylus'
concat     = require 'gulp-concat'
minifyCSS  = require 'gulp-minify-css'
fs         = require 'fs'
http       = require 'http'
argv       = require('minimist') process.argv
source     = require 'vinyl-source-stream'
gulpBuffer = require 'gulp-buffer'
Promise    = require 'bluebird'
del        = Promise.promisify require 'del'
exec       = Promise.promisify (require 'child_process').exec

ENTRY_PATH    = argv.entryPath ? './src/entry.coffee'
STYLES_PATH   = require './src/themes/styl.includes.coffee'
COFFEE_PATH   = ['./src/components/**/*.coffee','./src/core/**/*.coffee','./src/init.coffee']
LIBS_PATH     = ['./libs/*.js']
TEST_PATH     = ['./test/**/*.test.coffee']
LIBS          = require './src/lib.includes.coffee'

# Helpers

checkParam = (param) -> !(param in ['0', 0, no, 'false', 'no', 'off', '', undefined, null])

log = (color, message) ->
  gutil.log gutil.colors[color] message

gulpBrowserify = (options) ->
  options.extensions or= ['.coffee']
  options.debug = argv.devMode?
  b = browserify options
  b.transform coffeeify
  b.bundle()

watchLogger = (color, watcher) ->
  livereload = require 'gulp-livereload'
  server = livereload()  if useLiveReload
  watcher.on 'change', (event) ->
    log color, "file #{event.path} was #{event.type}"
    server?.changed event.path

createServer  = no
buildDir      = argv.outputDir ? 'build'
version       = if argv.buildVersion then "#{argv.buildVersion}." else ''
useLiveReload = checkParam argv.liveReload
useUglify     = checkParam argv.uglify
useMinify     = checkParam argv.minify
karmaAction   = 'watch'
buildDocs     = checkParam argv.docs
buildPlay     = checkParam argv.play
theme         = checkParam argv.theme


# Build Tasks


gulp.task 'styles', ['clean'], ->

  if theme
    resetStyles = require './src/themes/reset.includes.coffee'
    # FIXME: require & put real theme styl files array here
    themeStyles = []
    STYLES_PATH = themeStyles.concat resetStyles

  gulp.src STYLES_PATH
    .pipe stylus()
    .pipe concat 'kd.css'
    .pipe gulpif useMinify, minifyCSS()
    .pipe rename "kd.#{version}css"
    .pipe gulp.dest "#{buildDir}/css"


gulp.task 'libs', ['clean'], ->

  gulp.src LIBS
    # INVESTIGATE: this somehow breaks jQuery - SY
    # .pipe gulpif useUglify, uglify()
    .pipe uglify()
    .pipe concat 'tmp'
    .pipe rename "kd.libs.#{version}js"
    .pipe gulp.dest 'test'
    .pipe gulp.dest "#{buildDir}/js"

gulp.task 'export', ->

  return  if argv.entryPath

  exec "cd ./src;sh exporter.sh > entry.coffee; cd .."


gulp.task 'coffee', ['export', 'clean'], ->

  gulpBrowserify
      entries : ENTRY_PATH
    .pipe source ENTRY_PATH
    .pipe gulpBuffer()
    .pipe gulpif useUglify, uglify(mangle : no)
    .pipe rename "kd.#{version}js"
    .pipe gulp.dest "#{buildDir}/js"


# Build Playground

gulp.task 'play-styles', ['clean-play'], ->

  gulp.src ['./playground/main.styl']
    .pipe stylus()
    .pipe concat "kd.css"
    .pipe gulpif useMinify, minifyCSS()
    .pipe rename "main.css"
    .pipe gulp.dest "playground/css"


gulp.task 'play-html', ->

  livereload = require 'gulp-livereload'
  gulp.src './playground/index.html'
    .pipe gulpif useLiveReload, livereload()


gulp.task 'play-coffee', ['clean-play'], ->

  gulpBrowserify
      entries : ['./playground/main.coffee']
    .pipe source "main.js"
    .pipe gulp.dest "playground/js"


gulp.task 'play', ['clean-play', 'play-html', 'play-styles', 'play-coffee'], ->


# Build docs

gulp.task 'docs-exec', ->
  exec "cd docs;mkdir js;mkdir css;cd .."


gulp.task 'docs-coffee', ['docs-exec'], ->

  gulpBrowserify
      entries : ['./docs/src/main.coffee']
    .pipe source 'main.js'
    .pipe gulp.dest 'docs/js'


gulp.task 'docs-styles', ['docs-exec'],->

  gulp.src ['./docs/src/styl/main.styl']
    .pipe stylus()
    .pipe gulpif useMinify, minifyCSS()
    .pipe rename 'main.css'
    .pipe gulp.dest 'docs/css'


gulp.task 'docs-html', ->

  livereload = require 'gulp-livereload'
  gulp.src './docs/index.html'
    .pipe gulpif useLiveReload, livereload()


# sitemap task

# this creates a simple two level sitemap
# for the files under ./docs/contents
#
# e.g.
# ./docs/contents/getting.started/readme.md
# ./docs/contents/getting.started/sample.md
# ./docs/contents/more.examples/readme.md
# ./docs/contents/more.examples/sample.md
#
# becomes
#
# KD.sitemap = {
#   'getting.started' : ['readme.md', 'sample.md']
#   'more.examples'   : ['readme.md', 'sample.md']
# }

gulp.task 'docs-sitemap', ->

  find     = require 'findit'
  folder   = "#{__dirname}/docs/contents/"
  finder   = find folder
  tree     = {}
  trimBase = (dir) -> dir.replace folder, ''

  finder.on 'directory', (dir, stat, stop) ->
    dir = trimBase dir
    return  if /\//.test dir
    tree[dir] = []  if dir

  finder.on 'file', (file, stat) ->
    file = trimBase file
    return  unless /\//.test file
    [parent, file] = file.split '/'
    tree[parent].push file  if file

  finder.on 'end', ->
    content = "(function(){window.KD||(window.KD={});KD.sitemap=#{JSON.stringify tree}})()"
    fs.writeFileSync "#{__dirname}/docs/js/kd.sitemap.js", content


gulp.task 'docs', ['docs-exec', 'docs-html', 'docs-sitemap',
                   'docs-coffee', 'docs-styles']


# Build test suite

gulp.task 'coffee-test', ->

  stream = gulpBrowserify
      entries : './test/test.coffee'
    .pipe source "kd.test.js"
    .pipe gulp.dest 'test'


testFiles = [
  './test/kd.libs.js'
  './test/kd.test.js'
]

gulp.task 'karma', ['coffee-test'], ->

  karma = require 'gulp-karma'

  gulp.src testFiles
    .pipe karma
      configFile : 'karma.conf.js'
      action     : karmaAction


gulp.task 'karma-travis', ['coffee-test'], ->
  karma = require 'gulp-karma'
  gulp.src testFiles
    .pipe karma
      configFile : 'karma.travis.conf.js'
      action     : 'run'


gulp.task 'sauce', ->
  gulp.src testFiles
    .pipe karma
      browsers   : [
        'sl_firefox_windows'
        'sl_chrome_windows'
        'sl_ie_9'
        'sl_ie_10'
      ]
      configFile : 'karma.conf.js'
      action     : 'run'


# build webserver

gulp.task 'webserver', ['compile'], ->
  express = require 'express'
  app     = express()

  app.use express.static "#{__dirname}/#{buildDir}"

  app.get '*', (req, res) ->
    {url}            = req
    redirectTo = "/#!#{url}"

    res.header 'Location', redirectTo
    res.send 301

  app.listen 3000

  log 'green', "HTTP server for #{buildDir} is ready at localhost:3000"
  return


# Watch Tasks

gulp.task 'watch-test', ->

  watchLogger 'cyan', gulp.watch TEST_PATH, ['coffee-test']


gulp.task 'watch-coffee', ->

  watchLogger 'yellow', gulp.watch COFFEE_PATH, ['coffee']


gulp.task 'watch-libs', ->

  watchLogger 'yellow', gulp.watch LIBS_PATH, ['libs']


gulp.task 'watch-styles', ->

  watchLogger 'yellow', gulp.watch STYLES_PATH, ['styles']


gulp.task 'watch-playground', ->

  watchLogger 'blue', gulp.watch [
    './playground/**/*.coffee'
    './playground/**/*.styl'
    './playground/**/*.html'
  ], ['play']


gulp.task 'watch-docs', ->

  watchLogger 'blue', gulp.watch [
    './docs/src/**/*.coffee'
    './docs/src/**/*.styl'
    './docs/*.html'
  ], ['docs']


# Helper Tasks

gulp.task 'live', -> useLiveReload = yes


gulp.task 'run', -> karmaAction = 'run'


gulp.task 'clean', -> del ['build'], force : yes


gulp.task 'clean-play', -> del ['./playground/{css,js}'], force : yes



# Use markdox to output markdown files for the API Documentation.
gulp.task 'markdox', ->

  markdox = require 'gulp-markdox'

  gulp.src [
      'src/**/core/**/*.coffee'
      'src/**/components/**/*.coffee'
      ]
    .pipe markdox()
    .pipe rename extname: '.md'
    .pipe gulp.dest 'docs/api'


# Aggregate Tasks

gulp.task 'compile', ['styles', 'libs', 'coffee']

defaultTasks = ['compile', 'watch-styles', 'watch-coffee', 'watch-libs']

if buildDocs
  buildDir     = 'docs'
  defaultTasks = defaultTasks.concat ['live', 'docs', 'watch-docs', 'webserver']
else if buildPlay
  buildDir     = 'playground'
  defaultTasks = defaultTasks.concat ['live', 'play', 'watch-playground', 'webserver']


gulp.task 'default', defaultTasks , -> log 'green', 'All done!'


# error handling

process.on 'uncaughtException', (err)->

  log 'red', "An error has occurred: #{err.name}"
  console.error err