susy 2.2.14 → 3.0.0.alpha.1

data/sass/susy/_validation.scss

@@ -0,0 +1,132 @@
+// Validation
+// ==========
+// - su-valid-columns [function]
+// - su-valid-gutters [function]
+// - su-valid-spread [function]
+// - su-valid-location [function]
+
+
+// Valid Columns
+// -------------
+/// Check that the `columns` argument is a valid
+/// list of comparable column-lengths
+///
+/// @access private
+///
+/// @param {List} $columns -
+///   List of column-lengths using comparable units
+///
+/// @return {List} -
+///   Validated `$columns` list
+@function su-valid-columns(
+  $columns
+) {
+  $first: nth($columns, 1);
+
+  @each $col in $columns {
+    @if (type-of($col) != 'number') or (not comparable($col, $first)) {
+      $actual: '[#{type-of($columns)}] `#{inspect($columns)}`';
+      @error '#{$actual} is not a value for $columns.';
+    }
+  }
+
+  @return $columns;
+}
+
+
+// Valid Gutters
+// -------------
+/// Check that the `gutters` argument is a valid number
+///
+/// @access private
+///
+/// @param {Number} $gutters -
+///   Width of a gutter
+/// @param {List} $columns -
+///   Valid list of column-lengths using comparable units
+///
+/// @return {Number} -
+///   Validated `$gutters` number
+@function su-valid-gutters(
+  $gutters,
+  $columns
+) {
+  $type: type-of($gutters);
+
+  @if ($type == 'number') {
+    @if unitless($gutters) and (not unitless(nth($columns, 1))) {
+      @error 'Gutters must have units for a static grid.';
+    }
+
+    @return $gutters;
+  }
+
+  $actual: '[#{$type}] `#{inspect($gutters)}`';
+  @error '#{$actual} is not a value for $gutters.';
+}
+
+
+// Valid Spread
+// ------------
+/// Check that the `spread` argument is a valid
+/// intiger between `-1` and `1`
+///
+/// @access private
+///
+/// @param {0 | 1 | -1} $spread -
+///   Number of gutters to include in a span,
+///   relative to the number columns
+///
+/// @return {0 | 1 | -1} -
+///   Validated `$spread` number
+@function su-valid-spread(
+  $spread
+) {
+  @if index(0 1 -1, $spread) {
+    @return $spread;
+  }
+
+  $actual: '[#{type-of($spread)}] `#{inspect($spread)}`';
+  @error '#{$actual} is not a value for $spread.';
+}
+
+
+// Valid Location
+// --------------
+/// Check that the `location` argument is a valid number,
+/// within the scope of available columns
+///
+/// @access private
+///
+/// @param {Number} $span -
+///   Number of grid-columns to be spanned
+/// @param {Integer | String} $location -
+///   Starting (1-indexed) column-position of that span
+/// @param {List} $columns -
+///   List of available columns in the grid
+///
+/// @return {Integer} -
+///   Validated `$location` intiger
+@function su-valid-location(
+  $span,
+  $location,
+  $columns
+) {
+  $count: length($columns);
+
+  @if $location {
+    @if (type-of($location) != 'number') or (not unitless($location)) {
+      $actual: '[#{type-of($location)}] `#{$location}`';
+      @error '#{$actual} is not a value for $location.';
+    } @else if (round($location) != $location) {
+      @error 'Location (`#{$location}`) must be a 1-indexed intiger position.';
+    } @else if ($location > $count) {
+      @error 'Position `#{$location}` does not exist in grid `#{$columns}`.';
+    } @else if ($location + $span - 1 > $count) {
+      $details: 'grid `#{$columns}` for span `#{$span}` at `#{$location}`';
+      @error 'There are not enough columns in #{$details}';
+    }
+  }
+
+  @return $location;
+}

metadata

@@ -1,33 +1,33 @@
 --- !ruby/object:Gem::Specification
 name: susy
 version: !ruby/object:Gem::Version
-  version: 2.2.14
+  version: 3.0.0.alpha.1
 platform: ruby
 authors:
 - Miriam Eric Suzanne
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-01 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.3.0
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.3.0
-    - - "<"
+    - - <
       - !ruby/object:Gem::Version
         version: '3.5'
 description: Susy is a toolkit for building layouts of all types with a simple, natural
