nibjs 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+# 1.1.0 / 2011-02-23
+
+* Enhancements
+
+  * Added examples acting as both documentation, gh-pages and integration tests
+  * Added --footer and --standalone options
+  * Added alias for --autorequire as -a
+  * Added alias for --uglify as -u
+  * Added alias for --join as -j
+  * Major boolean options (uglify, join, autorequire) have a [no-] counterpart
+
 # 1.0.0 / 2011-02-22
 
 * Enhancements

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    nibjs (1.0.0)
+    nibjs (1.1.0)
       bundler (~> 1.0)
       quickl (~> 0.2.0)
 

data/Manifest.txt

@@ -1,6 +1,7 @@
 bin/**/*
 CHANGELOG.md
-dist
+dist/**/*
+examples/**/*
 Gemfile
 Gemfile.lock
 lib/**/*

data/README.md

@@ -62,3 +62,13 @@ Let assume that your project has the structure below.
          https://github.com/jashkenas/coffee-script/issues/#issue/1054 */
       var mylib = NibJS.require('mylib')
     </script>
+
+### See also
+
+This project is related to CommonJS Module specification. In a sense, it is an offline 
+"compiler" implementation of the version 1.0 of that specification (not even complete).
+I'll strongly consider any patch that would lead to respecting such specification more
+correctly!
+
+* http://wiki.commonjs.org/wiki/Modules/1.0
+* http://wiki.commonjs.org/wiki/Modules/CompiledModules

data/Rakefile

@@ -26,7 +26,7 @@ def dist(target)
   code += File.read("LICENCE.js")
   code += "(function(exports){\n"
   code += File.read(target).gsub(/^/m, "  ")
-  code += "}).call(this, this)"
+  code += "}).call(this, this);"
   File.open(target, "w"){|io| io << code}
 end
 

data/dist/nibjs-1.0.0.js

@@ -0,0 +1,74 @@
+/**
+ * nib.js - [Java/Coffee]script application packager from node.js conventions
+ * 
+ * Copyright 2011, Bernard Lambeau
+ * Released under the MIT License
+ * http://github.com/blambeau/nib.js
+ */
+(function(exports){
+  var Builder;
+  var __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+  exports.NibJS = {
+    pkgBuilders: [],
+    packages: [],
+    define: function(name, buildFn) {
+      return NibJS.pkgBuilders[name] = buildFn;
+    },
+    require: function(name) {
+      var _base, _ref;
+      return (_ref = (_base = NibJS.packages)[name]) != null ? _ref : _base[name] = NibJS._build_one(name);
+    },
+    _build_one: function(name) {
+      var builder;
+      builder = new Builder;
+      return NibJS.pkgBuilders[name](builder);
+    },
+    pending: [],
+    running: [],
+    ready: function(fn) {
+      return NibJS.pending.push(fn);
+    },
+    start: function() {
+      var fn, _i, _len, _ref;
+      _ref = NibJS.pending;
+      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
+        fn = _ref[_i];
+        NibJS.running.push(fn());
+      }
+      return NibJS.pending = [];
+    },
+    isRunning: function(fn) {
+      var c, _i, _len, _ref;
+      _ref = NibJS.running;
+      for (_i = 0, _len = _ref.length; _i < _len; _i++) {
+        c = _ref[_i];
+        if (c === fn) {
+          return true;
+        }
+      }
+      return false;
+    }
+  };
+  Builder = (function() {
+    function Builder() {
+      this.build_file = __bind(this.build_file, this);;
+      this.require = __bind(this.require, this);;
+      this.register = __bind(this.register, this);;    this.builders = [];
+      this.built = [];
+    }
+    Builder.prototype.register = function(file, builder) {
+      return this.builders[file] = builder;
+    };
+    Builder.prototype.require = function(file) {
+      var _base, _ref;
+      return (_ref = (_base = this.built)[file]) != null ? _ref : _base[file] = this.build_file(file);
+    };
+    Builder.prototype.build_file = function(file) {
+      var exports;
+      exports = {};
+      this.builders[file](exports, this.require);
+      return exports;
+    };
+    return Builder;
+  })();
+}).call(this, this)

data/dist/nibjs-1.0.0.min.js

