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

data/lib/archetype/actions/theme.rb

@@ -1,17 +1,16 @@
-require 'fileutils'
 description = "Generate a new Archetype theme"
 
 if @description.nil?
   options = {
-    :extends => 'archetype'
+    :extends => Archetype.name
   }
   OptionParser.new do |opts|
     opts.banner = description
-    opts.define_head "Usage: archetype theme [path] [options]"
+    opts.define_head "Usage: #{Archetype.name} theme [path] [options]"
     opts.separator ""
     opts.separator "Example usage:"
-    opts.separator " archetype theme /path/to/scss/ --name=myCustomTheme"
-    opts.separator " archetype theme --name=themes/myExtendedTheme --extends=themes/myBaseTheme"
+    opts.separator " #{Archetype.name} theme /path/to/scss/ --name=myCustomTheme"
+    opts.separator " #{Archetype.name} theme --name=themes/myExtendedTheme --extends=themes/myBaseTheme"
 
     opts.on('-n', '--name THEME', 'theme name') do |v|
       options[:theme] = v
@@ -38,7 +37,7 @@ if @description.nil?
     theme_template = File.join(File.dirname(__FILE__), '../../../templates/_theme/')
     theme_path = File.join(base, options[:theme])
     extends = "#{options[:extends]}"
-    if options[:extends] != 'archetype'
+    if options[:extends] != Archetype.name
       extends = "#{extends}/core"
     end
     theme_name = File.basename(options[:theme])
@@ -47,7 +46,7 @@ if @description.nil?
     FileUtils.cp_r(Dir["#{theme_template}/**"], tmp)
 
     puts "Creating theme '#{theme_name}' in #{File.expand_path(theme_path)}..."
-    puts "extending from #{options[:extends]}" if options[:extends] != 'archetype'
+    puts "extending from #{options[:extends]}" if options[:extends] != Archetype.name
 
     # update all placeholders in template files
     Dir.glob("#{tmp}/**/*.scss") do |filename|

data/lib/archetype/executor.rb

@@ -1,21 +1,27 @@
+require 'archetype'
 require 'optparse'
 
 @actions_path = File.join(File.dirname(__FILE__), 'actions')
+@needs_help = true
 
 if not ARGV[0].nil? and not ARGV[0].empty?
   action_name = ARGV[0]
-  action = File.join(@actions_path, action_name)
-  begin
-    require action
-  rescue
-    puts "unknown action: #{action_name}"
+  if /^[a-z]/ =~ action_name
+    action = File.join(@actions_path, action_name)
+    begin
+      require action
+    rescue LoadError
+      puts "unknown action: #{action_name}"
+    end
+  elsif /^-(h|-help)$/ =~ action_name
+    @needs_help = false
   end
 end
 
 # if we got here, there was either no action, or the action was invalid
 OptionParser.new do |opts|
   opts.banner = "Archetype command line actions\n\n"
-  opts.define_head "Usage: archetype <action> [options]"
+  opts.define_head "Usage: #{Archetype.name} <action> [options]"
   opts.separator ""
   opts.separator "Available Actions:"
   Dir.glob("#{@actions_path}/*.rb") do |action|
@@ -23,5 +29,13 @@ OptionParser.new do |opts|
     load action
     opts.separator "  * #{File.basename(action, '.rb')}\t- #{@description}"
   end
-  puts opts
+  opts.separator ""
+  opts.separator "Available Options:"
+  opts.on("-v", "--version", "reports the current version") do
+    puts Archetype::VERSION
+    exit
+  end
+  @options = opts
 end.parse!
+
+puts @options if @needs_help

data/lib/archetype/extensions.rb

@@ -0,0 +1,57 @@
+module Archetype
+  module Extensions
+    def self.register(name, *arguments)
+      # make sure the name is properly formatted
+      name = "#{NAME}-#{name.gsub(/^#{NAME}-/, '')}"
+      Compass::Frameworks.register(name, *arguments)
+    end
+
+    class GemspecHelper
+
+      ROOT_PATH = File.expand_path("../../../", __FILE__)
+
+      def initialize(name)
+
+        e = @extension = {}
+        # we only care about the name, so strip off anything if we were given a file/path
+        e[:name] = File.basename(name, '.gemspec').strip
+        # the path to the extension
+        e[:path] = File.join(ROOT_PATH, 'extensions', e[:name])
+        # the lib directory within the extension
+        e[:lib]  = File.join(e[:path], 'lib')
+
+        resolve_version
+      end
+
+      def info(prop)
+        return @extension[prop] || core.send(prop)
+      end
+
+      private
+
+      def resolve_version
+        # if a version.rb file exists within the extension, we'll get the version from that
+        version_rb = File.join(@extension[:lib], @extension[:name], 'version.rb')
+        require version_rb if File.exist?(version_rb)
+        # if the ::VERSION constant was set on the extension module, use it...
+        @extension[:version] = version_const if defined?(version_const)
+        # if the version isn't set, use Archetype's core version
+        @extension[:version] = core.version if @extension[:version].nil? or @extension[:version].empty?
+      end
+
+      def version_const
+        # converts the hyphenated name to a module
+        name = @extension[:name].gsub(/(?:_|\-|^)(\w)/){$1.upcase}
+        begin
+          return Module.const_get("#{name}::VERSION")
+        rescue NameError
+          return nil
+        end
+      end
+
+      def core
+        @core ||= Gem::Specification.load(File.join(ROOT_PATH, 'archetype.gemspec'))
+      end
+    end
+  end
+end

