archetype 1.0.0.alpha.4 → 1.0.0.alpha.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a245dc348e779929fa42e5d62f39ebc2ff17484
-  data.tar.gz: 5681711ab2e93e68dbde76a83a8fe56647e8bf7b
+  metadata.gz: e0bc82e5733b933600bff5fc78a4e15fadbac5d7
+  data.tar.gz: acdbfc8bd52ce18e9f9596776047808e15ada9b5
 SHA512:
-  metadata.gz: a7889dc272f3407af772361bb2767a1da0de7fa25c0b369442a1898b20ca559a1d6c5be2a5afac82b2a70a664440eeb310df726b061b374b835668bdda536cc2
-  data.tar.gz: e7e323e0fb48394518bcf6a6f614c277bd3e169ac6642f6f1ca86afd850889dbbddd6e7ca6d0152583a5271866db7f73265112b84958526e83edaf00cea4d423
+  metadata.gz: 9d7ed1d20f1227f1b7e1401b46043c44fd5951dacf32953c87055e94af7acb3fa0db5af502bdc5bc6e212a5060a0087dea4a2b95d4b3880b8c2c6aced6de8c16
+  data.tar.gz: a446520fe402c5b05ec8f592fc4755ebf3bef225281847e32b226ddb1bf3d0fb12d9cac925a71d65d38d75ffeecaee012845f496176851dafcc9985ee5647d4e

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 1.0.0.alpha.5 (unreleased)
+
+### New Features:
+
+- added `enable-breakpoint` and `disable-breakpoint` functions for toggling breakpoint output on/off
+- added `archetype-bundled` extension which is a "kitchen sink" bundle of Archetype core and all official extensions
+- added `styleguide_allow_missing` compiler option to force errors on missing styleguide identifiers
+
+### Resolved Issues:
+
+- allow non-multiplier values in `*-spacing` methods
+
 ## 1.0.0.alpha.4
 
 ### Resolved Issues:
@@ -227,7 +239,7 @@
 
 - `styleguide-add-component`, `styleguide-extend-component`, and `styleguide` now take a `$theme` parameter
 - `$CONFIG_THEME` can change the global theme
-- `$CONFIG_STYLEGUIDE_DISABLE_SPRITES` will prevent styleguide sprites from being generated if set to `true`
+- `$CONFIG_DISABLE_STYLEGUIDE_SPRITES` will prevent styleguide sprites from being generated if set to `true`
 - theme components are cached
 - `styleguide` calls are memoized
 

data/README.md

@@ -1,6 +1,6 @@
 # Archetype
 
