RubyGems - nibjs - Versions diffs - 1.0.0 → 1.1.0 - Mend

nibjs 1.0.0 → 1.1.0

Files changed (87) hide show

data/CHANGELOG.md +11 -0
data/Gemfile.lock +1 -1
data/Manifest.txt +2 -1
data/README.md +10 -0
data/Rakefile +1 -1
data/dist/nibjs-1.0.0.js +74 -0
data/dist/nibjs-1.0.0.min.js +7 -0
data/dist/nibjs-1.1.0.js +74 -0
data/dist/nibjs-1.1.0.min.js +7 -0
data/examples/1-basic/basic.js +27 -0
data/examples/1-basic/build +7 -0
data/examples/1-basic/illustrate.png +0 -0
data/examples/1-basic/index.html +56 -0
data/examples/1-basic/lib/App.js +9 -0
data/examples/1-basic/lib/StringUtils.js +7 -0
data/examples/1-basic/lib/index.js +2 -0
data/examples/2-coffee/build +7 -0
data/examples/2-coffee/coffee.js +24 -0
data/examples/2-coffee/illustrate.png +0 -0
data/examples/2-coffee/index.html +57 -0
data/examples/2-coffee/lib/App.coffee +9 -0
data/examples/2-coffee/lib/StringUtils.coffee +6 -0
data/examples/2-coffee/lib/index.coffee +2 -0
data/examples/3-embedded-coffee/build +7 -0
data/examples/3-embedded-coffee/embedded-coffee.coffee +25 -0
data/examples/3-embedded-coffee/illustrate.png +0 -0
data/examples/3-embedded-coffee/index.html +68 -0
data/examples/3-embedded-coffee/lib/App.coffee +9 -0
data/examples/3-embedded-coffee/lib/StringUtils.coffee +6 -0
data/examples/3-embedded-coffee/lib/index.coffee +2 -0
data/examples/4-coffee-join/build +7 -0
data/examples/4-coffee-join/coffee-join.js +19 -0
data/examples/4-coffee-join/illustrate.png +0 -0
data/examples/4-coffee-join/index.html +55 -0
data/examples/4-coffee-join/lib/App.coffee +7 -0
data/examples/4-coffee-join/lib/StringUtils.coffee +6 -0
data/examples/4-coffee-join/lib/index.coffee +2 -0
data/examples/5-standalone/build +7 -0
data/examples/5-standalone/illustrate.png +0 -0
data/examples/5-standalone/index.html +52 -0
data/examples/5-standalone/lib/App.coffee +7 -0
data/examples/5-standalone/lib/StringUtils.coffee +6 -0
data/examples/5-standalone/lib/index.coffee +2 -0
data/examples/5-standalone/standalone.js +94 -0
data/examples/README.md +43 -0
data/examples/commons.rb +11 -0
data/{test/integration/integration_test.rb → examples/handler.rb} +5 -12
data/examples/illustrate.png +0 -0
data/examples/illustrations.graffle +4382 -0
data/examples/index.html +32 -0
data/examples/public/TestSuite.coffee +43 -0
data/examples/public/TestSuite.js +53 -0
data/examples/public/coffee-script.js +8 -0
data/examples/public/forkme.png +0 -0
data/examples/public/leftnav.png +0 -0
data/examples/public/leftnav_bw.png +0 -0
data/examples/public/nibjs.js +74 -0
data/examples/public/rightnav.png +0 -0
data/examples/public/rightnav_bw.png +0 -0
data/examples/public/style.css +82 -0
data/examples/public/test-false.png +0 -0
data/examples/public/test-pending.gif +0 -0
data/examples/public/test-true.png +0 -0
data/lib/nibjs/main.rb +104 -79
data/lib/nibjs/version.rb +1 -1
data/nibjs.noespec +1 -1
data/src/nibjs.coffee +104 -107
data/tasks/analytics.txt +10 -0
data/tasks/examples.rake +25 -0
data/tasks/gh-pages.rake +15 -0
data/tasks/test.rake +2 -3
data/test/command/footer.js +1 -0
data/test/command/sc_coffee_6.exp +106 -0
data/test/command/sc_coffee_7.exp +151 -0
data/test/command/sc_common_6.exp +1 -0
data/test/command/sc_common_7.exp +33 -0
data/test/command/sc_common_8.exp +107 -0
data/test/command/sc_common_9.exp +7 -0
data/test/command/scenarios.rb +24 -0
data/test/jasmine/assumption_spec.coffee +23 -0
data/test/jasmine/nibjs_spec.coffee +14 -15
data/test/nibjs.js +33 -33
metadata +81 -14
data/test/integration/index.html +0 -42
data/test/integration/integration_test.coffee +0 -29
data/test/integration/integration_test.js +0 -34
data/test/integration/jquery-1.4.4.min.js +0 -167

data/examples/2-coffee/lib/StringUtils.coffee ADDED

@@ -0,0 +1,6 @@
+exports.StringUtils = {
+  pre: (what)->
+    "<pre>#{what}</pre>"
+}

