codelation_assets 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6549536b415b4fc11505c21b5672e6379a3ff7a
-  data.tar.gz: e82ea463c05fd0c5e333aa5ab2b01c391c751df2
+  metadata.gz: 9bf21642cb3b48b0e849b9c33cb37e8cffcd1e33
+  data.tar.gz: fbe8b036d9eae571d013962eae06223420892278
 SHA512:
-  metadata.gz: 817863835f95d6c9d6a7626d2200fb8fbe22fc6b43209d9f01abf06062ae54e35437a09a2c4bbe1d45edcb01b357b1eaeadf52c490582ee2b544ff0d2949a6b4
-  data.tar.gz: 1b7e396bb393cbe7bd5ed06ed771b42af2de12caf0edb7e6c5315d6920c108695a6407b566244577e206c94fa5d770e3b6647d3d431fdd61091bc4b42e13ea1c
+  metadata.gz: e14b15b966e8836036b0b553ec2394fb29bd6594cdeae16bf22227cec0c6439cde4b29cad294d15d959541250d94ee9dc731c3d9a10212075d8e88d5d0365a37
+  data.tar.gz: b6f53c2b0abf70257108638b81a46fa72690fe591199bab776201a83c2a5ea56f7d52c8449f8dd06ea5ad9b03f98384122d9fe72132d657a2537b676eae80746

data/README.md

@@ -1,13 +1,14 @@
 # Codelation Assets
 
