susy 2.0.0.alpha.6 → 2.0.0.beta.1

data/sass/susy/math/_columns.scss

@@ -6,8 +6,9 @@
 // Returns true if a grid is symmetrical.
 // - [$columns]   : <number> | <list>
 @function is-symmetrical(
-  $columns: susy-get(columns)
+  $columns: map-get($susy-defaults, columns)
 ) {
+  $columns: valid-columns($columns);
   @return if(type-of($columns) == number, $columns, null);
 }
 
@@ -16,8 +17,9 @@
 // Find the number of columns in a given layout
 // - [$columns]   : <number> | <list>
 @function column-count(
-  $columns: susy-get(columns)
+  $columns: map-get($susy-defaults, columns)
 ) {
+  $columns: valid-columns($columns);
   @return is-symmetrical($columns) or length($columns);
 }
 
@@ -26,12 +28,15 @@
 // Find the total sum of column-units in a layout
 // - [$columns]   : <number> | <list>
 // - [$gutters]   : <ratio>
-// - [$spread]     : <boolean>
+// - [$spread]    : false/narrow | wide | wider
 @function column-sum(
-  $columns  : susy-get(columns),
-  $gutters  : susy-get(gutters),
+  $columns  : map-get($susy-defaults, columns),
+  $gutters  : map-get($susy-defaults, gutters),
   $spread   : false
 ) {
+  $columns: valid-columns($columns);
+  $gutters: valid-gutters($gutters);
+
   $spread: if($spread == wide, 0, if($spread == wider, 1, -1));
   $gutter-sum: (column-count($columns) + $spread) * $gutters;
   $column-sum: is-symmetrical($columns);
@@ -49,18 +54,19 @@
 // -----------
 // Return a subset of columns at a given location.
 // - $span        : <number>
-// - $location    : first | last | <number>
+// - $location    : <number>
 // - [$columns]   : <number> | <list>
 @function get-columns(
   $span,
   $location,
-  $columns: susy-get(columns)
+  $columns: map-get($susy-defaults, columns)
 ) {
+  $columns: valid-columns($columns);
   $sub-columns: $span;
 
   @if not is-symmetrical($columns) {
-    $sub-columns  : ();
-    $location     : get-location($span, $location, $columns) or 1;
+    $location: $location or 1;
+    $sub-columns: ();
     @for $i from $location to ($location + $span) {
       $sub-columns: append($sub-columns, nth($columns, $i));
     }
@@ -76,17 +82,17 @@
 // - $location    : first | last | <number>
 // - [$columns]   : <number> | <list>
 // - [$gutters]   : <ratio>
-// - [$spread]     : <boolean>
+// - [$spread]    : <boolean>
 @function get-column-span-sum(
   $span,
   $location     : false,
-  $columns      : susy-get(columns),
-  $gutters      : susy-get(gutters),
+  $columns      : map-get($susy-defaults, columns),
+  $gutters      : map-get($susy-defaults, gutters),
   $spread       : false
 ) {
-  @if not is-symmetrical($columns) {
-    $span: get-columns($span, $location, $columns);
-  }
+  $columns: valid-columns($columns);
+  $gutters: valid-gutters($gutters);
+  $span: get-columns($span, $location, $columns);
 
   @return column-sum($span, $gutters, $spread);
 }

data/sass/susy/math/_container.scss

@@ -1,23 +1,6 @@
 // Container math
 // ==============
 
-// Parse Container Position
-// ------------------------
-// Parse the $container-position into margin values.
-// - [$justify]   : left | center | right | <length> [<length>]
-@function parse-container-position(
-  $justify: susy-get(container-position)
-) {
-  $return: if($justify == left, 0, auto) if($justify == right, 0, auto);
-
-  @if not index(left right center, $justify) {
-    $return: nth($justify, 1);
-    $return: $return if(length($justify) > 1, nth($justify, 2), $return);
-  }
-
-  @return $return;
-}
-
 // Calculate Container Width
 // -------------------------
 // Calculate the width of a container based on columns and gutters.
@@ -26,10 +9,12 @@
 // - [$column-width]  : <length>
 // - [$spread]        : <boolean>
 @function calculate-container-width(
-  $columns        : susy-get(columns),
-  $gutters        : susy-get(gutters),
-  $column-width   : susy-get(column-width),
+  $columns        : map-get($susy-defaults, columns),
+  $gutters        : map-get($susy-defaults, gutters),
+  $column-width   : map-get($susy-defaults, column-width),
   $spread         : false
 ) {
-  @return column-sum($columns, $gutters, $spread) * $column-width;
+  $sum: column-sum($columns, $gutters, $spread);
+  $column-width: valid-column-width($column-width);
+  @return $sum * $column-width;
 }

data/sass/susy/math/_settings.scss

@@ -0,0 +1,24 @@
+// Settings
+// ========
+
+// Version
+// -------
+$susy-version: 2.0;
+
+// Default Settings
+// ----------------
+// PRIVATE: The basic settings
+$susy-defaults: (
+  columns: 4,
+  gutters: .25,
+  column-width: false,
+);
+
+// Susy Defaults
+// -------------
+// PRIVATE: Add defaults to Susy
+@mixin susy-defaults(
+  $defaults
+) {
+  $susy-defaults: map-merge($susy-defaults, $defaults) !global;
+}

data/sass/susy/math/_validation.scss

@@ -0,0 +1,62 @@
+// Math Validation
+// ===============
+
+// Valid Columns
+// -------------
+// Check that a column setting is valid.
+@function valid-columns(
+  $columns
+) {
+  $type: type-of($columns);
+  $return: null;
+
+  @if $type == number and unitless($columns) {
+    $return: $columns;
+  } @else if $type == list {
+    $fail: false;
+    @each $col in $columns {
+      $number: if(type-of($col == number), true, null);
+      $fail: $fail or if($number and unitless($col), null, true);
+    }
+    $return: if($fail, $return, $columns);
+  }
+
+  @if $return != $columns {
+    $warn: '$columns must be a unitless number or list of unitless numbers.';
+    @warn $warn + ' Current value [#{$type}]: #{$columns}';
+  } @else {
+    @return $return;
+  }
+}
+
+// Valid Gutters
+// -------------
+// Check that a gutter setting is valid.
+@function valid-gutters(
+  $gutters
+) {
+  $type: type-of($gutters);
+
+  @if $type == number and unitless($gutters) {
+    @return $gutters;
+  } @else {
+    $warn: '$gutters must be a unitless number.';
+    @warn $warn + ' Current value [#{$type}]: #{$gutters}';
+  }
+}
+
+// Valid Column-Width
+// ------------------
+// Check that a column-width setting is valid.
+@function valid-column-width(
+  $column-width
+) {
+  $type: type-of($column-width);
+
+  @if ($type == number and unit($column-width)) or not $column-width {
+    @return $column-width;
+  } @else {
+    $warn: '$column-width must be a length (number with units), or false.';
+    @warn $warn + ' Current value [#{$type}]: #{$column-width}';
+  }
+}

data/templates/project/_base.scss

@@ -1,4 +1,4 @@
-// -------
-// Imports
+// Requirements
+// ============
 
 @import "susy";

data/templates/project/manifest.rb

@@ -1,19 +1,16 @@
 stylesheet 'screen.scss', :media => "screen, projection"
 stylesheet '_base.scss'
 
-description "Susy: a flexible static/fluid/elastic grid system native to compass."
+description "Susy: custom Sass layouts. Your markup, your design, our math."
 
 help %Q{
-Please see the Susy website for all documentation and tutorials:
+Full documentation and tutorials available online:
 
-    http://www.oddbird.net/susy
+    http://susy.oddbird.net/
 }
 
 welcome_message %Q{
-Please see the Susy website for all documentation and tutorials:
+Welcome to Susy! Check out the full documentation online:
 
-    http://www.oddbird.net/susy
-
-To get started, set up your grid in the base partial by following the inline instructions.
+    http://susy.oddbird.net/
 }
-

data/templates/project/screen.scss

@@ -1,4 +1,4 @@
-// -------
-// Imports
+// Screen
+// ======
 
 @import "base";

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: susy
 version: !ruby/object:Gem::Version
-  version: 2.0.0.alpha.6
+  version: 2.0.0.beta.1
 platform: ruby
 authors:
 - Eric Meyer
@@ -45,7 +45,7 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
-- CHANGELOG.mkdn
+- docs/changelog.rst
 - LICENSE.txt
 - README.md
 - lib/susy.rb
@@ -53,27 +53,26 @@ files:
 - lib/compass-susy.rb
 - lib/susy.rb
 - sass/_susy.scss
-- sass/susy/_core.scss
 - sass/susy/_helpers.scss
 - sass/susy/_math.scss
-- sass/susy/_settings.scss
 - sass/susy/api/_float.scss
 - sass/susy/api/_shared.scss
+- sass/susy/api/float/_clearfix.scss
 - sass/susy/api/float/_container.scss
 - sass/susy/api/float/_end.scss
 - sass/susy/api/float/_isolate.scss
 - sass/susy/api/float/_span.scss
 - sass/susy/api/shared/_background.scss
+- sass/susy/api/shared/_box-sizing.scss
 - sass/susy/api/shared/_container.scss
+- sass/susy/api/shared/_direction.scss
 - sass/susy/api/shared/_margins.scss
 - sass/susy/api/shared/_padding.scss
-- sass/susy/helpers/_box-sizing.scss
-- sass/susy/helpers/_clearfix.scss
-- sass/susy/helpers/_direction.scss
-- sass/susy/helpers/_nth.scss
 - sass/susy/language/_susy.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
@@ -87,12 +86,12 @@ files:
 - sass/susy/language/susy/_span.scss
 - sass/susy/math/_columns.scss
 - sass/susy/math/_container.scss
-- sass/susy/math/_location.scss
+- sass/susy/math/_settings.scss
+- sass/susy/math/_validation.scss
 - templates/project/_base.scss
 - templates/project/manifest.rb
-- templates/project/README.md
 - templates/project/screen.scss
-- CHANGELOG.mkdn
+- docs/changelog.rst
 - LICENSE.txt
 - README.md
 - VERSION

data/CHANGELOG.mkdn

@@ -1,269 +0,0 @@
-Susy Changelog
-==============
-
-v1.0.5 [Nov 27, 2012]
----------------------
-
-* Add support for rem-units.
-* Clean-up quoted arguments.
-* Fix a few bugs related to the override settings.
-
-v1.0.4 [Nov 3, 2012]
----------------------
-
-* Fix bug in nested mixins that adjust support (e.g. `nth-omeg` inside `at-breakpoint`).
-* Remove non-ie experimental support in `at-breakpoint` ie-fallback output.
-
-v1.0.3 [Oct 20, 2012]
----------------------
-
-* Fix Compass dependencies.
-
-v1.0.2 [Oct 20, 2012]
----------------------
-
-* Fix a bug with `container-outer-width` ignoring `$columns` argument.
-* Turn off legacy-ie support inside CSS3 selectors (`nth-omega` etc).
-
-v1.0.1 [Sept 12, 2012]
-----------------------
-
-* Fix a bug in the relationship between `$container-width` and `$border-box-sizing`,
-  so that grid-padding is subtracted from the width in certain cases.
-* Reset right margin to `auto` rather than `0` with `remove-omega`.
-
-v1.0 [Aug 14, 2012]
--------------------
-
-This release is loaded with new features, but don't let that fool you. Susy
-just became shockingly simple to use. See the [website][site] for details.
-
-The gem name has changed from `compass-susy-plugin` to `susy`.
-First uninstall the old gem, then install the new one.
-If you have both gems installed, you will get errors.
-
-[site]: http://susy.oddbird.net/
-
-Semantics:
-
-We re-arranged the code
-in order to make the syntax simpler and more consistent:
-
-* `$total-cols` is now `$total-columns`.
-* `$col-width` is now `$column-width`.
-* `$side-gutter-width` is now `$grid-padding`
-  and gets applied directly to the grid container.
-* `un-column` & `reset-column` mixins have merged into `reset-columns`.
-* `columns` has been renamed `span-columns` to resolve the conflict with CSS3 columns.
-  See other improvements to span-columns below.
-
-We also removed several bothersome requirements:
-
-* The `alpha` mixin is no longer needed. Ever.
-* The `omega` no longer takes a `$context` argument.
-* `full` has been removed entirely.
-  Elements will be full-width by default.
-  You can add `clear: both;` back in as needed.
-* `side-gutter()` is no longer needed.
-  You can use the `$grid-padding` setting directly.
-
-Upgrade:
-
-That's all you need in order to upgrade from Susy 0.9.
-
-1. Uninstall and re-install the gem.
-2. Find and replace the semantic changes listed above.
-
-You're done! Stop worrying about all that "nested vs. root" bullshit,
-and start playing with the new toys!
-
-If you use the `$from` directional arguments
-directly in the `span-columns` mixin,
-there may be one more change to make.
-See below:
-
-New Features:
-
-* `span-columns` supports new features:
-  - "omega" can be applied directly through the `$columns` argument.
-  - Internal padding can be added through the `$padding` argument.
-  - This pushes the `$from` argument from third position into fourth.
-* `at-breakpoint` allows you to change layouts at media breakpoints.
-* `container` accepts multiple media-layout combinations as a shortcut.
-* `layout` allows you to use a different layout at any time.
-* `with-grid-settings` allows you to change any or all grid settings.
-* `set-container-width` does what it says, without the other container code.
-* `$breakpoint-media-output`, `$breakpoint-ie-output`, and `$breakpoint-raw-output`
-  settings help manage the different outputs from `at-breakpoint`
-  when you have IE-overrides living in a file of their own.
-* `border-box-sizing` will  apply the popular `* { box-sizing: border-box }`
-  universal box-model fix, as well as changing the Susy `$border-box-model` setting for you,
-  so Susy knows to adjust some math.
-* The `space()` function can be used anywhere you need column+gutter math.
-* `push`, `pull`, `pre`, `post`, and `squish` mixins help manage margins.
-* use the `nth-omega` mixin to set omega on any nth-child, nth-of-type,
-  first, last, or only element.
-* `remove-omega` and `remove-nth-omega` will remove
-  the omega-specific styles from an element.
-* `$container-width` will override the width of your container
-  with any arbitrary length.
-* `$container-style` will override the type of grid container
-  (magic, fluid, fixed, static, etc) to use.
-
-v0.9 [Apr 25 2011]
-------------------
-
-Everything here is about simplicity. Susy has scaled back to it's most basic
-function: providing flexible grids. That is all.
-
-Deprecated:
-
-* The `susy/susy` import is deprecated in favor of simply importing `susy`.
-* The `show-grid` import is deprecated in favor of CSS3 gradient-based
-grid-images. You can now use the `susy-grid-background` mixin. See below.
-
-Removed:
-
-* Susy no longer imports all of compass.
-* Susy no longer establishes your baseline and no longer provides a reset.
-All of that is in the Compass core. You can (and should!) keep using them, but
-you will need to import them from compass.
-
-New:
-
-* Use the `susy-grid-background` mixin on any `container` to display the grid.
-This toggles on and off with the same controls that are used by the compass
-grid-background module.
-
-v0.9.beta.3 [Mar 16 2011]
--------------------------
-
-Deprecated:
-
-* The `susy/reset` import has been deprecated in favor of the Compass core `compass/reset` import.
-* The `susy` mixin has been deprecated. If you plan to continue using vertical-rhythms, you should replace it with the `establish-baseline` mixin from the Compass Core.
-
-Removed:
-
-* The `vertical-rhythm` module has moved into compass core. The API remains the same, but if you were importing it directly, you will have to update that import. (`$px2em` was removed as part of this, but didn't make it into core).
-* The `defaults` template has been removed as 'out-of-scope'. This will not effect upgrading in any way, but new projects will not get a template with default styles.
-
-New Features:
-
-* Susy now supports RTL grids and bi-directional sites using the `$from-direction` variable (default: left) and an optional additional from-direction argument on all affected mixins. Thanks to @bangpound for the initial implementation.
-* Susy is now written in pure Sass! No extra Ruby functions included! Thanks to the Sass team for making it possible.
-
-v0.8.1 [Sep 24 2010]
---------------------
-
-* Fixed typos in tutorial and `_defaults.scss`
-
-v0.8.0 [Aug 13 2010]
---------------------
-
-Deprecated:
-
-* The `skip-link` was deprecated as it doesn't belong in Susy.
-* All the IE-specific mixins have been deprecated, along with the `$hacks` variable. Hacks are now used in the default mixins as per Compass.
-* The `hide` mixin was deprecated in favor of the Compass code `hide-text` mixin.
-
-Other Changes:
-
-* `inline-block-list` will be moved to the compass core soon. In preparation, I've cleaned it up some. You can now apply a padding of "0" to override previous padding arguments. You can also use `inline-block-list-container` and `inline-block-list-item` as you would with the Compass `horizontal-list` mixins.
-* The `$align` arguments have been removed from both the `susy` and `container` mixins. Text-alignment is no longer used or needed in achieving page centering. That was a cary-over from the IE5 Mac days.
-* The `container` mixin now uses the `pie-clearfix` compass mixin to avoid setting the overflow to hidden.
-* Default styles have been cleaned up to account for better font stacks and typography, html5 elements, vertically-rhythmed forms, expanded print styles, use of `@extend`, and overall simplification.
-
-v0.7.0 [Jun 01 2010]
---------------------
-
-* updated documentation
-
-v0.7.0.rc2 [May 13 2010]
-------------------------
-
-* Fixes a bug with grid.png and a typo in the readme. Nothing major here.
-
-v0.7.0.rc1 [May 12 2010]
-------------------------
-
-* template cleanup & simplification - no more pushing CSSEdit comments, etc.
-* expanded base and defaults with better fonts & styles out-of-the-box
-* expanded readme documentation. This will expand out into a larger docs/tutorial site in the next week.
-
-v0.7.0.pre8 [Apr 20 2010]
--------------------------
-
-* mostly syntax and gem cleanup
-* added `un-column` mixin to reset elements previously declared as columns.
-* added `rhythm` mixin as shortcut for leaders/trailers. accepts 4 args: leader, padding-leader, padding-trailer, trailer.
-* added a warning on `alpha` to remind you that `alpha` is not needed at nested levels.
-
-v0.7.0.pre7 [Apr 13 2010]
--------------------------
-
-* *Requires HAML 3 and Compass 0.10.0.rc2*
-* Internal syntax switched to scss. This will have little or no effect on users. You can still use Susy with either (Sass/Scss) syntax.
-* `$default-rhythm-border-style` overrides default rhythm border styles
-* Better handling of sub-pixel rounding for IE6
-
-v0.7.0.pre6 [Mar 29 2010]
--------------------------
-
-* Added `+h-borders()` shortcut for vertical_rhythm `+horizontal-borders()`
-* Fixed vertical rhythm font-size typo (thanks @oscarduignan)
-* Added to template styles, so susy is already in place from the start
-
-v0.7.0.pre5 [Mar 19 2010]
--------------------------
-
-* Expanded and adjusted `_vertical_rhythm.sass` in ways that are not entirely backwards compatible. Check the file for details.
-* `_defaults.sass` is re-ordered from inline to block.
-* `:focus` defaults cleaned up.
-* README and docs updated.
-
-v0.7.0.pre4 [Jan 20 2010]
--------------------------
-
-Update: pre2 was missing a file in the manifest. Use pre4.
-
-*Update:* Forgot to note one change: `+susy` is no longer assigned to the `body` tag, but instead at the top level of the document (not nested under anything).
-
-Warning: This update is not backwards compatible. We've changed some things. You'll have to change some things. Our changes were fairly major in cleaning up the code - yours will be minor and also clean up some code.
-
-Added:
-
-* new `_vertical_rhythm.sass` (thanks to Chris Eppstein) provides better establishing of the baseline grid, as well as mixins to help you manage it.
-* `!px2em` has replaced `px2em()` - see below.
-
-Removed:
-
-* `px2em()` has been removed and replaced with a simple variable `!px2em` which returns the size of one pixel relative to your basic em-height. Multiply against your desired px dimensions (i.e. `border-width = !px2em*5px` will output the em-equivalent of 5px).
-* `!base_font_size_px` and `!base_line_height_px` have been replaced with `!base_font_size` and `!base_line_height` which take advantage of sass's built-in unit handling.
-* `!grid_units` is not needed, as you can now declare your units directly in the other grid `_width` variables. Use any one type of units in declaring your grid. The units you use will be used in setting the container size.
-
-Once you've upgraded, before you compile your files, make these changes:
-
-* remove the "_px" from the font-size and line-height variables, and add "px" to their values.
-* remove the `!grid_units` variable and add units to your grid variable values.
-* find any uses of `px2em()` and replace them with something.
-* enjoy!
-
-v0.7.0.pre1 [Nov 30 2009]
--------------------------
-
-Not a lot of new functionality here – it all moved over to Compass 0.10.0 – mostly just cleaning it up to match.
-
-* simplified the default styles and gave them their own project template (‘_defaults.sass’).
-* defaults not imported by ‘ie.sass’, as ‘ie.sass’ should be cascading on top of ‘screen.sass’ anyway
-* changed the syntax to match CSS and Compass (‘property:’ replaces ‘:property’)
-* added more inline documentation and brought tutorial up to date
-* moved CSS3 module over to Compass
-* import the compass HTML5 reset along with the normal reset by default (because Susy loves the future)
-* little internal management fixes and so on and so on…
-
-older…
--------
-
-* not documented here.
-* check the commit log.