archetype 0.0.1.pre.13 → 1.0.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d73c8fbdab53ce9a623ba9c8f8bfa25defd2dca3
-  data.tar.gz: bde34dc53d79e37772e9c1397509ffcdfb778f43
+  metadata.gz: c6a2fb81e863d967312ecbecbc7f3c5448b59c62
+  data.tar.gz: 0b6e44d73cafd433970965a671a2fa0c43c405bc
 SHA512:
-  metadata.gz: 367183d15630183a4e101f58b913a1c85028064a74b0cd269586157bf19818a39288ef0eaee64ffed617fe002653b3e245931fb9c94ca9f0bf3975c03fc3c22e
-  data.tar.gz: 892fb1fa496f0d55ec61fefbeef8404d35df8458034b8f8b5dd5983f5d1793c019e7fccb4cb9179aea7b77f1e992bdccd302c83926c47570aeeee247fa3ab202
+  metadata.gz: fc1349d999e060d49b2e94e4bd8abfe527e9bd6fff4b3ecfcc7c29c24698cf651ceeece94496347a4a230764ad43d41e3eb4d8c02fb32e4f3d649e92a9ca4e19
+  data.tar.gz: 16adc0073b1fec35365d4c55edd05dc677ef49959266675955a4c0f67bf469804f62214626223bbc74ce93c858952139d40be3c2541c2cc2b4b28af45a9767c8

data/CHANGELOG.md

@@ -1,33 +1,106 @@
 # Changelog
 
-## 0.0.1
+## 1.0.0.alpha.1 (unreleased)
 