-A collection of SCSS mixins and JavaScript helpers used by Codelation for building awesome Rails apps quickly.
+A collection of SCSS mixins and JavaScript helpers used by
+[Codelation](https://codelation.com) for building awesome Rails apps quickly.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem "codelation-assets"
+gem "codelation_assets"
 ```
 
 Install the Codelation Assets gem with Bundler:
@@ -18,18 +19,84 @@ bundle install
 
 ## Usage
 
-**JavaScript**
+### JavaScript
+
+Add to `application.js`:
 
 ```javascript
 //= require codelation
 ```
 
-**Sass**
+### Sass
+
+Add to `application.scss`:
 
 ```scss
 @include "codelation";
 ```
 
+#### Included Sass/CSS Libraries
+
+- [Bourbon](http://bourbon.io) - A simple and lightweight mixin library for Sass.
+- [Normalize.css](https://necolas.github.io/normalize.css/) - A modern, HTML5-ready alternative to CSS resets
+
+#### Additional Functions and Mixins
+
+A handful of useful Sass functions and mixins written by Codelation are also included.
+
+##### Sass Functions
+
+###### color($color, $number: 500)
+
+The [Google Material Design Colors](https://www.google.com/design/spec/style/color.html) come in handy when you
+need a color for creating application interfaces. They are a much better alternative to CSS's named colors
+(blue, green, red, etc.), but just as easy to use.
+
+Examples:
+
+```scss
+// The named colors are available as variables of the same name
+.warning {
+  color: $amber;
+}
+
+// You can also use the different shades available
+.error {
+  color: ($red, 700);
+}
+
+// @see https://www.google.com/design/spec/style/color.html
+.success {
+  color: ($green, 600);
+}
+```
+
+###### text-color($color)
+
+This function is useful for creating mixins where you have a background color as a variable
+and need to display either black or white text on top of the given color.
+
+##### Sass Mixins
+
+###### button($background-color: color($grey, 100), $font-color: $grey, $active-background-color: $accent-color, $active-font-color: text-color($accent-color))
+
+By default, this will create a plain grey button. It is close to the default button in some browsers, but will
+actually be rendered the same across all browsers. Useful for applications that need to be obvious about
+a button looking like a button.
+
+###### center-children
+
+This mixin uses flexbox to center the child elements horizontally and vertically inside the element.
+A good use case is centering an image of unknown height inside a container with a fixed height.
+
+###### has-cards($columns, $margin: 0)
+
+TODO: Write description/usage
+
+###### has-columns($columns, $gutter: 0)
+
+TODO: Write description/usage
+
 ## Contributing
 
 1. Fork it

data/app/assets/javascripts/codelation/app.js

@@ -2,11 +2,15 @@
   "use strict";
 
   var app = window.App;
+  var bodyClass, bodyElement;
 
   if (app === undefined) {
     app = window.App = {};
   }
 
+  app.enterFunctions = { component: [] };
+  app.exitFunctions  = { component: [] };
+
   // Register functions to run when any page or specific pages are loaded.
   //
   // Example for running code only when `pages#home` loads:
@@ -25,28 +29,63 @@
   //     // Tear down (Might be needed for Turbolinks)
   //   });
   app.register = function(mixed) {
-    if (mixed === 'component') {
-      return appComponent();
-    } else {
-      return appController(mixed);
+    return {
+      enter: function(callback) {
+        app.registerEnter(mixed, callback);
+        return this;
+      },
+
+      exit: function(callback) {
+        app.registerExit(mixed, callback);
+        return this;
+      }
+    };
+  };
+
+  app.registerEnter = function(key, callback) {
+    if (app.enterFunctions[key] === undefined) {
+      app.enterFunctions[key] = [];
     }
+    app.enterFunctions[key].push(callback);
   };
 
-  // Returns an object with `enter` and `exit` functions with for setting
-  // up and tearing down components pages specified by the controller/action.
-  function appController(controllerWithAction) {
-    var body = $('body');
-    var split = controllerWithAction.split('.');
-    var controller = split[0];
-    var action = split[1];
+  app.registerExit = function(key, callback) {
+    if (app.exitFunctions[key] === undefined) {
+      app.exitFunctions[key] = [];
+    }
+    app.exitFunctions[key].push(callback);
+  };
 
-    // enter: ready page:load
-    // exit:  page:before-unload
-  }
+  // Fires off any callbacks registered for enter, with or without Turbolinks.
+  $(document).on('ready page:load', function() {
+    bodyElement = $('body');
 
-  // Returns an object with `enter` and `exit` functions with for setting
-  // up and tearing down components on each page load/change.
-  function appComponent() {
+    // Determine which functions should be fired
+    var fireFunctions = [];
+    $.each(app.enterFunctions, function(key, functions) {
+      bodyClass = key.split('.').join(' ');
+      if (bodyClass === 'component' || bodyElement.hasClass(bodyClass)) {
+        fireFunctions = fireFunctions.concat(functions);
+      }
+    });
 
-  }
+    // Fire off each function
+    $.each(fireFunctions, function() { this.call(); });
+  });
+
+  // Fires off any callbacks registered for exit, ONLY if using Turbolinks.
+  $(document).on('page:before-unload', function() {
+    var fireFunctions = [];
+
+    // Determine which functions should be fired
+    $.each(app.exitFunctions, function(key, functions) {
+      bodyClass = key.split('.').join(' ');
+      if (bodyClass === 'component' || bodyElement.hasClass(bodyClass)) {
+        fireFunctions = fireFunctions.concat(functions);
+      }
+    });
+
+    // Fire off each function
+    $.each(fireFunctions, function() { this.call(); });
+  });
 })();

data/app/assets/stylesheets/_normalize.scss

