appjs 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76814bb98088d2c026c7113e6e989e168e0128b8
-  data.tar.gz: c878d5f13e19b67bc27e0ffaf7733e42ff8dd2b3
+  metadata.gz: 9b399779bbccc64c399ce46c171c2a68478933ad
+  data.tar.gz: 1e3d0c3748d22447c779dff5e3651a90bc3739f1
 SHA512:
-  metadata.gz: b9ec78b5fb509850e0ea60df048482bf04f2b5e9e23cc4df9849004089fd3e9014e0a540ce6e39d8504137f808227bb5d77d9843db85a7d47a39dcf7a4b86ae6
-  data.tar.gz: 52ff28819c8fd67e77ea8da27ec95fe6c0c10603601cc5b9df1a78b9ddc018510f18dfb1847fa2e287834ed73fb033530c0af93ff7a7c9a0c104b70ecdb83c01
+  metadata.gz: 68111d5c705c5ec8b70c845b50dc833991c1d7721fa20f6dc9f3387dab7e10adb1f10319a280fe65bc3547940c148541f66d0de5e49c7c1b6dcf4019c99eb3f9
+  data.tar.gz: 9fa9aa2233a18750828e861677029e1f3926d52cb44e1ede93eb2c5680774bd313bf0cb2d2907fe23c15c1b5c6fb1d330019aa881696c2ee909c65a0ac5e48e0

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.ruby-*

data/README.md

@@ -1,6 +1,79 @@
 # Appjs
 
