deac/tar-js
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Removed require-kiss dependency in favor of pakmanager

Browse source
This commit is contained in:
Jameson Little 2011-10-28 18:04:25 -06:00
parent f28fe10f6b
commit 5bdc55ed37
8 changed files with 53 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
README.md
View file

@ -17,14 +17,14 @@ Dependencies
Tar needs an HTML5 compliant browser. More specifically it needs `Uint8Array` to work. Tar needs an HTML5 compliant browser. More specifically it needs `Uint8Array` to work.
The only external module is require-kiss, which makes browser JS much more Node-like. The examples depend on pakmanager, a package manager for the browser to make code written for node run in the browser. Install it as such:
This module can be installed from npm (`npm install require-kiss`) or directly downloaded from github (https://github.com/coolaj86/require-kiss-js). `pakmanager build`
Usage Guide Usage Guide
=========== ===========
In your HTML file, make sure that require-kiss is included first. Then, to use it, do something like this: The easiest way to interface with it is by using pakmanager. Include the package from pakmanager in your html, and then in you javascript:
var Tar = require('tar'), var Tar = require('tar'),
tape = new Tar(); tape = new Tar();

36
examples/index.html
View file

@ -3,41 +3,7 @@
<head> <head>
<title>Browser Tar</title> <title>Browser Tar</title>
<script src='../node_modules/require-kiss/require-kiss.js'></script> <script src='./pakmanaged.js'></script>
<script src='../lib/utils.js'></script>
<script src='../lib/header.js'></script>
<script src='../lib/tar.js'></script>
<script>
(function () {
"use strict";
var Tar = require('tar'),
utils = require('utils'),
tape = new Tar(),
out,
url,
base64;
function uint8ToString(buf) {
var i, length, out = '';
for (i = 0, length = buf.length; i < length; i += 1) {
out += String.fromCharCode(buf[i]);
}
return out;
}
out = tape.append('output.txt', 'This is test1!');
out = tape.append('dir/out.txt', 'This is test2! I changed up the directory');
out = tape.append('arr.txt', utils.stringToUint8('This is a Uint8Array!'));
base64 = btoa(uint8ToString(out));
url = "data:application/tar;base64," + base64;
window.open(url);
}());
</script>
</head> </head>
<body> <body>

38
examples/main.js Normal file
View file

@ -0,0 +1,38 @@
(function () {
"use strict";
var Tar = require('tar-js'),
tape = new Tar(),
out,
url,
base64;
function uint8ToString(buf) {
var i, length, out = '';
for (i = 0, length = buf.length; i < length; i += 1) {
out += String.fromCharCode(buf[i]);
}
return out;
}
function stringToUint8 (input) {
var out = new Uint8Array(input.length), i;
for (i = 0; i < input.length; i += 1) {
out[i] = input.charCodeAt(i);
}
return out;
}
out = tape.append('output.txt', 'This is test1!');
out = tape.append('dir/out.txt', 'This is test2! I changed up the directory');
out = tape.append('arr.txt', stringToUint8('This is a Uint8Array!'));
base64 = btoa(uint8ToString(out));
url = "data:application/tar;base64," + base64;
window.open(url);
}());

10
examples/package.json Normal file
View file

@ -0,0 +1,10 @@
{
"author": "",
"name": "tar-example",
"engines": {
"node": "~0.4.7"
},
"main": "./main.js",
"dependencies": {
}
}

4
lib/header.js
View file

@ -6,8 +6,6 @@
(function () { (function () {
"use strict"; "use strict";
require('require-kiss');
/* /*
struct posix_header { // byte offset struct posix_header { // byte offset
char name[100]; // 0 char name[100]; // 0
@ -124,6 +122,4 @@ struct posix_header { // byte offset
module.exports.structure = headerFormat; module.exports.structure = headerFormat;
module.exports.format = formatHeader; module.exports.format = formatHeader;
provide('header', module.exports);
}()); }());

4
lib/tar.js
View file

@ -6,8 +6,6 @@
(function () { (function () {
"use strict"; "use strict";
require('require-kiss');
var header = require("./header"), var header = require("./header"),
utils = require("./utils"), utils = require("./utils"),
recordSize = 512, recordSize = 512,
@ -109,6 +107,4 @@
}; };
module.exports = Tar; module.exports = Tar;
provide('tar', module.exports);
}()); }());

4
lib/utils.js
View file

@ -6,8 +6,6 @@
(function () { (function () {
"use strict"; "use strict";
require('require-kiss');
var lookup = [ var lookup = [
'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H', 'A', 'B', 'C', 'D', 'E', 'F', 'G', 'H',
'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P', 'I', 'J', 'K', 'L', 'M', 'N', 'O', 'P',
@ -90,6 +88,4 @@
module.exports.extend = extend; module.exports.extend = extend;
module.exports.stringToUint8 = stringToUint8; module.exports.stringToUint8 = stringToUint8;
module.exports.uint8ToBase64 = uint8ToBase64; module.exports.uint8ToBase64 = uint8ToBase64;
provide('utils');
}()); }());

3
package.json
View file

@ -1,7 +1,7 @@
{ {
"name": "tar-js", "name": "tar-js",
"description": "Tar implemented in the browser", "description": "Tar implemented in the browser",
"version": "0.1.1", "version": "0.2.0",
"homepage": "http://github.com/beatgammit/tar-js", "homepage": "http://github.com/beatgammit/tar-js",
"repository": { "repository": {
"type": "git", "type": "git",
@ -14,6 +14,5 @@
"lib": "lib" "lib": "lib"
}, },
"dependencies": { "dependencies": {
"require-kiss": "*"
} }
} }