neat 1.7.0.pre → 1.7.0.rc

data/app/assets/stylesheets/grid/_to-deprecate.scss

@@ -56,16 +56,52 @@
   @include omega($nth $display, $direction);
 }
 
+/**
+ * Resets the active display property to `block`. Particularly useful when changing the display property in a single row.
+ *
+ * @example scss - Usage
+ *   .element {
+ *     @include row(table);
+ *     // Context changed to table display
+ *   }
+ *
+ *   @include reset-display;
+ *   // Context is reset to block display
+ */
 @mixin reset-display {
   $container-display-table: false !global;
   @include -neat-warn("Resetting $display will be deprecated in future versions in favor of the display(){...} mixin.");
 }
 
+/**
+ * Resets the active layout direction to the default value set in `$default-layout-direction`. Particularly useful when changing the layout direction in a single row.
+ *
+ * @example scss - Usage
+ *   .element {
+ *     @include row($direction: RTL);
+ *     // Context changed to right-to-left
+ *   }
+ *
+ *   @include reset-layout-direction;
+ *   // Context is reset to left-to-right
+ */
 @mixin reset-layout-direction {
   $layout-direction: $default-layout-direction !global;
   @include -neat-warn("Resetting $direction will be deprecated in future versions in favor of the direction(){...} mixin.");
 }
 