@@ -37,101 +37,52 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- docs/changelog.rst
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/susy.rb
 files:
-- LICENSE.txt
-- README.md
-- VERSION
-- docs/changelog.rst
 - lib/compass-susy.rb
 - lib/susy.rb
-- sass/_su.scss
+- sass/_prefix.scss
 - sass/_susy.scss
-- sass/_susyone.scss
-- sass/susy/_su.scss
-- sass/susy/language/_susy.scss
-- sass/susy/language/_susyone.scss
-- sass/susy/language/susy/_background.scss
-- sass/susy/language/susy/_bleed.scss
-- sass/susy/language/susy/_box-sizing.scss
-- sass/susy/language/susy/_breakpoint-plugin.scss
-- sass/susy/language/susy/_container.scss
-- sass/susy/language/susy/_context.scss
-- sass/susy/language/susy/_gallery.scss
-- sass/susy/language/susy/_grids.scss
-- sass/susy/language/susy/_gutters.scss
-- sass/susy/language/susy/_isolate.scss
-- sass/susy/language/susy/_margins.scss
-- sass/susy/language/susy/_padding.scss
-- sass/susy/language/susy/_rows.scss
-- sass/susy/language/susy/_settings.scss
-- sass/susy/language/susy/_span.scss
-- sass/susy/language/susy/_validation.scss
-- sass/susy/language/susyone/_background.scss
-- sass/susy/language/susyone/_functions.scss
-- sass/susy/language/susyone/_grid.scss
-- sass/susy/language/susyone/_isolation.scss
-- sass/susy/language/susyone/_margin.scss
-- sass/susy/language/susyone/_media.scss
-- sass/susy/language/susyone/_padding.scss
-- sass/susy/language/susyone/_settings.scss
-- sass/susy/output/_float.scss
-- sass/susy/output/_shared.scss
-- sass/susy/output/_support.scss
-- sass/susy/output/float/_container.scss
-- sass/susy/output/float/_end.scss
-- sass/susy/output/float/_isolate.scss
-- sass/susy/output/float/_span.scss
-- sass/susy/output/shared/_background.scss
-- sass/susy/output/shared/_container.scss
-- sass/susy/output/shared/_direction.scss
-- sass/susy/output/shared/_inspect.scss
-- sass/susy/output/shared/_margins.scss
-- sass/susy/output/shared/_output.scss
-- sass/susy/output/shared/_padding.scss
-- sass/susy/output/support/_background.scss
-- sass/susy/output/support/_box-sizing.scss
-- sass/susy/output/support/_clearfix.scss
-- sass/susy/output/support/_prefix.scss
-- sass/susy/output/support/_rem.scss
-- sass/susy/output/support/_support.scss
-- sass/susy/su/_grid.scss
-- sass/susy/su/_settings.scss
-- sass/susy/su/_utilities.scss
-- sass/susy/su/_validation.scss
-- templates/project/_grids.scss
-- templates/project/manifest.rb
-- templates/project/style.scss
+- sass/susy/_api.scss
+- sass/susy/_grids.scss
+- sass/susy/_parser.scss
+- sass/susy/_settings.scss
+- sass/susy/_unprefix.scss
+- sass/susy/_validation.scss
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- VERSION
 homepage: http://susy.oddbird.net/
 licenses:
 - BSD-3-Clause
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--line-numbers"
-- "--inline-source"
-- "--title"
+- --line-numbers
+- --inline-source
+- --title
 - Susy
-- "--main"
+- --main
 - README.md
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '1.2'
+      version: 1.3.1
 requirements: []
 rubyforge_project: susy
-rubygems_version: 2.6.12
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 3
 summary: Responsive layout toolkit for Sass.

data/sass/_su.scss

@@ -1,4 +0,0 @@
-// Su
-// ==
-
-@import 'susy/su';

data/sass/_susyone.scss

@@ -1,4 +0,0 @@
-// Susy
-// ====
-
-@import 'susy/language/susyone';