data/lib/archetype/functions.rb

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

data/lib/archetype/functions/css.rb

@@ -0,0 +1,70 @@
+# :stopdoc:
+
+%w(constants helpers routers shorthands).each do |dep|
+  require "archetype/functions/css/#{dep}"
+end
+
+module Archetype::Functions::CSS
+  #include Sass::Script::Value::Helpers
+
+  #
+  # returns a best guess for the default CSS value of a given property
+  #
+  # *Parameters*:
+  # - <tt>key</tt> {String} the property to lookup
+  # *Returns*:
+  # - {*} the default value
+  #
+  def self.default(key)
+    value = ALL_CSS_PROPERTIES[key] || :invalid
+    if value.is_a?(Array)
+      value = Sass::Script::Value::List.new(value.map {|item| CSS_PRIMITIVES[item]}, :space)
+    else
+      value = CSS_PRIMITIVES[value]
+    end
+    helpers.warn("[#{Archetype.name}:css:default] cannot find a default value for `#{key}`") if value.nil?
+    return value
+  end
+
+  #
+  # calculates derived styles from a given map
+  #
+  # *Parameters*:
+  # - <tt>map</tt> {Sass::Script::Value::Map} the map of styles
+  # - <tt>properties</tt> {String|List|Array} the properties to extract the derived styles for
+  # - <tt>format</tt> {String} the format to return the results in [auto|map|list]
+  # - <tt>strict</tt> {Boolean} if true, will only return an exact match, and not try to extrapolate the value (TODO)
+  # *Returns*:
+  # - {*} the derived styles as either a list/map of the values or the individual value itself (based on the format)
+  #
+  def self.get_derived_styles(map, properties = [], format = :auto, strict = false)
+    # TODO how to handle multiple values?
+    computed = ::Archetype::Hash.new
+    (properties || []).to_a.each do |property|
+      value = Sass::Script::Value::Null.new
+      if not property.value.nil?
+        property = helpers.to_str(property, ' ', :quotes)
+        # simple case, exact match only
+        value = map[property] if map.key? property
+
+        # if we're not doing strict matching...
+        if not strict
+          # if the property is a short- or long-hand, we need to figure out what the value actually is
+          value = get_derived_styles_via_router(map, property) || value
+        end
+      end
+      computed[property] = value
+    end
+
+    format = :map if computed.length > 1 and format == :auto
+
+    case format
+    when :map
+      return helpers.hash_to_map(computed)
+    when :list
+      return Sass::Script::Value::List.new(computed.values, :comma)
+    else
+      return computed.values.first
+    end
+  end
+end

data/lib/archetype/functions/css/constants.rb