-- initial public release
+### Resolved Issues:
+
+- support Sass 3.3.0 and Compass 1.0.0
+- `content` is no longer improperly quoted if not needed
+- fix for IE7 `:before` glyphs not being positioned correctly
+- fix for IE7 potentially crashing with `Operation Aborted` due to glyph injection
+
+### New Features:
+
+- added `$CONFIG_STATE_BEM` and `$CONFIG_BEM_MODIFIER_SEPARATOR` to generate [BEM style state selectors](http://bem.info/method/)
+- added `$CONFIG_BEM_ELEMENT_SEPARATOR` and `bem` mixin
+- added `bem-selector` function to help compute the BEM style selector for a context
+- added `str-replace` function for simple Sass::Script::Value::String replacements
+- added `$CONFIG_THEME_EXCLUDE` takes a list of components that will be excluded (not registered)
+- added `switch-locale` mixin to switch the interface locale
+- styleguides now support registering maps
+- `to-styles` now takes a map (but still supports a key-value paired list)
+- improved debugging messages generated by `styleguide` and `styleguide-diff`
+- `glyph-icons` mixin now supports multiple glyph libraries as well as multiple grid sizes via `$CONFIG_GLYPHS_LIBRARIES`
+- `glyph-icons` mixin now supports multiple glyph icons on one element
+- added `glyph-icons` function to help with retrieving glyph info (returned in a map for access)
+- added `$CONFIG_GLYPHS_OUTPUT_FALLBACK` config
+- added `archetype migrate` command line action to test for migration/back-compat issues
+- improved locale functionality, including
+  - support for more complex formats. e.g. `sr_SP@Cyrillic`
+  - new methods to extract a piece of a locale: `locale-language`, `locale-territory`, `locale-modifier`
+- added `derived-style` and `styleguide-derived-style` for extracting individual style rules from maps of styles or styleguide components
+- improved memoizer scheme with option for `:aggressive` memoizing
+- added `-archetype-list` to mimic the deprecated `-compass-list`
+- added `$CONFIG_NAMESPACE` to allow namespacing global generated CSS (keyframes, font-face, etc)
+- added `high-resolution` mixin for scoping high resolution (HiDPI / retina) code
+- added `resolution-to-*` functions for converting between various resolution types (ratio, dppx, dpi, dpcm)
+  - `resolution_to_x`, `resolution-to-ratio`, `resolution-to-dppx`, `resolution-to-dpi`, `resolution-to-dpcm`
+- added `to-fraction` function for converting a decimal number to a fractional representation (e.g. `1.5` -> `3/2`)
+- added `list-join` function for joining a list into a string
+- added `archetype-meta` function to retrieve values set on `$CONFIG_META` or `Compass.configuration.archetype_meta`
+- added `register-breakpoint` and `get-breakpoint` functions for registering / retrieving breakpoint definitions
+- added `breakpoint` mixin for creating breakpoint media queries
+- added `switch-locale` function to assist switching locale states
+- added helper functions for working with Archetype modules: `register-archetype-module`, `has-archetype-modules`, `require-archetype-modules`
+- added `runtime-locale-value` for decorating a map so we can compute it's value respective to the locale at runtime (better support for `switch-locale`)
+  - e.g. `runtime-locale-value((default: a, en_US: b, ru_RU: c, ...))`
+- added `get-runtime-locale-value` for selecting the value based on the current locale. this should be in conjunction with `runtime-locale-value`
+- added `register-glyph-library`, `get-glyph-library`, and `get-all-glyph-libraries` functions for registering / retrieving glyph icon libraries
+- added `before` and `after` mixins to ease the pain in styling `:before` and `:after` elements cross-browser
+- allow `target-browser` and `target-os` to accept a map of property-value pairs
+
+### Major Changes:
+
+- dropped support for older versions of Sass/Compass (sorry, can't pass up the new feature set)
+- removed `gradient-with-deg` mixin
+- removed `_isLegacySupported` function
+- `inline-block` in styleguide component has changed syntax to take proper arguments
+- dropped `gradient` from supported keywords in styleguide components (use `background-image` instead)
+- `$CORE_STATE_MAPPINGS` and `$CONFIG_STATE_MAPPINGS` are now proper Sass maps
+- `styleguide` function now has the same signature as the mixin and can take multiple definitions at once
+- `styleguide-diff` now takes two `styleguide` results as params
+- removed `testing` configuration, instead check for `defined?(ArchetypeTestHelpers)`
+- removed `$CONFIG_GLYPHS_NAME`, `$CONFIG_GLYPHS_VERSION`, `$CONFIG_GLYPHS_SVG_ID`, `$CONFIG_GLYPHS_BASE_PATH`, `$CONFIG_GLYPHS_EOT`, `$CONFIG_GLYPHS_FILES`, `$CONFIG_GLYPHS_THRESHOLD`, `$CORE_GLYPHS_MAPPINGS`, `$CONFIG_GLYPHS_MAPPINGS` and instead merged these configs into `$CORE_GLYPHS_LIBRARIES` and `$CONFIG_GLYPHS_LIBRARIES`
+- removed all RTL functions
+- `styleguide-sprite*` and `styleguide-image*` functions have been replaced with private methods (`-archetype-sprite*`, `-archetype-image*`)
+- ported many functions to ruby instead of defined as Sass user functions
+- glyph icon mappings now take a map (optionally) of format `(char: characterCode, size: defaultSize)` (note that the previous list support is now deprecated)
+- Archetype has now been split into smaller projects
+  - the core will provide the most widely used functions/mixins with much opinion on your generated CSS
+  - things that are more specialized, opinionated, or heavy-handed have been moved to extensions, these extensions currently include:
+    - `archetype-grid`
+    - `archetype-theme`
+    - `archetype-base`
+      - `archetype-base-h5bp`
+      - `archetype-base-normalize`
+      - `archetype-base-reset`
+      - `archetype-base-hybrid`
+  - the goal of this split is to provide consumers with the most useful and non-intrusive features upfront while still offering (via extension) the robustness we've already built
 
 ## 0.0.1.pre.3 (pre-released)
 
 ### New Features:
 
-- added `styleguide-component-exists()` method to check if a component/extension has already been registered in the theme
+- added `styleguide-component-exists` method to check if a component/extension has already been registered in the theme
 - added `memoize` compiler configuration to allow enabling/disabling the internal styleguide memoizer
-- `glyph-icon()` can now take `false` as an icon name and not output anything
-- added `unstyled-button()` method to remove default styling from a `<button>` element
-- added `prefixed-tag()` method for consistency when generating tag names
+- `glyph-icon` can now take `false` as an icon name and not output anything
+- added `unstyled-button` method to remove default styling from a `<button>` element
+- added `prefixed-tag` method for consistency when generating tag names
 - added Chinese font stacks
-- added wildcard support to `locale()` function (e.g. `locale(en_ ja_JP _DE)`)
-- added `transparent-focusable()` mixin for transparent background support in older IE
-- added ability to customize `output-style()` with `custom-output-styler()` mixin and `has-custom-output-styler()` function (NEEDS DOCUMENTATION)
-- added better support for targeting IE6/7 glyphs and `ie-pseudo()` generated elements (NEEDS DOCUMENTATION)
-- making `unique()` generated IDs genuinely unique
-- adding support for a `testing` config flag
-- adding support for `@extend` from a styleguide component
+- added wildcard support to `locale` function (e.g. `locale(en_ ja_JP _DE)`)
+- added `transparent-focusable` mixin for transparent background support in older IE
+- added ability to customize `output-style` with `custom-output-styler` mixin and `has-custom-output-styler` function (NEEDS DOCUMENTATION)
+- added better support for targeting IE6/7 glyphs and `ie-pseudo` generated elements (NEEDS DOCUMENTATION)
+- made `unique` generated IDs genuinely unique
+- added support for a `testing` config flag
+- added support for `@extend` from a styleguide component
 
 ### Resolved Issues:
 
-- quotes on strings passed to `associative()` weren't being stripped correctly
+- quotes on strings passed to `associative` weren't being stripped correctly
 - fixed some minor glyph issues
 - out-of-order CSS issues in Ruby 1.8.7 are fixed using `Hashery::OrderedHash`
-- fixed issue with `archetype-version()` incorrectly matching comparators
+- fixed issue with `archetype-version` incorrectly matching comparators
 
 ### Tests:
 
@@ -45,10 +118,10 @@
 - added support for `drop` and `styleguide` keywords in components
   - `drop` allows you to drop previously defined styles within a component definition (e.g. if you need to remove defaults)
   - `styleguide` in a component definition will insert the derived styles from a styleguide() call. this allows you to share styles between components
-- added `styleguide-diff()` method
-- added `ie-pseudo()` methods to support dynamically generating pseudo :before and :after elements (using expressions)
-- added `stroke()` mixin to create a stroke line around text (or font icon)
-- added `hide-element()` mixin to hide elements from screen but keep them screen-reader accessible
+- added `styleguide-diff` method
+- added `ie-pseudo` methods to support dynamically generating pseudo :before and :after elements (using expressions)
+- added `stroke` mixin to create a stroke line around text (or font icon)
+- added `hide-element` mixin to hide elements from screen but keep them screen-reader accessible
 - added basic support for fallback CSS values (e.g. border: red; border: rgba(255,0,0, 0.8);)
 - added `$CONFIG_STATE_MAPPINGS` to simplify the mapping between state names and selectors
 
@@ -56,13 +129,13 @@
 
 - loading spinners now use CSS3 animations and require some integration work
 - updated default vertical/horizontal spacing to 5px
-- `list-extend()` is now `associative-merge()`
+- `list-extend` is now `associative-merge`
 
 ### Resolved Issues:
 
 - nested inheritance would get corrupted (due to a volatile context being passed along)
 - `$exclude` in `to-styles` wasn't taking a list of keys cleanly
-- `font-family()` and `lang()` weren't respecting locale aliases
+- `font-family` and `lang` weren't respecting locale aliases
 - fixed thread safety issues
 
 ### Documentation:
@@ -75,15 +148,15 @@
 
 ### New Features:
 
-- `styleguide-add-component()`, `styleguide-extend-component()`, and `styleguide()` now take a `$theme` parameter
+- `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`
 - theme components are cached
-- `styleguide()` calls are memoized
+- `styleguide` calls are memoized
 
 ### Major Changes:
 
-- `filter()` mixin is now `ie-filter()` to prevent conflicts with Compass' `filter()` mixin
+- `filter` mixin is now `ie-filter` to prevent conflicts with Compass' `filter` mixin
 - Compass overrides are no longer loaded as Archetype core
 
 ### Resolved Issues:

data/README.md

@@ -1,8 +1,10 @@
 # Archetype
 
-[![Build Status](https://travis-ci.org/linkedin/archetype.png)](https://travis-ci.org/linkedin/archetype) [![Gem Version](https://badge.fury.io/rb/archetype.png)](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)
+[![Dependency Status](https://gemnasium.com/eoneill/archetype.svg)](https://gemnasium.com/eoneill/archetype)
 
-Archetype is a UI pattern and component library for quickly iterating on and maintaining scalable web interfaces.
+Archetype is a Compass/Sass based framework for authoring configurable, composable UI components and patterns.
+The natural language syntax that Archetype provides allows your designers and developers to discuss UI compositions using the same vocabulary.
 
 ## Resources
 
@@ -15,11 +17,15 @@ Archetype is a UI pattern and component library for quickly iterating on and mai
 - [Discussion](https://github.com/eoneill/archetype/issues)
 - [Archetype configuration](http://www.archetypecss.com/documentation/configuration/)
 
+## Developing Archetype
+
+If you're looking to contribute to Archetype, check out the [CONTRIBUTING](CONTRIBUTING.md) article.
+
 ## Installation
 
 ### Install the gem
 
-```bash
+```sh
 [sudo] gem install archetype --pre
 ```
 
@@ -27,7 +33,7 @@ Instead of installing the gem directly via the command line, we recommend using
 
 ### Creating a new project with Archetype
 
-```bash
+```sh
 compass create ~/workspace/your-project -r archetype --using archetype
 ```
 
@@ -82,6 +88,6 @@ This project couldn't have been made possible without the amazing work by the fo
 
 - Dave Gandy for his awesome work on [FontAwesome](http://fortawesome.github.com/Font-Awesome/)
 - Chris Eppstein and other contributors of [Compass](http://compass-style.org/) for building an amazing framework, and for some great scaffolding code we've _borrowed_
-- Nathan Weizenbaum and contributors for [making CSS fun again](http://sass-lang.com/)
+- Hampton Catlin, Nathan Weizenbaum, Chris Eppstein and contributors for [making CSS fun again](http://sass-lang.com/)
 - Nicolas Gallagher and Jonathan Neal for some [Normalize.css](https://github.com/necolas/normalize.css) greatness
 - Nicolas Gallagher, Jonathan Neal, Kroc Camen, Paul Irish, and others for [HTML5 Boilerplate](http://html5boilerplate.com/)

data/VERSION

@@ -0,0 +1 @@
+1.0.0.alpha.1

data/lib/archetype.rb

@@ -4,26 +4,27 @@ require 'compass'
 # Initialize Archetype and register it as a Compass extension
 #
 module Archetype
-  # extension info
-  @archetype = {}
-  @archetype[:name] = 'archetype'
-  @archetype[:path] = File.expand_path(File.join(File.dirname(__FILE__), ".."))
-  # register the extension
-  def self.register
-    Compass::Frameworks.register(@archetype[:name], :path => @archetype[:path])
-  end
+  NAME = 'archetype'
+
+  # info
+  @archetype = {
+    :name => NAME,
+    :path => File.expand_path(File.join(File.dirname(__FILE__), ".."))
+  }
+
   # initialize Archetype
   def self.init
-    # register it
-    self.register
-    # setup configs
+    ## register it
+    register
+
+    ## setup configs
     # locale
     Compass::Configuration.add_configuration_property(:locale, "the user locale") do
       'en_US'
     end
-    # reading direction (ltr|rtl)
-    Compass::Configuration.add_configuration_property(:reading, "the user interface reading direction") do
-      'ltr'
+    # locale_aliases
+    Compass::Configuration.add_configuration_property(:locale_aliases, "a mapping of locale name aliases") do
+      {}
     end
     # environment
     Compass::Configuration.add_configuration_property(:environment, "current environment") do
@@ -33,17 +34,28 @@ 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
-    # testing (for running unit tests)
-    Compass::Configuration.add_configuration_property(:testing, "is this a testing environment") do
-      ENV['CI']
+    # meta
+    Compass::Configuration.add_configuration_property(:archetype_meta, "any meta data you want made available to the environment") do
+      {}
     end
   end
+
+  def self.name
+    NAME
+  end
+
+  private
+
+  ## register as a Compass extension
+  def self.register
+    Compass::Frameworks.register(NAME, :path => @archetype[:path]);
+  end
 end
 
 # init
 Archetype.init
 
 # load dependencies
-%w(functions sass_extensions).each do |lib|
+%w(extensions functions sass_extensions).each do |lib|
   require "archetype/#{lib}"
 end

data/lib/archetype/actions/migrate.rb

@@ -0,0 +1,152 @@
+description = "Check a set of files for migration and back-compat issues"
+if @description.nil?
+  DELIMITER = "\n  "
+  DATA = {
+    '1.0.0.alpha.1' => {
+      :notice => %q{Archetype now requires Sass 3.3+ and Compass 0.13+},
+      :tests => {
+        :sacss => [
+          {
+            :pattern => /(gradient[_-]with[_-]deg|[_-]isLegacySupported)/m,
+            :message => 'mixin or function `$1` has been removed'
+          },
+          {
+            :pattern => /(?:\@include\s+|\+)(wrapper[_-]rtl|(?:padding|margin)(?:[_-](?:top|right|bottom|left))?|border(?:[_-](?:top|right|bottom|left))?[_-](?:width|color|style)|clear|float|text[_-]align|left|right|background[_-]position)\s*\(([^\)]*)/m,
+            :message => 'the RTL mixin `$1` has been deprecated, just use `$1: $2`'
+          },
+          {
+            :pattern => /(?:\@include\s+|\+)wrapper[_-]rtl/m,
+            :message => 'the RTL mixin `wrapper-rtl` has been deprecated'
+          },
+          {
+            :pattern => /[\:\s\(\{](rtl|reading[_-]direction)\s*\(/m,
+            :message => 'the RTL function `$1()` has been deprecated'
+          },
+          {
+            :pattern => /(?:styleguide[_-](?:add|extend)[_-]component)[^\;]*(inline-block)(?:\s+|\:)true/m,
+            :message => '`inline-block` has changed syntax within a styleguide component'
+          },
+          {
+            :pattern => /(?:styleguide[_-](?:add|extend)[_-]component)[^\;]*\s+\(?(gradient)(?:\s|\:)/m,
+            :message => 'use `background-image` instead of `$1` within your styleguide component'
+          },
+          {
+            :pattern => /(\$CONFIG_(?:STATE_MAPPINGS|BROWSER_VENDORS_HACK|OS_VENDORS_CLASS|SAFE_FONTS|LOADERS))\s*\:\s*\(\s*[^\:]+\s*\)(?: \!default)?\;/m,
+            :message => '`$1` is now a map structure instead of lists'
+          },
+          {
+            :pattern => /(?:(?:nth(?:-cyclic)?|associative)\s*\(\s*)(\$CONFIG_(?:STATE_MAPPINGS|BROWSER_VENDORS_HACK|OS_VENDORS_CLASS|SAFE_FONTS|LOADERS))/m,
+            :message => '`$1` is now a map structure instead of lists'
+          },
+          {
+            :pattern => /(\$CONFIG_GLYPHS_(?:NAME|VERSION|SVG_ID|BASE_PATH|EOT|FILES|THRESHOLD|MAPPINGS))/m,
+            :message => '`$1` is deprecated, use `register-glyph-library()` instead'
+          },
+          {
+            :pattern => /(\$CONFIG_GRID_DIRECTION)/m,
+            :message => '`$1` is deprecated'
+          },
+          {
+            :pattern => /(styleguide[_-]((?:sprite|image)(?:[_-][a-z]+)?))/m,
+            :message => '`$1` has been replaced with `-archetype-$2`'
+          },
+          {
+            :pattern => /(\$CONFIG_(?:KEYFRAMES|GLYPHS)_AUTO)/m,
+            :message => '`$1` has been deprecated, use `$CONFIG_RESET_AUTO` instead'
+          }
+        ],
+        :rb => [],
+        :scss => [],
+        :sass => []
+      }
+    }
+  }
+
+  options = {
+    :from => ''
+  }
+  OptionParser.new do |opts|
+    opts.banner = description
+    opts.define_head "Usage: #{Archetype.name} migrate [path] [options]"
+    opts.separator ""
+    opts.separator "Example usage:"
+    opts.separator " archetype migrate /path/to/scss/ --from=0.0.1.alpha"
+
+    opts.on('-f', '--from VERSION', 'Archetype version migrating from') do |v|
+      options[:from] = v
+    end
+
+    opts.on('-h', '--help', 'shows this help message') do
+      puts opts
+      exit
+    end
+
+    if not @help.nil?
+      puts opts
+      exit
+    end
+  end.parse!
+
+  base = ARGV[1] || '.'
+  count = 0
+  files = {}
+  DATA.each do |version, obj|
+    if version > options[:from]
+      messages = []
+      messages << obj[:notice] if not obj[:notice].nil?
+      obj[:tests].each do |category, tests|
+        if not tests.nil? and not tests.empty?
+          ext = case category
+          when :rb
+            '.rb'
+          when :sass
+            '.sass'
+          when :scss
+            '.scss'
+          when :all
+            ''
+          else
+            '.s[ac]ss'
+          end
+
+          Dir.glob(File.join(base, '**', "*#{ext}")) do |file|
+            contents = files[file]
+            message = []
+
+            tests.each do |test|
+              if contents.nil?
+                contents = ''
+                File.readlines(file).select do |line|
+                  # strip off the comments and push it onto the contents
+                  contents << line.gsub(/\s*((\/\/.*)|(\/\*(?!\*\/)?\*\/))/, '')
+                end
+                # cache the contents so we don't have to read it in again
+                files[file] = contents
+              end
+
+              if contents =~ test[:pattern]
+                contents.scan(test[:pattern]).each do |match|
+                  message << test[:message].gsub(/\$1/, match[0] || '').gsub(/\$2/, match[1] || '')
+                  count += 1
+                end
+              end
+
+            end
+
+            messages << "#{file}:#{DELIMITER}#{message.join(DELIMITER)}" unless message.empty?
+          end
+        end
+      end
+      puts "#{'='*20}\nv#{version}\n#{'-'*20}\n#{messages.join("\n\n")}" unless messages.empty?
+    end
+  end
+
+  if count > 0
+    puts "\n#{count} backward compatibility issue#{count > 1 ? 's' : ''} found!"
+  else
+    puts "\neverything else looks good!"
+  end
+  exit
+else
+  @description = description
+end