data/sass/susy/_su.scss

@@ -1,7 +0,0 @@
-// Su
-// ==
-
-@import "su/utilities";
-@import "su/settings";
-@import "su/validation";
-@import "su/grid";

data/sass/susy/language/_susy.scss

@@ -1,24 +0,0 @@
-// Susy Next Syntax
-// ================
-
-$susy-version: 2.1;
-
-@import "../su";
-@import "../output/float";
-
-@import "susy/settings";
-@import "susy/validation";
-@import "susy/grids";
-@import "susy/box-sizing";
-@import "susy/context";
-@import "susy/background";
-@import "susy/container";
-@import "susy/span";
-@import "susy/gutters";
-@import "susy/isolate";
-@import "susy/gallery";
-@import "susy/rows";
-@import "susy/margins";
-@import "susy/padding";
-@import "susy/bleed";
-@import "susy/breakpoint-plugin";

data/sass/susy/language/_susyone.scss

@@ -1,13 +0,0 @@
-// ---------------------------------------------------------------------------
-// Partials
-
-$susy-version: 1.5;
-
-@import "susyone/settings";
-@import "susyone/functions";
-@import "susyone/grid";
-@import "susyone/isolation";
-@import "susyone/padding";
-@import "susyone/margin";
-@import "susyone/media";
-@import "susyone/background";

data/sass/susy/language/susy/_background.scss

