diff options
| author | Dave Geddes | 2012-10-21 00:37:59 -0600 | 
|---|---|---|
| committer | Igor Minar | 2013-03-05 23:35:13 -0800 | 
| commit | 7a77fdae4f6a1a03734374aacc7264ebd6dbe94d (patch) | |
| tree | 603153ab33e9927adf72b3316a10c44f504430f9 /lib | |
| parent | b13da18e11d5f67696906d1ecd2fc9e753d50da4 (diff) | |
| download | angular.js-7a77fdae4f6a1a03734374aacc7264ebd6dbe94d.tar.bz2 | |
chore(Grunt): switch from Rake to Grunt
Migrates the Angular project from Rake to Grunt.
Benefits:
- Drops Ruby dependency
- Lowers barrier to entry for contributions from JavaScript ninjas
- Simplifies the Angular project setup and build process
- Adopts industry-standard tools specific to JavaScript projects
- Support building angular.js on Windows platform (really?!? why?!?)
BREAKING CHANGE: Rake is completely replaced by Grunt. Below are the deprecated Rake tasks and their Grunt equivalents:
rake --> grunt
rake package --> grunt package
rake init --> N/A
rake clean --> grunt clean
rake concat_scenario --> grunt build:scenario
rake concat --> grunt build
rake concat_scenario --> grunt build:scenario
rake minify --> grunt minify
rake version --> grunt write:version
rake docs --> grunt docs
rake webserver --> grunt webserver
rake test --> grunt test
rake test:unit --> grunt test:unit
rake test:<jqlite|jquery|modules|e2e> --> grunt test:<jqlite|jquery|modules|end2end|e2e>
rake test[Firefox+Safari] --> grunt test --browsers Firefox,Safari
rake test[Safari] --> grunt test --browsers Safari
rake autotest --> grunt autotest
NOTES:
* For convenience grunt test:e2e starts a webserver for you, while grunt test:end2end doesn't.
  Use grunt test:end2end if you already have the webserver running.
* Removes duplicate entry for Describe.js in the angularScenario section of angularFiles.js
* Updates docs/src/gen-docs.js to use #done intead of the deprecated #end
* Uses grunt-contrib-connect instead of lib/nodeserver (removed)
* Removes nodeserver.sh, travis now uses grunt webserver
* Built and minified files are identical to Rake's output, with the exception of one less
  character for git revisions (using --short) and a couple minor whitespace differences