data/examples/2-coffee/lib/index.coffee ADDED

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

data/examples/3-embedded-coffee/build ADDED

@@ -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 --no-coffee-compile --libname=embedded-coffee}
+output = File.join(here, 'embedded-coffee.coffee')
+nibjs(options, __output(output), lib)

data/examples/3-embedded-coffee/embedded-coffee.coffee ADDED

@@ -0,0 +1,25 @@
+NibJS.define 'embedded-coffee', (nibjs)->
+  nibjs.register './App', (exports, require)->
+    {StringUtils} = require('./StringUtils')
+    exports.App = {
+      runTests: ()->
+        $("body").append StringUtils.pre("Check 'nibjs --coffee --no-coffee-compile'")
+        true
+    }
+  nibjs.register './index', (exports, require)->
+    exports.StringUtils = require('./StringUtils').StringUtils
+    exports.App = require('./App').App
+  nibjs.register './StringUtils', (exports, require)->
+    exports.StringUtils = {
+      pre: (what)->
+        "<pre>#{what}</pre>"
+    }
+  nibjs.require './index'

data/examples/3-embedded-coffee/illustrate.png ADDED

Binary file

data/examples/3-embedded-coffee/index.html ADDED

@@ -0,0 +1,68 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>NibJS - Embedded 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/coffee-script.js" type="text/javascript"></script>
+  <script src="../public/nibjs.js" type="text/javascript"></script>
+  <script src="embedded-coffee.coffee" type="text/coffeescript"></script>
+  <script>
+    /* this is what we should have without coffeescript's issue 1054
+       https://github.com/jashkenas/coffee-script/issues/#issue/1054 */
+    function run(){
+      //
+      // this is how you require your application. App will now contain whatever
+      // your index.js has exported.
+      //
+      App = NibJS.require('embedded-coffee').App;
+      //
+      // Let me profit from your browser and run the integration tests :-)
+      //
+      TestSuite.runOne(App);
+    }
+    // this function will wait until the package has been built
+    function wait() {
+      try{ NibJS } catch (err){ setTimeout(wait, 100); return; }
+      if (NibJS.hasPackage('embedded-coffee')) {
+        run();
+      } else {
+        setTimeout(wait, 100);
+      }
+    }
+    $(document).ready(function(){ wait(); });
+  </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>Or even embedding CoffeeScript directly in the browser!</h2>
+      <p class="comment">
+        In addition to the previous example, the coffeescript source of this example is compiled by the browser
+        instead of being prepared by nibjs at packaging time. This coffeescript/nibjs feature is useful when coffee
+        compiler is not easily available on the server.
+      </p>
+      <div style="text-align:center">
+        <img src="illustrate.png" width="80%">
+      </div>
+      <p class="comment">
+        Please be aware that making so is not really recommended for production use...
+      </p>
+    </div>
+    <div id="navigation">
+      <a href="../2-coffee/index.html" class="button" id="leftnav"></a>
+      <a href="../4-coffee-join/index.html" class="button" id="rightnav"></a>
+      <div style="clear:both"></div>
+    </div>
+  </body>
+</html>

data/examples/3-embedded-coffee/lib/App.coffee ADDED

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

data/examples/3-embedded-coffee/lib/StringUtils.coffee ADDED

@@ -0,0 +1,6 @@
+exports.StringUtils = {
+  pre: (what)->
+    "<pre>#{what}</pre>"
+}

data/examples/3-embedded-coffee/lib/index.coffee ADDED

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

data/examples/4-coffee-join/build ADDED

@@ -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 --join --libname=coffee-join}
+output = File.join(here, 'coffee-join.js')
+nibjs(options, __output(output), lib)

data/examples/4-coffee-join/coffee-join.js ADDED

@@ -0,0 +1,19 @@
+NibJS.define('coffee-join', function(nibjs) {
+  nibjs.register('./index', function(exports, require) {
+    var App, StringUtils;
+    App = {
+      runTests: function() {
+        $("body").append(StringUtils.pre("'nibjs --join' option is for you!"));
+        return true;
+      }
+    };
+    StringUtils = {
+      pre: function(what) {
+        return "<pre>" + what + "</pre>";
+      }
+    };
+    exports.StringUtils = StringUtils;
+    return exports.App = App;
+  });
+  return nibjs.require('./index');
+});

data/examples/4-coffee-join/illustrate.png ADDED

Binary file

data/examples/4-coffee-join/index.html ADDED

@@ -0,0 +1,55 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>NibJS - Join 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-join.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-join').App;
+      console.log(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>Do exports.XXX and require('./XXX') look painful?</h2>
+      <p class="comment">
+        Sometimes, you simply want to maintain your code source "as if it were in a single file"
+        but still splitting different features in different files... In that case, you would like
+        to avoid having to exports and require everything everytime.
+      </p>
+      <div style="text-align:center">
+        <img src="illustrate.png" width="80%">
+      </div>
+      <p class="comment">
+        This should only be used if your code 1) has no name clash accross different files and 2)
+        has no particular dependency order.
+      </p>
+    </div>
+    <div id="navigation">
+      <a href="../3-embedded-coffee/index.html" class="button" id="leftnav"></a>
+      <a href="../5-standalone/index.html" class="button" id="rightnav"></a>
+      <div style="clear:both"></div>
+    </div>
+  </body>
+</html>