@@ -1,385 +0,0 @@
-// Background Grid Syntax
-// ======================
-
-$susy-overlay-grid-head-exists: false;
-
-
-// Show Grid/s
-// -----------
-// Show grid on any element using either background or overlay.
-// - [$grid]  : <settings>
-@mixin show-grid(
-  $grid: $susy
-) {
-  $inspect: $grid;
-  $_output: debug-get(output, $grid);
-
-  @include susy-inspect(show-grid, $inspect);
-  @if $_output == overlay and susy-get(debug image, $grid) != hide {
-    @include overlay-grid($grid);
-  } @else {
-    @include background-grid($grid);
-  }
-}
-
-@mixin show-grids(
-  $grid: $susy
-) {
-  @include show-grid($grid);
-}
-
-// Background Grid
-// ---------------
-// Show a grid background on any element.
-// - [$grid]  : <settings>
-@mixin background-grid(
-  $grid: $susy
-) {
-  $inspect  : $grid;
-  $_output  : get-background($grid);
-
-  @if length($_output) > 0 {
-    $_flow: susy-get(flow, $grid);
-
-    $_image: ();
-    @each $name, $layer in map-get($_output, image) {
-      $_direction: if($name == baseline, to bottom, to to($_flow));
-      $_image: append($_image, linear-gradient($_direction, $layer), comma);
-    }
-    $_output: map-merge($_output, (image: $_image));
-
-    @include background-grid-output($_output...);
-    @include susy-inspect(background-grid, $inspect);
-  }
-}
-
-
-// Overlay Grid
-// ------------
-// Generate an icon to trigger grid-overlays on any given elements.
-// $grids...  : <selector> [<settings>] [, <selector>]*
-@mixin overlay-grid (
-  $grid: $susy
-) {
-  @if not($susy-overlay-grid-head-exists) {
-    @at-root head { @include overlay-head($grid); }
-    @at-root head:before { @include overlay-trigger; }
-    @at-root head:hover { @include overlay-trigger-hover; }
-    $susy-overlay-grid-head-exists: true !global;
-  }
-
-  head:hover ~ &,
-  head:hover ~ body & {
-    position: relative;
-    &:before {
-      @include grid-overlay-base;
-      @include background-grid($grid);
-    }
-  }
-}
-
-
-// [Private] Overlay Trigger
-// -------------------------
-@mixin overlay-trigger {
-  content: "|||";
-  display: block;
-  padding: 5px 10px;
-  font: {
-    family: sans-serif;
-    size: 16px;
-    weight: bold;
-  }
-}
-
-
-// [Private] Overlay Trigger Hover
-// -------------------------------
-@mixin overlay-trigger-hover {
-  background: rgba(white, .5);
-  color: red;
-}
-
-
-// [Private] Overlay Head
-// ----------------------
-// <head> styles to create grid overlay toggle
-@mixin overlay-head (
-  $grid: $susy
-) {
-  $_toggle: debug-get(toggle, $grid);
-  $_horz: null;
-  $_vert: null;
-
-  @each $side in $_toggle {
-    $_horz: if($side == left or $side == right, $side, $_horz);
-    $_vert: if($side == top or $side == bottom, $side, $_vert);
-  }
-
-  display: block;
-  position: fixed;
-  #{$_horz}: 10px;
-  #{$_vert}: 10px;
-  z-index: 999;
-  color: #333;
-  background: rgba(white, .25);
-}
-
-
-// [Private] Grid Overlay Base
-// ---------------------------
-// Base styles for generating a grid overlay
-@mixin grid-overlay-base() {
-  position: absolute;
-  top: 0;
-  left: 0;
-  bottom: 0;
-  right: 0;
-  content: " ";
-  z-index: 998;
-}
-
-
-// Get Symmetrical Background
-// --------------------------
-// - $grid: <map>
-@function get-background-sym(
-  $grid
-) {
-  $grid           : parse-grid($grid);
-  $_gutters       : susy-get(gutters, $grid);
-  $_column-width  : susy-get(column-width, $grid);
-  $_math          : susy-get(math, $grid);
-
-  $_color         : debug-get(color);
-  $_trans         : transparent;
-  $_light         : lighten($_color, 15%);
-
-  $_end           : 1 + $_gutters;
-  $_after         : percentage(1/$_end);
-  $_stops         : ();
-  $_size          : span(1 $grid wide);
-
-  @if is-inside($grid) {
-    $_stops: $_color, $_light;
-  } @else if is-split($grid) {
-    $_split: $_gutters/2;
-    $_before: percentage($_split/$_end);
-    $_after: percentage((1 + $_split)/$_end);
-    $_stops: $_trans $_before, $_color $_before, $_light $_after, $_trans $_after;
-  } @else {
-    $_stops: $_color, $_light $_after, $_trans $_after;
-  }
-
-  @if $_math == static {
-    $_size: valid-column-math($_math, $_column-width) * $_end;
-  }
-
-  $_output: (
-    image: (columns: $_stops),
-    size: $_size,
-  );
-
-  @return $_output;
-}
-
-
-// Get Asymmetrical Inside
-// -----------------------
-// - $grid: <settings>
-@function get-asym-inside(
-  $grid
-) {
-  $grid     : parse-grid($grid);
-  $_columns : susy-get(columns, $grid);
-
-  $_color   : debug-get(color);
-  $_light   : lighten($_color, 15%);
-  $_stops   : ();
-
-  @for $location from 1 through susy-count($_columns) {
-    $this-stop: ();
-
-    @if $location == 1 {
-      $this-stop: append($this-stop, $_color, comma);
-    } @else {
-      $start: parse-span(1 at $location $grid);
-      $start: get-isolation($start);
-      $this-stop: append($this-stop, $_color $start, comma);
-    }
-
-    @if $location == susy-count($_columns) {
-      $this-stop: append($this-stop, $_light, comma);
-    } @else {
-      $_end: parse-span(1 at ($location + 1) $grid);
-      $_end: get-isolation($_end);
-      $this-stop: append($this-stop, $_light $_end, comma);
-    }
-
-    $_stops: join($_stops, $this-stop, comma);
-  }
-
-  @return $_stops;
-}
-
-
-// Get Asymmetrical Split
-// ----------------------
-// - $grid: <settings>
-@function get-asym-split(
-  $grid
-) {
-  $grid     : parse-grid($grid);
-  $_columns : susy-get(columns, $grid);
-
-  $_color   : debug-get(color);
-  $_light   : lighten($_color, 15%);
-  $_stops   : ();
-
-  @for $location from 1 through susy-count($_columns) {
-    $this-stop: ();
-
-    $start: parse-span(1 at $location $grid);
-    $start: get-isolation($start);
-    $this-stop: append($this-stop, transparent $start, comma);
-    $this-stop: append($this-stop, $_color $start, comma);
-
-    $_end: $start + span(1 at $location $grid);
-    $this-stop: append($this-stop, $_light $_end, comma);
-    $this-stop: append($this-stop, transparent $_end, comma);
-
-    $_stops: join($_stops, $this-stop, comma);
-  }
-
-  @return $_stops;
-}
-
-
-// Get Asymmetrical Outside
-// ------------------------
-// - $grid: <settings>
-@function get-asym-outside(
-  $grid
-) {
-  $grid     : parse-grid($grid);
-  $_columns : susy-get(columns, $grid);
-
-  $_color   : debug-get(color);
-  $_light   : lighten($_color, 15%);
-  $_trans   : transparent;
-  $_stops   : ();
-
-  @for $location from 1 through susy-count($_columns) {
-    $this-stop: ();
-
-    @if $location == 1 {
-      $this-stop: append($this-stop, $_color, comma);
-    } @else {
-      $start: parse-span(1 at $location $grid);
-      $start: get-isolation($start);
-      $this-stop: append($this-stop, $_color $start, comma);
-    }
-
-    @if $location == susy-count($_columns) {
-      $this-stop: append($this-stop, $_light, comma);
-    } @else {
-      $gutter: get-span-width(first $location $grid);
-
-      $_end: parse-span(1 at ($location + 1) $grid);
-      $_end: get-isolation($_end);
-
-      $gutter: $_light $gutter, $_trans $gutter, $_trans $_end;
-      $this-stop: join($this-stop, $gutter, comma);
-    }
-
-    $_stops: join($_stops, $this-stop, comma);
-  }
-
-  @return $_stops;
-}
-
-
-// Get Asymmetrical Background
-// ---------------------------
-// - $grid: <settings>
-@function get-background-asym(
-  $grid
-) {
-  $_stops: ();
-
-  @if is-inside($grid) {
-    $_stops: get-asym-inside($grid);
-  } @else if is-split($grid) {
-    $_stops: get-asym-split($grid);
-  } @else {
-    $_stops: get-asym-outside($grid);
-  }
-
-  @return (image: (columns: $_stops));
-}
-
-
-// Get Background
-// --------------
-// - $grid: <settings>
-@function get-background(
-  $grid
-) {
-  $grid     : parse-grid($grid);
-  $_show    : susy-get(debug image, $grid);
-  $_return  : ();
-
-  @if $_show and $_show != 'hide' {
-    $_columns: susy-get(columns, $grid);
-
-    @if $_show != 'show-baseline' {
-      $_sym: is-symmetrical($_columns);
-      $_return: if($_sym, get-background-sym($grid), get-background-asym($grid));
-      $_return: map-merge($_return, (clip: content-box));
-    }
-
-    @if $_show != 'show-columns'
-      and global-variable-exists(base-line-height)
-      and type-of($base-line-height) == 'number'
-      and not unitless($base-line-height) {
-      $_color: variable-exists('grid-background-baseline-color');
-      $_color: if($_color, $grid-background-baseline-color, #000);
-
-      $_image: map-get($_return, image);
-      $_size: map-get($_return, size);
-      $_baseline: (baseline: ($_color 1px, transparent 1px));
-      $_baseline-size: 100% $base-line-height;
-
-      $_return: map-merge($_return, (
-        image: if($_image, map-merge($_image, $_baseline), $_baseline),
-        size: if($_size, ($_size, $_baseline-size), $_baseline-size),
-      ));
-
-      @if $_show == 'show' {
-        $_clip: map-get($_return, clip);
-        $_return: map-merge($_return, (clip: join($_clip, border-box, comma)));
-      }
-    } @else if $_show == 'show-baseline' {
-      @warn 'Please provide a $base-line-height with the desired height and units';
-    }
-  }
-
-  @if map-get($_return, image) {
-    $_return: map-merge($_return, (flow: susy-get(flow, $grid)));
-  }
-
-  @return $_return;
-}
-
-
-// Get Debug
-// ---------
-// Return the value of a debug setting
-// - $key: <setting>
-@function debug-get(
-  $key,
-  $grid: $susy
-) {
-  $key: join(debug, $key, space);
-  @return susy-get($key, $grid);
-}