chroma-sass 1.0.0.beta.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d790126ea8171eb7be69c7cd459e9efbdd9d970d
-  data.tar.gz: 0c4ca0e76a0d4e5152150e11b75c3be5f19a8451
+  metadata.gz: f8985848e269073f03fd0cd6ddf52227cbed3dc9
+  data.tar.gz: 72cde7143265b4cfe705ec41e32f8dd1541366bd
 SHA512:
-  metadata.gz: b4e4963fa9803e6c83d586369009431cfc8cef440503829a8011ecdcadcc9d2724e73a3470e8425b726bedfd3c73d4f192e1205cb1827faae9b12c3f36fc13d8
-  data.tar.gz: f963d961e3c581f6831a668d377e3b0523834abf698409716c8add0b22f9641dc2c88fafb9d8a140d5f0abcaf44a90ffd446794b7e0ffa6cbdb8d926034bc65b
+  metadata.gz: b67c868cd3824776ee517a14d2ab52b8ccf315401194af5c3e319884ea506e1440d6e24d22acf5a0689b0cc9eeeb0a3e2f0cd52a5659e59201c57d62bbb42222
+  data.tar.gz: 42b4faa8bfbf1aefa8b4a8a57cb8419d71242aef39c6ab07299813f6a7f3e16ef45c904d574152dad74f4284ed6ed2a3611b97bca183b64c1bed3c29605c84b8

data/README.md

@@ -4,8 +4,7 @@ Chroma is a Sass library that manages a project's color names, color variations,
 
 ## USAGE
 
-Betters docs are coming, but here's some documentation in the form of example
-code.
+~~Betters docs are coming, but~~ Better docs are now available at http://johnalbin.github.io/chroma/ and here's some quick documentation in the form of example code.
 
 ```scss
 @import "chroma";
@@ -82,7 +81,7 @@ gem install chroma-sass
 If you are using Bundler (and you should!) then you can add it to an existing project by editing the project's Gemfile and adding this line:
 
 ```ruby
-gem 'chroma-sass',  '~> 1.0.0.beta.3'
+gem 'chroma-sass',  '~> 1.0.0'
 ```
 
 If you are using Compass, edit your project's config.rb and add this line:
@@ -101,6 +100,10 @@ You can then start using Chroma in your Sass files. Just add this line to one of
 
 * Sass 3.4.0 or later
 
+Note: libsass 3.2.5 or earlier does not work with chroma-sass due to a bug in
+libsass. ☹ libsass 3.3.0 should fix the bug, but it has not been tested. See
+https://github.com/JohnAlbin/chroma/issues/10
+
 ## LICENSE
 
 Available under the GPL v2 license. See [LICENSE.txt](https://github.com/JohnAlbin/chroma/blob/master/LICENSE.txt).

data/chroma-sass.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.homepage     = 'http://github.com/JohnAlbin/chroma'
   spec.rubyforge_project =
 
-  spec.version      = '1.0.0.beta.3'
-  spec.date         = '2015-08-17'
+  spec.version      = '1.0.0'
+  spec.date         = '2015-08-31'
   spec.licenses     = ['GPL-2']
 
   spec.authors      = ['John Albin Wilkins']

data/sass/_chroma.scss

@@ -1,3 +1,4 @@
 // Import the required partials for Chroma.
 
 @import './chroma/functions';
+@import './chroma/skin';

data/sass/chroma/_colour.scss

@@ -60,7 +60,7 @@ $_chroma-spelling: 'colour';
 //
 // See `add-colors()` for the documentation.
 //
-// Style guide: functions.add-colours
+// Style guide: colour.add-colours
 @function add-colours($scheme, $colours: null) {
   @return add-colors($scheme, $colours);
 }

data/sass/chroma/_functions.scss

@@ -2,6 +2,8 @@
 //
 // The main module for Chroma.
 //
+// Weight: -1
+//
 // Style guide: functions
 
 // Import the global variables and internal functions needed by all of Chroma.
@@ -311,3 +313,53 @@ $chroma: _chroma-init();
 
   @return $chroma;
 }
+
+// define-skin($scheme, $selector)
+//
+// Defines that the specified color scheme can be used as a skin when the
+// given parent selector matches our HTML. See the `skin()` mixin.
+//
+// Usage:
+// ```scss
+// $chroma: define-skin('scheme1', '.is-scheme1-skin');
+// ```
+//
+// $scheme   - Name of the color scheme to use when the `$selector` matches our
+//             HTML.
+// $selector - A CSS parent selector that triggers the use of the defined
+//             `$scheme` instead of the default color scheme. We recommend using
+//             a simple CSS selector like `.is-CUSTOMNAME-skin`.
+//
+// Style guide: skin.define-skin
+@function define-skin($scheme, $selector) {
+  $skins: map-merge(
+    map-get($chroma, 'skins'),
+    ($scheme: $selector)
+  );
+
+  @return map-merge(
+    $chroma,
+    ('skins': $skins)
+  );
+}
+
+// define-skins($skins)
+//
+// Helper function to define multiple skins at once.
+//
+// Usage:
+// ```scss
+// $chroma: define-skins((
+//   'scheme1': '.is-scheme1-skin',
+//   'scheme2': '.is-scheme2-skin',
+//   'scheme3': 'html > body.this-works-but-is.way.too.specific.IMHO',
+// ));
+// ```
+//
+// $skins - A list of color schemes and their
+@function define-skins($skins) {
+  @each $scheme, $selector in $skins {
+    $chroma: define-skin($scheme, $selector) !global;
+  }
+  @return $chroma;
+}

