mxm-boilerplate 0.0.2 → 0.0.3

data/Readme.md

@@ -14,7 +14,7 @@ Run ``rails generate mxm:setup``
 
 1. SMACSS folder conventions
 2. Normalize
-3. A simple 12 / 16 column grid
+3. A simple, fluid 12 column grid
 4. Typography defaults
 5. Boilerplate helpers
 
@@ -29,6 +29,20 @@ Run ``rails generate mxm:setup``
 1. HTML5 Boilerplate layout
 2. Partials for headers / footers / tracking
 
-# Licence
+# Changelog
+
+*0.0.3* 
+- Upgrade BigBird to latest
+- Remove 16x columns from Flynn grid
+- Drop `controllers` & `views` folders, use `modules` instead
+
+*0.0.2* 
+- Fix imports in CSS
+
+*0.0.1*
+- Initial release
+
+# License
+
+http://www.opensource.org/licenses/MIT
 
-http://www.opensource.org/licenses/MIT

data/lib/generators/mxm/assets/templates/stylesheets/_variables.css.scss

@@ -1,2 +1,2 @@
 // Any variables should be placed in here
-// $white-colour = #fff
+// $white-colour: #fff;

data/lib/generators/mxm/assets/templates/stylesheets/application.css.scss

@@ -10,11 +10,11 @@
 // Base
 //-----------------------------------------
 
-@import "base/default"
-@import "base/grid"
-@import "base/typography"
-@import "base/lists"
-@import "base/helpers"
+@import "base/default";
+@import "base/grid";
+@import "base/typography";
+@import "base/lists";
+@import "base/helpers";
 
 //-----------------------------------------
 // Layout

data/lib/generators/mxm/assets/templates/stylesheets/base/grid.css.scss

@@ -3,8 +3,7 @@
 // https://github.com/callum-/flynn
 //-----------------------------------------
 
-.l-sixteen-columns,
-.l-twelve-columns,
+.l-columns,
 .l-column {
     margin: 0;
     padding: 0;
@@ -13,8 +12,7 @@
             box-sizing: border-box;
 }
 
-.l-sixteen-columns:after,
-.l-twelve-columns:after,
+.l-columns:after,
 .l-column:after {
     content: "";
     display: table;
@@ -30,63 +28,6 @@
     padding: 0 !important;
 }
 
-
-/*
-16x column sizes
-================
- 1. 6.25%
- 2. 12.5%
- 3. 18.75%
- 4. 25%
- 5. 31.25%
- 6. 37.5%
- 7. 43.75%
- 8. 50%
- 9. 56.25%
-10. 62.5%
-11. 68.75%
-12. 75%
-13. 81.25%
-14. 87.5%
-15. 93.75%
-16. 100%
-*/
-
-.l-sixteen-columns .l-column {
-    width: 6.25%;}
-
-.l-sixteen-columns .l-span-two {
-    width: 12.5%;}
-.l-sixteen-columns .l-span-three {
-    width: 18.75%;}
-.l-sixteen-columns .l-span-four {
-    width: 25%;}
-.l-sixteen-columns .l-span-five {
-    width: 31.25%;}
-.l-sixteen-columns .l-span-six {
-    width: 37.5%;}
-.l-sixteen-columns .l-span-seven {
-    width: 43.75%;}
-.l-sixteen-columns .l-span-eight {
-    width: 50%;}
-.l-sixteen-columns .l-span-nine {
-    width: 56.25%;}
-.l-sixteen-columns .l-span-ten {
-    width: 62.5%;}
-.l-sixteen-columns .l-span-eleven {
-    width: 68.75%;}
-.l-sixteen-columns .l-span-twelve {
-    width: 75%;}
-.l-sixteen-columns .l-span-thirteen {
-    width: 81.25%;}
-.l-sixteen-columns .l-span-fourteen {
-    width: 87.5%;}
-.l-sixteen-columns .l-span-fifteen {
-    width: 93.75%;}
-.l-sixteen-columns .l-span-sixteen {
-    width: 100%;}
-
-
 /*
 12x column sizes
 ================
@@ -104,28 +45,28 @@
 12. 100%
 */
 