@@ -0,0 +1,247 @@
+module Archetype::Functions::CSS
+  CSS_PRIMITIVES = {
+    # common
+    :inherit      => Sass::Script::Value::String.new('inherit'),
+    :none         => Sass::Script::Value::String.new('none'),
+    :auto         => Sass::Script::Value::String.new('auto'),
+    :left         => Sass::Script::Value::String.new('left'),
+    :top          => Sass::Script::Value::String.new('top'),
+    :normal       => Sass::Script::Value::String.new('normal'),
+    :repeat       => Sass::Script::Value::String.new('repeat'),
+    :visible      => Sass::Script::Value::String.new('visible'),
+    :scroll       => Sass::Script::Value::String.new('scroll'),
+    :border_box   => Sass::Script::Value::String.new('border-box'),
+    :padding_box  => Sass::Script::Value::String.new('padding-box'),
+    :solid        => Sass::Script::Value::String.new('solid'),
+    :static       => Sass::Script::Value::String.new('static'),
+    :ease         => Sass::Script::Value::String.new('ease'),
+    :running      => Sass::Script::Value::String.new('running'),
+    :separate     => Sass::Script::Value::String.new('separate'),
+    :stretch      => Sass::Script::Value::String.new('stretch'),
+    :single       => Sass::Script::Value::String.new('single'),
+    :inline_axis  => Sass::Script::Value::String.new('inline-axis'),
+    :start        => Sass::Script::Value::String.new('start'),
+    :content_box  => Sass::Script::Value::String.new('content-box'),
+    :balance      => Sass::Script::Value::String.new('balance'),
+    :medium       => Sass::Script::Value::String.new('medium'),
+    :ltr          => Sass::Script::Value::String.new('ltr'),
+    :inline       => Sass::Script::Value::String.new('inline'),
+    :show         => Sass::Script::Value::String.new('show'),
+    :outside      => Sass::Script::Value::String.new('outside'),
+    :disc         => Sass::Script::Value::String.new('disc'),
+    :invert       => Sass::Script::Value::String.new('invert'),
+    :current      => Sass::Script::Value::String.new('current'),
+    :window       => Sass::Script::Value::String.new('window'),
+    :above        => Sass::Script::Value::String.new('above'),
+    :flat         => Sass::Script::Value::String.new('flat'),
+    :all          => Sass::Script::Value::String.new('all'),
+    :baseline     => Sass::Script::Value::String.new('baseline'),
+
+    # numbers
+    :zero         => Sass::Script::Value::Number.new(0),
+    :one          => Sass::Script::Value::Number.new(1),
+    :p100         => Sass::Script::Value::Number.new(100, ['%']),
+    :p100         => Sass::Script::Value::Number.new(50, ['%']),
+    # colors
+    :transparent  => Sass::Script::Value::Color.new([0, 0, 0, 0]),
+    :black        => Sass::Script::Value::Color.new([0, 0, 0]),
+  }
+
+  # a list of all CSS properties
+  ALL_CSS_PROPERTIES = {
+    'animation'                   => [:none, :zero, :ease, :zero, :one, :normal],
+    'animation-delay'             => :zero,
+    'animation-direction'         => :normal,
+    'animation-duration'          => :zero,
+    'animation-fill-mode'         => :none,
+    'animation-iteration-count'   => :one,
+    'animation-name'              => :none,
+    'animation-play-state'        => :running,
+    'animation-timing-function'   => :ease,
+    'appearance'                  => :normal,
+    'backface-visibility'         => :visible,
+    'background'                  => :none,
+    'background-attachment'       => :scroll,
+    'background-clip'             => :border_box,
+    'background-color'            => :transparent,
+    'background-image'            => :none,
+    'background-origin'           => :padding_box,
+    'background-position'         => [:left, :top],
+    'background-repeat'           => :repeat,
+    'background-size'             => :auto,
+    'border'                      => :none,
+    'border-bottom'               => :none,
+    'border-bottom-color'         => :transparent,
+    'border-bottom-left-radius'   => :zero,
+    'border-bottom-right-radius'  => :zero,
+    'border-bottom-style'         => :solid,
+    'border-bottom-width'         => :zero,
+    'border-collapse'             => :separate,
+    'border-color'                => :transparent,
+    'border-image'                => [:none, :p100, :one1, :zero, :stretch],
+    'border-image-outset'         => :zero,
+    'border-image-repeat'         => :stretch,
+    'border-image-slice'          => :p100,
+    'border-image-source'         => :none,
+    'border-image-width'          => :zero,
+    'border-left'                 => :none,
+    'border-left-color'           => :transparent,
+    'border-left-style'           => :solid,
+    'border-left-width'           => :zero,
+    'border-radius'               => :zero,
+    'border-right'                => :none,
+    'border-right-color'          => :transparent,
+    'border-right-style'          => :solid,
+    'border-right-width'          => :zero,
+    'border-spacing'              => :inherit,
+    'border-style'                => :solid,
+    'border-top'                  => :none,
+    'border-top-color'            => :transparent,
+    'border-top-left-radius'      => :zero,
+    'border-top-right-radius'     => :zero,
+    'border-top-style'            => :solid,
+    'border-top-width'            => :zero,
+    'border-width'                => :zero,
+    'bottom'                      => :auto,
+    'box-align'                   => :stretch,
+    'box-direction'               => :normal,
+    'box-flex'                    => :zero,
+    'box-flex-group'              => :one,
+    'box-lines'                   => :single,
+    'box-ordinal-group'           => :one,
+    'box-orient'                  => :inline_axis,
+    'box-pack'                    => :start,
+    'box-shadow'                  => :none,
+    'box-sizing'                  => :content_box,
+    'caption-side'                => :top,
+    'clear'                       => :none,
+    'clip'                        => :auto,
+    'color'                       => :inherit,
+    'column-count'                => :auto,
+    'column-fill'                 => :balance,
+    'column-gap'                  => :normal,
+    'column-rule'                 => [:medium, :none, :black],
+    'column-rule-color'           => :black,
+    'column-rule-style'           => :none,
+    'column-rule-width'           => :width,
+    'column-span'                 => :one,
+    'column-width'                => :auto,
+    'columns'                     => [:auto, :auto],
+    'content'                     => :normal,
+    'counter-increment'           => :none,
+    'counter-reset'               => :none,
+    'cursor'                      => :auto,
+    'direction'                   => :ltr,
+    'display'                     => :inline,
+    'empty-cells'                 => :show,
+    'float'                       => :none,
+    'font'                        => :inherit,
+    'font-family'                 => :inherit,
+    'font-size'                   => :inherit,
+    'font-size-adjust'            => :inherit,
+    'font-stretch'                => :inherit,
+    'font-style'                  => :inherit,
+    'font-variant'                => :inherit,
+    'font-weight'                 => :inherit,
+    'grid-columns'                => :none,
+    'grid-rows'                   => :none,
+    'hanging-punctuation'         => :none,
+    'height'                      => :auto,
+    'icon'                        => :auto,
+    'left'                        => :auto,
+    'letter-spacing'              => :normal,
+    'line-height'                 => :normal,
+    'list-style'                  => [:disc, :outside, :none],
+    'list-style-image'            => :none,
+    'list-style-position'         => :outside,
+    'list-style-type'             => :disc,
+    'margin'                      => :zero,
+    'margin-bottom'               => :zero,
+    'margin-left'                 => :zero,
+    'margin-right'                => :zero,
+    'margin-top'                  => :zero,
+    'max-height'                  => :none,
+    'max-width'                   => :none,
+    'min-height'                  => :none,
+    'min-width'                   => :none,
+    'nav-down'                    => :auto,
+    'nav-index'                   => :auto,
+    'nav-left'                    => :auto,
+    'nav-right'                   => :auto,
+    'nav-up'                      => :auto,
+    'opacity'                     => :one,
+    'outline'                     => [:invert, :none, :medium],
+    'outline-color'               => :invert,
+    'outline-offset'              => :zero,
+    'outline-style'               => :none,
+    'outline-width'               => :medium,
+    'overflow'                    => :visible,
+    'overflow-x'                  => :visible,
+    'overflow-y'                  => :visible,
+    'padding'                     => :zero,
+    'padding-bottom'              => :zero,
+    'padding-left'                => :zero,
+    'padding-right'               => :zero,
+    'padding-top'                 => :zero,
+    'page-break-after'            => :auto,
+    'page-break-before'           => :auto,
+    'page-break-inside'           => :auto,
+    'perspective'                 => :none,
+    'perspective-origin'          => [:p50, :p50],
+    'position'                    => :static,
+    'punctuation-trim'            => :none,
+    'quotes'                      => :inherit,
+    'resize'                      => :none,
+    'right'                       => :auto,
+    'rotation'                    => :zero,
+    'rotation-point'              => [:p50, :p50],
+    'table-layout'                => :auto,
+    'target'                      => [:current, :window, :above],
+    'target-name'                 => :current,
+    'target-new'                  => :window,
+    'target-position'             => :above,
+    'text-align'                  => :left,
+    'text-decoration'             => :none,
+    'text-indent'                 => :zero,
+    'text-justify'                => :auto,
+    'text-outline'                => :none,
+    'text-overflow'               => :clip,
+    'text-shadow'                 => :none,
+    'text-transform'              => :none,
+    'text-wrap'                   => :normal,
+    'top'                         => :auto,
+    'transform'                   => :none,
+    'transform-origin'            => [:p50, :p50, :zero],
+    'transform-style'             => :flat,
+    'transition'                  => [:all, :zero, :ease, :zero],
+    'transition-delay'            => :zero,
+    'transition-duration'         => :zero,
+    'transition-property'         => :all,
+    'transition-timing-function'  => :ease,
+    'unicode-bidi'                => :normal,
+    'vertical-align'              => :baseline,
+    'visibility'                  => :visible,
+    'white-space'                 => :normal,
+    'width'                       => :auto,
+    'word-break'                  => :normal,
+    'word-spacing'                => :normal,
+    'word-wrap'                   => :normal,
+    'z-index'                     => :zero,
+    # archetype custom properties...
+    'ie-filter'                   => :none,
+    'border-top-radius'           => :zero,
+    'border-right-radius'         => :zero,
+    'border-bottom-radius'        => :zero,
+    'border-left-radius'          => :zero
+  }
+
+  private
+
+  R_TIMING_FUNCTION = /^(?:linear|ease|ease-in|ease-out|ease-in-out|step-start|step-stop|steps\(.*\)|cubic-bezier\(.*\)|)$/
+  RS_BORDER_POSITION = '(-(?:top|right|bottom|left))'
+  RS_BORDER_TYPE = '(-(?:color|width|style))'
+  R_BORDER_STD = /^border#{RS_BORDER_POSITION}?#{RS_BORDER_TYPE}?$/
+  R_BORDER_SHORTHANDS = /^border#{RS_BORDER_POSITION}?$/
+  R_BORDER_IMG_OR_RADIUS = /(image|radius)/
+
+end