1.4.0

Add dir argument to filter function
fixes #11 closes #18
2014-10-03 12:02:53 -04:00 · 2014-10-03 11:45:59 -04:00 · 2014-10-03 11:17:30 -04:00
6 changed files with 52 additions and 7 deletions
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -1,3 +1,9 @@
+1.4.0 / 2014-10-03
+==================
+
+  * Add `dir` argument to `filter` function
+  * Support using tokens multiple times
+
 1.3.1 / 2014-10-01
 ==================

--- a/README.md
+++ b/README.md
@@ -35,7 +35,11 @@ Serve index accepts these properties in the options object.

 ##### filter

-Apply this filter function to files. Defaults to `false`.
+Apply this filter function to files. Defaults to `false`. The `filter` function
+is called for each file, with the signature `filter(filename, index, files, dir)`
+where `filename` is the name of the file, `index` is the array index, `files` is
+the array of files and `dir` is the absolute path the file is located (and thus,
+the directory the listing is for).

 ##### hidden

--- a/index.js
+++ b/index.js
@@ -142,7 +142,9 @@ exports = module.exports = function serveIndex(root, options){
      fs.readdir(path, function(err, files){
        if (err) return next(err);
        if (!hidden) files = removeHidden(files);
-        if (filter) files = files.filter(filter);
+        if (filter) files = files.filter(function(filename, index, list) {
+          return filter(filename, index, list, path);
+        });
        files.sort();

        // content-negotiation
@@ -172,10 +174,10 @@ exports.html = function(req, res, files, next, dir, showUp, icons, path, view, t
        files.sort(fileSort);
        if (showUp) files.unshift({ name: '..' });
        str = str
-          .replace('{style}', style.concat(iconStyle(files, icons)))
-          .replace('{files}', html(files, dir, icons, view))
-          .replace('{directory}', dir)
-          .replace('{linked-path}', htmlPath(dir));
+          .replace(/\{style\}/g, style.concat(iconStyle(files, icons)))
+          .replace(/\{files\}/g, html(files, dir, icons, view))
+          .replace(/\{directory\}/g, dir)
+          .replace(/\{linked-path\}/g, htmlPath(dir));

        var buf = new Buffer(str, 'utf8');
        res.setHeader('Content-Type', 'text/html; charset=utf-8');
--- a/package.json
+++ b/package.json
@@ -1,7 +1,7 @@
 {
  "name": "serve-index",
  "description": "Serve directory listings",
-  "version": "1.3.1",
+  "version": "1.4.0",
  "author": "Douglas Christopher Wilson <doug@somethingdoug.com>",
  "license": "MIT",
  "repository": "expressjs/serve-index",
--- a/test/shared/template.html
+++ b/test/shared/template.html
@@ -6,6 +6,7 @@
  </head>
  <body class="directory">
    <h1>This is the test template</h1>
+    <h2>directory {directory}</h2>
    <div id="wrapper">
      <h1>{linked-path}</h1>
      {files}
--- a/test/test.js
+++ b/test/test.js
@@ -264,6 +264,26 @@ describe('serveIndex(root)', function () {
        done()
      });
    });
+
+    it('should filter directory paths', function (done) {
+      var seen = false
+      var server = createServer(fixtures, {'filter': filter})
+
+      function filter(name, index, list, dir) {
+        if (path.normalize(dir) === path.normalize(path.join(fixtures, '/users'))) {
+          seen = true
+        }
+        return true
+      }
+
+      request(server)
+      .get('/users')
+      .expect(200, function (err, res) {
+        if (err) return done(err)
+        seen.should.be.true
+        done()
+      });
+    });
  });

  describe('with "icons" option', function () {
@@ -506,6 +526,18 @@ describe('serveIndex(root)', function () {
      .set('Accept', 'text/html')
      .expect(200, /ul#files/, done)
    });
+
+    it('should list directory twice', function (done) {
+      request(server)
+      .get('/users/')
+      .set('Accept', 'text/html')
+      .expect(function (res) {
+        var occurances = res.text.match(/directory \/users\//g)
+        if (occurances && occurances.length === 2) return
+        throw new Error('directory not listed twice')
+      })
+      .expect(200, done)
+    });
  });

  describe('when setting a custom stylesheet', function () {
Author	SHA1	Message	Date
Douglas Christopher Wilson	ac94303941	1.4.0	2014-10-03 12:02:53 -04:00
Evgenus	cececc8c2e	Add dir argument to filter function fixes #11 closes #18	2014-10-03 11:45:59 -04:00
Evgenus	5e050a7d23	Support using tokens multiple times closes #19	2014-10-03 11:17:30 -04:00