sassy-namespaces 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f0bdb5ce796b20f153bb162ea5ed7ceb66d0b6dd
-  data.tar.gz: 1430c1505c5843be12216c336237831eacd812fe
+  metadata.gz: 2769b569ed18c8110272fd03140e32b5e902fba1
+  data.tar.gz: 68e75d1b46cb7cf79fc494197e9e86d87d68043b
 SHA512:
-  metadata.gz: 83fc0385c77870ea40e837395e08a92ee0c5d48f602ac48d0035ac46b1350d4c852d0b23292fed59d38fa6d6d06a6e864b08971736c9e1d087a0165c138dc71f
-  data.tar.gz: 895e57d52677c65180cef5f54a9595a3a58f18d015ef5b94bc1a8b923cd37f604c9b5be59349fe262fe7cae392a18d3860ba70e71a878607fe0e2d9917c3e0b6
+  metadata.gz: aae3d39c3b2604fef1328e96a98073949a10f76f813fb0d022d7b6106b1ad52492fde07a0060ac62f2836248fd454794d38aa4621de5229fd9a7536b40cf860b
+  data.tar.gz: e2dac496bc5263370bdad64dd5034dbffd52b8b124b5270260ff787ae80e4e25f606f1a2aa8aeae94b1f980d6db89592c52043813e6009ca68951fd904651ba2

data/README.md

@@ -1,32 +1,39 @@
 Sassy Namespaces
 ================
 
-Sass 3.3 brought us maps, which are great for organizing related values into groups, but the syntax is a bit tedious. Sassy Namespaces offers pattern for creating and accessing namespaces using Sass maps.
+Sass 3.3 brought us maps, which are great for grouping related values, but the syntax is a bit tedious. Sassy Namespaces offers a pattern for creating and accessing namespaces using Sass maps.
 
 Yes, it's essentially a wrapper around the excellent [Sassy Maps](https://github.com/Team-Sass/Sassy-Maps) extension.
 
 The problem
 -----------
 
-In vanilla Sass, even single-level namespaces are a bit of hassle:
+In vanilla Sass, even single-level namespaces are a bit of a chore:
 
 ```scss
+// Create "color" namespace
 $color: ();
+// Add key-value pair
 $color: $map-merge($color, (primary: red));
 
-foo {
-  bar: map-get($color, primary); // bar: red
+output {
+  foo: map-get($color, primary); // foo: red
 }
 ```
 
-You could define functions/mixins to streamline the process:
+A partial solution is to define wrapper functions/mixins that abstract away the ugliness:
 
 ```scss
+// Create "color" namespace
 $color: ();
 
+@function color-set($key, $value) {
+  @return $map-merge($color, ($key: $value));
+}
+
 // Setter
-@mixin set-color($key, $value) {
-  $color: $map-merge($color, ($key: $value));
+@mixin color-set($key, $value) {
+  $color: color-set($key, $value);
 }
 
 // Getter
@@ -34,43 +41,47 @@ $color: ();
   @return map-get($color, $key);
 }
 
-@include set-color(primary, red);
-foo {
-  bar: color(primary); // bar: red
+// Add key-value pair
+@include color-set(primary, red);
+output {
+  foo: color(primary); // foo: red
 }
 ```
 
 But this quickly gets tiresome, especially once you try to create namespaces with more than one level of hierarchy.
 
-Sass namespaces, minus the headaches
+Namespaces, minus the headaches
 ------------------------------------
 
-Here's how you do it with Sassy Namespaces:
+With Sassy Namespaces, maps are created and used internally. You don't ever have to deal with them directly. Easy as:
 
 ```scss
-@include create-namespace(color);
+// Create a "color" namespace
+@include namespace-create(color); // (This step can be skipped)
+// Add key-value pair
 @include namespace-set(color, primary, red);
-foo {
-  bar: namespace-get(color, primary); // bar: red;
+ouput {
+  foo: namespace-get(color, primary); // foo: red;
 }
 ```
 
-Maps are created and used internally, but you don't ever have to deal with them.
+It's possible streamline to this even further. `namespace-set()` will create a namespace if it doesn't exist, so we can skip `namespace-create()`.
 
-It's still a good idea to create convenience functions/mixins. Pretty straightfoward:
+Also, instead of calling `namespace-set()` and `namespace-get()`, we can replace both with the wrapper function/mixin `namespace()`, which will either get or set as is appropriate. This comes in handy when creating wrapper functions/mixins:
 
 ```scss
-@mixin set-color($args...) {
-  @include namespace-set(color, $args...);
+// Alias color() to namespace(color)
+@mixin color($args...) {
+  $color: namespace(color, $args...);
 }
 
 @function color($args...) {
-  @return namespace-get(color, $args...);
+  @return namespace(color, $args...);
 }
 
-@include set-color(primary, red);
-foo {
-  bar: color(primary); // bar: red
+@include color(primary, red);
+output {
+  foo: color(primary); // foo: red
 }
 ```
 
