Test for creating file in subdirectories

.gitignore

@@ -1 +1,3 @@
-/node_modules/
+node_modules
+experiments
+build

AUTHORS

@@ -8,3 +8,12 @@ Chris Chua (http://sirh.cc/)
 Kael Zhang (http://kael.me)
 Krasimir Tsonev (http://krasimirtsonev.com/blog)
 brett-shwom
+Kai Groner
+zeripath
+Tim Schaub (http://tschaub.net/)
+Amjad Masad (http://amasad.github.com/)
+Eric Schoffstall (http://contra.io/)
+Eric O'Connor (http://oco.nnor.org/)
+Cheng Zhao (https://github.com/zcbenz)
+Kevin Sawicki (https://github.com/kevinsawicki)
+Nathan Sobo (https://github.com/nathansobo)

Gruntfile.js

@@ -1,28 +1,15 @@
 module.exports = function(grunt) {
   'use strict';
+
+  grunt.option('stack', true);
+
   grunt.initConfig({
-    benchmark: {
-      all: {
-        src: ['benchmarks/*.js'],
-        options: { times: 10 }
-      }
-    },
     nodeunit: {
       files: ['test/*_test.js'],
     },
     jshint: {
-      options: {
-        jshintrc: '.jshintrc'
-      },
-      gruntfile: {
-        src: 'Gruntfile.js'
-      },
-      lib: {
-        src: ['lib/**/*.js']
-      },
-      test: {
-        src: ['test/**/*_test.js']
-      },
+      options: { jshintrc: true },
+      all: ['Gruntfile.js', 'lib/**/*.js', 'test/*.js', 'benchmarks/*.js', '!lib/pathwatcher.js'],
     },
   });
 
@@ -32,7 +19,6 @@ module.exports = function(grunt) {
     grunt.task.run('nodeunit');
   });
 
-  grunt.loadNpmTasks('grunt-benchmark');
   grunt.loadNpmTasks('grunt-contrib-jshint');
   grunt.loadNpmTasks('grunt-contrib-nodeunit');
   grunt.registerTask('default', ['jshint', 'nodeunit']);

LICENSE-MIT

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Kyle Robinson Young
+Copyright (c) 2014 Kyle Robinson Young
 
 Permission is hereby granted, free of charge, to any person
 obtaining a copy of this software and associated documentation

README.md

@@ -1,10 +1,22 @@
-# gaze [![Build Status](https://travis-ci.org/shama/gaze.png?branch=master)](https://travis-ci.org/shama/gaze)
+# gaze [![Build Status](http://img.shields.io/travis/shama/gaze.svg)](https://travis-ci.org/shama/gaze) [![gittip.com/shama](http://img.shields.io/gittip/shama.svg)](https://www.gittip.com/shama)
 
 A globbing fs.watch wrapper built from the best parts of other fine watch libs.  
 Compatible with Node.js 0.10/0.8, Windows, OSX and Linux.
 
 ![gaze](http://dontkry.com/images/repos/gaze.png)
 
+## Features
+
+[![NPM](https://nodei.co/npm/gaze.png?downloads=true)](https://nodei.co/npm/gaze/)
+
+* Consistent events on OSX, Linux and Windows
+* Very fast start up and response time
+* High test coverage
+* Uses native OS events but falls back to stat polling
+* Option to force stat polling with special file systems such as networked
+* Downloaded over 400K times a month
+* Used by [Grunt](http://gruntjs.com), [gulp](http://gulpjs.com), [Tower](http://tower.github.io/) and many others
+
 ## Usage
 Install the module with: `npm install gaze` or place into your `package.json`
 and run `npm install`.
@@ -18,7 +30,9 @@ gaze('**/*.js', function(err, watcher) {
   // watcher === this
 
   // Get all watched files
-  console.log(this.watched());
+  this.watched(function(watched) {
+    console.log(watched);
+  });
 
   // On file changed
   this.on('changed', function(filepath) {
@@ -41,7 +55,9 @@ gaze('**/*.js', function(err, watcher) {
   });
 
   // Get watched files with relative paths
-  console.log(this.relative());
+  this.relative(function(err, files) {
+    console.log(files);
+  });
 });
 
 // Also accepts an array of patterns
@@ -68,21 +84,36 @@ gaze.on('all', function(event, filepath) { });
 ### Errors
 
 ```javascript
-gaze('**/*', function() {
-  this.on('error', function(err) {
-    // Handle error here
-  });
+gaze('**/*', function(error, watcher) {
+  if (error) {
+    // Handle error if it occurred while starting up
+  }
+});
+
+// Or with the alternative interface
+var gaze = new Gaze();
+gaze.on('error', function(error) {
+  // Handle error here
 });
+gaze.add('**/*');
 ```
 
+#### `EMFILE` errors
+
+By default, gaze will use native OS events and then fallback to slower stat polling when an `EMFILE` error is reached. Gaze will still emit or return the error as the first argument of the ready callback for you to handle.
+
+It is recommended to advise your users to increase their file descriptor limits to utilize the faster native OS watching. Especially on OSX where the default descriptor limit is 256.
+
+In some cases, native OS events will not work. Such as with networked file systems or vagrant. It is recommended to set the option `mode: 'poll'` to always stat poll for those situations.
+
 ### Minimatch / Glob
 
 See [isaacs's minimatch](https://github.com/isaacs/minimatch) for more
 information on glob patterns.
 
 ## Documentation
 
-### gaze(patterns, [options], callback)
+### gaze([patterns, options, callback])
 
 * `patterns` {String|Array} File patterns to be matched
 * `options` {Object}
@@ -92,7 +123,7 @@ information on glob patterns.
 
 ### Class: gaze.Gaze
 
-Create a Gaze object by instanting the `gaze.Gaze` class.
+Create a Gaze object by instancing the `gaze.Gaze` class.
 
 ```javascript
 var Gaze = require('gaze').Gaze;
@@ -105,6 +136,8 @@ var gaze = new Gaze(pattern, options, callback);
   * `interval` {integer} Interval to pass to fs.watchFile
   * `debounceDelay` {integer} Delay for events called in succession for the same
     file/event
+  * `mode` {string} Force the watch mode. Either `'auto'` (default), `'watch'` (force native events), or `'poll'` (force stat polling).
+  * `cwd` {string} The current working directory to base file patterns from. Default is `process.cwd()`.
 
 #### Events
 
@@ -126,33 +159,37 @@ var gaze = new Gaze(pattern, options, callback);
 * `add(patterns, callback)` Adds file(s) patterns to be watched.
 * `remove(filepath)` removes a file or directory from being watched. Does not
   recurse directories.
-* `watched()` Returns the currently watched files.
-* `relative([dir, unixify])` Returns the currently watched files with relative paths.
+* `watched([callback])` Returns the currently watched files.
+  * `callback` {function} Calls with `function(err, files)`.
+* `relative([dir, unixify, callback])` Returns the currently watched files with relative paths.
   * `dir` {string} Only return relative files for this directory.
   * `unixify` {boolean} Return paths with `/` instead of `\\` if on Windows.
+  * `callback` {function} Calls with `function(err, files)`.
 
 ## FAQs
 
 ### Why Another `fs.watch` Wrapper?
 I liked parts of other `fs.watch` wrappers but none had all the features I
-needed. This lib combines the features I needed from other fine watch libs:
-Speedy data behavior from
-[paulmillr's chokidar](https://github.com/paulmillr/chokidar), API interface
-from [mikeal's watch](https://github.com/mikeal/watch) and file globbing using
-[isaacs's glob](https://github.com/isaacs/node-glob) which is also used by
-[cowboy's Grunt](https://github.com/gruntjs/grunt).
-
-### How do I fix the error `EMFILE: Too many opened files.`?
-This is because of your system's max opened file limit. For OSX the default is
-very low (256). Increase your limit temporarily with `ulimit -n 10480`, the
-number being the new max limit.
+needed when this library was originally written. This lib once combined the features I needed from other fine watch libs
+but now has taken on a life of it's own (**gaze doesn't wrap `fs.watch` or `fs.watchFile` anymore**).
+
+Other great watch libraries to try are:
+
+* [paulmillr's chokidar](https://github.com/paulmillr/chokidar)
+* [mikeal's watch](https://github.com/mikeal/watch)
+* [github's pathwatcher](https://github.com/atom/node-pathwatcher)
+* [bevry's watchr](https://github.com/bevry/watchr)
 
 ## Contributing
 In lieu of a formal styleguide, take care to maintain the existing coding style.
 Add unit tests for any new or changed functionality. Lint and test your code
 using [grunt](http://gruntjs.com/).
 
 ## Release History
+* 0.6.3 - Add support for node v0.11
+* 0.6.2 - Fix argument error with watched(). Fix for erroneous added events on folders. Ignore msvs build error 4244.
+* 0.6.1 - Fix for absolute paths.
+* 0.6.0 - Uses native OS events (fork of pathwatcher) but can fall back to stat polling. Everything is async to avoid blocking, including `relative()` and `watched()`. Better error handling. Update to [email protected]. No longer watches `cwd` by default. Added `mode` option. Better `EMFILE` message. Avoids `ENOENT` errors with symlinks. All constructor arguments are optional.
 * 0.5.1 - Use setImmediate (process.nextTick for node v0.8) to defer ready/nomatch events (@amasad).
 * 0.5.0 - Process is now kept alive while watching files. Emits a nomatch event when no files are matching.
 * 0.4.3 - Track file additions in newly created folders (@brett-shwom).
@@ -176,5 +213,5 @@ using [grunt](http://gruntjs.com/).
 * 0.1.0 - Initial release
 
 ## License
-Copyright (c) 2013 Kyle Robinson Young  
+Copyright (c) 2014 Kyle Robinson Young  
 Licensed under the MIT license.

benchmarks/benchmarker.js

@@ -0,0 +1,70 @@
+'use strict';
+
+var async = require('async');
+var fs = require('fs');
+var rimraf = require('rimraf');
+var path = require('path');
+var AsciiTable = require('ascii-table');
+var readline = require('readline');
+
+function Benchmarker(opts) {
+  if (!(this instanceof Benchmarker)) return new Benchmarker(opts);
+  opts = opts || {};
+  this.table = new AsciiTable(opts.name || 'benchmark');
+  this.tmpDir = opts.tmpDir || path.resolve(__dirname, 'tmp');
+  var max = opts.max || 2000;
+  var multiplesOf = opts.multiplesOf || 100;
+  this.fileNums = [];
+  for (var i = 0; i <= max / multiplesOf; i++) {
+    this.fileNums.push(i * multiplesOf);
+  }
+  this.startTime = 0;
+  this.files = [];
+}
+module.exports = Benchmarker;
+
+Benchmarker.prototype.log = function() {
+  readline.cursorTo(process.stdout, 0, 0);
+  readline.clearScreenDown(process.stdout);
+  this.table.addRow.apply(this.table, arguments);
+  console.log(this.table.toString());
+};
+
+Benchmarker.prototype.setup = function(num) {
+  this.teardown();
+  fs.mkdirSync(this.tmpDir);
+  this.files = [];
+  for (var i = 0; i <= num; i++) {
+    var file = path.join(this.tmpDir, 'test-' + i + '.txt');
+    fs.writeFileSync(file, String(i));
+    this.files.push(file);
+  }
+};
+
+Benchmarker.prototype.teardown = function() {
+  if (fs.existsSync(this.tmpDir)) {
+    rimraf.sync(this.tmpDir);
+  }
+};
+
+Benchmarker.prototype.run = function(fn, done) {
+  var self = this;
+  async.eachSeries(this.fileNums, function(num, next) {
+    self.setup(num);
+    fn(num, function() {
+      process.nextTick(next);
+    });
+  }, function() {
+    self.teardown();
+    done();
+  });
+};
+
+Benchmarker.prototype.start = function() {
+  this.startTime = process.hrtime();
+};
+
+Benchmarker.prototype.end = function(radix) {
+  var diff = process.hrtime(this.startTime);
+  return ((diff[0] * 1e9 + diff[1]) * 0.000001).toFixed(radix || 2).replace(/\d(?=(\d{3})+\.)/g, '$&,') + 'ms';
+};

benchmarks/changed.js

@@ -0,0 +1,27 @@
+'use strict';
+
+var gaze = require('../');
+var path = require('path');
+var fs = require('fs');
+var Benchmarker = require('./benchmarker');
+
+var b = new Benchmarker({ name: path.basename(__filename) });
+b.table.setHeading('files', 'ms').setAlign(0, 2).setAlign(1, 2);
+b.run(function(num, done) {
+  gaze('**/*', {cwd: b.tmpDir, maxListeners:0}, function(err, watcher) {
+    if (err) {
+      console.error(err.code + ': ' + err.message);
+      return process.exit();
+    }
+    watcher.on('changed', function() {
+      b.log(num, b.end());
+      watcher.close();
+    });
+    watcher.on('end', done);
+    var randFile = path.join(b.tmpDir, 'test-' + Math.floor(Math.random() * num) + '.txt');
+    b.start();
+    fs.writeFileSync(randFile, '1234');
+  });
+}, function() {
+  process.exit();
+});