-[![Build Status](https://api.travis-ci.org/linkedin/archetype.svg)](https://travis-ci.org/linkedin/archetype) [![Gem Version](https://badge.fury.io/rb/archetype.svg)](http://badge.fury.io/rb/archetype)
+[![Build Status](https://api.travis-ci.org/linkedin/archetype.svg)](https://travis-ci.org/linkedin/archetype) [![Gem Version](https://badge.fury.io/rb/archetype.svg)](http://badge.fury.io/rb/archetype) [![Documentation Status](https://inch-ci.org/github/linkedin/archetype.svg?branch=master)](https://inch-ci.org/github/linkedin/archetype/)
 [![Dependency Status](https://gemnasium.com/eoneill/archetype.svg)](https://gemnasium.com/eoneill/archetype)
 
 Archetype is a Compass/Sass based framework for authoring configurable, composable UI components and patterns.

data/VERSION

@@ -1 +1 @@
-1.0.0.alpha.4
+1.0.0.alpha.5

data/lib/archetype.rb

@@ -34,14 +34,18 @@ module Archetype
     Compass::Configuration.add_configuration_property(:memoize, "should the memoizer be used to improve compilation speed") do
       not (Compass.configuration.environment || :development).to_s.include?('dev')
     end
-    # meta
+    # archetype_meta
     Compass::Configuration.add_configuration_property(:archetype_meta, "any meta data you want made available to the environment") do
       {}
     end
-    # meta
-    Compass::Configuration.add_configuration_property(:styleguide_debug, "if true, detailed debugging is turned on for styleguide components") do
+    # styleguide_debug
+    Compass::Configuration.add_configuration_property(:styleguide_debug, "if `true`, detailed debugging is turned on for styleguide components") do
       false
     end
+    # styleguide_allow_missing
+    Compass::Configuration.add_configuration_property(:styleguide_allow_missing, "if `false`, will hard error on missing styleguide components, otherwise will throw a warning") do
+      true
+    end
   end
 
   def self.name

data/lib/archetype/functions/helpers.rb

@@ -19,7 +19,7 @@ module Archetype::Functions::Helpers
   # provides a convenience interface to the Compass::Logger
   #
   def self.logger
-    @logger ||= Compass::Logger.new
+    @logger ||= ::Compass::Logger.new
   end
 
   #
@@ -29,6 +29,14 @@ module Archetype::Functions::Helpers
     logger.record(:warning, msg)
   end
 
+  #
+  # provides a convenience interface for logging errors
+  #
+  def self.error(msg)
+    logger.record(:error, msg)
+    raise RuntimeError.new
+  end
+
   #
   # provides a convenience interface for logging debug messages
   # silently captures failures

data/lib/archetype/sass_extensions/functions/locale.rb

@@ -25,7 +25,6 @@ module Archetype::SassExtensions::Locale
       end
     end
     return Sass::Script::Bool.new(
-      locales.include?(locale) ||
       locales.include?("#{locale[:language]}_#{locale[:territory]}") ||
       locales.include?(locale[:language] + '_') ||
       locales.include?('_' + locale[:territory])

data/lib/archetype/sass_extensions/functions/styleguide/styles.rb

@@ -120,8 +120,10 @@ module Archetype::SassExtensions::Styleguide
         end
         styles = styles.rmerge(extracted)
       elsif not helpers.is_value(sentence, :nil)
+        severity = Compass.configuration.styleguide_allow_missing ? :warn : :error
         msg = modifiers.length > 0 ? "please specify one of: #{modifiers.sort.join(', ')}" : "there are no registered components"
-        helpers.warn("[#{Archetype.name}:styleguide:identifier] `#{helpers.to_str(sentence)}` does not contain an identifier. #{msg}")
+        msg = "[#{Archetype.name}:styleguide:identifier] `#{helpers.to_str(sentence)}` does not contain an identifier. #{msg}"
+        helpers.method(severity).call(msg)
       end
     end
 

data/lib/archetype/sass_extensions/functions/ui/scopes.rb

@@ -22,7 +22,7 @@ module Archetype::SassExtensions::UI::Scopes
     # otherwise, if the current value is different...
     elsif breakpoints[key] != value
       # throw a warning
-      helpers.warn("[#{Archetype.name}:breakpoint] a breakpoint for `#{key}` is already set to `#{breakpoints[key]}`, ignoring `#{value}`")
+      helpers.warn("[#{Archetype.name}:breakpoint:register] a breakpoint for `#{key}` is already set to `#{breakpoints[key]}`, ignoring `#{value}`")
       return bool(false)
     end
     environment.global_env.set_var('CONFIG_BREAKPOINTS', Sass::Script::Value::Map.new(breakpoints))
@@ -40,10 +40,44 @@ module Archetype::SassExtensions::UI::Scopes
   # - {*} the registered breakpoint
   #
   def get_breakpoint(key)
-    return registered_breakpoints[key] || null
+    if disabled_breakpoints.include?(key)
+      helpers.debug("[#{Archetype.name}:breakpoint:get] a breakpoint for `#{key}` was found, but is currently disabled (most likely with `toggle-breakpoint` or `disable-breakpoint`).")
+      return null
+    end
+    breakpoint = registered_breakpoints[key] || null
+    if breakpoint.nil? || helpers.is_null(breakpoint)
+      helpers.warn("[#{Archetype.name}:breakpoint:get] a breakpoint for `#{key}` was not found.")
+    end
+    return breakpoint
   end
   Sass::Script::Functions.declare :get_breakpoint, [:key]
 
+  #
+  # Enable a breakpoint.
+  #
+  # *Parameters*:
+  # - <tt>$key</tt> {String} the key to enable.
+  # *Returns*:
+  # - {Boolean} true, if the key is enabled successfully
+  #
+  def enable_breakpoint(key)
+    return toggle_breakpoint(key, true)
+  end
+  Sass::Script::Functions.declare :enable_breakpoint, [:key]
+
+  #
+  # Disable a breakpoint.
+  #
+  # *Parameters*:
+  # - <tt>$key</tt> {String} the key to disable.
+  # *Returns*:
+  # - {Boolean} true, if the key disabled successfully
+  #
+  def disable_breakpoint(key)
+    return toggle_breakpoint(key, false)
+  end
+  Sass::Script::Functions.declare :disable_breakpoint, [:key]
+
   #
   # convert a modifier/element context to a BEM style selector
   #
@@ -93,4 +127,36 @@ private
     breakpoints.respond_to?(:to_h) ? breakpoints.to_h : {}
   end
 
+  def disabled_breakpoints
+    breakpoints = environment.var('CONFIG_BREAKPOINTS_DISABLED')
+    breakpoints.respond_to?(:to_a) ? breakpoints.to_a : {}
+  end
+
+  # Enable or disable a breakpoint.
+  #
+  # *Parameters*:
+  # - <tt>$key</tt> {String} the key to enable or disable.
+  # - <tt>$toggle</tt> {Boolean} Set to true to enable the breakpoint. false to disable it.
+  # *Returns*:
+  # - {Boolean} true, if the disable or enable operation was successful.
+  #
+  def toggle_breakpoint(key, toggle)
+    friendly_method = toggle ? 'enable' : 'disable'
+    if registered_breakpoints[key].nil? || helpers.is_null(registered_breakpoints[key])
+      helpers.warn("[#{Archetype.name}:breakpoint:#{friendly_method}] a breakpoint for `#{key}` was not found.")
+      return bool(false)
+    end
+
+    method = toggle ? 'delete' : 'add'
+
+    # this will ensure that there aren't any duplicate keys
+    breakpoints = Set.new(disabled_breakpoints)
+    breakpoints.method(method).call(key)
+
+    breakpoints = Sass::Script::Value::List.new(breakpoints, :space)
+    environment.global_env.set_var('CONFIG_BREAKPOINTS_DISABLED', breakpoints)
+
+    return bool(true)
+  end
+
 end

data/lib/archetype/sass_extensions/functions/util/spacing.rb

@@ -36,6 +36,9 @@ module Archetype::SassExtensions::Util::Spacing
   #
   def _spacing(unit = null, direction = identifier(horizontal), abuse = bool(false))
     return null if helpers.is_null(unit)
+
+    return unit unless (unit.is_a?(Sass::Script::Value::Number) && unitless(unit).to_bool)
+
     unit = _archetype_integerize(unit, abuse)
     direction = helpers.to_str(direction) == 'vertical' ? 'VERTICAL' : 'HORIZONTAL'
     config = "CONFIG_#{direction}_SPACING"

data/stylesheets/archetype/config/_environment.scss

@@ -1,6 +1,6 @@
 // environment
 $CONFIG_DEBUG_ENVS:   (dev development) !default;                                       // environments to allow debug in
-$CONFIG_DEBUG:        (index($CONFIG_DEBUG_ENVS, archetype-env()) != false) !default;   // global debugging mode (enabled by default in $CONFIG_DEBUG_ENVS)
+$CONFIG_DEBUG:        (not not index($CONFIG_DEBUG_ENVS, archetype-env())) !default;   // global debugging mode (enabled by default in $CONFIG_DEBUG_ENVS)
 
 $CONFIG_LOCALE:       locale() !default;                                                // the default locale
 

data/stylesheets/archetype/ui/_breakpoints.scss

@@ -2,18 +2,26 @@
 
 // wraps the content block in a breakpoint media query
 // @mixin     breakpoint
-// @param     $key {String} the breakpoint to use
+// @param     $key... {String} the breakpoint(s) to use
 // @content
-@mixin breakpoint($key) {
-  $breakpoint: get-breakpoint($key);
-  @if $breakpoint {
-    @media #{$breakpoint} {
+@mixin breakpoint($key...) {
+  $breakpoints: ();
+
+  @each $name in $key {
+    $breakpoint: get-breakpoint($name);
+
+    // if we got a valid breakpoint, keep it...
+    @if $breakpoint {
+      $breakpoints: append($breakpoints, $breakpoint, comma);
+    }
+  }
+
+  // output all of our collected breakpoints
+  @if length($breakpoints) > 0 {
+    @media #{$breakpoints} {
       /* [archetype:breakpoint:begin] --- #{$key} --- */
       @content;
       /* [archetype:breakpoint:end] --- #{$key} --- */
     }
   }
-  @else {
-    @warn "[archetype:breakpoint] could not find a breakpoint for `#{$key}`";
-  }
 }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: archetype
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.4
+  version: 1.0.0.alpha.5
 platform: ruby
 authors:
 - Eugene ONeill
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2015-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: compass