archetype 0.0.1.pre.1 → 0.0.1.pre.3.00dfd9a

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97c23e2750bc27861f4602ddb1c1a80f48a172b8
+  data.tar.gz: fe2470feea0f4c8ae90db32247c4b1a8159400ba
+SHA512:
+  metadata.gz: 0125375a83db183fe5f903730204110f0d77073f509696392a5ab91bee052f27e72e6539b16f567102de3be5a9c1106f35d56f6a7198eb92453407d771aa6721
+  data.tar.gz: d53907489ca4c58266946c2ee08eb49e93f11a4a124c41d7ffba53cf920958c70e6281be8db0e8c13f683759926e710161537d86b74fec367ed15da3358d297f

data/CHANGELOG.md

@@ -0,0 +1,88 @@
+# Changelog
+
+## 0.0.1
+
+- initial public release
+
+## 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 `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
+- added Chinese font stacks
+- added wildcard support to `locale()` function (e.g. `locale(en_ ja_JP _DE)`)
+
+### Resolved Issues:
+
+- 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`
+
+### Tests:
+
+- added test case for fallback CSS properties
+- added test case for generating loading spinner keyframe animations
+- updated test cases for minor changes
+
+## 0.0.1.pre.2 (unreleased)
+
+### New Features:
+
+- added HTML5 Boilerplate reset
+- updated normalize to 2.0.1
+- added support for selective states in `styleguide` calls (e.g. styleguide(large primary button, $state: disabled))
+- 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 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
+
+### Major Changes:
+
+- loading spinners now use CSS3 animations and require some integration work
+- updated default vertical/horizontal spacing to 5px
+- `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
+- fixed thread safety issues
+
+### Documentation:
+
+- updated README to be a bit friendlier
+- added CONTRIBUTING
+- added RDoc documentation to source
+
+## 0.0.1.pre.1 (unreleased)
+
+### New Features:
+
+- `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
+
+### Major Changes:
+
+- `filter()` mixin is now `ie-filter()` to prevent conflicts with Compass' `filter()` mixin
+- Compass overrides are no longer loaded as Archetype core
+
+### Resolved Issues:
+
+- no known issues to resolve
+
+### Documentation:
+
+- added README

data/LICENSE

@@ -0,0 +1,16 @@
+Archetype
+Copyright (c) 2013 LinkedIn Corp.  All rights reserved.
+Apache Software License 2.0
+
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -1 +1,87 @@
-placeholder
+# Archetype
+
+[![Build Status](https://travis-ci.org/linkedin/archetype.png)](https://travis-ci.org/linkedin/archetype)
+
+Archetype is a UI pattern and component library for quickly iterating on and maintaining scalable web interfaces.
+
+## Resources
+
+- [Archetype Homepage](http://www.archetypecss.com/)
+- [Documentation](http://www.archetypecss.com/documentation/)
+- [Components](http://www.archetypecss.com/components/)
+- [Tutorials](http://www.archetypecss.com/tutorials/)
+- [Blog](http://www.archetypecss.com/blog/)
+- [Add-ons](http://www.archetypecss.com/addons/)
+- [Discussion](https://github.com/eoneill/archetype/issues)
+- [Archetype configuration](http://www.archetypecss.com/documentation/configuration/)
+
+## Installation
+
+### Install the gem
+
+```bash
+[sudo] gem install archetype --pre
+```
+
+Instead of installing the gem directly via the command line, we recommend using [Bundler](http://gembundler.com/) to manage your gem dependencies.
+
+### Creating a new project with Archetype
+
+```bash
+compass create ~/workspace/your-project -r archetype --using archetype
+```
+
+### Adding Archetype to an existing Compass project
+
+In your `config.rb`, add
+
+```ruby
+require "archetype"
+```
+
+### Import Archetype into your Sass file
+
+```sass
+@import "archetype";
+```
+
+Learn more about [Archetype configuration](http://www.archetypecss.com/documentation/configuration/).
+
+## Credits
+
+### Author
+
+Archetype was originally written by [Eugene O'Neill](http://www.linkedin.com/in/eugeneoneill).
+
+### Inspiration
+
+- [Styleguides for the Web](http://paulrobertlloyd.com/2010/12/styleguides_for_the_web/)
+- [BBC Global Experience Language](http://www.bbc.co.uk/gel)
+- [Our Living Style Guide (Writing maintainable HTML/CSS)](http://blog.rjmetrics.com/our-living-style-guide-writing-maintainable-htmlcss/)
+- [The Fight for a Living Style Guide](http://www.mapletonhillmedia.com/the-fight-for-a-living-style-guide/)
+- [Anchoring Your Design Language in a Live Style Guide ](http://uxmag.com/articles/anchoring-your-design-language-in-a-live-style-guide)
+- [Unifying Agile and UX with Live Style Guides](https://speakerdeck.com/u/thoughtmerchant/p/unifying-agile-and-ux-with-live-style-guides)
+- [Twitter Bootstrap](http://twitter.github.com/bootstrap/)
+- [ZURB Foundation](http://foundation.zurb.com/)
+
+### Special Thanks
+
+- [Johnathan Leppert](http://www.linkedin.com/in/jleppert)
+- [Jakob Heuser](http://www.felocity.com/)
+- [David Delo](http://www.linkedin.com/in/daviddelo)
+- [Robert Martone](http://www.linkedin.com/in/robertmartone)
+- [Sean Sands](http://www.linkedin.com/in/snds117)
+- [Chris Eppstein](http://chriseppstein.github.com/)
+- [LinkedIn](http://www.linkedin.com/)
+- [Compass](http://compass-style.org/)
+- [Sass](http://sass-lang.com/)
+
+### Acknowledgements
+
+This project couldn't have been made possible without the amazing work by the following heroes:
+
+- 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/)
+- 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.yml

@@ -0,0 +1,6 @@
+---
+:major: 0
+:minor: 0
+:build: 1
+:state: pre
+:iteration: 3

data/lib/README.rdoc

@@ -0,0 +1,4 @@
+= Archetype UI pattern and component library
+
+Archetype is a feature rich, front-end development framework built
+on top of Compass and Sass.

data/lib/archetype.rb

@@ -0,0 +1,45 @@
+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
+  # initialize Archetype
+  def self.init
+    # register it
+    self.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'
+    end
+    # environment
+    Compass::Configuration.add_configuration_property(:environment, "current environment") do
+      :development
+    end
+    # memoize
+    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
+  end
+end
+
+# init
+Archetype.init
+
+# load dependencies
+%w(functions sass_extensions).each do |lib|
+  require "archetype/#{lib}"
+end

data/lib/archetype/functions.rb

@@ -0,0 +1,9 @@
+# :stopdoc:
+# Load necessary functions.
+#
+module Archetype::Functions
+end
+
+%w(hash helpers styleguide_memoizer).each do |dep|
+  require "archetype/functions/#{dep}"
+end

data/lib/archetype/functions/hash.rb

@@ -0,0 +1,149 @@
+# :stopdoc:
+# This module extends the native Ruby Hash class to support deep merging
+# and comparing the difference between hashes.
+# This functionality mimics that found in ActiveSupport
+# @see https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+#
+module Archetype::Functions::Hash
+  #
+  # recursively merge two hashes with deep merging
+  #
+  # *Parameters*:
+  # - +other_hash+ {Hash} the other hash to merge with
+  # *Returns*:
+  # - {Hash} a new hash containing the contents of other_hash and the contents of hsh, deep merged
+  #
+  def rmerge(other_hash, &block)
+    dup.rmerge!(other_hash, &block)
+  end
+
+  #
+  # adds the contents of other_hash to hsh, deep merged
+  #
+  # *Parameters*:
+  # - +other_hash+ {Hash} the other hash to merge with
+  # *Returns*:
+  # - {Hash} the original hash with the addition of the contents of other_hash
+  #
+  def rmerge!(other_hash, &block)
+    other_hash.each_pair do |k,v|
+      tv = self[k]
+      if tv.is_a?(Hash) && v.is_a?(Hash)
+        self[k] = tv.rmerge(v, &block)
+      else
+        self[k] = block && tv ? block.call(k, tv, v) : v
+      end
+    end
+    return self
+  end
+
+  #
+  # get the difference of another hash
+  #
+  # *Parameters*:
+  # - +other_hash+ {Hash} the other hash to compare against
+  # *Returns*:
+  # - {Hash} a representation of the difference between the two hashes
+  #
+  def diff(other_hash)
+    (self.keys + other_hash.keys).uniq.inject(Archetype::Hash.new) do |tmp, key|
+      # special comparison for gradients
+      are_gradients = self[key].is_a?(Compass::SassExtensions::Functions::GradientSupport::LinearGradient) and other_hash[key].is_a?(Compass::SassExtensions::Functions::GradientSupport::LinearGradient)
+      eq_gradients = are_gradients ? (self[key].to_s == other_hash[key].to_s) : true
+      unless self[key] == other_hash[key] and eq_gradients
+        if self[key].kind_of?(Hash) && other_hash[key].kind_of?(Hash)
+          tmp[key] = self[key].diff(other_hash[key])
+        else
+          tmp[key] = other_hash[key] || css_defaults(key)
+          # if the key is `filter-gradient` and it was removed, we need to change the key to `ie-filter`
+          tmp['ie-filter'] = css_defaults('ie-filter') if key == 'filter-gradient' and tmp[key].nil?
+          # if it came back as `nil` we couldn't understand it or it has no default, so axe it
+          tmp.delete(key) if tmp[key].nil?
+        end
+      end
+      tmp
+    end
+  end
+
+private
+  #
+  # returns a best guess for the default CSS value of a given property
+  #
+  # *Parameters*:
+  # - <tt>key</tt> {String} the property to lookup
+  # *Returns*:
+  # - {Sass::String|Sass::Number} the default value
+  #
+  def css_defaults(key)
+    if @css_defaults.nil?
+      s = {}
+      # color
+      s['color'] = 'inherit'
+      # text
+      s['font'] = s['font-size'] = s['font-family'] = s['font-style'] = s['font-variant'] = s['font-weight'] = 'inherit'
+      s['text-decoration'] = s['text-transform'] = 'none'
+      s['text-align'] = 'left'
+      s['text-indent'] = 0
+      s['text-justify'] = 'auto'
+      s['text-overflow'] = 'clip'
+      s['line-height'] = 'normal'
+      # backgrounds
+      s['background'] = 'none'
+      s['background-color'] = 'transparent'
+      s['background-image'] = 'none'
+      s['background-repeat'] = 'repeat'
+      s['background-position'] = 'left top'
+      s['background-attachment'] = 'scroll'
+      s['background-clip'] = 'border-box'
+      s['background-size'] = 'auto'
+      s['background-origin'] = 'padding-box'
+      # borders
+      s['border'] = s['border-top'] = s['border-left'] = s['border-bottom'] = s['border-right'] = 'none'
+      s['border-color'] = s['border-top-color'] = s['border-left-color'] = s['border-bottom-color'] = s['border-right-color'] = 'transparent'
+      s['border-width'] = s['border-top-width'] = s['border-left-width'] = s['border-bottom-width'] = s['border-right-width'] = 0
+      s['border-style'] = s['border-top-style'] = s['border-left-style'] = s['border-bottom-style'] = s['border-right-style'] = 'solid'
+      # border-radius
+      s['border-radius'] = s['border-top-left-radius'] = s['border-top-right-radius'] = s['border-bottom-left-radius'] = s['border-bottom-right-radius'] = 0
+      # margin
+      s['margin'] = s['margin-top'] = s['margin-left'] = s['margin-bottom'] = s['margin-right'] = 0
+      # padding
+      s['padding'] = s['padding-top'] = s['padding-left'] = s['padding-bottom'] = s['padding-right'] = 0
+      # shadows
+      s['text-shadow'] = s['box-shadow'] = 'none'
+      # width/height
+      s['height'] = s['width'] = 'auto'
+      s['min-width'] = s['max-width'] = s['min-height'] = s['max-height'] = 'none'
+      # position
+      s['position'] = 'static'
+      s['top'] = s['right'] = s['bottom'] = s['left'] = 'auto'
+      s['clear'] = s['float'] = 'none'
+      # misc
+      s['overflow'] = 'visible'
+      s['opacity'] = 1
+      s['visibility'] = 'visible'
+      s['ie-filter'] = 'gradient(enabled=false)'
+      s['z-index'] = 0
+      # --------------------
+      @css_defaults = s
+    end
+    value = @css_defaults[key]
+    value = Sass::Script::String.new(value) if value.is_a? String
+    value = Sass::Script::Number.new(value) if value.is_a? Numeric
+    return value
+  end
+end
+
+# this shims the Hash functionality to ensure we have an ordered hash guarantee
+module Archetype
+  if RUBY_VERSION < '1.9'
+    require 'hashery/ordered_hash'
+    class Hash < Hashery::OrderedHash
+      include Archetype::Functions::Hash
+    end
+  else
+    class Hash < ::Hash
+      include Archetype::Functions::Hash
+    end
+  end
+end
+

data/lib/archetype/functions/helpers.rb

@@ -0,0 +1,125 @@
+# :stopdoc:
+# This module provides a set of helper functions and methods for working with Sass literals.
+#
+module Archetype::Functions::Helpers
+private
+
+  #
+  # provides a convenience interface to the Compass::Logger
+  #
+  def self.logger
+    @logger ||= Compass::Logger.new
+  end
+
+  #
+  # convert a Hash to a Sass::List
+  #
+  # *Parameters*:
+  # - <tt>hsh</tt> {Hash} the hash to convert
+  # - <tt>depth</tt> {Integer} the depth to walk down into the hash
+  # - <tt>separator</tt> {Symbol} the separator to use for the Sass::List
+  # *Returns*:
+  # - {Sass::List} the converted list
+  #
+  def self.hash_to_list(hsh, depth = 0, separator = :comma)
+    if hsh.is_a? Hash
+      list = []
+      hsh.each do |key, item|
+        item = [key, item]
+        # if its a hash, convert it to a List
+        if item.is_a? Hash or item.is_a? Array
+          tmp = []
+          item[1] = [item[1]] if not item[1].is_a? Array
+          item[1].each do |i|
+            list.push Sass::Script::List.new([Sass::Script::String.new(item[0]), hash_to_list(i, depth + 1)], separator)
+          end
+        end
+      end
+      return Sass::Script::List.new(list, separator)
+    end
+    # if its an array, cast to a List
+    return Sass::Script::List.new(hsh, separator) if hsh.is_a? Array
+    # otherwise just return it
+    return hsh
+  end
+
+  #
+  # convert a Sass::List to a Hash
+  #
+  # *Parameters*:
+  # - <tt>list</tt> {Sass::List} the list to convert
+  # - <tt>depth</tt> {Integer} the depth to reach into nested Lists
+  # - <tt>nest</tt> {Array} a list of keys to treat as nested objects
+  # *Returns*:
+  # - {Hash} the converted hash
+  #
+  def self.list_to_hash(list, depth = 0, nest = [], additives = [])
+    list = list.to_a
+    hsh = Archetype::Hash.new
+    list.each do |item|
+      item = item.to_a
+      # convert the key to a string and strip off quotes
+      key = to_str(item[0], ' ' , :quotes)
+      value = item[1]
+      if key != 'nil'
+        # check if if it's a nesting hash
+        nested = nest.include?(key)
+        # if it's nested or we haven't reached out depth, recurse
+        if nested or depth > 0
+          value = list_to_hash(value, nested ? depth + 1 : depth - 1, nest, additives)
+        end
+        # update the hash key
+        if not is_value(value, :blank)
+          if additives.include?(key)
+            hsh[key] ||= []
+            hsh[key].push(value)
+          else
+            hsh[key] = value
+          end
+        end
+      end
+    end
+    return hsh
+  end
+
+  #
+  # convert things to a String
+  #
+  # *Parameters*:
+  # - <tt>value</tt> {String|Sass::String|Sass::List} the thing to convert
+  # - <tt>separator</tt> {String} the separator to use for joining Sass::List
+  # *Returns*:
+  # - {String} the converted String
+  #
+  def self.to_str(value, separator = ' ', strip = nil)
+    value = value.is_a?(String) ? value : ((value.to_a).each{ |i| i.is_a?(String) ? i : i.value }).join(separator || '')
+    strip = /\A"|"\Z/ if strip == :quotes
+    return strip.nil? ? value : value.gsub(strip, '')
+  end
+
+  #
+  # test a value for blankness or nilness
+  #
+  # *Parameters*:
+  # - <tt>value</tt> {String|Array|Sass::String|Sass::List} the thing to test
+  # - <tt>test</tt> {Symbol} the test to perform [:blank|:nil]
+  # *Returns*:
+  # - {Boolean} whether or not the value is nil/blank
+  #
+  def self.is_value(value, test = :nil)
+    is_it = nil
+    case test
+    when :blank
+      is_it = false
+      value = value.value if value.is_a?(Sass::Script::String)
+      is_it = value.empty? if value.is_a?(String)
+      is_it = value.to_a.empty? if value.is_a?(Sass::Script::List) or value.is_a?(Array)
+    when :nil
+      is_it = false
+      value = value.value if value.is_a?(Sass::Script::String)
+      is_it = value == 'nil' if value.is_a?(String)
+      is_it = to_str(value) == 'nil' if value.is_a?(Sass::Script::List) or value.is_a?(Array)
+    end
+    return is_it
+  end
+end