+/**
+ * Resets both the active layout direction and the active display property.
+ *
+ * @example scss - Usage
+ *   .element {
+ *     @include row(table, RTL);
+ *     // Context changed to table table and right-to-left
+ *   }
+ *
+ *   @include reset-all;
+ *   // Context is reset to block display and left-to-right
+ */
 @mixin reset-all {
   @include reset-display;
   @include reset-layout-direction;

data/app/assets/stylesheets/grid/_visual-grid.scss

@@ -30,7 +30,7 @@
     }
 
     @each $breakpoint in $visual-grid-breakpoints {
-      @if $breakpoint != nil {
+      @if $breakpoint {
         @include media($breakpoint) {
           @include grid-column-gradient(gradient-stops($grid-columns));
         }

data/app/assets/stylesheets/settings/_disable-warnings.scss

@@ -3,7 +3,6 @@
  *
  * @type Bool
  */
-
 $disable-warnings: false !default;
 
 @mixin -neat-warn($message) {

data/app/assets/stylesheets/settings/_grid.scss

@@ -1,7 +1,55 @@
-$column: golden-ratio(1em, 3) !default; // Column width
-$gutter: golden-ratio(1em, 1) !default; // Gutter between each two columns
-$grid-columns: 12 !default; // Total number of columns in the grid
-$max-width: em(1088) !default; // Max-width of the outer container
-$border-box-sizing: true !default; // Makes all elements have a border-box layout
+/**
+ * Sets the relative width of a single grid column. The unit used should be the same one used to define `$gutter`. To learn more about golden-ratio() see [Bourbon docs](http://bourbon.io/docs/#golden-ratio). Set with a `!global` flag.
+ *
+ * @type Number (Unit)
+ */
+$column: golden-ratio(1em, 3) !default;
+
+/**
+ * Sets the relative width of a single grid gutter. The unit used should be the same one used to define `$column`. To learn more about golden-ratio() see [Bourbon docs](http://bourbon.io/docs/#golden-ratio). Set with the `!global` flag.
+ *
+ * @type Number (Unit)
+ */
+$gutter: golden-ratio(1em, 1) !default;
+
+/**
+ * Sets the total number of columns in the grid. Its value can be overridden inside a media query using the `media()` mixin. Set with the `!global` flag.
+ *
+ * @type Number (Unitless)
+ */
+$grid-columns: 12 !default;
+
+/**
+ * Sets the max-width property of the element that includes `outer-container()`. To learn more about `em()` see [Bourbon docs](http://bourbon.io/docs/#px-to-em). Set with the `!global` flag.
+ *
+ * @type Number (Unit)
+ */
+$max-width: em(1088) !default;
+
+/**
+ * When set to true, it sets the box-sizing property of all elements to `border-box`. Set with a `!global` flag.
+ *
+ * @type Bool
+ *
+ * @example css - CSS Output
+ *   * {
+ *     -webkit-box-sizing: border-box;
+ *     -moz-box-sizing: border-box;
+ *     box-sizing: border-box;
+ *   }
+ */
+$border-box-sizing: true !default;
+
+/**
+ * Sets the default [media feature](http://www.w3.org/TR/css3-mediaqueries/#media) that `media()` and `new-breakpoint()` revert to when only a breakpoint value is passed. Set with a `!global` flag.
+ *
+ * @type String
+ */
 $default-feature: min-width; // Default @media feature for the breakpoint() mixin
+
+/**
+ * Sets the default layout direction of the grid. Can be `LTR` or `RTL`. Set with a `!global` flag.
+ *
+ * @type String
+ */
 $default-layout-direction: LTR !default;

data/app/assets/stylesheets/settings/_visual-grid.scss

@@ -1,5 +1,29 @@
-$visual-grid: false !default; // Display the base grid
+/**
+ * Displays the visual grid when set to true. The overlaid grid may be few pixels off depending on the browser's rendering engine and pixel rounding algorithm. Set with the `!global` flag.
+ *
+ * @type Bool
+ */
+$visual-grid: false !default;
+
+/**
+ * Sets the visual grid color. Set with `!global` flag.
+ *
+ * @type Color
+ */
 $visual-grid-color: #EEE !default;
-$visual-grid-index: back !default; // Show grid behind content (back) or overlay it over the content (front)
+
+/**
+ * Sets the `z-index` property of the visual grid. Can be `back` (behind content) or `front` (in front of content). Set with `!global` flag.
+ *
+ * @type String
+ */
+$visual-grid-index: back !default;
+
+/**
+ * Sets the opacity property of the visual grid. Set with `!global` flag.
+ *
+ * @type Number (unitless)
+ */
 $visual-grid-opacity: 0.4 !default;
+
 $visual-grid-breakpoints: () !default;

data/bower.json

@@ -12,7 +12,9 @@
     "Rakefile",
     "neat.gemspec",
     "CONTRIBUTING.md",
-    "NEWS.md"
+    "NEWS.md",
+    "test",
+    "spec"
   ],
   "dependencies": {
     "bourbon": ">=4.0"

data/lib/neat/version.rb

@@ -1,3 +1,3 @@
 module Neat
-  VERSION = '1.7.0.pre'
+  VERSION = '1.7.0.rc'
 end

data/sache.json

@@ -0,0 +1,5 @@
+{
+  "name": "Neat",
+  "description": "A lightweight, semantic grid framework built on top of Bourbon",
+  "tags": ["neat", "grid", "layout", "columns", "semantic", "media-queries", "media", "queries", "bourbon"]
+}

data/spec/neat/direction_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe "@include direction() {...}" do
+describe "@include direction-context() {...}" do
   before(:all) do
-    ParserSupport.parse_file("direction")
+    ParserSupport.parse_file("direction-context")
   end
 
   context "with no argument" do

data/spec/neat/display_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe "@include display() {...}" do
+describe "@include display-context() {...}" do
   before(:all) do
-    ParserSupport.parse_file("display")
+    ParserSupport.parse_file("display-context")
   end
 
   context "with argument (table)" do

data/test/{direction.scss → direction-context.scss}

@@ -1,12 +1,12 @@
 @import 'setup';
 
-@include direction() {
+@include direction-context() {
   .default-block {
     @include span-columns(6);
   }
 }
 
-@include direction(right-to-left) {
+@include direction-context(right-to-left) {
   .right-to-left-block {
     @include span-columns(6);
   }

data/test/{display.scss → display-context.scss}

@@ -1,13 +1,13 @@
 @import 'setup';
 
-@include display(table) {
+@include display-context(table) {
   .display-table-block {
     @include span-columns(6);
   }
 }
 
-@include display(table) {
-  @include display(block) {
+@include display-context(table) {
+  @include display-context(block) {
     .display-nested-block {
       @include span-columns(6);
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: neat
 version: !ruby/object:Gem::Version
-  version: 1.7.0.pre
+  version: 1.7.0.rc
 platform: ruby
 authors:
 - Kyle Fiedler
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -161,8 +161,8 @@ files:
 - app/assets/stylesheets/functions/_new-breakpoint.scss
 - app/assets/stylesheets/functions/_private.scss
 - app/assets/stylesheets/grid/_box-sizing.scss
-- app/assets/stylesheets/grid/_direction.scss
-- app/assets/stylesheets/grid/_display.scss
+- app/assets/stylesheets/grid/_direction-context.scss
+- app/assets/stylesheets/grid/_display-context.scss
 - app/assets/stylesheets/grid/_fill-parent.scss
 - app/assets/stylesheets/grid/_media.scss
 - app/assets/stylesheets/grid/_omega.scss
@@ -185,6 +185,7 @@ files:
 - lib/neat/version.rb
 - lib/tasks/install.rake
 - neat.gemspec
+- sache.json
 - spec/neat/columns_spec.rb
 - spec/neat/container_spec.rb
 - spec/neat/default_spec.rb
@@ -205,8 +206,8 @@ files:
 - spec/support/sass_support.rb
 - test/_setup.scss
 - test/default.scss
-- test/direction.scss
-- test/display.scss
+- test/direction-context.scss
+- test/display-context.scss
 - test/media.scss
 - test/new-breakpoint.scss
 - test/omega.scss
@@ -260,8 +261,8 @@ test_files:
 - spec/support/sass_support.rb
 - test/_setup.scss
 - test/default.scss
-- test/direction.scss
-- test/display.scss
+- test/direction-context.scss
+- test/display-context.scss
 - test/media.scss
 - test/new-breakpoint.scss
 - test/omega.scss