@@ -81,18 +92,18 @@ If you want to set multiple values at once, without calling `namespace-set()` ov
 $map: (primary: red, secondary: green)
 
 @include namespace-set(color, $map);
-foo {
-  bar: namespace-get(color, primary); // bar: red
-  baz: namespace-get(color, secondary); // baz: green
+output {
+  foo: namespace-get(color, primary); // foo: red
+  bar: namespace-get(color, secondary); // bar: green
 }
 ```
 
-And, since Sassy Namespaces uses Sassy Maps internally, hierarchical namespaces are free:
+And, since Sassy Namespaces uses Sassy Maps internally, hierarchical namespaces are easy, too:
 
 ```scss
 @include namespace-set(color, text link hover, green);
-foo {
-  bar: namespace-get(color, text link hover); // bar: green
+output {
+  foo: namespace-get(color, text link hover); // foo: green
 }
 ```
 
@@ -100,23 +111,19 @@ At any time, you can return the underlying namespace map:
 
 ```scss
 @include namespace-set(color, primary, red);
-$namespace-1: namespace(color);
+$namespace-1: namespace-get(color);
 
 @include namespace-set(color, secondary, green);
-$namespace-2: namespace(color);
+$namespace-2: namespace-get(color);
 
 /*
   $namespace-1: (
-    color: (
-      primary: red
-    )
+    primary: red
   )
 
   $namespace-2: (
-    color: (
-      primary: red,
-      secondary: green
-    )
+    primary: red,
+    secondary: green
   )
 */
 ```

data/lib/sassy-namespaces.rb

@@ -5,6 +5,6 @@ extension_path = File.expand_path(File.join(File.dirname(__FILE__), ".."))
 Compass::Frameworks.register('SassyNamespaces', :path => extension_path)
 
 module SassyNamespaces
-  VERSION = "0.1"
+  VERSION = "0.1.1"
   DATE = "2014-03-17"
 end

data/stylesheets/{_sassy-maps.scss → _sassy-stylesheets.scss}

@@ -1,20 +1,19 @@
 @import "sassy-maps";
 
+// Private map that holds the namespaces
 $__sassy-namespaces: ();
 
-@mixin create-namespace($name) {
-  $__sassy-namespaces: map-set($__sassy-namespaces, $name, ());
-}
-
+// Add a key-value pair to an existing namespace, or to a new one if it doesn't already exist
+// Returns the updated namespace map
 @function namespace-set($name, $args...) {
   $length: length($args);
-  $namespace: map-get($__sassy-namespaces, $name);
+  $namespace: map-get($__sassy-namespaces, $name) or ($name: ());
   
   @if length($args) == 1 {
     @if type-of(nth($args, 1)) == map {
       $namespace: map-merge($namespace, nth($args, 1));
     } @else {
-      @warn "Must pass either a map or 2 or more values."
+      @warn "Must pass either a map or a key and a value.";
     }
   }
   @else {
@@ -31,10 +30,17 @@ $__sassy-namespaces: ();
   @return $namespace;
 }
 
+
+// Return value for key of a namespace
+// Returns null if key or namespace doesn't exist
 @function namespace-get($name, $args...) {
   $length: length($args);
   $namespace: map-get($__sassy-namespaces, $name);
   
+  @if not $namespace {
+    @return null;
+  }
+  
   @if $length > 0 {
     $keys: nth($args, 1);
     
@@ -48,6 +54,22 @@ $__sassy-namespaces: ();
   }
 }
 
-@mixin namespace-set($name, $args...) {
+@function namespace($args...) {
+  @return namespace-get($args...) or namespace-set($args...);
+}
+
+@mixin namespace-get($args...) {
   $namespace: namespace-set($name, $args...);
+}
+
+@mixin namespace-get($args...) {
+  $namespace: namespace-get($name, $args...);
+}
+
+@mixin namespace($name, $args...) {
+  $namespace: namespace($name, $args...);
+}
+
+@mixin namespace-create($name, $args...) {
+  @include namespace-set($name, $args...);
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sassy-namespaces
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Clark
@@ -61,8 +61,8 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/sassy-namespaces.rb
-- stylesheets/_sassy-maps.scss
-homepage: 
+- stylesheets/_sassy-stylesheets.scss
+homepage: https://github.com/acdlite/sassy-namespaces
 licenses: []
 metadata: {}
 post_install_message: