Merge pull request #14 from rovjuvano/feat/conforming-behavior

Feat/conforming behavior

Author: hparra

README.md

@@ -10,30 +10,41 @@ gulp-rename provides simple file renaming methods.
 var rename = require("gulp-rename");
 
 // rename via string
-gulp.src("./src/hello.txt")
-	.pipe(rename("goodbye.txt"))
-	.pipe(gulp.dest("./dist"));
+gulp.src("./src/main/text/hello.txt")
+	.pipe(rename("main/text/ciao/goodbye.md"))
+	.pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/goodbye.md
 
 // rename via function
-gulp.src("./src/hello.txt")
-	.pipe(rename(function (dir, base, ext) {
-		return base + "-goodbye" + ext;
+gulp.src("./src/**/hello.txt")
+	.pipe(rename(function (path) {
+		path.dirname += "/ciao";
+		path.basename += "-goodbye";
+		path.extname = ".md"
 	}))
-	.pipe(gulp.dest("./dist")); // ./dist/hello-goodbye.txt
+	.pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/hello-goodbye.md
 
 // rename via hash
-gulp.src("./src/hello.txt")
+gulp.src("./src/main/text/hello.txt", { base: process.cwd() })
 	.pipe(rename({
+		dirname: "main/text/ciao",
+		basename: "aloha",
 		prefix: "bonjour-",
 		suffix: "-hola",
-		ext: ".md"
+		extname: ".md"
 	}))
-	.pipe(gulp.dest("./dist")); // ./dist/bonjour-hello-hola.md
+	.pipe(gulp.dest("./dist")); // ./dist/main/text/ciao/bonjour-aloha-hola.md
 ```
 
+**See test/rename.spec.js for more examples and test/path-parsing.spec.js for hairy details.**
+
 ## Notes
 
-`ext` follows the node convention in that it includes the period.
+* `dirname` is the relative path from the base directory set by `gulp.src` to the filename.
+  * `gulp.src()` uses glob-stream which sets the base to the parent of the first directory glob (`*`, `**`, [], or extglob). `dirname` is the remaining directories or `./` if none. glob-stream versions >= 3.1.0 (used by gulp >= 3.2.2) accept a `base` option, which can be used to explicitly set the base.
+  * `gulp.dest()` renames the directories between `process.cwd()` and `dirname` (i.e. the base relative to CWD). Use `dirname` to rename the directories matched by the glob or descendents of the base of option.
+  * KNOWN ISSUE: The base set when using brace expansion may not be what you expect (See wearefractal/glob2base#1). Use the `base` option described above.
+* `basename` is the filename without the extension like path.basename(filename, path.extname(filename)).
+* `extname` is the file extension including the '.' like path.extname(filename).
 
 ## License
 

index.js

@@ -1,44 +1,51 @@
 var map = require("map-stream"),
-	path = require("path");
+	Path = require("path");
 
 module.exports = function (obj) {
 	"use strict";
 
+	function parsePath(path) {
+		var extname = Path.extname(path);
+		return {
+			dirname: Path.dirname(path),
+			basename: Path.basename(path, extname),
+			extname: extname
+		};
+	}
+
 	function rename(file, callback) {
 
-		if (!obj) {
-			callback(new Error("No renaming parameter supplied"), undefined);
-		}
+		var parsedPath = parsePath(file.relative);
+		var path;
 
-		// helper variables
-		var relativePath = path.relative(file.cwd, file.path),
-			dir = path.dirname(relativePath),
-			firstname = file.path.substr(file.path.indexOf(".", 1)),
-			ext = file.path.substr(file.path.lastIndexOf(".")),
-			base = path.basename(file.path, ext),
-			finalName = "";
+		var type = typeof obj;
 
-		if (typeof obj === "string") {
+		if (type === "string" && obj !== "") {
 
-			finalName = obj;
+			path = obj;
 
-		} else if (typeof obj === "function") {
+		} else if (type === "function") {
 
-			finalName = obj(dir, base, ext);
+			var result = obj(parsedPath) || parsedPath;
+			path = Path.join(result.dirname, result.basename + result.extname);
 
-		} else if (typeof obj === "object") {
+		} else if (type === "object" && obj !== undefined && obj !== null) {
 
-			var prefix = obj.prefix || "",
+			var dirname = obj.dirname || parsedPath.dirname,
+				prefix = obj.prefix || "",
 				suffix = obj.suffix || "",
-				extension = obj.ext || ext;
+				basename = obj.basename || parsedPath.basename,
+				extname = obj.extname || parsedPath.extname;
 
-			finalName = prefix + path.basename(file.path, firstname) + suffix + extension;
+			path = Path.join(dirname, prefix + basename + suffix + extname);
 
 		} else {
 			callback(new Error("Unsupported renaming parameter type supplied"), undefined);
+			return;
 		}
 
-		file.path = path.join(dir, finalName);
+		file.path = Path.join(file.base, path);
+
 		callback(null, file);
 	}
 

package.json

@@ -18,7 +18,7 @@
     "url": "git://github.com/hparra/gulp-rename.git"
   },
   "scripts": {
-    "test": "mocha"
+    "test": "mocha test/*.spec.js"
   },
   "dependencies": {
     "map-stream": "~0.0.4"

test/main.js

@@ -0,0 +1,107 @@
+/*global describe, context, it, helper */
+"use strict";
+
+require("./spec-helper");
+var Path = require("path");
+
+describe("gulp-rename path parsing", function () {
+	describe("dirname", function () {
+		context("when src pattern contains no globs", function () {
+			it("dirname is '.'", function (done) {
+				var srcPattern = "test/fixtures/hello.txt";
+				var obj = function (path) {
+					path.dirname.should.equal(".");
+				};
+				helper(srcPattern, obj, null, done);
+			});
+		});
+
+		context("when src pattern contains filename glob", function () {
+			it("dirname is '.'", function (done) {
+				var srcPattern = "test/fixtures/*.min.txt";
+				var obj = function (path) {
+					path.dirname.should.equal(".");
+				};
+				helper(srcPattern, obj, null, done);
+			});
+		});
+
+		var dirname_helper = function (srcPattern, expectedPath) {
+			it("dirname is path from directory glob to file", function (done) {
+				var obj = function (path) {
+					path.dirname.should.match(/^fixtures[0-9]?$/);
+				};
+				helper(srcPattern, obj, null, done);
+			});
+		}
+
+		context("when src pattern matches a directory with *", function () {
+			dirname_helper("test/*/*.min.txt");
+		});
+
+		context("when src pattern matches a directory with **", function () {
+			dirname_helper("test/**/*.min.txt");
+		});
+
+		context("when src pattern matches a directory with [...]", function () {
+			dirname_helper("test/fixt[a-z]res/*.min.txt");
+		});
+
+		/* SKIP: glob2base does not handle brace expansion as expected. See wearefractal/glob2base#1 */
+		context.skip("when src pattern matches a directory with {...,...}", function () {
+			dirname_helper("test/f{ri,ixtur}es/*.min.txt");
+		});
+
+		/* SKIP: glob2base does not handle brace expansion as expected. See wearefractal/glob2base#1 */
+		context.skip("when src pattern matches a directory with {#..#}", function () {
+			dirname_helper("test/fixtures{0..9}/*.min.txt");
+		});
+
+		context("when src pattern matches a directory with an extglob", function () {
+			dirname_helper("test/f+(ri|ixtur)es/*.min.txt");
+		});
+
+		/* requires glob-stream >= 3.1.0 */
+		context.skip("when src pattern includes `base` option", function () {
+			it("dirname is path from given directory to file", function (done) {
+				var srcPattern = "test/**/*.min.txt";
+				var srcOptions = {base: process.cwd()};
+				var obj = function (path) {
+					path.dirname.should.equal("test/fixtures");
+				};
+				helper({pattern: srcPattern, options: srcOptions}, obj, null, done);
+			});
+		});
+	});
+
+	describe("basename", function () {
+		it("strips extension like Path.basename(path, ext)", function (done) {
+			var srcPattern = "test/fixtures/hello.min.txt";
+			var obj = function (path) {
+				path.basename.should.equal("hello.min");
+				path.basename.should.equal(Path.basename(srcPattern, Path.extname(srcPattern)));
+			};
+			helper(srcPattern, obj, null, done);
+		});
+	});
+
+	describe("extname", function () {
+		it("includes '.' like Path.extname", function (done) {
+			var srcPattern = "test/fixtures/hello.txt";
+			var obj = function (path) {
+				path.extname.should.equal(".txt");
+				path.extname.should.equal(Path.extname(srcPattern));
+			};
+			helper(srcPattern, obj, null, done);
+		});
+
+		it("excludes multiple extensions like Path.extname", function (done) {
+			var srcPattern = "test/fixtures/hello.min.txt";
+			var obj = function (path) {
+				path.extname.should.equal(".txt");
+				path.extname.should.equal(Path.extname(srcPattern));
+			};
+			helper(srcPattern, obj, null, done);
+		});
+	});
+});