twitter-flight-rails 0.0.2 → 1.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Twitter Flight framework for Rails
 
-This asset gem packages the [twitter flight](https://github.com/twitter/flight/) framework for the Rails asset pipeline.
+This asset gem packages the [twitter flight](https://github.com/twitter/flight/) framework for Rails.
 
 ## Installation
 
@@ -12,34 +12,45 @@ Add this line to your application's Gemfile:
 
     gem 'twitter-flight-rails', :git => "git@github.com:yourabi/twitter-flight-rails.git"
     
+You'll also want to add the following dependencies to your Gemfile (see the dependencies section for more details)
+
+    gem 'requirejs-rails'
+
+    gem 'es5-shim-rails'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
+## Dependencies
 
-    $ gem install twitter-flight-rails
+Twitter flight depdends on ES5-shim, jQuery and an AMD implementation like require.js.
 
-## Usage
+One possible Rails/Require.js integration is [requirejs-rails](https://github.com/jwhitley/requirejs-rails) ... you'll probably want to read their documentation and follow their initial setup instructions.
 
-To start using the twitter flight fraemwork in your rails app enable it via the asset pipeline (app/assets/javascripts/application.js).
+[ES5-shim](https://github.com/kriskowal/es5-shim) is used to polyfill ES5 support for older browsers and [JQuery](http://jquery.com) for DOM manipulation API. This is provided by the [es5-shim-rails](https://github.com/yourabi/es5-shim-rails) gem.
 
-Add the folllwing:
+## Usage
+
+Eventually you'll end up using require.js to include jquery, es5-shim, flight and your own compnents using something like this
 
 ```js
+  // here "root" is a file that contains your own components under app/assets/javascripts/root.js and accessed at /assets/root.js
+  require(['jquery', 'es5-shim/shims/es5-shim', 'es5-shim/shims/es5-sham', 'twitter/flight/', 'root'], function($) {
 
-//= require twitter/flight                                                                                                                                                                                                                             
+    // this is your own boot.js file in app/assets/javascripts/boot.js accessed at /assets/boot.js
+    require(['boot'], function(initialize) {
+      initialize();
+    });
 
-```
+  });
 
-Currently this version tracks flight master [commit e07b90c78d](https://github.com/twitter/flight/commit/e07b90c78d416549455354cbcd3e7f8a001c4fdf) and may support release tags in the future.
+```
 
-## Dependencies
+## Changelog
 
-Flight uses [ES5-shim](https://github.com/kriskowal/es5-shim) to polyfill ES5 support for older browsers and [JQuery](http://jquery.com) for DOM manipulation API. 
+Currently this version tracks [flight v1.0.2](https://github.com/twitter/flight/tree/v1.0.2) with a few bugs backported from master ($.browser reference in jQuery 1.9) and paths tweaked slightly.
 
-Note: as of version 0.0.2 the es5-shim dependency is not handled.
 
 ## Contributing
 

data/lib/twitter-flight-rails/version.rb

@@ -1,7 +1,7 @@
 module Twitter
   module Flight
     module Rails
-      VERSION = "0.0.2"
+      VERSION = "1.0.2"
     end
   end
 end

data/twitter-flight-rails.gemspec

@@ -14,12 +14,10 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency             'railties',   '>= 3.1'
   gem.add_dependency             'actionpack', '>= 3.1'
-  gem.add_dependency             'jquery-rails'
-  
+  gem.add_dependency             'jquery-rails', '>= 2.2.1'
+
   gem.add_development_dependency 'rails', '>= 3.1'
 
   gem.files         = `git ls-files`.split($/)
-  # gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  # gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 end

data/vendor/assets/javascripts/twitter/flight/component.js

@@ -17,6 +17,9 @@ define(
 
   function(advice, utils, compose, registry) {
 
+    var functionNameRegEx = /function (.*?)\s?\(/;
+    var spaceCommaRegEx = /\s\,/g;
+
     function teardownInstance(instanceInfo){
       instanceInfo.events.slice().forEach(function(event) {
         var args = [event.type];
@@ -43,6 +46,17 @@ define(
       });
     }
 
+    function checkSerializable(type, data) {
+      try {
+        window.postMessage(data, '*');
+      } catch(e) {
+        console.log('unserializable data for event',type,':',data);
+        throw new Error(
+          ["The event", type, "on component", this.describe, "was triggered with non-serializable data"].join(" ")
+        );
+      }
+    }
+
     //common mixin allocates basic functionality - used by all component prototypes
     //callback context is bound to component
     function withBaseComponent() {
@@ -50,33 +64,43 @@ define(
       // delegate trigger, bind and unbind to an element
       // if $element not supplied, use component's node
       // other arguments are passed on
+      // event can be either a string specifying the type
+      // of the event, or a hash specifying both the type
+      // and a default function to be called.
       this.trigger = function() {
-        var $element, type, data;
+        var $element, type, data, event, defaultFn;
         var args = utils.toArray(arguments);
+        var lastArg = args[args.length - 1];
 
-        if (typeof args[args.length - 1] != "string") {
+        if (typeof lastArg != "string" && !(lastArg && lastArg.defaultBehavior)) {
           data = args.pop();
         }
 
         $element = (args.length == 2) ? $(args.shift()) : this.$node;
-        type = args[0];
+        event = args[0];
+
+        if (event.defaultBehavior) {
+          defaultFn = event.defaultBehavior;
+          event = $.Event(event.type);
+        }
+
+        type = event.type || event;
 
         if (window.DEBUG && window.postMessage) {
-          try {
-            window.postMessage(data, '*');
-          } catch(e) {
-            console.log('unserializable data for event',type,':',data);
-            throw new Error(
-              ["The event", event.type, "on component", this.describe, "was triggered with non-serializable data"].join(" ")
-            );
-          }
+          checkSerializable.call(this, type, data);
         }
 
         if (typeof this.attr.eventData === 'object') {
           data = $.extend(true, {}, this.attr.eventData, data);
         }
 
-        return $element.trigger(type, data);
+        var returnVal = $element.trigger((event || type), data);
+
+        if (defaultFn && !event.isDefaultPrevented()) {
+          (this[defaultFn] || defaultFn).call(this);
+        }
+
+        return returnVal;
       };
 
       this.on = function() {
@@ -92,7 +116,14 @@ define(
           originalCb = args.pop();
         }
 
-        callback = originalCb && originalCb.bind(this);
+        $element = (args.length == 2) ? $(args.shift()) : this.$node;
+        type = args[0];
+
+        if (typeof originalCb != 'function' && typeof originalCb != 'object') {
+          throw new Error("Unable to bind to '" + type + "' because the given callback is not a function or an object");
+        }
+
+        callback = originalCb.bind(this);
         callback.target = originalCb;
 
         // if the original callback is already branded by jQuery's guid, copy it to the context-bound version
@@ -100,13 +131,6 @@ define(
           callback.guid = originalCb.guid;
         }
 
-        $element = (args.length == 2) ? $(args.shift()) : this.$node;
-        type = args[0];
-
-        if (typeof callback == 'undefined') {
-          throw new Error("Unable to bind to '" + type + "' because the given callback is undefined");
-        }
-
         $element.on(type, callback);
 
         // get jquery's guid from our bound fn, so unbinding will work
@@ -177,13 +201,14 @@ define(
 
       Component.toString = function() {
         var prettyPrintMixins = mixins.map(function(mixin) {
-          if ($.browser.msie) {
-            var m = mixin.toString().match(/function (.*?)\s?\(/);
+          if (mixin.name == null) {
+            //function name property not supported by this browser, use regex
+            var m = mixin.toString().match(functionNameRegEx);
             return (m && m[1]) ? m[1] : "";
           } else {
             return mixin.name;
           }
-        }).join(', ').replace(/\s\,/g,'');//weed out no-named mixins
+        }).join(', ').replace(spaceCommaRegEx,'');//weed out no-named mixins
 
         return prettyPrintMixins;
       };

data/vendor/assets/javascripts/twitter/flight/compose.js

@@ -10,7 +10,7 @@ define(
 
   [
     './utils',
-    '../tools/debug/debug'
+    'twitter/flight/tools/debug/debug'
   ],
 
   function(util, debug) {

data/vendor/assets/javascripts/twitter/flight/tools/debug/debug.js

@@ -0,0 +1,125 @@
+"use strict";
+
+define(
+
+  [
+    '../../registry',
+    '../../utils'
+  ],
+
+  function(registry, utils) {
+
+    var logFilter;
+
+    //******************************************************************************************
+    // Search object model
+    //******************************************************************************************
+
+    function traverse(util, searchTerm, options) {
+      var options = options || {};
+      var obj = options.obj || window;
+      var path = options.path || ((obj==window) ? "window" : "");
+      var props = Object.keys(obj);
+      props.forEach(function(prop) {
+        if ((tests[util] || util)(searchTerm, obj, prop)){
+          console.log([path, ".", prop].join(""), "->",["(", typeof obj[prop], ")"].join(""), obj[prop]);
+        }
+        if(Object.prototype.toString.call(obj[prop])=="[object Object]" && (obj[prop] != obj) && path.split(".").indexOf(prop) == -1) {
+          traverse(util, searchTerm, {obj: obj[prop], path: [path,prop].join(".")});
+        }
+      });
+    }
+
+    function search(util, expected, searchTerm, options) {
+      if (!expected || typeof searchTerm == expected) {
+        traverse(util, searchTerm, options);
+      } else {
+        console.error([searchTerm, 'must be', expected].join(' '))
+      }
+    }
+
+    var tests = {
+      'name': function(searchTerm, obj, prop) {return searchTerm == prop},
+      'nameContains': function(searchTerm, obj, prop) {return prop.indexOf(searchTerm)>-1},
+      'type': function(searchTerm, obj, prop) {return obj[prop] instanceof searchTerm},
+      'value': function(searchTerm, obj, prop) {return obj[prop] === searchTerm},
+      'valueCoerced': function(searchTerm, obj, prop) {return obj[prop] == searchTerm}
+    }
+
+    function byName(searchTerm, options) {search('name', 'string', searchTerm, options);};
+    function byNameContains(searchTerm, options) {search('nameContains', 'string', searchTerm, options);};
+    function byType(searchTerm, options) {search('type', 'function', searchTerm, options);};
+    function byValue(searchTerm, options) {search('value', null, searchTerm, options);};
+    function byValueCoerced(searchTerm, options) {search('valueCoerced', null, searchTerm, options);};
+    function custom(fn, options) {traverse(fn, null, options);};
+
+    //******************************************************************************************
+    // Event logging
+    //******************************************************************************************
+    var logLevel = 'all';
+    logFilter = {actions: logLevel, eventNames: logLevel}; //no filter by default
+
+    function filterEventLogsByAction(/*actions*/) {
+      var actions = [].slice.call(arguments, 0);
+
+      logFilter.eventNames.length || (logFilter.eventNames = 'all');
+      logFilter.actions = actions.length ? actions : 'all';
+    }
+
+    function filterEventLogsByName(/*eventNames*/) {
+      var eventNames = [].slice.call(arguments, 0);
+
+      logFilter.actions.length || (logFilter.actions = 'all');
+      logFilter.eventNames = eventNames.length ? eventNames : 'all';
+    }
+
+    function hideAllEventLogs() {
+      logFilter.actions = [];
+      logFilter.eventNames = [];
+    }
+
+    function showAllEventLogs() {
+      logFilter.actions = 'all';
+      logFilter.eventNames = 'all';
+    }
+
+    return {
+
+      enable: function(enable) {
+        this.enabled = !!enable;
+
+        if (enable && window.console) {
+          console.info('Booting in DEBUG mode');
+          console.info('You can filter event logging with DEBUG.events.logAll/logNone/logByName/logByAction');
+        }
+
+        window.DEBUG = this;
+      },
+
+      find: {
+        byName: byName,
+        byNameContains: byNameContains,
+        byType: byType,
+        byValue: byValue,
+        byValueCoerced: byValueCoerced,
+        custom: custom
+      },
+
+      events: {
+        logFilter: logFilter,
+
+        // Accepts any number of action args
+        // e.g. DEBUG.events.logByAction("on", "off")
+        logByAction: filterEventLogsByAction,
+
+        // Accepts any number of event name args (inc. regex or wildcards)
+        // e.g. DEBUG.events.logByName(/ui.*/, "*Thread*");
+        logByName: filterEventLogsByName,
+
+        logAll: showAllEventLogs,
+        logNone: hideAllEventLogs
+      }
+    };
+  }
+);
+

data/vendor/assets/javascripts/twitter/flight.js

@@ -1 +1 @@
-//= require_directory twitter/flight
+//=require_directory ./flight

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter-flight-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-12 00:00:00.000000000 Z
+date: 2013-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.2.1
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -98,6 +98,7 @@ files:
 - vendor/assets/javascripts/twitter/flight/index.js
 - vendor/assets/javascripts/twitter/flight/logger.js
 - vendor/assets/javascripts/twitter/flight/registry.js
+- vendor/assets/javascripts/twitter/flight/tools/debug/debug.js
 - vendor/assets/javascripts/twitter/flight/utils.js
 homepage: https://github.com/yourabi/twitter-flight-rails
 licenses: []