@@ -0,0 +1,427 @@
+/*! normalize.css v3.0.2 | MIT License | git.io/normalize */
+
+/**
+ * 1. Set default font family to sans-serif.
+ * 2. Prevent iOS text size adjust after orientation change, without disabling
+ *    user zoom.
+ */
+
+html {
+  font-family: sans-serif; /* 1 */
+  -ms-text-size-adjust: 100%; /* 2 */
+  -webkit-text-size-adjust: 100%; /* 2 */
+}
+
+/**
+ * Remove default margin.
+ */
+
+body {
+  margin: 0;
+}
+
+/* HTML5 display definitions
+   ========================================================================== */
+
+/**
+ * Correct `block` display not defined for any HTML5 element in IE 8/9.
+ * Correct `block` display not defined for `details` or `summary` in IE 10/11
+ * and Firefox.
+ * Correct `block` display not defined for `main` in IE 11.
+ */
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+menu,
+nav,
+section,
+summary {
+  display: block;
+}
+
+/**
+ * 1. Correct `inline-block` display not defined in IE 8/9.
+ * 2. Normalize vertical alignment of `progress` in Chrome, Firefox, and Opera.
+ */
+
+audio,
+canvas,
+progress,
+video {
+  display: inline-block; /* 1 */
+  vertical-align: baseline; /* 2 */
+}
+
+/**
+ * Prevent modern browsers from displaying `audio` without controls.
+ * Remove excess height in iOS 5 devices.
+ */
+
+audio:not([controls]) {
+  display: none;
+  height: 0;
+}
+
+/**
+ * Address `[hidden]` styling not present in IE 8/9/10.
+ * Hide the `template` element in IE 8/9/11, Safari, and Firefox < 22.
+ */
+
+[hidden],
+template {
+  display: none;
+}
+
+/* Links
+   ========================================================================== */
+
+/**
+ * Remove the gray background color from active links in IE 10.
+ */
+
+a {
+  background-color: transparent;
+}
+
+/**
+ * Improve readability when focused and also mouse hovered in all browsers.
+ */
+
+a:active,
+a:hover {
+  outline: 0;
+}
+
+/* Text-level semantics
+   ========================================================================== */
+
+/**
+ * Address styling not present in IE 8/9/10/11, Safari, and Chrome.
+ */
+
+abbr[title] {
+  border-bottom: 1px dotted;
+}
+
+/**
+ * Address style set to `bolder` in Firefox 4+, Safari, and Chrome.
+ */
+
+b,
+strong {
+  font-weight: bold;
+}
+
+/**
+ * Address styling not present in Safari and Chrome.
+ */
+
+dfn {
+  font-style: italic;
+}
+
+/**
+ * Address variable `h1` font-size and margin within `section` and `article`
+ * contexts in Firefox 4+, Safari, and Chrome.
+ */
+
+h1 {
+  font-size: 2em;
+  margin: 0.67em 0;
+}
+
+/**
+ * Address styling not present in IE 8/9.
+ */
+
+mark {
+  background: #ff0;
+  color: #000;
+}
+
+/**
+ * Address inconsistent and variable font size in all browsers.
+ */
+
+small {
+  font-size: 80%;
+}
+
+/**
+ * Prevent `sub` and `sup` affecting `line-height` in all browsers.
+ */
+
+sub,
+sup {
+  font-size: 75%;
+  line-height: 0;
+  position: relative;
+  vertical-align: baseline;
+}
+
+sup {
+  top: -0.5em;
+}
+
+sub {
+  bottom: -0.25em;
+}
+
+/* Embedded content
+   ========================================================================== */
+
+/**
+ * Remove border when inside `a` element in IE 8/9/10.
+ */
+
+img {
+  border: 0;
+}
+
+/**
+ * Correct overflow not hidden in IE 9/10/11.
+ */
+
+svg:not(:root) {
+  overflow: hidden;
+}
+
+/* Grouping content
+   ========================================================================== */
+
+/**
+ * Address margin not present in IE 8/9 and Safari.
+ */
+
+figure {
+  margin: 1em 40px;
+}
+
+/**
+ * Address differences between Firefox and other browsers.
+ */
+
+hr {
+  -moz-box-sizing: content-box;
+  box-sizing: content-box;
+  height: 0;
+}
+
+/**
+ * Contain overflow in all browsers.
+ */
+
+pre {
+  overflow: auto;
+}
+
+/**
+ * Address odd `em`-unit font size rendering in all browsers.
+ */
+
+code,
+kbd,
+pre,
+samp {
+  font-family: monospace, monospace;
+  font-size: 1em;
+}
+
+/* Forms
+   ========================================================================== */
+
+/**
+ * Known limitation: by default, Chrome and Safari on OS X allow very limited
+ * styling of `select`, unless a `border` property is set.
+ */
+
+/**
+ * 1. Correct color not being inherited.
+ *    Known issue: affects color of disabled elements.
+ * 2. Correct font properties not being inherited.
+ * 3. Address margins set differently in Firefox 4+, Safari, and Chrome.
+ */
+
+button,
+input,
+optgroup,
+select,
+textarea {
+  color: inherit; /* 1 */
+  font: inherit; /* 2 */
+  margin: 0; /* 3 */
+}
+
+/**
+ * Address `overflow` set to `hidden` in IE 8/9/10/11.
+ */
+
+button {
+  overflow: visible;
+}
+
+/**
+ * Address inconsistent `text-transform` inheritance for `button` and `select`.
+ * All other form control elements do not inherit `text-transform` values.
+ * Correct `button` style inheritance in Firefox, IE 8/9/10/11, and Opera.
+ * Correct `select` style inheritance in Firefox.
+ */
+
+button,
+select {
+  text-transform: none;
+}
+
+/**
+ * 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
+ *    and `video` controls.
+ * 2. Correct inability to style clickable `input` types in iOS.
+ * 3. Improve usability and consistency of cursor style between image-type
+ *    `input` and others.
+ */
+
+button,
+html input[type="button"], /* 1 */
+input[type="reset"],
+input[type="submit"] {
+  -webkit-appearance: button; /* 2 */
+  cursor: pointer; /* 3 */
+}
+
+/**
+ * Re-set default cursor for disabled elements.
+ */
+
+button[disabled],
+html input[disabled] {
+  cursor: default;
+}
+
+/**
+ * Remove inner padding and border in Firefox 4+.
+ */
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+  border: 0;
+  padding: 0;
+}
+
+/**
+ * Address Firefox 4+ setting `line-height` on `input` using `!important` in
+ * the UA stylesheet.
+ */
+
+input {
+  line-height: normal;
+}
+
+/**
+ * It's recommended that you don't attempt to style these elements.
+ * Firefox's implementation doesn't respect box-sizing, padding, or width.
+ *
+ * 1. Address box sizing set to `content-box` in IE 8/9/10.
+ * 2. Remove excess padding in IE 8/9/10.
+ */
+
+input[type="checkbox"],
+input[type="radio"] {
+  box-sizing: border-box; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Fix the cursor style for Chrome's increment/decrement buttons. For certain
+ * `font-size` values of the `input`, it causes the cursor style of the
+ * decrement button to change from `default` to `text`.
+ */
+
+input[type="number"]::-webkit-inner-spin-button,
+input[type="number"]::-webkit-outer-spin-button {
+  height: auto;
+}
+
+/**
+ * 1. Address `appearance` set to `searchfield` in Safari and Chrome.
+ * 2. Address `box-sizing` set to `border-box` in Safari and Chrome
+ *    (include `-moz` to future-proof).
+ */
+
+input[type="search"] {
+  -webkit-appearance: textfield; /* 1 */
+  -moz-box-sizing: content-box;
+  -webkit-box-sizing: content-box; /* 2 */
+  box-sizing: content-box;
+}
+
+/**
+ * Remove inner padding and search cancel button in Safari and Chrome on OS X.
+ * Safari (but not Chrome) clips the cancel button when the search input has
+ * padding (and `textfield` appearance).
+ */
+
+input[type="search"]::-webkit-search-cancel-button,
+input[type="search"]::-webkit-search-decoration {
+  -webkit-appearance: none;
+}
+
+/**
+ * Define consistent border, margin, and padding.
+ */
+
+fieldset {
+  border: 1px solid #c0c0c0;
+  margin: 0 2px;
+  padding: 0.35em 0.625em 0.75em;
+}
+
+/**
+ * 1. Correct `color` not being inherited in IE 8/9/10/11.
+ * 2. Remove padding so people aren't caught out if they zero out fieldsets.
+ */
+
+legend {
+  border: 0; /* 1 */
+  padding: 0; /* 2 */
+}
+
+/**
+ * Remove default vertical scrollbar in IE 8/9/10/11.
+ */
+
+textarea {
+  overflow: auto;
+}
+
+/**
+ * Don't inherit the `font-weight` (applied by a rule above).
+ * NOTE: the default cannot safely be changed in Chrome and Safari on OS X.
+ */
+
+optgroup {
+  font-weight: bold;
+}
+
+/* Tables
+   ========================================================================== */
+
+/**
+ * Remove most spacing between table cells.
+ */
+
+table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+td,
+th {
+  padding: 0;
+}

data/app/assets/stylesheets/codelation.scss

@@ -1,5 +1,20 @@
-// A collection of mixins by Codelation
+// A collection of mixins used in Codelation Rails projects
 // https://codelation.com
 
+@import "bourbon";
 @import "codelation/functions/**/*";
 @import "codelation/mixins/**/*";
+@import "normalize";
+
+// Border Box by default for all elements
+html { // http://bit.ly/1qk2tVR
+  box-sizing: border-box;
+}
+
+* {
+  &,
+  &::after,
+  &::before {
+    box-sizing: inherit;
+  }
+}

data/app/assets/stylesheets/codelation/mixins/button.scss

@@ -1,3 +1,5 @@
+$accent-color: $blue !default;
+
 @mixin button($background-color: color($grey, 100), $font-color: $grey, $active-background-color: $accent-color, $active-font-color: text-color($accent-color)) {
   background-image: linear-gradient(to bottom, $background-color, darken($background-color, 8%));
   border: 0;

data/app/assets/stylesheets/codelation/mixins/has_cards.scss

@@ -1,6 +1,6 @@
 // Sets up a element and its child elements with the flexbox properties needed
 // to have the given number of columns with optional gutters or margins.
-$mobile-breakpoint: 768px !default;
+$mobile-breakpoint: 767px !default;
 
 @mixin has-cards($columns, $margin: 0) {
   @include align-content(flex-start);

data/app/assets/stylesheets/codelation/mixins/has_columns.scss

@@ -1,6 +1,6 @@
 // Sets up a element and its child elements with the flexbox properties needed
 // to have the given number of columns with an optional gutter value.
-$mobile-breakpoint: 768px !default;
+$mobile-breakpoint: 767px !default;
 
 @mixin has-columns($columns, $gutter: 0) {
   @include align-content(stretch);
@@ -10,8 +10,6 @@ $mobile-breakpoint: 768px !default;
   @include flex-wrap(wrap);
   @include justify-content(space-around);
   column-count: $columns; // Used as a reference for JavaScript functions
-  margin: 0;
-  padding: 0;
 
   > * {
     @include flex(1 1 auto);

data/lib/codelation_assets.rb

@@ -1,3 +1,4 @@
+require "bourbon"
 require "rails/engine"
 
 module CodelationAssets

data/lib/codelation_assets/version.rb

@@ -1,3 +1,3 @@
 module CodelationAssets
-  VERSION = "0.0.1"
+  VERSION = "0.1.0".freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: codelation_assets
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Brian Pattison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: bourbon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,7 @@ files:
 - app/assets/javascripts/codelation.js
 - app/assets/javascripts/codelation/app.js
 - app/assets/javascripts/codelation/components/columns.js
+- app/assets/stylesheets/_normalize.scss
 - app/assets/stylesheets/codelation.scss
 - app/assets/stylesheets/codelation/functions/color.scss
 - app/assets/stylesheets/codelation/functions/text-color.scss