-
Notifications
You must be signed in to change notification settings - Fork 101
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit 2ba1cb4
Showing
14 changed files
with
1,449 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
# Automatically normalize line endings for all text-based files | ||
* text=auto |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
# Coverage report | ||
coverage | ||
|
||
# Installed npm modules | ||
node_modules | ||
|
||
# Folder view configuration files | ||
.DS_Store | ||
Desktop.ini | ||
|
||
# Thumbnail cache files | ||
._* | ||
Thumbs.db | ||
|
||
# Files that might appear on external disks | ||
.Spotlight-V100 | ||
.Trashes |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
language: node_js | ||
node_js: | ||
- "0.10" | ||
before_script: | ||
- "npm install -g grunt-cli" | ||
# Narwhal uses a hardcoded path to openjdk v6, so use that version | ||
- "sudo apt-get update -qq" | ||
- "sudo apt-get install -qq openjdk-6-jre" | ||
- "PACKAGE=rhino1_7R3; wget http://ftp.mozilla.org/pub/mozilla.org/js/$PACKAGE.zip && sudo unzip $PACKAGE -d /opt/ && rm $PACKAGE.zip" | ||
- "PACKAGE=rhino1_7R3; echo -e '#!/bin/sh\\njava -jar /opt/'$PACKAGE'/js.jar $@' | sudo tee /usr/local/bin/rhino && sudo chmod +x /usr/local/bin/rhino" | ||
- "PACKAGE=ringojs-0.9; wget http://ringojs.org/downloads/$PACKAGE.zip && sudo unzip $PACKAGE -d /opt/ && rm $PACKAGE.zip" | ||
- "PACKAGE=ringojs-0.9; sudo ln -s /opt/$PACKAGE/bin/ringo /usr/local/bin/ringo && sudo chmod +x /usr/local/bin/ringo" | ||
- "PACKAGE=v0.3.2; wget https://github.com/280north/narwhal/archive/$PACKAGE.zip && sudo unzip $PACKAGE -d /opt/ && rm $PACKAGE.zip" | ||
- "PACKAGE=narwhal-0.3.2; sudo ln -s /opt/$PACKAGE/bin/narwhal /usr/local/bin/narwhal && sudo chmod +x /usr/local/bin/narwhal" | ||
# If the enviroment stores rt.jar in a different directory, find it and symlink the directory | ||
- "PREFIX=/usr/lib/jvm; if [ ! -d $PREFIX/java-6-openjdk ]; then for d in $PREFIX/java-6-openjdk-*; do if [ -e $d/jre/lib/rt.jar ]; then sudo ln -s $d $PREFIX/java-6-openjdk; break; fi; done; fi" | ||
script: | ||
"grunt ci" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,85 @@ | ||
module.exports = function(grunt) { | ||
|
||
grunt.initConfig({ | ||
'shell': { | ||
'options': { | ||
'stdout': true, | ||
'stderr': true, | ||
'failOnError': true | ||
}, | ||
'cover': { | ||
'command': 'istanbul cover --report "html" --verbose --dir "coverage" "tests/tests.js"' | ||
}, | ||
'test-narwhal': { | ||
'command': 'echo "Testing in Narwhal..."; export NARWHAL_OPTIMIZATION=-1; narwhal "tests/tests.js"' | ||
}, | ||
'test-phantomjs': { | ||
'command': 'echo "Testing in PhantomJS..."; phantomjs "tests/tests.js"' | ||
}, | ||
// Rhino 1.7R4 has a bug that makes it impossible to test in. | ||
// https://bugzilla.mozilla.org/show_bug.cgi?id=775566 | ||
// To test, use Rhino 1.7R3, or wait (heh) for the 1.7R5 release. | ||
'test-rhino': { | ||
'command': 'echo "Testing in Rhino..."; rhino -opt -1 "tests.js"', | ||
'options': { | ||
'execOptions': { | ||
'cwd': 'tests' | ||
} | ||
} | ||
}, | ||
'test-ringo': { | ||
'command': 'echo "Testing in Ringo..."; ringo -o -1 "tests/tests.js"' | ||
}, | ||
'test-node': { | ||
'command': 'echo "Testing in Node..."; node "tests/tests.js"' | ||
}, | ||
'test-browser': { | ||
'command': 'echo "Testing in a browser..."; open "tests/index.html"; open "tests/index.html?norequire=true"' | ||
} | ||
}, | ||
'template': { | ||
'build': { | ||
'options': { | ||
'data': function() { | ||
return require('./scripts/export-data.js'); | ||
} | ||
}, | ||
'files': { | ||
'base64.js': ['src/base64.js'] | ||
} | ||
} | ||
} | ||
}); | ||
|
||
grunt.loadNpmTasks('grunt-shell'); | ||
grunt.loadNpmTasks('grunt-template'); | ||
|
||
grunt.registerTask('cover', 'shell:cover'); | ||
grunt.registerTask('ci', [ | ||
'template', | ||
'shell:test-narwhal', | ||
'shell:test-phantomjs', | ||
'shell:test-rhino', | ||
'shell:test-ringo', | ||
'shell:test-node', | ||
]); | ||
grunt.registerTask('test', [ | ||
'ci', | ||
'shell:test-browser' | ||
]); | ||
|
||
grunt.registerTask('fetch', [ | ||
'shell:fetch', | ||
'build' | ||
]); | ||
|
||
grunt.registerTask('build', [ | ||
'default' | ||
]); | ||
|
||
grunt.registerTask('default', [ | ||
'template', | ||
'shell:test-node' | ||
]); | ||
|
||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
Copyright Mathias Bynens <http://mathiasbynens.be/> | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,124 @@ | ||
# base64 [![Build status](https://travis-ci.org/mathiasbynens/base64.svg?branch=master)](https://travis-ci.org/mathiasbynens/base64) [![Dependency status](https://gemnasium.com/mathiasbynens/base64.svg)](https://gemnasium.com/mathiasbynens/base64) | ||
|
||
_base64_ is a robust base64 encoder/decoder that is fully compatible with [`atob()` and `btoa()`](http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#atob), written in JavaScript. The base64-encoding and -decoding algorithms it uses are fully [RFC 4648](http://tools.ietf.org/html/rfc4648#section-4) compliant. | ||
|
||
## Installation | ||
|
||
Via [npm](http://npmjs.org/): | ||
|
||
```bash | ||
npm install base-64 | ||
``` | ||
|
||
Via [Bower](http://bower.io/): | ||
|
||
```bash | ||
bower install base-64 | ||
``` | ||
|
||
Via [Component](https://github.com/component/component): | ||
|
||
```bash | ||
component install mathiasbynens/base64 | ||
``` | ||
|
||
In a browser: | ||
|
||
```html | ||
<script src="base64.js"></script> | ||
``` | ||
|
||
In [Narwhal](http://narwhaljs.org/), [Node.js](http://nodejs.org/), and [RingoJS](http://ringojs.org/): | ||
|
||
```js | ||
var base64 = require('base-64'); | ||
``` | ||
|
||
In [Rhino](http://www.mozilla.org/rhino/): | ||
|
||
```js | ||
load('base64.js'); | ||
``` | ||
|
||
Using an AMD loader like [RequireJS](http://requirejs.org/): | ||
|
||
```js | ||
require( | ||
{ | ||
'paths': { | ||
'base64': 'path/to/base64' | ||
} | ||
}, | ||
['base64'], | ||
function(base64) { | ||
console.log(base64); | ||
} | ||
); | ||
``` | ||
|
||
## API | ||
|
||
### `base64.version` | ||
|
||
A string representing the semantic version number. | ||
|
||
### `base64.encode(input)` | ||
|
||
This function takes a byte string (the `input` parameter) and encodes it according to base64. The input data must be in the form of a string containing only characters in the range from U+0000 to U+00FF, each representing a binary byte with values `0x00` to `0xFF`. The `base64.encode()` function is designed to be fully compatible with [`btoa()` as described in the HTML Standard](http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#dom-windowbase64-btoa). | ||
|
||
```js | ||
var encodedData = base64.encode(input); | ||
``` | ||
|
||
To base64-encode any Unicode string, [encode it as UTF-8 first](https://github.com/mathiasbynens/utf8.js#utf8encodestring): | ||
|
||
```js | ||
var base64 = require('base-64'); | ||
var utf8 = require('utf8'); | ||
|
||
var text = 'foo © bar 𝌆 baz'; | ||
var bytes = utf8.encode(text); | ||
var encoded = base64.encode(bytes); | ||
console.log(encoded); | ||
// → 'Zm9vIMKpIGJhciDwnYyGIGJheg==' | ||
``` | ||
|
||
### `base64.decode(input)` | ||
|
||
This function takes a base64-encoded string (the `input` parameter) and decodes it. The return value is in the form of a string containing only characters in the range from U+0000 to U+00FF, each representing a binary byte with values `0x00` to `0xFF`. The `base64.decode()` function is designed to be fully compatible with [`atob()` as described in the HTML Standard](http://www.whatwg.org/specs/web-apps/current-work/multipage/webappapis.html#dom-windowbase64-atob). | ||
|
||
```js | ||
var decodedData = base64.decode(encodedData); | ||
``` | ||
|
||
To base64-decode UTF-8-encoded data back into a Unicode string, [UTF-8-decode it](https://github.com/mathiasbynens/utf8.js#utf8decodebytestring) after base64-decoding it: | ||
|
||
```js | ||
var encoded = 'Zm9vIMKpIGJhciDwnYyGIGJheg=='; | ||
var bytes = base64.decode(encoded); | ||
var text = utf8.decode(bytes); | ||
console.log(text); | ||
// → 'foo © bar 𝌆 baz' | ||
``` | ||
|
||
## Support | ||
|
||
_base64_ is designed to work in at least Node.js v0.10.0, Narwhal 0.3.2, RingoJS 0.8-0.9, PhantomJS 1.9.0, Rhino 1.7RC4, as well as old and modern versions of Chrome, Firefox, Safari, Opera, and Internet Explorer. | ||
|
||
## Unit tests & code coverage | ||
|
||
After cloning this repository, run `npm install` to install the dependencies needed for development and testing. You may want to install Istanbul _globally_ using `npm install istanbul -g`. | ||
|
||
Once that’s done, you can run the unit tests in Node using `npm test` or `node tests/tests.js`. To run the tests in Rhino, Ringo, Narwhal, and web browsers as well, use `grunt test`. | ||
|
||
To generate the code coverage report, use `grunt cover`. | ||
|
||
## Author | ||
|
||
| [![twitter/mathias](https://gravatar.com/avatar/24e08a9ea84deb17ae121074d0f17125?s=70)](https://twitter.com/mathias "Follow @mathias on Twitter") | | ||
|---| | ||
| [Mathias Bynens](http://mathiasbynens.be/) | | ||
|
||
## License | ||
|
||
_base64_ is available under the [MIT](http://mths.be/mit) license. |
Oops, something went wrong.