[Pkg-javascript-commits] [node-cached-path-relative] 01/09: Initial commit

[Bastien Roucariès]

This is an automated email from the git hooks/post-receive script.

rouca pushed a commit to branch master
in repository node-cached-path-relative.

commit 28c1577cf40d2048581ade6102e9c30fd0316204
Author: Andrew Shaffer <andrew at weo.io>
Date:   Wed Apr 13 12:58:00 2016 -0700

    Initial commit
---
 .gitignore    |  2 ++
 History.md    |  0
 Makefile      | 20 ++++++++++++++++++++
 Readme.md     | 41 +++++++++++++++++++++++++++++++++++++++++
 lib/index.js  | 43 +++++++++++++++++++++++++++++++++++++++++++
 package.json  | 13 +++++++++++++
 shim.js       | 12 ++++++++++++
 test/index.js | 17 +++++++++++++++++
 8 files changed, 148 insertions(+)

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..eb03e3e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,2 @@
+node_modules
+*.log
diff --git a/History.md b/History.md
new file mode 100644
index 0000000..e69de29
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..5a8f21d
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,20 @@
+#
+# Vars
+#
+
+BIN = ./node_modules/.bin
+
+#
+# Tasks
+# 
+
+node_modules: package.json
+	@npm install
+
+test: node_modules
+	@${BIN}/tape test/*
+
+validate: node_modules
+	@${BIN}/standard
+
+.PHONY: test validate
diff --git a/Readme.md b/Readme.md
new file mode 100644
index 0000000..7b3d4c4
--- /dev/null
+++ b/Readme.md
@@ -0,0 +1,41 @@
+
+# cached-path-relative
+
+[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](https://github.com/feross/standard)
+
+Memoize the results of the path.relative function. `path.relative` can be an expensive operation if it happens a lot, and its results shouldn't change for the same arguments.
+
+## Installation
+
+    $ npm install cached-path-relative
+
+## Usage
+
+Use it just like your normal path.relative, but it's memoized:
+
+```javascript
+var relative = require('cached-path-relative')
+
+
+relative('test/index.js', '.') === '../..'
+```
+
+## Shim
+
+If you want to shim path.relative globally so that you can optimize things that don't know about this module (browserify rebuild times are a good use-case here), you can just import the shim:
+
+`require('cached-path-relative/shim')`
+
+This will globally shim `path.relative` so that its results are cached.
+
+## License
+
+The MIT License
+
+Copyright © 2016, Weo.io <info at weo.io>
+
+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.
diff --git a/lib/index.js b/lib/index.js
new file mode 100644
index 0000000..6b12da6
--- /dev/null
+++ b/lib/index.js
@@ -0,0 +1,43 @@
+/**
+ * Modules
+ */
+
+var path = require('path')
+
+/**
+ * Vars
+ */
+
+var relative = path.relative.bind(path)
+var lastCwd = process.cwd()
+var cache = {}
+
+/**
+ * Expose cachedPathRelative
+ */
+
+module.exports = cachedPathRelative
+
+/**
+ * cachedPathRelative
+ */
+
+function cachedPathRelative (from, to) {
+  // If the current working directory changes, we need
+  // to invalidate the cache
+  var cwd = process.cwd()
+  if (cwd !== lastCwd) {
+    cache = {}
+    lastCwd = cwd
+  }
+
+  if (cache[from] && cache[from][to]) return cache[from][to]
+
+  var result = relative.call(path, from, to)
+
+  cache[from] = cache[from] || {}
+  cache[from][to] = result
+
+  return result
+
+}
diff --git a/package.json b/package.json
new file mode 100644
index 0000000..eb1b621
--- /dev/null
+++ b/package.json
@@ -0,0 +1,13 @@
+{
+  "name": "cached-path-relative",
+  "description": "Memoize the results of the path.relative function",
+  "repository": "git://github.com/ashaffer/cached-path-relative.git",
+  "version": "0.1.0",
+  "license": "MIT",
+  "main": "lib/index.js",
+  "dependencies": {},
+  "devDependencies": {
+    "tape": "^4.2.0",
+    "standard": "^4.0.0"
+  }
+}
diff --git a/shim.js b/shim.js
new file mode 100644
index 0000000..3d3b67a
--- /dev/null
+++ b/shim.js
@@ -0,0 +1,12 @@
+/**
+ * Modules
+ */
+
+var path = require('path')
+var cachedPathRelative = require('.')
+
+/**
+ * Install shim
+ */
+
+path.relative = cachedPathRelative
diff --git a/test/index.js b/test/index.js
new file mode 100644
index 0000000..c0258f9
--- /dev/null
+++ b/test/index.js
@@ -0,0 +1,17 @@
+/**
+ * Imports
+ */
+
+var relative = require('..')
+var path = require('path')
+var test = require('tape')
+
+/**
+ * Tests
+ */
+
+test('should work', function (t) {
+  t.equal(relative('test/index.js', '.'), path.relative('test/index.js', '.'))
+  t.equal(relative('test/index.js', '.'), path.relative('test/index.js', '.'))
+  t.end()
+})

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-javascript/node-cached-path-relative.git