-.l-twelve-columns .l-column {
+.l-column {
     width: 8.333333333333334%;}
 
-.l-twelve-columns .l-span-two {
+.l-span-two {
     width: 16.666666666666668%;}
-.l-twelve-columns .l-span-three {
+.l-span-three {
     width: 25%;}
-.l-twelve-columns .l-span-four {
+.l-span-four {
     width: 33.333333333333336%;}
-.l-twelve-columns .l-span-five {
+.l-span-five {
     width: 41.66666666666667%;}
-.l-twelve-columns .l-span-six {
+.l-span-six {
     width: 50%;}
-.l-twelve-columns .l-span-seven {
+.l-span-seven {
     width: 58.333333333333336%;}
-.l-twelve-columns .l-span-eight {
+.l-span-eight {
     width: 66.66666666666667%;}
-.l-twelve-columns .l-span-nine {
+.l-span-nine {
     width: 75%;}
-.l-twelve-columns .l-span-ten {
+.l-span-ten {
     width: 83.33333333333334%;}
-.l-twelve-columns .l-span-eleven {
+.l-span-eleven {
     width: 91.66666666666667%;}
-.l-twelve-columns .l-span-twelve {
+.l-span-twelve {
     width: 100%;}

data/lib/mxm/rails/version.rb

@@ -1,5 +1,5 @@
 module Mxm
   module Rails
-    VERSION = "0.0.2"
+    VERSION = "0.0.3"
   end
 end

data/vendor/assets/javascripts/bigbird.js

@@ -1,26 +1,35 @@
 // Big Bird
-// v0.1.0
-// by @cjbell88, @ninjabiscuit & @callumj_
+// v0.1.1
+// by @cjbell88, @ninjabiscuit & @callumj_ all from @madebymany
 (function() {
+
+  // Initial setup
+  // -------------
+
   var BigBird = window.BigBird = {};
 
+  // Current version of BigBird
+  BigBird.VERSION = '0.1.1';
+
+  // Use jQuery (our only dependency)
+  // If it's not included and require is included then require it.
   var $ = jQuery;
   if (!$ && (typeof require !== 'undefined')) { $ = require('jquery'); }
 
-  /* jQuery Tiny Pub/Sub - v0.7 - 10/27/2011
-   * http://benalman.com/
-   * Copyright (c) 2011 "Cowboy" Ben Alman; Licensed MIT, GPL */
-
+  // Tiny Pub / Sub
+  // Copyright (c) 2011 "Cowboy" Ben Alman; Licensed MIT, GPL
   var o = $({});
   $.subscribe = function() { o.on.apply(o, arguments); };
   $.unsubscribe = function() { o.off.apply(o, arguments); };
   $.publish = function() { o.trigger.apply(o, arguments); };
 
-  /*
-    BigBird Initializer
-    -
-    Used for DOM ready execution of the application passed to it.
-  */
+  
+  // BigBird Initializer
+  // -------------------
+
+  // Some basic defaults for the initializer. Using the body
+  // and the data-module and data-action to select which module
+  // and action to load.
 
   var InitializerDefaults = {
     base: $(document.body),
@@ -36,6 +45,7 @@
   };
 
   $.extend(Initializer.prototype, {
+
     initialize: function(){
       this.base = this.options.base;
       this.module = this.base.attr(this.options.module);
@@ -89,70 +99,9 @@
 
   });
 
-  /*
-    BigBird Base
-    -
-    Controller and View inherit from this
-  */
-
-  var Base = {
-    publish : $.publish,
-    subscribe : $.subscribe,
-
-    initialize: function() {},
-
-    subscribeToEvents: function() {
-      for (var key in this.subscriptions) {
-        var methodName = this.subscriptions[key];
-        this.subscribe(key, $.proxy(this[methodName], this));
-      }
-    },
-
-    eventSplitter: /^(\S+)\s*(.*)$/,
-
-    _setOptions: function(options) {
-      this.options = options;
-
-      for (var key in this.options) {
-        this[key] = this.options[key];
-      }
-    }
-  };
-
-  /*
-    BigBird Controller
-    -
-    Rewrite of Andy Walker's (@ninjabiscuit) controller into more of a backbone / underscore style
-  */
-
-  var Controller = BigBird.Controller = function(options){
-    this._setOptions(options || {});
-
-    if (this.subscriptions) { this.subscribeToEvents(); }
-    if (this.proxied) { this.proxyFunctions(); }
-
-    this.initialize.apply(this, arguments);
-  };
-
-  $.extend(Controller.prototype, Base, {
-    stateful: function(collection, state_machine){
-      return state_machine ? state_machine.addCollection(collection) : new BigBird.StateMachine(collection);
-    },
-
-    proxyFunctions: function() {
-      var len = this.proxied.length;
-      for (len; len--;) {
-        var methodName = this.proxied[len];
-        if (typeof this[methodName] === "function") {
-          this[methodName] = $.proxy(this[methodName], this);
-        }
-      }
-    }
-  });
-
-  /*
-    BigBird Simple State Machine
-  */
+  
+  // BigBird Simple State Machine
+  // ----------------------------
 
   BigBird.StateMachine = function(collection){
     this.o = $({});
@@ -163,6 +112,7 @@
   };
 
   BigBird.StateMachine.prototype = {
+
     publish : function(){
       this.o.trigger.apply( this.o, arguments );
     },
@@ -186,27 +136,82 @@
     }
   };
 
-  /*
-    BigBird View
-    -
-  */
+  
+  // BigBird Module
+  // --------------
 
-  var View = BigBird.View = function(options){
-    this.setElement();
+  var Module = BigBird.Module = function(options) {
     this._setOptions(options || {});
 
+    if (this.el) { this.setElement(this.el); }
     if (this.subscriptions) { this.subscribeToEvents(); }
     if (this.events) { this.delegateEvents(); }
+    if (this.proxied) { this.proxyFunctions(); }
 
     this.initialize.apply(this, arguments);
   };
 
-  $.extend(View.prototype, Base, {
+  $.extend(Module.prototype, {
+
+    // Establish references to the pub /sub methods for convienience
+    publish : $.publish,
+    subscribe : $.subscribe,
+
+    $el: null,
+
+    // Initialize is an empty function by default. Override it with your own
+    // initialization logic.
+    initialize: function() {},
+
+    // Scoped jQuery dom finds to the `$el`.
+    // Allows for short hand selectors like `this.$('a')`
     $: function(selector) {
+      if (this.$el === null) { return; }
+
       return this.$el.find(selector);
     },
 
+    
+    // Takes an array of functions `['foo', 'bar']`
+    // and uses `$.proxy` to retain lexical scope for each.
+    // this means you can call these later without fear of losing scope
+    // especially useful in callbacks from events like `.bind(event, this.function)`
+    proxyFunctions: function() {
+      var len = this.proxied.length;
+      for (len; len--;) {
+        var methodName = this.proxied[len];
+        if (typeof this[methodName] === "function") {
+          this[methodName] = $.proxy(this[methodName], this);
+        }
+      }
+    },
+
+    // Set subscriptions with event and function pairs. `{ "/test": "testMethod" }`
+    // methods are bound to the Module, so should correspond
+    // to methods that you have defined.
+    subscribeToEvents: function() {
+      for (var key in this.subscriptions) {
+        var methodName = this.subscriptions[key];
+        this.subscribe(key, $.proxy(this[methodName], this));
+      }
+    },
+
+    // Set callbacks, where `this.events` is a hash of
+    //
+    // *{"event selector": "callback"}*
+    //
+    //     {
+    //       'mousedown .title':  'edit',
+    //       'click .button':     'save'
+    //       'click .open':       function(e) { ... }
+    //     }
+    //
+    // pairs. Callbacks will be bound to the view, with `this` set properly.
+    // Uses event delegation for efficiency.
+    // Omitting the selector binds the event to `this.el`.
     delegateEvents: function() {
+      if (this.$el === null) { return; }
+
       for (var key in this.events) {
         var methodName = this.events[key];
         var method     = $.proxy(this[methodName], this);
@@ -222,6 +227,8 @@
       }
     },
 
+    eventSplitter: /^(\S+)\s*(.*)$/,
+
     activate: function(){
       this.$el.addClass("active");
     },
@@ -236,9 +243,36 @@
       this.$el = this.el instanceof $ ? this.el : $(this.el);
       this.el = this.$el[0];
       this.data = this.$el.data();
+    },
+
+    destroy: function() {
+      if (this.$el === null) { return; }
+
+      for (var key in this.events) {
+        var match = key.match(this.eventSplitter);
+        var eventName = match[1], selector = match[2];
+
+        var target = (selector === '') ? this.$el : this.$el.find(selector);
+        target.unbind(eventName);
+      }
+    },
+
+    _setOptions: function(options) {
+      this.options = options;
+      for (var key in this.options) {
+        this[key] = this.options[key];
+      }
     }
   });
 
+  // Helpers
+  // -------
+
+  // Helper function to correctly set up the prototype chain, for subclasses.
+  // Similar to `goog.inherits`, but uses a hash of prototype properties and
+  // class properties to be extended.
+  // From Backbone JS: https://github.com/documentcloud/backbone/blob/master/backbone.js
+
   var extend = function(protoProps, staticProps) {
     var parent = this;
     var child;
@@ -272,13 +306,16 @@
     return child;
   };
 
-  function capitaliseFirstLetter(string)
-  {
-      return string.charAt(0).toUpperCase() + string.slice(1);
+  // Capitilises the first letter of a string
+  // Used within the Initialiser to make it case insensitive.
+  function capitaliseFirstLetter(string) {
+    return string.charAt(0).toUpperCase() + string.slice(1);
   }
 
-  View.extend = Controller.extend = extend;
+  // Setup inheritence for the Module, so we can do BigBird.Module.extend({})
+  Module.extend = extend;
 
+  // Setup BigBird as a module, if require is available
   if (typeof define !== "undefined" && typeof define === "function" && define.amd) {
     define( "bigbird", [], function () { return BigBird; } );
   }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mxm-boilerplate
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-22 00:00:00.000000000 Z
+date: 2013-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -56,8 +56,7 @@ files:
 - Readme.md
 - lib/generators/mxm/assets/assets_generator.rb
 - lib/generators/mxm/assets/templates/javascripts/application.js
-- lib/generators/mxm/assets/templates/javascripts/controllers/.empty_directory
-- lib/generators/mxm/assets/templates/javascripts/views/.empty_directory
+- lib/generators/mxm/assets/templates/javascripts/modules/.empty_directory
 - lib/generators/mxm/assets/templates/stylesheets/_helpers/.empty_directory
 - lib/generators/mxm/assets/templates/stylesheets/_variables.css.scss
 - lib/generators/mxm/assets/templates/stylesheets/application.css.scss