@@ -0,0 +1,7 @@
+/**
+ * nib.js - [Java/Coffee]script application packager from node.js conventions
+ * 
+ * Copyright 2011, Bernard Lambeau
+ * Released under the MIT License
+ * http://github.com/blambeau/nib.js
+ */(function(a){var b,c=function(a,b){return function(){return a.apply(b,arguments)}};a.NibJS={pkgBuilders:[],packages:[],define:function(a,b){return NibJS.pkgBuilders[a]=b},require:function(a){var b,c;return(c=(b=NibJS.packages)[a])!=null?c:b[a]=NibJS._build_one(a)},_build_one:function(a){var c;c=new b;return NibJS.pkgBuilders[a](c)},pending:[],running:[],ready:function(a){return NibJS.pending.push(a)},start:function(){var a,b,c,d;d=NibJS.pending;for(b=0,c=d.length;b<c;b++)a=d[b],NibJS.running.push(a());return NibJS.pending=[]},isRunning:function(a){var b,c,d,e;e=NibJS.running;for(c=0,d=e.length;c<d;c++){b=e[c];if(b===a)return!0}return!1}},b=function(){function a(){this.build_file=c(this.build_file,this),this.require=c(this.require,this),this.register=c(this.register,this),this.builders=[],this.built=[]}a.prototype.register=function(a,b){return this.builders[a]=b},a.prototype.require=function(a){var b,c;return(c=(b=this.built)[a])!=null?c:b[a]=this.build_file(a)},a.prototype.build_file=function(a){var b;b={},this.builders[a](b,this.require);return b};return a}()}).call(this,this)

data/dist/nibjs-1.1.0.js

@@ -0,0 +1,74 @@
+/**
+ * nib.js - [Java/Coffee]script application packager from node.js conventions
+ * 
+ * Copyright 2011, Bernard Lambeau
+ * Released under the MIT License
+ * http://github.com/blambeau/nib.js
+ */
+(function(exports){
+  var Builder, Exception;
+  var __hasProp = Object.prototype.hasOwnProperty, __extends = function(child, parent) {
+    for (var key in parent) { if (__hasProp.call(parent, key)) child[key] = parent[key]; }
+    function ctor() { this.constructor = child; }
+    ctor.prototype = parent.prototype;
+    child.prototype = new ctor;
+    child.__super__ = parent.prototype;
+    return child;
+  }, __bind = function(fn, me){ return function(){ return fn.apply(me, arguments); }; };
+  exports.NibJS = {
+    pkgBuilders: [],
+    packages: [],
+    hasPackage: function(name) {
+      return (NibJS.pkgBuilders[name] != null) || (NibJS.packages[name] != null);
+    },
+    define: function(name, buildFn) {
+      return NibJS.pkgBuilders[name] = buildFn;
+    },
+    require: function(name) {
+      var _base, _ref;
+      return (_ref = (_base = NibJS.packages)[name]) != null ? _ref : _base[name] = NibJS._build_one(name);
+    },
+    _build_one: function(name) {
+      var builder;
+      if (NibJS.pkgBuilders[name]) {
+        builder = new Builder;
+        return NibJS.pkgBuilders[name](builder);
+      } else {
+        throw new Exception("NibJS error: no module '" + name + "' has been previously registered.");
+      }
+    }
+  };
+  Exception = (function() {
+    __extends(Exception, Error);
+    function Exception(message) {
+      this.message = message;
+    }
+    return Exception;
+  })();
+  Builder = (function() {
+    function Builder() {
+      this.build_file = __bind(this.build_file, this);;
+      this.require = __bind(this.require, this);;
+      this.register = __bind(this.register, this);;    this.builders = [];
+      this.built = [];
+    }
+    Builder.prototype.register = function(file, builder) {
+      return this.builders[file] = builder;
+    };
+    Builder.prototype.require = function(file) {
+      var _base, _ref;
+      return (_ref = (_base = this.built)[file]) != null ? _ref : _base[file] = this.build_file(file);
+    };
+    Builder.prototype.build_file = function(file) {
+      var file_exp;
+      if (this.builders[file] != null) {
+        file_exp = {};
+        this.builders[file](file_exp, this.require);
+        return file_exp;
+      } else {
+        throw new Exception("NibJS error: no such file " + file);
+      }
+    };
+    return Builder;
+  })();
+}).call(this, this);

data/dist/nibjs-1.1.0.min.js

@@ -0,0 +1,7 @@
+/**
+ * nib.js - [Java/Coffee]script application packager from node.js conventions
+ * 
+ * Copyright 2011, Bernard Lambeau
+ * Released under the MIT License
+ * http://github.com/blambeau/nib.js
+ */(function(a){var b,c,d=Object.prototype.hasOwnProperty,e=function(a,b){function e(){this.constructor=a}for(var c in b)d.call(b,c)&&(a[c]=b[c]);e.prototype=b.prototype,a.prototype=new e,a.__super__=b.prototype;return a},f=function(a,b){return function(){return a.apply(b,arguments)}};a.NibJS={pkgBuilders:[],packages:[],hasPackage:function(a){return NibJS.pkgBuilders[a]!=null||NibJS.packages[a]!=null},define:function(a,b){return NibJS.pkgBuilders[a]=b},require:function(a){var b,c;return(c=(b=NibJS.packages)[a])!=null?c:b[a]=NibJS._build_one(a)},_build_one:function(a){var d;if(NibJS.pkgBuilders[a]){d=new b;return NibJS.pkgBuilders[a](d)}throw new c("NibJS error: no module '"+a+"' has been previously registered.")}},c=function(){function a(a){this.message=a}e(a,Error);return a}(),b=function(){function a(){this.build_file=f(this.build_file,this),this.require=f(this.require,this),this.register=f(this.register,this),this.builders=[],this.built=[]}a.prototype.register=function(a,b){return this.builders[a]=b},a.prototype.require=function(a){var b,c;return(c=(b=this.built)[a])!=null?c:b[a]=this.build_file(a)},a.prototype.build_file=function(a){var b;if(this.builders[a]!=null){b={},this.builders[a](b,this.require);return b}throw new c("NibJS error: no such file "+a)};return a}()}).call(this,this)

data/examples/1-basic/basic.js

@@ -0,0 +1,27 @@
+NibJS.define('basic', function(nibjs) {
+  nibjs.register('./App', function(exports, require) {
+    var StringUtils = require('./StringUtils').StringUtils;
+    exports.App = {
+      
+      runTests: function(){
+        $("body").append(StringUtils.pre("nibjs --output jsapp.js lib"));
+        return true;
+      }
+      
+    };
+  });
+  nibjs.register('./index', function(exports, require) {
+    exports.StringUtils = require('./StringUtils').StringUtils;
+    exports.App = require('./App').App;
+  });
+  nibjs.register('./StringUtils', function(exports, require) {
+    exports.StringUtils = {
+      
+      pre: function(what) {
+        return "<pre>" + what + "</pre>";
+      }
+      
+    };
+  });
+  return nibjs.require('./index');
+});

data/examples/1-basic/build

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../commons', __FILE__)
+here = File.dirname(__FILE__)
+lib = File.join(here, 'lib')
+options = %q{--libname=basic}
+output = File.join(here, 'basic.js')
+nibjs(options, __output(output), lib)

data/examples/1-basic/index.html

@@ -0,0 +1,56 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>NibJS - Basic Example</title>
+
+  <!-- This is your application -->
+  <script src="http://code.jquery.com/jquery-1.5.min.js" type="text/javascript"></script>
+  <script src="../public/nibjs.js" type="text/javascript"></script>
+  <script src="basic.js" type="text/javascript"></script>
+  <script>
+    $(document).ready(function(){
+      //
+      // this is how you require your application. App will now contain whatever 
+      // your index.js has exported.
+      //
+      App = NibJS.require('basic').App;
+      
+      //
+      // Let me profit from your browser and run the integration tests :-)
+      //
+      TestSuite.runOne(App);
+    });
+  </script>
+
+  <!-- This is some to be able to run integration tests -->
+  <link rel="stylesheet" type="text/css" href="../public/style.css">
+  <script src="../public/TestSuite.js" type="text/javascript"></script>
+  
+</head>
+  <body>
+    <a id="forkme" href="http://github.com/blambeau/nib.js"></a>
+    <div id="content">
+      <div id="feedback"><img src="../public/test-pending.gif"/></div>
+      <h2>Package your javascript in one single command</h2>
+      <p class="comment">
+        NibJS comes with a simple <code>nibjs</code> commandline tool that packages your app
+        offline. NibJS makes <b>no assumption about the server side technology</b>. It performs a 
+        smart concatenation of .js files, while binding and respecting <code>exports</code> and 
+        <code>require</code> conventions!
+      </p>
+      <div style="text-align:center">
+        <img src="illustrate.png" width="80%">
+      </div>
+      <p class="comment">
+        The basic use case is really simple, you want to concatenate <code>lib/**/*.js</code>
+        files, while respecting CommonJS conventions about <code>exports</code> and <code>require</code>.
+      </p>
+    </div>
+    <div id="navigation">
+      <a href="../index.html" class="button" id="leftnav"></a>
+      <a href="../2-coffee/index.html" class="button" id="rightnav"></a>
+      <div style="clear:both"></div>
+    </div>
+  </body>
+</html>

data/examples/1-basic/lib/App.js

@@ -0,0 +1,9 @@
+var StringUtils = require('./StringUtils').StringUtils;
+exports.App = {
+  
+  runTests: function(){
+    $("body").append(StringUtils.pre("nibjs --output jsapp.js lib"));
+    return true;
+  }
+  
+};

data/examples/1-basic/lib/StringUtils.js

@@ -0,0 +1,7 @@
+exports.StringUtils = {
+  
+  pre: function(what) {
+    return "<pre>" + what + "</pre>";
+  }
+  
+};

data/examples/1-basic/lib/index.js

@@ -0,0 +1,2 @@
+exports.StringUtils = require('./StringUtils').StringUtils;
+exports.App = require('./App').App;

data/examples/2-coffee/build

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+require File.expand_path('../../commons', __FILE__)
+here = File.dirname(__FILE__)
+lib = File.join(here, 'lib')
+options = %q{--coffee --libname=coffee}
+output = File.join(here, 'coffee.js')
+nibjs(options, __output(output), lib)

data/examples/2-coffee/coffee.js

@@ -0,0 +1,24 @@
+NibJS.define('coffee', function(nibjs) {
+  nibjs.register('./App', function(exports, require) {
+    var StringUtils;
+    StringUtils = require('./StringUtils').StringUtils;
+    return exports.App = {
+      runTests: function() {
+        $("body").append(StringUtils.pre("Have a look at 'nibjs --coffee'"));
+        return true;
+      }
+    };
+  });
+  nibjs.register('./index', function(exports, require) {
+    exports.StringUtils = require('./StringUtils').StringUtils;
+    return exports.App = require('./App').App;
+  });
+  nibjs.register('./StringUtils', function(exports, require) {
+    return exports.StringUtils = {
+      pre: function(what) {
+        return "<pre>" + what + "</pre>";
+      }
+    };
+  });
+  return nibjs.require('./index');
+});

data/examples/2-coffee/index.html

@@ -0,0 +1,57 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>NibJS - Coffee Example</title>
+  
+  <!-- This is your application -->
+  <script src="http://code.jquery.com/jquery-1.5.min.js" type="text/javascript"></script>
+  <script src="../public/nibjs.js" type="text/javascript"></script>
+  <script src="coffee.js" type="text/javascript"></script>
+  <script>
+    $(document).ready(function(){
+      //
+      // this is how you require your application. App will now contain whatever 
+      // your index.js has exported.
+      //
+      App = NibJS.require('coffee').App;
+      
+      //
+      // Let me profit from your browser and run the integration tests :-)
+      //
+      TestSuite.runOne(App);
+    });
+  </script>
+
+  <!-- This is some to be able to run integration tests -->
+  <link rel="stylesheet" type="text/css" href="../public/style.css">
+  <script src="../public/TestSuite.js" type="text/javascript"></script>
+
+</head>
+  <body>
+    <a id="forkme" href="http://github.com/blambeau/nib.js"></a>
+    <div id="content">
+      <div id="feedback"><img src="../public/test-pending.gif"/></div>
+      <h2>Why not writing source code in CoffeeScript instead?</h2>
+      <p class="comment">
+        CoffeeScript compiles to JavaScript but has a lot of friendly syntactic and semantic
+        features, like
+        <a href="http://jashkenas.github.com/coffee-script/#strings">string interpolation</a>, 
+        <a href="http://jashkenas.github.com/coffee-script/#destructuring">destructuring assignment</a> and
+        <a href="http://jashkenas.github.com/coffee-script/#expressions">everything is an expression</a>.
+      </p>
+      <div style="text-align:center">
+        <img src="illustrate.png" width="80%">
+      </div>
+      <p class="comment">
+        So it makes sense to be able to maintain the sources in CoffeeScript instead of Javascript while
+        keeping the packaging option!
+      </p>
+    </div>
+    <div id="navigation">
+      <a href="../1-basic/index.html" class="button" id="leftnav"></a>
+      <a href="../3-embedded-coffee/index.html" class="button" id="rightnav"></a>
+      <div style="clear:both"></div>
+    </div>
+  </body>
+</html>

data/examples/2-coffee/lib/App.coffee

@@ -0,0 +1,9 @@
+{StringUtils} = require('./StringUtils')
+
+exports.App = {
+  
+  runTests: ()->
+    $("body").append StringUtils.pre("Have a look at 'nibjs --coffee'")
+    true
+  
+}