chroma-sass 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f8985848e269073f03fd0cd6ddf52227cbed3dc9
-  data.tar.gz: 72cde7143265b4cfe705ec41e32f8dd1541366bd
+  metadata.gz: c2805923b354ea2912ee2510ae926166569821f7
+  data.tar.gz: 94bfffb798c22174513e3c47c562b4f566f02d98
 SHA512:
-  metadata.gz: b67c868cd3824776ee517a14d2ab52b8ccf315401194af5c3e319884ea506e1440d6e24d22acf5a0689b0cc9eeeb0a3e2f0cd52a5659e59201c57d62bbb42222
-  data.tar.gz: 42b4faa8bfbf1aefa8b4a8a57cb8419d71242aef39c6ab07299813f6a7f3e16ef45c904d574152dad74f4284ed6ed2a3611b97bca183b64c1bed3c29605c84b8
+  metadata.gz: 7d842b907fd6adc6b5957f92f1d3d67da70d47d11667e4f19aae34960466789e441a84c2d609bda42aadd347f090f00b63d3256039bfd8c6fa11d24fe51d1d09
+  data.tar.gz: 0c973e1dbeaff8632a37f7aabd5756af2f272a44e7fb68105f1371755428c958485579a3496877f5a0e464ac6bb776f7af0285bd986842015b7ba7fd53651cc9

data/README.md

@@ -4,7 +4,7 @@ Chroma is a Sass library that manages a project's color names, color variations,
 
 ## USAGE
 
-~~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.
+Full documentation is available at [http://johnalbin.github.io/chroma/](http://johnalbin.github.io/chroma/). But here are some quick examples to give you an idea of what Chroma can do.
 
 ```scss
 @import "chroma";
@@ -72,29 +72,7 @@ $chroma-active-scheme: 'functional';
 
 ## INSTALLATION
 
-Chroma is distributed as a Ruby Gem. On your computer, simply run:
-
-```sh
-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'
-```
-
-If you are using Compass, edit your project's config.rb and add this line:
-
-```ruby
-require 'chroma'
-```
-
-You can then start using Chroma in your Sass files. Just add this line to one of your .sass or .scss files and start creating!
-
-```scss
-@import "chroma";
-```
+Chroma can be installed either as a Ruby Gem, as a Bower component, or as a NPM module. See [Chroma’s online documentation](http://johnalbin.github.io/chroma/) for more information.
 
 ## REQUIREMENTS
 

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'
-  spec.date         = '2015-08-31'
+  spec.version      = '1.0.1'
+  spec.date         = '2015-09-09'
   spec.licenses     = ['GPL-2']
 
   spec.authors      = ['John Albin Wilkins']

data/sass/chroma/_colour.scss

@@ -47,13 +47,13 @@ $_chroma-spelling: 'colour';
   @return define-color-scheme($scheme, $description, $parent);
 }
 
-// define-default-colour-scheme($description)
+// define-default-colour-scheme([$name,] $description)
 //
 // See `define-default-color-scheme()` for the documentation.
 //
 // Style guide: colour.define-default-colour-scheme
-@function define-default-colour-scheme($description) {
-  @return define-color-scheme($CHROMA_DEFAULT_SCHEME, $description);
+@function define-default-colour-scheme($name, $description: null) {
+  @return define-default-color-scheme($name, $description);
 }
 
 // add-colours([$scheme,] $colours)

data/sass/chroma/_functions.scss

@@ -56,7 +56,7 @@ $chroma: _chroma-init();
     // Check if Sass _has_ converted the color into a hex value that we can't
     // convert back to a keyword.
     @else if map-has-key($_chroma-dangerous-converted-keywords, $name) {
-      @error "Sass has converted a color keyword into the hexidecimal value, #{$name}, and Chroma was not be able to determine if the original name was #{map-get($_chroma-dangerous-converted-keywords, $name)}. To prevent this error, use quotes around the keyword.";
+      @error "Sass has converted a #{$_chroma-spelling} keyword into the hexidecimal value, #{$name}, and Chroma was not be able to determine if the original name was #{map-get($_chroma-dangerous-converted-keywords, $name)}. To prevent this error, use quotes around the keyword.";
     }
   }
   @return false;
@@ -75,16 +75,20 @@ $chroma: _chroma-init();
   // hexadecimal value before we can read the name. And some hex values map to
   // more than one keyword (e.g. gray and grey), so the original name would be
   // irretrievable.
-  @if is-dangerous-color-keyword($name) {
-    // If true, the is-dangerous-color-keyword() would @die before it returned.
-  }
+  //
+  // While is-dangerous-color-keyword() would normally @error before it
+  // returned, if it does return a true value, we should continue inspecting
+  // $name so we can convert it to a string.
+  $is-dangerous: is-dangerous-color-keyword($name);
 
   // Convert the color to a string.
   @if type-of($name) == 'color' {
     $name: inspect($name);
+
+    @return if(map-has-key($_chroma-css4-color-keywords, $name), map-get($_chroma-css4-color-keywords, $name), false);
   }
 
-  @return if(map-has-key($_chroma-css4-color-keywords, $name), map-get($_chroma-css4-color-keywords, $name), false);
+  @return false;
 }
 
 // chroma-to-string($name)
@@ -145,9 +149,10 @@ $chroma: _chroma-init();
     @return map-get($color, 'value');
   }
   @else {
-    // The value of $actual-scheme::$name is based on parents in $actual-scheme.
-    // But one or more of the parents may be defined in $scheme too, so we need
-    // to check the full reference chain.
+    // The value of $actual-scheme::$name is based on colors in $actual-scheme
+    // and its parent schemes. But one or more of the parent colors may be
+    // defined (overridden) in $scheme too, so we need to check the full
+    // reference chain.
     $ref: map-get($color, 'reference');
     @while $ref {
       $actual-scheme: chroma-has-color($ref, $scheme);
@@ -208,20 +213,56 @@ $chroma: _chroma-init();
   );
 }
 
-// define-default-color-scheme($description)
+// define-default-color-scheme([$name,] $description)
 //
 // Sets the description of the default color scheme.
 //
 // Usage:
 // ```scss
 // $chroma: define-default-color-scheme('Default colors');
+// // or:
+// $chroma: define-default-color-scheme('branding', 'Basic branding colors');
 // ```
 //
+// $name - Optional: default color scheme name; defaults to `default`.
 // $description - Description of the default color scheme.
 //
 // Style guide: functions.define-default-color-scheme
-@function define-default-color-scheme($description) {
-  @return define-color-scheme($CHROMA_DEFAULT_SCHEME, $description);
+@function define-default-color-scheme($name, $description: null) {
+  @if type-of($description) == 'null' {
+    // The shortcut syntax was used since $description is null. Move the actual
+    // description to the $description parameter.
+    $description: $name;
+    @return define-color-scheme($CHROMA_DEFAULT_SCHEME, $description);
+  }
+
+  // Remove the old default.
+  $schemes: map-remove(map-get($chroma, 'schemes'), $CHROMA_DEFAULT_SCHEME);
+  // Update all child schemes of the default.
+  @each $scheme-name, $map in $schemes {
+    @if map-get($map, 'parent') == $CHROMA_DEFAULT_SCHEME {
+      $schemes: map-merge(
+        $schemes,
+        ($scheme-name: (
+          'description': map-get($map, 'description'),
+          'parent': $name,
+        ))
+      );
+    }
+  }
+  // Set the new default scheme name.
+  $CHROMA_DEFAULT_SCHEME: $name !global;
+  // Add the default scheme (and the updated schemes) back into $chroma.
+  @return map-merge(
+    $chroma,
+    ('schemes': map-merge(
+      $schemes,
+      ($name: (
+        'description': $description,
+        'parent': false,
+      ))
+    ))
+  );
 }
 
 // add-colors([$scheme,] $colors)
@@ -307,7 +348,7 @@ $chroma: _chroma-init();
       }
     }
     @else {
-      @error 'Unexpected value given for color "#{$color-name}".';
+      @error 'Unexpected value, "#{$color-value}", given for #{$_chroma-spelling} "#{$color-name}".';
     }
   }
 
