Initial commit

Author: backflip

.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+node_modules
+test/results
+npm-debug.log

.npmignore

@@ -0,0 +1,2 @@
+.DS_Store
+test/results

.travis.yml

@@ -0,0 +1,6 @@
+language: node_js
+node_js:
+  - 0.10
+
+script:
+  - npm test

LICENCE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2013 Thomas Jaggi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -0,0 +1,62 @@
+# gulp-resolve-dependencies
+> Resolve dependency directives in assets, e.g. ```@depend``` ([Juicer](https://github.com/cjohansen/juicer)) or ```//= require``` ([Sprockets](https://github.com/sstephenson/sprockets))). Inspired by [grunt-concat-in-order](https://github.com/miensol/grunt-concat-in-order). Useful in combination with [gulp-concat](https://github.com/wearefractal/gulp-concat).
+
+## Usage
+
+First, install `gulp-resolve-dependencies` as a development dependency:
+
+```shell
+npm install --save-dev gulp-resolve-dependencies
+```
+
+Then, add it to your `gulpfile.js` (probably together with [gulp-concat](https://github.com/wearefractal/gulp-concat)):
+
+```javascript
+var resolveDependencies = require('gulp-resolve-dependencies');
+var concat = require('gulp-concat');
+
+gulp.task('js', function(){
+  gulp.src(['app/assets/js/main.js'])
+    .pipe(resolveDependencies({
+      pattern: /\* @depend (.*?\.js)/g
+    })
+    .pipe(concat())
+    .pipe(gulp.dest('dest/assets/js/'));
+});
+```
+
+And use the directives in your JS files (dependencies can be nested, they are handled recursively):
+
+```javascript
+/**
+ * @depend libs/jquery/jquery.js
+ * @depend ../modules/slideshow/slideshow.js
+ */
+
+(function(window, document, $, undefined) {
+    'use strict';
+
+    $(document).on('ready', function() {
+        $('.slideshow').slideshow();
+    });
+
+})(window, document, jQuery);
+```
+
+**Warning**: This might not be very efficient (especially in case of nested dependencies). Some kind of caching mechanism could come in handy.
+
+
+## API
+
+### resolveDependencies(options)
+
+#### options.pattern
+Type: `RegExp`
+
+The matching pattern (optional, defaults to ```/\* @depend (.*?\.js)/g``).
+
+#### options.log
+Type: `Boolean`
+
+Whether to log the resolved dependencies (optional, defaults to ```false```.
+

index.js

@@ -0,0 +1,112 @@
+'use strict';
+
+var fs = require('fs'),
+	path = require('path'),
+	gutil = require('gulp-util'),
+	_ = require('lodash'),
+	Stream = require('stream');
+
+var PLUGIN_NAME  = 'gulp-resolve-dependencies';
+
+function resolveDependencies(config) {
+	var stream,
+		fileCache = [],
+		filesReturned = [],
+		getFiles = function(targetFile) {
+			var pattern = _.clone(config, true).pattern,
+				files = [],
+				content,
+				match,
+				relFilePath,
+				filePath,
+				file,
+				dependencies;
+
+			// Skip if already added to dependencies
+			if (_.indexOf(fileCache, targetFile.path) !== -1) {
+				return false;
+			} else {
+				fileCache.push(targetFile.path);
+			}
+
+			content = targetFile.contents.toString('utf8');
+
+			while (match = pattern.exec(content)) {
+				filePath = path.join(path.dirname(targetFile.path), match[1]);
+
+				// Skip if already added to dependencies
+				if (_.indexOf(fileCache, filePath) !== -1) {
+					continue;
+				}
+
+				// Create new file
+				file = new gutil.File({
+					base: targetFile.base,
+					path: filePath,
+					contents: fs.readFileSync(filePath)
+				});
+
+				// Get new dependencies
+				while (dependencies = getFiles(file)) {
+					files = files.concat(dependencies);
+				}
+			}
+
+			// Add file itself
+			files.push(targetFile);
+
+			return files;
+		};
+
+	// Set default values
+	config = _.merge({
+		pattern: /\* @depend (.*?\.js)/g,
+		log: false
+	}, config);
+
+	// Happy streaming
+	stream = Stream.Transform({
+		objectMode: true
+	});
+
+	stream._transform = function(file, unused, cb) {
+		var files;
+
+		if (file.isNull()) {
+			this.push(file);
+
+			return cb();
+		}
+
+		files = getFiles(file);
+
+		if (!files) {
+			return cb();
+		}
+
+		// Add dependencies and file itself to stream
+		files.forEach(_.bind(function(file) {
+			this.push(file);
+		}, this));
+
+		if (config.log) {
+			filesReturned = filesReturned.concat(files.map(function(file) {
+				return file.path;
+			}));
+		}
+
+		cb();
+	};
+
+	stream._flush = function(cb) {
+		if (config.log) {
+			gutil.log('[' + gutil.colors.green(PLUGIN_NAME) + '] Files returned to stream:', filesReturned);
+		}
+
+		cb();
+	};
+
+	return stream;
+};
+
+module.exports = resolveDependencies;

package.json

@@ -0,0 +1,36 @@
+{
+  "name": "gulp-resolve-dependencies",
+  "version": "0.0.1",
+  "description": "Resolve dependency directives in assets (e.g. \"@depend\" or \"//= require\" in JavaScript)",
+  "license": "MIT",
+  "repository": "backflip/gulp-resolve-dependencies",
+  "author": "Thomas Jaggi",
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "test": "mocha"
+  },
+  "main": "./index.js",
+  "keywords": [
+    "gulpplugin",
+    "gulp",
+    "js",
+    "dependencies",
+    "depend",
+    "depends",
+    "concat",
+    "order",
+    "juicer",
+    "sprockets"
+  ],
+  "dependencies": {
+    "gulp-util": "~2.2.0",
+    "lodash": "~2.4.1"
+  },
+  "devDependencies": {
+    "mocha": "*",
+    "event-stream": "~3.1.0",
+    "gulp": "~3.5.2"
+  }
+}

test/expected/main.js

@@ -0,0 +1,11 @@
+console.log('lib.js');
+
+/**
+ * @depend ../libs/lib.js
+ */
+console.log('test.js');
+
+/**
+ * @depend test/test.js
+ */
+console.log('main.js');

test/fixtures/libs/lib.js

@@ -0,0 +1 @@
+console.log('lib.js');

test/fixtures/main.js

@@ -0,0 +1,4 @@
+/**
+ * @depend test/test.js
+ */
+console.log('main.js');