Closes #199
Conflicts:
	Rakefile
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/grunt/plugins.js | 61 | ||||
| -rw-r--r-- | lib/grunt/utils.js | 175 | ||||
| -rw-r--r-- | lib/nodeserver/favicon.ico | bin | 1150 -> 0 bytes | |||
| -rw-r--r-- | lib/nodeserver/server.js | 273 | 
4 files changed, 236 insertions, 273 deletions
| diff --git a/lib/grunt/plugins.js b/lib/grunt/plugins.js new file mode 100644 index 00000000..c67aa545 --- /dev/null +++ b/lib/grunt/plugins.js @@ -0,0 +1,61 @@ +var util = require('./utils.js'); +var spawn = require('child_process').spawn; + +module.exports = function(grunt) { + +  grunt.registerMultiTask('min', 'minify JS files', function(){ +    util.min.call(util, this.data, this.async()); +  }); + + +  grunt.registerTask('minall', 'minify all the JS files in parallel', function(){ +    var files = grunt.config('min'); +    files = Object.keys(files).map(function(key){ return files[key]; }); +    grunt.util.async.forEach(files, util.min.bind(util), this.async()); +  }); + + +  grunt.registerMultiTask('build', 'build JS files', function(){ +    util.build.call(util, this.data, this.async()); +  }); + + +  grunt.registerTask('buildall', 'build all the JS files in parallel', function(){ +    var builds = grunt.config('build'); +    builds = Object.keys(builds).map(function(key){ return builds[key]; }); +    grunt.util.async.forEach(builds, util.build.bind(util), this.async()); +  }); + + +  grunt.registerMultiTask('write', 'write content to a file', function(){ +    grunt.file.write(this.data.file, this.data.val); +    grunt.log.ok('wrote to ' + this.data.file); +  }); + + +  grunt.registerMultiTask('docs', 'create angular docs', function(){ +    var done = this.async(); +    var files = this.data; +    var docs  = spawn('node', ['docs/src/gen-docs.js']); +    docs.stdout.pipe(process.stdout); +    docs.stderr.pipe(process.stderr); +    docs.on('exit', function(code){ +      if(code !== 0) grunt.fail.warn('Error creating docs'); +      grunt.file.expand(files).forEach(function(file){ +        grunt.file.write(file, util.process(grunt.file.read(file), grunt.config('NG_VERSION'), false)); +      }); +      grunt.log.ok('docs created'); +      done(); +    }); +  }); + + +  grunt.registerMultiTask('test', 'Run the unit tests with testacular', function(){ +    util.startTestacular.call(util, this.data, true, this.async()); +  }); + + +  grunt.registerMultiTask('autotest', 'Run and watch the unit tests with testacular', function(){ +    util.startTestacular.call(util, this.data, false, this.async()); +  }); +}; diff --git a/lib/grunt/utils.js b/lib/grunt/utils.js new file mode 100644 index 00000000..80a41f30 --- /dev/null +++ b/lib/grunt/utils.js @@ -0,0 +1,175 @@ +var fs = require('fs'); +var shell = require('shelljs'); +var yaml = require('yaml-js'); +var grunt = require('grunt'); +var spawn = require('child_process').spawn; + +module.exports = { + +  init: function() { +    shell.exec('npm install'); +  }, + + +  getVersion: function(){ +    var versionYaml = yaml.load(fs.readFileSync('version.yaml', 'UTF-8')); +    var match = versionYaml.version.match(/^([^\-]*)(-snapshot)?$/); +    var semver = match[1].split('.'); +    var hash = shell.exec('git rev-parse --short HEAD', {silent: true}).output.replace('\n', ''); + +    var version = { +      full: (match[1] + (match[2] ? '-' + hash : '')), +      major: semver[0], +      minor: semver[1], +      dot: semver[2], +      codename: versionYaml.codename, +      stable: versionYaml.stable +    }; + +    return version; +  }, + + +  startTestacular: function(config, singleRun, done){ +    var browsers = grunt.option('browsers'); +    var reporters = grunt.option('reporters'); +    var noColor = grunt.option('no-colors'); +    var p = spawn('node', ['node_modules/testacular/bin/testacular', 'start', config, +      singleRun ? '--single-run=true' : '', +      reporters ? '--reporters=' + reporters : '', +      browsers ? '--browsers=' + browsers : '', +      noColor ? '--no-colors' : '' +    ]); +    p.stdout.pipe(process.stdout); +    p.stderr.pipe(process.stderr); +    p.on('exit', function(code){ +      if(code !== 0) grunt.fail.warn("Test(s) failed"); +      done(); +    }); +  }, + + +  wrap: function(src, name){ +    src.unshift('src/' + name + '.prefix'); +    src.push('src/' + name + '.suffix'); +    return src; +  }, + + +  addStyle: function(src, styles, minify){ +    styles = styles.map(processCSS.bind(this)).join('\n'); +    src += styles; +    return src; + +    function processCSS(file){ +      var css = fs.readFileSync(file).toString(); +      if(minify){ +        css = css +          .replace(/\n/g, '') +          .replace(/\/\*.*?\*\//g, '') +          .replace(/:\s+/g, ':') +          .replace(/\s*\{\s*/g, '{') +          .replace(/\s*\}\s*/g, '}') +          .replace(/\s*\,\s*/g, ',') +          .replace(/\s*\;\s*/g, ';'); +      } +      //espace for js +      css = css +        .replace(/\\/g, '\\\\') +        .replace(/'/g, "\\'") +        .replace(/\n/g, '\\n'); +      return "angular.element(document).find('head').append('<style type=\"text/css\">" + css + "</style>');"; +    } +  }, + + +  process: function(src, NG_VERSION, strict){ +    var processed = src +      .replace(/"NG_VERSION_FULL"/g, NG_VERSION.full) +      .replace(/"NG_VERSION_MAJOR"/, NG_VERSION.major) +      .replace(/"NG_VERSION_MINOR"/, NG_VERSION.minor) +      .replace(/"NG_VERSION_DOT"/, NG_VERSION.dot) +      .replace(/"NG_VERSION_STABLE"/, NG_VERSION.stable) +      .replace(/"NG_VERSION_CODENAME"/, NG_VERSION.codename); +    if (strict !== false) processed = this.singleStrict(processed, '\n\n', true); +    return processed; +  }, + + +  build: function(config, fn){ +    var files = grunt.file.expand(config.src); +    var styles = config.styles; +    //concat +    var src = files.map(function(filepath){ +      return grunt.file.read(filepath); +    }).join(grunt.util.normalizelf('\n')); +    //process +    var processed = this.process(src, grunt.config('NG_VERSION'), config.strict); +    if (styles) processed = this.addStyle(processed, styles.css, styles.minify); +    //write +    grunt.file.write(config.dest, processed); +    grunt.log.ok('File ' + config.dest + ' created.'); +    fn(); +  }, + + +  singleStrict: function(src, insert, newline){ +    var useStrict = newline ? "$1\n'use strict';" : "$1'use strict';"; +    return src +      .replace(/\s*("|')use strict("|');\s*/g, insert) // remove all file-specific strict mode flags +      .replace(/(\(function\([^)]*\)\s*\{)/, useStrict); // add single strict mode flag +  }, + + +  min: function(file, done) { +    var minFile = file.replace(/\.js$/, '.min.js'); +    shell.exec( +        'java ' + +            this.java32flags() + ' ' + +            '-jar lib/closure-compiler/compiler.jar ' + +            '--compilation_level SIMPLE_OPTIMIZATIONS ' + +            '--language_in ECMASCRIPT5_STRICT ' + +            '--js ' + file + ' ' + +            '--js_output_file ' + minFile, +      function(code) { +        if (code !== 0) grunt.fail.warn('Error minifying ' + file); +        grunt.file.write(minFile, this.singleStrict(grunt.file.read(minFile), '\n')); +        grunt.log.ok(file + ' minified into ' + minFile); +        done(); +    }.bind(this)); +  }, + + +  //returns the 32-bit mode force flags for java compiler if supported, this makes the build much faster +  java32flags: function(){ +    if (process.platform === "win32") return ''; +    if (shell.exec('java -version -d32 2>&1', {silent: true}).code !== 0) return ''; +    return ' -d32 -client'; +  }, + + +  //csp connect middleware +  csp: function(){ +    return function(req, res, next){ +      res.setHeader("X-WebKit-CSP", "default-src 'self';"); +      res.setHeader("X-Content-Security-Policy", "default-src 'self'"); +      next(); +    }; +  }, + + +  //rewrite connect middleware +  rewrite: function(){ +    return function(req, res, next){ +      var REWRITE = /\/(guide|api|cookbook|misc|tutorial).*$/, +          IGNORED = /(\.(css|js|png|jpg)$|partials\/.*\.html$)/, +          match; + +      if (!IGNORED.test(req.url) && (match = req.url.match(REWRITE))) { +        console.log('rewriting', req.url); +        req.url = req.url.replace(match[0], '/index.html'); +      } +      next(); +    }; +  } +}; diff --git a/lib/nodeserver/favicon.ico b/lib/nodeserver/favicon.icoBinary files differ deleted file mode 100644 index fe24a63a..00000000 --- a/lib/nodeserver/favicon.ico +++ /dev/null diff --git a/lib/nodeserver/server.js b/lib/nodeserver/server.js deleted file mode 100644 index 1c7f012c..00000000 --- a/lib/nodeserver/server.js +++ /dev/null @@ -1,273 +0,0 @@ -var sys = require('sys'), -    http = require('http'), -    fs = require('fs'), -    url = require('url'), -    events = require('events'); - -var DEFAULT_PORT = 8000; - -function main(argv) { -  new HttpServer({ -    'GET': createServlet(StaticServlet), -    'HEAD': createServlet(StaticServlet) -  }).start(Number(argv[2]) || DEFAULT_PORT); -} - -function escapeHtml(value) { -  return value.toString(). -    replace('<', '<'). -    replace('>', '>'). -    replace('"', '"'); -} - -function createServlet(Class) { -  var servlet = new Class(); -  return servlet.handleRequest.bind(servlet); -} - -/** - * An Http server implementation that uses a map of methods to decide - * action routing. - * - * @param {Object} Map of method => Handler function - */ -function HttpServer(handlers) { -  this.handlers = handlers; -  this.server = http.createServer(this.handleRequest_.bind(this)); -} - -HttpServer.prototype.start = function(port) { -  this.port = port; -  this.server.listen(port); -  sys.puts('Http Server running at http://127.0.0.1:' + port + '/'); -}; - -HttpServer.prototype.parseUrl_ = function(urlString) { -  var parsed = url.parse(urlString); -  parsed.pathname = url.resolve('/', parsed.pathname); -  return url.parse(url.format(parsed), true); -}; - -HttpServer.prototype.handleRequest_ = function(req, res) { -  var logEntry = req.method + ' ' + req.url; -  if (req.headers['user-agent']) { -    logEntry += ' ' + req.headers['user-agent']; -  } -  sys.puts(logEntry); -  req.url = this.parseUrl_(req.url); -  var handler = this.handlers[req.method]; -  if (!handler) { -    res.writeHead(501); -    res.end(); -  } else { -    handler.call(this, req, res); -  } -}; - -/** - * Handles static content. - */ -function StaticServlet() {} - -StaticServlet.MimeMap = { -  'txt': 'text/plain', -  'html': 'text/html', -  'css': 'text/css', -  'xml': 'application/xml', -  'json': 'application/json', -  'js': 'application/javascript', -  'jpg': 'image/jpeg', -  'jpeg': 'image/jpeg', -  'gif': 'image/gif', -  'png': 'image/png', -  'manifest': 'text/cache-manifest', -  // it should be application/font-woff -  // but only this silences chrome warnings -  'woff': 'font/opentype' -}; - -StaticServlet.prototype.handleRequest = function(req, res) { -  var self = this; -  var path = ('./' + req.url.pathname).replace('//','/').replace(/%(..)/g, function(match, hex){ -    return String.fromCharCode(parseInt(hex, 16)); -  }); -  var parts = path.split('/'); -  if (parts[parts.length-1].charAt(0) === '.') -    return self.sendForbidden_(req, res, path); - -  // favicon rewriting -  if (path === './favicon.ico') -    return self.sendFile_(req, res, './lib/nodeserver/favicon.ico'); - -  // docs rewriting -  var REWRITE = /\/(guide|api|cookbook|misc|tutorial).*$/, -      IGNORED = /(\.(css|js|png|jpg)$|partials\/.*\.html$)/, -      match; - -  if (!IGNORED.test(path) && (match = path.match(REWRITE))) { -      path = path.replace(match[0], '/index.html'); -      sys.puts('Rewrite to ' + path); -  } - -  // end of docs rewriting - -  fs.stat(path, function(err, stat) { -    if (err) -      return self.sendMissing_(req, res, path); -    if (stat.isDirectory()) -      return fs.stat(path + 'index.html', function(err, stat) { -        // send index.html if exists -        if (!err) -          return self.sendFile_(req, res, path + 'index.html'); - -        // list files otherwise -        return self.sendDirectory_(req, res, path); -      }); - -    return self.sendFile_(req, res, path); -  }); -}; - -StaticServlet.prototype.sendError_ = function(req, res, error) { -  res.writeHead(500, { -      'Content-Type': 'text/html' -  }); -  res.write('<!doctype html>\n'); -  res.write('<title>Internal Server Error</title>\n'); -  res.write('<h1>Internal Server Error</h1>'); -  res.write('<pre>' + escapeHtml(sys.inspect(error)) + '</pre>'); -  sys.puts('500 Internal Server Error'); -  sys.puts(sys.inspect(error)); -}; - -StaticServlet.prototype.sendMissing_ = function(req, res, path) { -  path = path.substring(1); -  res.writeHead(404, { -      'Content-Type': 'text/html' -  }); -  res.write('<!doctype html>\n'); -  res.write('<title>404 Not Found</title>\n'); -  res.write('<h1>Not Found</h1>'); -  res.write( -    '<p>The requested URL ' + -    escapeHtml(path) + -    ' was not found on this server.</p>' -  ); -  res.end(); -  sys.puts('404 Not Found: ' + path); -}; - -StaticServlet.prototype.sendForbidden_ = function(req, res, path) { -  path = path.substring(1); -  res.writeHead(403, { -      'Content-Type': 'text/html' -  }); -  res.write('<!doctype html>\n'); -  res.write('<title>403 Forbidden</title>\n'); -  res.write('<h1>Forbidden</h1>'); -  res.write( -    '<p>You do not have permission to access ' + -    escapeHtml(path) + ' on this server.</p>' -  ); -  res.end(); -  sys.puts('403 Forbidden: ' + path); -}; - -StaticServlet.prototype.sendRedirect_ = function(req, res, redirectUrl) { -  res.writeHead(301, { -      'Content-Type': 'text/html', -      'Location': redirectUrl -  }); -  res.write('<!doctype html>\n'); -  res.write('<title>301 Moved Permanently</title>\n'); -  res.write('<h1>Moved Permanently</h1>'); -  res.write( -    '<p>The document has moved <a href="' + -    redirectUrl + -    '">here</a>.</p>' -  ); -  res.end(); -  sys.puts('301 Moved Permanently: ' + redirectUrl); -}; - -StaticServlet.prototype.sendFile_ = function(req, res, path) { -  var self = this; -  var file = fs.createReadStream(path); -  res.writeHead(200, { -    // CSP headers, uncomment to enable CSP -    //"X-WebKit-CSP": "default-src 'self';", -    //"X-Content-Security-Policy": "default-src 'self'", -    'Content-Type': StaticServlet. -      MimeMap[path.split('.').pop()] || 'text/plain' -  }); -  if (req.method === 'HEAD') { -    res.end(); -  } else { -    file.on('data', res.write.bind(res)); -    file.on('close', function() { -      res.end(); -    }); -    file.on('error', function(error) { -      self.sendError_(req, res, error); -    }); -  } -}; - -StaticServlet.prototype.sendDirectory_ = function(req, res, path) { -  var self = this; -  if (path.match(/[^\/]$/)) { -    req.url.pathname += '/'; -    var redirectUrl = url.format(url.parse(url.format(req.url))); -    return self.sendRedirect_(req, res, redirectUrl); -  } -  fs.readdir(path, function(err, files) { -    if (err) -      return self.sendError_(req, res, error); - -    if (!files.length) -      return self.writeDirectoryIndex_(req, res, path, []); - -    var remaining = files.length; -    files.forEach(function(fileName, index) { -      fs.stat(path + '/' + fileName, function(err, stat) { -        if (err) -          return self.sendError_(req, res, err); -        if (stat.isDirectory()) { -          files[index] = fileName + '/'; -        } -        if (!(--remaining)) -          return self.writeDirectoryIndex_(req, res, path, files); -      }); -    }); -  }); -}; - -StaticServlet.prototype.writeDirectoryIndex_ = function(req, res, path, files) { -  path = path.substring(1); -  res.writeHead(200, { -    'Content-Type': 'text/html' -  }); -  if (req.method === 'HEAD') { -    res.end(); -    return; -  } -  res.write('<!doctype html>\n'); -  res.write('<title>' + escapeHtml(path) + '</title>\n'); -  res.write('<style>\n'); -  res.write('  ol { list-style-type: none; font-size: 1.2em; }\n'); -  res.write('</style>\n'); -  res.write('<h1>Directory: ' + escapeHtml(path) + '</h1>'); -  res.write('<ol>'); -  files.forEach(function(fileName) { -    if (fileName.charAt(0) !== '.') { -      res.write('<li><a href="' + -        escapeHtml(fileName) + '">' + -        escapeHtml(fileName) + '</a></li>'); -    } -  }); -  res.write('</ol>'); -  res.end(); -}; - -// Must be last, -main(process.argv); | 