data/sass/chroma/_internals.scss

@@ -3,6 +3,8 @@
 // Helper functions that query the internal data structure in $chroma. These are
 // not part of the public API and are subject to change at any time.
 //
+// Weight: 10
+//
 // Style guide: internals
 
 // Import the global variables needed by all of Chroma.
@@ -69,7 +71,7 @@
 // _chroma-init()
 //
 // Private function that sets up the initial data structure of the $chroma
-// variable.
+// variable. Can be called repeatedly without damaging existing data.
 //
 // Style guide: internals._chroma-init
 @function _chroma-init() {
@@ -81,6 +83,7 @@
           'parent': false,
         ),
       ),
+      'skins': (),
       'names': (),
     );
   }

data/sass/chroma/_skin.scss

@@ -0,0 +1,71 @@
+// Skin module
+//
+// A "Skin" module for Chroma.
+//
+// Sometimes design and engineering requirements mean that we need to:
+// - output the colors for default color scheme and one or more additional color
+//   schemes into the same CSS file
+// - and to control which color scheme is used via a "global" CSS class name set
+//   on the web pages's `html` or `body` element.
+//
+// For example, the `.my-complexion` component may output a blue text color on
+// most pages, but on pages with a `<html class="skin-wicked-witch">`, the
+// `.my-complexion` component will output a green text color.
+//
+// The Skin module will help with this requirement.
+//
+// After defining your color schemes and their colors, you can define one or
+// more of those schemes as skins while providing the proper CSS parent selector
+// to use for that skin.
+//
+// Weight: -1
+//
+// Style guide: skin
+
+@import "./functions";
+
+// skin([$skins])
+//
+// Output the default color and all the colors needed for defined skins.
+//
+// Usage:
+// ```scss
+// h1 {
+//   @include skin() {
+//     color: color(heading);
+//   }
+// }
+// ```
+//
+// $skins - An optional list of color scheme names and selectors to use instead
+//          of the skins defined with `define-skin()`. The format of this list
+//          should match that of the `$skins` parameter in `define-skins()`.
+//
+// Style guide: skin.skin
+@mixin skin($skins: null) {
+  @if type-of($skins) == 'null' {
+    $skins: map-get($chroma, 'skins');
+  }
+
+  // Save the current active scheme.
+  $original-active-scheme: $chroma-active-scheme;
+
+  // Output the default color property.
+  @content;
+
+  @if length($skins) == 0 {
+    @warn "skin() mixin used, but no skins have been defined in Chroma.";
+  }
+
+  // Output the color property for each scheme.
+  @each $scheme, $selector in $skins {
+    $chroma-active-scheme: $scheme !global;
+
+    #{$selector} & {
+      @content
+    }
+  }
+
+  // Restore the original active scheme.
+  $chroma-active-scheme: $original-active-scheme !global;
+}

data/sass/chroma/_variables.scss

@@ -5,6 +5,8 @@
 //
 // Auto-imported by other modules.
 //
+// Weight: -2
+//
 // Style guide: variables
 
 //

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma-sass
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta.3
+  version: 1.0.0
 platform: ruby
 authors:
 - John Albin Wilkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-17 00:00:00.000000000 Z
+date: 2015-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -40,6 +40,7 @@ files:
 - sass/chroma/_functions.scss
 - sass/chroma/_internals.scss
 - sass/chroma/_kss.scss
+- sass/chroma/_skin.scss
 - sass/chroma/_variables.scss
 homepage: http://github.com/JohnAlbin/chroma
 licenses:
@@ -56,12 +57,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project: 1.0.0.beta.3
-rubygems_version: 2.4.8
+rubyforge_project: 1.0.0
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Chroma is the Sass color manager.