data/examples/4-coffee-join/lib/App.coffee ADDED

@@ -0,0 +1,7 @@
+App = {
+  runTests: ()->
+    $("body").append StringUtils.pre("'nibjs --join' option is for you!")
+    true
+}

data/examples/4-coffee-join/lib/StringUtils.coffee ADDED

@@ -0,0 +1,6 @@
+StringUtils = {
+  pre: (what)->
+    "<pre>#{what}</pre>"
+}

data/examples/4-coffee-join/lib/index.coffee ADDED

	@@ -0,0 +1,2 @@
1	+ exports.StringUtils = StringUtils
2	+ exports.App = App

data/examples/5-standalone/build ADDED

@@ -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 --join --standalone --libname=standalone}
+output = File.join(here, 'standalone.js')
+nibjs(options, __output(output), lib)

data/examples/5-standalone/illustrate.png ADDED

Binary file

data/examples/5-standalone/index.html ADDED

@@ -0,0 +1,52 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html;charset=UTF-8" />
+  <title>NibJS - Join Example</title>
+  <!-- This is your application -->
+  <script src="http://code.jquery.com/jquery-1.5.min.js" type="text/javascript"></script>
+  <script src="standalone.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('standalone').App;
+      console.log(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>Your users don't even need NibJS as runtime dependency!</h2>
+      <p class="comment">
+        By default, you need to include <code>nibjs.js</code> to your webpage in order
+        to implement the CommonJS module specification. However if you plan to redistribute
+        your library, having NibJS as dependency may not be friendly for your own users.
+      </p>
+      <div style="text-align:center">
+        <img src="illustrate.png" width="80%">
+      </div>
+      <p class="comment">
+        In that case packaging a self-contained .js file containing NibJS itself makes sense:
+      </p>
+    </div>
+    <div id="navigation">
+      <a href="../4-coffee-join/index.html" class="button" id="leftnav"></a>
+      <div style="clear:both"></div>
+    </div>
+  </body>
+</html>

data/examples/5-standalone/lib/App.coffee ADDED

@@ -0,0 +1,7 @@
+App = {
+  runTests: ()->
+    $("body").append StringUtils.pre("This is why 'nibjs --standalone' exists!")
+    true
+}

data/examples/5-standalone/lib/StringUtils.coffee ADDED

@@ -0,0 +1,6 @@
+StringUtils = {
+  pre: (what)->
+    "<pre>#{what}</pre>"
+}

data/examples/5-standalone/lib/index.coffee ADDED

	@@ -0,0 +1,2 @@
1	+ exports.StringUtils = StringUtils
2	+ exports.App = App

data/examples/5-standalone/standalone.js ADDED

@@ -0,0 +1,94 @@
+/**
+ * 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);
+NibJS.define('standalone', function(nibjs) {
+  nibjs.register('./index', function(exports, require) {
+    var App, StringUtils;
+    App = {
+      runTests: function() {
+        $("body").append(StringUtils.pre("This is why 'nibjs --standalone' exists!"));
+        return true;
+      }
+    };
+    StringUtils = {
+      pre: function(what) {
+        return "<pre>" + what + "</pre>";
+      }
+    };
+    exports.StringUtils = StringUtils;
+    return exports.App = App;
+  });
+  return nibjs.require('./index');
+});

data/examples/README.md ADDED

@@ -0,0 +1,43 @@
+# NibJS - Examples
+This folder contains typical use cases in using nib.js, one in each subfolder.
+Each example is self-contained, and respects the following folder structure:
+    x-example/
+      build             # run to (re-)build the example
+      example.js        # generated by build using nibjs command
+      index.html        # to be opened in your prefered browser
+      lib/
+        ...             # java/coffee script source files
+Examples are kept built in the sources, so that they can be executed immediately
+in a browser. In other words, opening any x-example/index.html file in a browser
+should work. Otherwise, please report the bug on github.
+Please report any error on "github":https://github.com/blambeau/nib.js/issues
+## 1-basic
+Demonstrates a simple use case where you maintain an application as well as some
+utility modules and compile them as a single self-contained .js file ready for
+inclusion in the browser (you don't even need to include nibjs itself in your
+html file). NibJS is invoked as follows (see 1-basic/build):
+    nibjs --libname=basic --standalone --output=basic.js lib
+## 2-coffee
+Same as the previous example, but written in coffeescript. NibJS invocation:
+    nibjs --coffee --libname=coffee --standalone --output=coffee.js lib
+## Credits
+Icons used in examples are from www.veryicon.com, distributed under LGPL
+licence with following licence information:
+TITLE:	Crystal Project Icons
+AUTHOR:	Everaldo Coelho
+SITE:	http://www.everaldo.com
+CONTACT: everaldo@everaldo.com
+LICENSE: LGPL