-TODO: Write a gem description
+Since repetition is the killer of all productivity, we decided to define a
+generic way, for handling stuff like modularization and dependency-handling/-injection.
+
+## Concepts
+
+### Modularization
+
+It's all about the modules you are creating or you want to reuse on a later
+project. We follow a similar approach as [require.js](http://requirejs.org/):
+
+```javascript
+app.define('views.TodoList', function () {
+  var Backbone  = app.require('Backbone'),
+      $         = app.require('jQuery'),
+      U         = app.require('Underscore');
+      view, 
+      render_helper;
+
+  render_helper = function () {
+    // ...
+  };
+
+
+  view = Backbone.View.extend({
+    render: render_helper
+  });
+
+  return view;
+});
+```
+
+Effectively, this creates an Object `TodoList` in the Namespace `views`.
+
+Main advantage is the lazy definition of this helper. The function is not
+called, until somewhere a call in the later application demands this specific
+Object:
+
+```javascript
+var TodoList  = app.require('views.TodoList'),
+    $         = app.require('jQuery'),
+    my_list;
+
+my_list = new TodoList({
+  el: $('.todo-list')
+});
+```
+
+### Predefined mediators
+
+Since most of the libraries you can use pollute somehow the global namespace; we
+where searching for a way, to integrate those tools into our
+define-require-schema.
+
+Luckily, most of them provide a no-conflict mode. This lead us to some helper
+for common libraries. An `application.js` could look as following:
+
+```javascript
+
+//= require underscore
+//= require jquery
+//= require backbone
+//
+//= require app
+//= require app/mediators/underscore
+//= require app/mediators/jquery
+//= require app/mediators/backbone
+```
+
+The mediators automatically invoke no-conflict calls and store the main
+constant(s) of the libraries into a app-definition:
+
+* `mediators/underscore` provides `app.require('Underscore')`
+* `mediators/jquery` provides `app.require('jQuery')`
+* `mediators/backbone` provides `app.require('Backbone')`
 
 ## Installation
 
@@ -18,7 +91,12 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+First step would be to add
+
+    //= require app
+
+to your application.js. This should be followed by the appropiate mediators, to
+clean-up your global namespace.
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,3 @@
 require "bundler/gem_tasks"
+
+require "teatime/tasks"

data/Teafile

@@ -0,0 +1,22 @@
+Teatime do |config|
+  # root dir of all requireable lib files
+  # config.lib_dir      = 'lib'
+  config.lib_dir      = 'lib/assets/javascripts'
+
+
+  # pattern to determine relevant lib files
+  config.lib_files    = '**/*.js'
+
+
+  # root dir of all the test files
+  config.test_dir     = 'test/javascripts'
+
+  # test helpers will be included in the
+  # provided order
+  config.test_helpers = [ 'test_helper.js' ]
+
+  # pattern to determine relevant testfiles
+  config.test_files   = '**/*_test.js'
+end
+
+# vim: set ft=ruby:

data/appjs.gemspec

@@ -7,8 +7,8 @@ Gem::Specification.new do |spec|
   spec.name          = "appjs"
   spec.version       = Appjs::VERSION
   spec.authors       = ["Jakob Holderbaum"]
-  spec.email         = ["jakob@featurefabrik.de"]
-  spec.summary       = %q{JS structure for web-apps (middleman/rails)}
+  spec.email         = ["gems@techfolio.de"]
+  spec.summary       = %q{That's how we structure the JS in our Rails-apps.}
   spec.homepage      = "http://www.featurefabrik.com/"
   spec.license       = "MIT"
 
@@ -19,4 +19,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "teatime"
 end

data/lib/appjs/version.rb

@@ -1,3 +1,3 @@
 module Appjs
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/assets/javascripts/app.js

@@ -0,0 +1,42 @@
+var App = function () {
+    var app_instance;
+
+    app_instance = function () {
+        var app = {},
+            definitions = {},
+            constants = {};
+
+        app.define = function (constant, definition) {
+            if (definitions[constant] !== undefined) {
+                throw "Constant '" + constant + "' already defined."
+            }
+            if (typeof definition !== 'function') {
+                throw "Definition has to be a function."
+            }
+
+            definitions[constant] = definition;
+        };
+
+        app.require = function (constant) {
+            if (constants[constant] === undefined) {
+                if (definitions[constant] === undefined) {
+                    throw "Constant '" + constant + "' not defined."
+                }
+                constants[constant] = definitions[constant]();
+            }
+
+            return constants[constant];
+        };
+
+        return app;
+    }
+
+    return {
+        Mediators: {},
+        induce: function (scope) {
+            scope.app = app_instance();
+        }
+    };
+}();
+
+App.induce(window);

data/lib/assets/javascripts/app/mediators/backbone.js

@@ -0,0 +1,13 @@
+(function () {
+    var cache;
+
+    if (typeof Backbone !== 'undefined') {
+        cache = Backbone.noConflict();
+    }
+
+    if (cache) {
+        app.define('Backbone', function () {
+            return cache;
+        });
+    }
+}());

data/lib/assets/javascripts/app/mediators/jquery.js

@@ -0,0 +1,17 @@
+(function () {
+    var cache;
+
+    if (typeof $ !== 'undefined') {
+        cache = $.noConflict();
+    } else if (typeof jQuery !== 'undefined') {
+        cache = jQuery;
+        delete jQuery;
+    }
+
+
+    if (cache) {
+        app.define('jQuery', function () {
+            return cache;
+        });
+    }
+}());

data/lib/assets/javascripts/app/mediators/underscore.js

@@ -0,0 +1,13 @@
+(function () {
+    var cache;
+
+    if (typeof _ !== 'undefined') {
+        cache = _.noConflict(); 
+    }
+
+    if (cache) {
+        app.define('underscore', function () {
+            return cache;
+        });
+    }
+}());

data/test/javascripts/app_test.js

@@ -0,0 +1,127 @@
+describe('app', function () {
+
+    describe('induce', function () {
+
+        it('enhances namespace with app', function () {
+            var namespace = {};
+
+            App.induce(namespace);
+
+            assert.ok(namespace.app);
+        });
+
+        it('creates separated instances', function () {
+            var namespace1 = {},
+                namespace2 = {};
+
+            App.induce(namespace1);
+            App.induce(namespace2);
+
+            namespace1.app.test = 23;
+
+            assert.isUndefined(namespace2.app.test);
+        });
+
+        it('is already called on window', function () {
+            assert.ok(window.app);
+        })
+
+    });
+
+    describe('define', function () {
+        var namespace;
+
+        beforeEach(function () {
+            namespace = {};
+            App.induce(namespace);
+        });
+
+        it('is no evaluated initially', function () {
+            var counter = 0;
+
+            namespace.app.define('module.Object', function () {
+                counter += 1;
+
+                return {
+                    attr: 12
+                };
+            });
+
+            assert.equal(counter, 0);
+        });
+
+        it('can not be called twice with identical constant', function () {
+            namespace.app.define('const', function () {});
+
+            assert.throws(function () {
+                namespace.app.define('const', function () {});
+            }, /already defined/i)
+        });
+
+        it('accepts only a function', function () {
+            assert.throws(function () {
+                namespace.app.define('const', {});
+            }, /definition has to be a function/i);
+        })
+    });
+
+    describe('require', function () {
+        var namespace;
+
+        beforeEach(function () {
+            namespace = {};
+            App.induce(namespace);
+        });
+
+        it('invokes the definition', function () {
+            var counter = 0,
+                car;
+
+            namespace.app.define('Car', function () {
+                counter += 1;
+
+                return {
+                    hasTires: true
+                };
+            });
+
+            assert.equal(counter, 0);
+
+            car = namespace.app.require('Car');
+
+            assert.equal(counter, 1);
+            assert.ok(car.hasTires)
+        });
+
+        it('invokes the definition only the first time', function () {
+            var counter = 0,
+                car;
+
+            namespace.app.define('Car', function () {
+                counter += 1;
+
+                return {
+                    hasTires: true
+                };
+            });
+
+            car = namespace.app.require('Car');
+
+            assert.equal(counter, 1);
+            assert.ok(car.hasTires)
+
+            car = namespace.app.require('Car');
+
+            assert.equal(counter, 1);
+            assert.ok(car.hasTires)
+        });
+
+        it('throws if definition is not found', function () {
+            assert.throws(function () {
+                namespace.app.require('MyConst');
+            }, /not defined/i);
+        });
+
+    });
+
+});

data/test/javascripts/test_helper.js

@@ -0,0 +1,3 @@
+mocha.ui('bdd');
+
+var assert = chai.assert;

data/test/mediators.html

@@ -0,0 +1,42 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
+"http://www.w3.org/TR/html4/strict.dtd">
+<html>
+<head>
+  <meta http-equiv="content-type" content="text/html; charset=utf-8">
+  <title>Jquery mediator</title>
+  <script type="text/javascript" charset="utf-8">
+    window.$ = {
+      noConflict: function () {
+        return 123;
+      }
+    }
+
+    window._ = {
+      noConflict: function () {
+        return 456;
+      }
+    }
+
+    window.Backbone = {
+      noConflict: function () {
+        return 789;
+      }
+    }
+  </script>
+
+  <script type="text/javascript" charset="utf-8" src="../../lib/assets/javascripts/app.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../lib/assets/javascripts/app/mediators/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../lib/assets/javascripts/app/mediators/underscore.js"></script>
+  <script type="text/javascript" charset="utf-8" src="../../lib/assets/javascripts/app/mediators/backbone.js"></script>
+
+  <script type="text/javascript" charset="utf-8">
+    document.write("jQuery: " + (app.require('jQuery') === 123) + '<br/>')
+    document.write("underscore: " + (app.require('underscore') === 456) + '<br/>')
+    document.write("backbone: " + (app.require('Backbone') === 789) + '<br/>')
+  </script>
+
+
+</head>
+<body>
+</body>
+</html>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appjs
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jakob Holderbaum
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-18 00:00:00.000000000 Z
+date: 2013-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,9 +38,23 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: teatime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
-- jakob@featurefabrik.de
+- gems@techfolio.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -50,9 +64,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Teafile
 - appjs.gemspec
 - lib/appjs.rb
 - lib/appjs/version.rb
+- lib/assets/javascripts/app.js
+- lib/assets/javascripts/app/mediators/backbone.js
+- lib/assets/javascripts/app/mediators/jquery.js
+- lib/assets/javascripts/app/mediators/underscore.js
+- test/javascripts/app_test.js
+- test/javascripts/test_helper.js
+- test/mediators.html
 homepage: http://www.featurefabrik.com/
 licenses:
 - MIT
@@ -76,5 +98,8 @@ rubyforge_project:
 rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
-summary: JS structure for web-apps (middleman/rails)
-test_files: []
+summary: That's how we structure the JS in our Rails-apps.
+test_files:
+- test/javascripts/app_test.js
+- test/javascripts/test_helper.js
+- test/mediators.html