@@ -356,7 +397,9 @@ $chroma: _chroma-init();
 // ));
 // ```
 //
-// $skins - A list of color schemes and their
+// $skins - A list of color schemes and their A CSS parent selectors
+//
+// Style guide: skin.define-skins
 @function define-skins($skins) {
   @each $scheme, $selector in $skins {
     $chroma: define-skin($scheme, $selector) !global;

data/sass/chroma/_variables.scss

@@ -17,13 +17,27 @@
 //
 // The colors and meta-data managed by Chroma.
 //
+// Chroma stores all of its colors, color schemes, skins etc. in the global
+// sass variable, `$chroma`. All of Chroma's configuration functions are
+// designed to save their changes to the system by changing the value of the
+// `$chroma` variable. For example: `$chroma: add-colors((kermit, #70af00));`
+//
+// Note: since the `$chroma` variable is a complex map of data structures, it
+// is highly recommended to only access `$chroma` through the functions and
+// mixins provided and not attempt to read data from `$chroma` with Sass'
+// `map-get()` and `map-set()` functions. (If you find you need more helper
+// functions, submit a feature request! We're happy to help.)
+//
 // Style guide: variables.chroma
 $chroma: () !default;
 
 // $CHROMA_DEFAULT_SCHEME
 //
-// The name of the default color scheme. There seems to be no reason to change
-// this value, but Chroma won't stifle your creativity.
+// The name of the default color scheme; defaults to `default`. This variable
+// is READ ONLY; changing its value will break Chroma.
+//
+// If you want to change this variable's value, you must use the
+// `define-default-color-scheme()` function instead.
 //
 // Style guide: variables.CHROMA_DEFAULT_SCHEME
 $CHROMA_DEFAULT_SCHEME: 'default';

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: chroma-sass
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - John Albin Wilkins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2015-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sass
@@ -61,8 +61,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 1.0.0
-rubygems_version: 2.4.5.1
+rubyforge_project: 1.0.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Chroma is the Sass color manager.