compass-rails31 0.12.0.alpha.0.91a748a

data/lib/compass/sass_extensions/functions/image_size.rb

@@ -0,0 +1,102 @@
+module Compass::SassExtensions::Functions::ImageSize
+  # Returns the width of the image relative to the images directory
+  def image_width(image_file)
+    image_path = real_path(image_file)
+    width = ImageProperties.new(image_path).size.first
+    Sass::Script::Number.new(width,["px"])
+  end
+
+  # Returns the height of the image relative to the images directory
+  def image_height(image_file)
+    image_path = real_path(image_file)
+    height = ImageProperties.new(image_path).size.last
+    Sass::Script::Number.new(height, ["px"])
+  end
+
+  class ImageProperties
+    def initialize(file)
+      @file = file
+      @file_type = File.extname(@file)[1..-1]
+    end
+
+    def size
+      @dimensions ||= send(:"get_size_for_#{@file_type}")
+    rescue NoMethodError
+      raise Sass::SyntaxError, "Unrecognized file type: #{@file_type}"
+    end
+
+  private
+    def get_size_for_png
+      File.open(@file, "rb") {|io| io.read}[0x10..0x18].unpack('NN')
+    end
+
+    def get_size_for_gif
+      File.open(@file, "rb") {|io| io.read}[6..10].unpack('SS')
+    end
+
+    def get_size_for_jpg
+      get_size_for_jpeg
+    end
+
+    def get_size_for_jpeg
+      jpeg = JPEG.new(@file)
+      [jpeg.width, jpeg.height]
+    end
+  end
+
+private
+  def real_path(image_file)
+    path = image_file.value
+    # Compute the real path to the image on the file stystem if the images_dir is set.
+    if Compass.configuration.images_path
+      File.join(Compass.configuration.images_path, path)
+    else
+      File.join(Compass.configuration.project_path, path)
+    end
+  end
+
+  class JPEG
+    attr_reader :width, :height, :bits
+
+    def initialize(file)
+      if file.kind_of? IO
+        examine(file)
+      else
+        File.open(file, 'rb') { |io| examine(io) }
+      end
+    end
+
+  private
+    def examine(io)
+      class << io
+        unless method_defined?(:readbyte)
+          def readbyte
+            getc
+          end
+        end
+        def readint; (readbyte << 8) + readbyte; end
+        def readframe; read(readint - 2); end
+        def readsof; [readint, readbyte, readint, readint, readbyte]; end
+        def next
+          c = readbyte while c != 0xFF
+          c = readbyte while c == 0xFF
+          c
+        end
+      end
+
+      raise 'malformed JPEG!' unless io.readbyte == 0xFF && io.readbyte == 0xD8 # SOI
+
+      while marker = io.next
+        case marker
+          when 0xC0..0xC3, 0xC5..0xC7, 0xC9..0xCB, 0xCD..0xCF # SOF markers
+            length, @bits, @height, @width, components = io.readsof
+            raise 'malformed JPEG' unless length == 8 + components * 3
+          when 0xD9, 0xDA then  break # EOI, SOS
+          when 0xFE then @comment = io.readframe # COM
+          when 0xE1 then io.readframe # APP1, contains EXIF tag
+          else io.readframe # ignore frame
+        end
+      end
+    end
+end
+end

data/lib/compass/sass_extensions/functions/inline_image.rb

@@ -0,0 +1,62 @@
+module Compass::SassExtensions::Functions::InlineImage
+
+  def inline_image(path, mime_type = nil)
+    path = path.value
+    real_path = File.join(Compass.configuration.images_path, path)
+    inline_image_string(data(real_path), compute_mime_type(path, mime_type))
+  end
+
+  def inline_font_files(*args)
+    raise Sass::SyntaxError, "An even number of arguments must be passed to font_files()" unless args.size % 2 == 0
+    files = []
+    while args.size > 0
+      path = args.shift.value
+      real_path = File.join(Compass.configuration.fonts_path, path)
+      url = "url('data:#{compute_mime_type(path)};base64,#{data(real_path)}')"
+      files << "#{url} format('#{args.shift}')"
+    end
+    Sass::Script::String.new(files.join(", "))
+  end
+
+protected
+  def inline_image_string(data, mime_type)
+    data = [data].flatten.pack('m').gsub("\n","")
+    url = "url('data:#{mime_type};base64,#{data}')"
+    Sass::Script::String.new(url)
+  end
+
+private
+  def compute_mime_type(path, mime_type = nil)
+    return mime_type if mime_type
+    case path
+    when /\.png$/i
+      'image/png'
+    when /\.jpe?g$/i
+      'image/jpeg'
+    when /\.gif$/i
+      'image/gif'
+    when /\.svg$/i
+      'image/svg+xml'
+    when /\.otf$/i
+      'font/opentype'
+    when /\.ttf$/i
+      'font/truetype'
+    when /\.woff$/i
+      'font/woff'
+    when /\.off$/i
+      'font/openfont'
+    when /\.([a-zA-Z]+)$/
+      "image/#{Regexp.last_match(1).downcase}"
+    else
+      raise Compass::Error, "A mime type could not be determined for #{path}, please specify one explicitly."
+    end
+  end
+
+  def data(real_path)
+    if File.readable?(real_path)
+      File.open(real_path, "rb") {|io| io.read}
+    else
+      raise Compass::Error, "File not found or cannot be read: #{real_path}"
+    end
+  end
+end

data/lib/compass/sass_extensions/functions/lists.rb

@@ -0,0 +1,96 @@
+module Compass::SassExtensions::Functions::Lists
+
+  # Returns true when the object is false, an empty string, or an empty list
+  def blank(obj)
+    case obj
+    when Sass::Script::Bool
+      Sass::Script::Bool.new !obj.to_bool
+    when Sass::Script::String
+      Sass::Script::Bool.new obj.value.strip.size == 0
+    when Sass::Script::List
+      Sass::Script::Bool.new obj.value.size == 0 || obj.value.all?{|el| blank(el).to_bool}
+    else
+      Sass::Script::Bool.new false
+    end
+  end
+
+  # Returns a new list after removing any non-true values
+  def compact(*args)
+    sep = :comma
+    if args.size == 1 && args.first.is_a?(Sass::Script::List)
+      list = args.first
+      args = list.value
+      sep = list.separator
+    end
+    Sass::Script::List.new(args.reject{|a| !a.to_bool}, sep)
+  end
+
+  # Get the nth value from a list
+  def _compass_nth(list, place)
+    assert_type list, :List
+    if place.value == "first"
+      list.value.first
+    elsif place.value == "last"
+      list.value.last
+    else
+      list.value[place.value - 1]
+    end
+  end
+
+  # Returns a list object from a value that was passed.
+  # This can be used to unpack a space separated list that got turned
+  # into a string by sass before it was passed to a mixin.
+  def _compass_list(arg)
+    if arg.is_a?(Sass::Script::List)
+      Sass::Script::List.new(arg.value.dup, arg.separator)
+    else
+      Sass::Script::List.new([arg], :space)
+    end
+  end
+
+  # If the argument is a list, it will return a new list that is space delimited
+  # Otherwise it returns a new, single element, space-delimited list.
+  def _compass_space_list(list)
+    if list.is_a?(Sass::Script::List)
+      Sass::Script::List.new(list.value.dup, :space)
+    else
+      Sass::Script::List.new([list], :space)
+    end
+  end
+
+  # Returns the size of the list.
+  def _compass_list_size(list)
+    assert_list list
+    Sass::Script::Number.new(list.value.size)
+  end
+
+  # slice a sublist from a list
+  def _compass_slice(list, start_index, end_index = nil)
+    end_index ||= Sass::Script::Number.new(-1)
+    start_index = start_index.value
+    end_index = end_index.value
+    start_index -= 1 unless start_index < 0
+    end_index -= 1 unless end_index < 0
+    Sass::Script::List.new list.values[start_index..end_index], list.separator
+  end
+
+  # returns the first value of a space delimited list.
+  def first_value_of(list)
+    if list.is_a?(Sass::Script::String)
+      Sass::Script::String.new(list.value.split(/\s+/).first)
+    elsif defined?(Sass::Script::List) && list.is_a?(Sass::Script::List)
+      list.value.first
+    else
+      list
+    end
+  end
+
+  protected
+
+  def assert_list(value)
+    unless value.is_a?(Sass::Script::List)
+      raise ArgumentError.new("#{value.inspect} is not a list")
+    end
+  end
+
+end

data/lib/compass/sass_extensions/functions/selectors.rb

@@ -0,0 +1,64 @@
+module Compass::SassExtensions::Functions::Selectors
+  COMMA_SEPARATOR = /\s*,\s*/
+
+  # Permute multiple selectors each of which may be comma delimited, the end result is
+  # a new selector that is the equivalent of nesting each under the previous selector.
+  # To illustrate, the following mixins are equivalent:
+  # =mixin-a(!selector1, !selector2, !selector3)
+  #   #{!selector1}
+  #     #{selector2}
+  #       #{selector3}
+  #         width: 2px
+  # =mixin-b(!selector1, !selector2)
+  #   #{nest(!selector, !selector2, !selector3)}
+  #     width: 2px
+  def nest(*arguments)
+    nested = arguments.map{|a| a.value}.inject do |memo,arg|
+      ancestors = memo.split(COMMA_SEPARATOR)
+      descendants = arg.split(COMMA_SEPARATOR)
+      ancestors.map{|a| descendants.map{|d| "#{a} #{d}"}.join(", ")}.join(", ")
+    end
+    Sass::Script::String.new(nested)
+  end
+
+  # Permute two selectors, the first may be comma delimited.
+  # The end result is a new selector that is the equivalent of nesting the second
+  # selector under the first one in a sass file and preceding it with an &.
+  # To illustrate, the following mixins are equivalent:
+  # =mixin-a(!selector, !to_append)
+  #   #{!selector}
+  #     &#{!to_append}
+  #       width: 2px
+  # =mixin-b(!selector, !to_append)
+  #   #{append_selector(!selector, !to_append)}
+  #     width: 2px
+  def append_selector(selector, to_append)
+    ancestors = selector.value.split(COMMA_SEPARATOR)
+    descendants = to_append.value.split(COMMA_SEPARATOR)
+    nested = ancestors.map{|a| descendants.map{|d| "#{a}#{d}"}.join(", ")}.join(", ")
+    Sass::Script::String.new(nested)
+  end
+
+  # Return the header selectors for the levels indicated
+  # Defaults to all headers h1 through h6
+  # For example:
+  # headers(all) => h1, h2, h3, h4, h5, h6
+  # headers(4) => h1, h2, h3, h4
+  # headers(2,4) => h2, h3, h4
+  def headers(from = nil, to = nil)
+    if from && !to
+      if from.is_a?(Sass::Script::String) && from.value == "all"
+        from = Sass::Script::Number.new(1)
+        to = Sass::Script::Number.new(6)
+      else
+        to = from
+        from = Sass::Script::Number.new(1)
+      end
+    else
+      from ||= Sass::Script::Number.new(1)
+      to ||= Sass::Script::Number.new(6)
+    end
+    Sass::Script::String.new((from.value..to.value).map{|n| "h#{n}"}.join(", "))
+  end
+  alias headings headers
+end

data/lib/compass/sass_extensions/functions/sprites.rb

@@ -0,0 +1,182 @@
+module Compass::SassExtensions::Functions::Sprites
+  ZERO = Sass::Script::Number::new(0)
+  VALID_SELECTORS = %w(hover active target)
+  # Provides a consistent interface for getting a variable in ruby
+  # from a keyword argument hash that accounts for underscores/dash equivalence
+  # and allows the caller to pass a symbol instead of a string.
+  module VariableReader
+    def get_var(variable_name)
+      self[variable_name.to_s.gsub(/-/,"_")]
+    end
+  end
+
+  # Creates a Compass::SassExtensions::Sprites::SpriteMap object. A sprite map, when used in a property is the same
+  # as calling sprite-url. So the following background properties are equivalent:
+  #
+  #     $icons: sprite-map("icons/*.png");
+  #     background: sprite-url($icons) no-repeat;
+  #     background: $icons no-repeat;
+  #
+  # The sprite map object will generate the sprite map image, if necessary,
+  # the first time it is converted to a url. Simply constructing it has no side-effects.
+  def sprite_map(glob, kwargs = {})
+    kwargs.extend VariableReader
+    Compass::SassExtensions::Sprites::SpriteMap.from_uri(glob, self, kwargs)
+  end
+  Sass::Script::Functions.declare :sprite_map, [:glob], :var_kwargs => true
+
+  # Returns the image and background position for use in a single shorthand property:
+  #
+  #     $icons: sprite-map("icons/*.png"); // contains icons/new.png among others.
+  #     background: sprite($icons, new) no-repeat;
+  #
+  # Becomes:
+  #
+  #     background: url('/images/icons.png?12345678') 0 -24px no-repeat;
+  def sprite(map, sprite, offset_x = ZERO, offset_y = ZERO)
+    sprite = convert_sprite_name(sprite)    
+    verify_map(map)
+    unless sprite.is_a?(Sass::Script::String)
+      raise Sass::SyntaxError, %Q(The second argument to sprite() must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
+    end
+    url = sprite_url(map)
+    position = sprite_position(map, sprite, offset_x, offset_y)
+    Sass::Script::List.new([url] + position.value, :space)
+  end
+  Sass::Script::Functions.declare :sprite, [:map, :sprite]
+  Sass::Script::Functions.declare :sprite, [:map, :sprite, :offset_x]
+  Sass::Script::Functions.declare :sprite, [:map, :sprite, :offset_x, :offset_y]
+
+  # Returns the name of a sprite map
+  # The name is derived from the folder than contains the sprites.
+  def sprite_map_name(map)
+    verify_map(map, "sprite-map-name")
+    Sass::Script::String.new(map.name)
+  end
+  Sass::Script::Functions.declare :sprite_name, [:sprite]
+
+  # Returns the path to the original image file for the sprite with the given name
+  def sprite_file(map, sprite)
+    sprite = convert_sprite_name(sprite)
+    verify_map(map, "sprite")
+    verify_sprite(sprite)
+    if image = map.image_for(sprite.value)
+      Sass::Script::String.new(image.relative_file)
+    else
+      missing_image!(map, sprite)
+    end
+  end
+  Sass::Script::Functions.declare :sprite_file, [:map, :sprite]
+
+  # Returns voolean if sprite has a parent
+  def sprite_does_not_have_parent(map, sprite)
+    sprite = convert_sprite_name(sprite)
+    verify_map map
+    verify_sprite sprite
+    Sass::Script::Bool.new map.image_for(sprite.value).parent.nil?
+  end
+  
+  Sass::Script::Functions.declare :sprite_does_not_have_parent, [:map, :sprite]
+
+  # Returns boolean if sprite has the selector
+  def sprite_has_selector(map, sprite, selector)
+    sprite = convert_sprite_name(sprite)
+    verify_map map
+    verify_sprite sprite
+    unless VALID_SELECTORS.include?(selector.value)
+      raise Sass::SyntaxError, "Invalid Selctor did you mean one of: #{VALID_SELECTORS.join(', ')}"
+    end
+    Sass::Script::Bool.new map.send(:"has_#{selector.value}?", sprite)
+  end
+  
+  Sass::Script::Functions.declare :sprite_has_selector, [:map, :sprite, :selector]
+
+
+  # Returns a url to the sprite image.
+  def sprite_url(map)
+    verify_map(map, "sprite-url")
+    map.generate
+    image_url(Sass::Script::String.new("#{map.path}-s#{map.uniqueness_hash}.png"),
+              Sass::Script::Bool.new(false),
+              Sass::Script::Bool.new(false))
+  end
+  Sass::Script::Functions.declare :sprite_url, [:map]
+
+  # Returns the position for the original image in the sprite.
+  # This is suitable for use as a value to background-position:
+  #
+  #     $icons: sprite-map("icons/*.png");
+  #     background-position: sprite-position($icons, new);
+  #
+  # Might generate something like:
+  #
+  #     background-position: 0 -34px;
+  #
+  # You can adjust the background relative to this position by passing values for
+  # `$offset-x` and `$offset-y`:
+  #
+  #     $icons: sprite-map("icons/*.png");
+  #     background-position: sprite-position($icons, new, 3px, -2px);
+  #
+  # Would change the above output to:
+  #
+  #     background-position: 3px -36px;
+  def sprite_position(map, sprite = nil, offset_x = ZERO, offset_y = ZERO)
+    sprite = convert_sprite_name(sprite)
+    verify_map(map, "sprite-position")
+    unless sprite && sprite.is_a?(Sass::Script::String)
+      raise Sass::SyntaxError, %Q(The second argument to sprite-position must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
+    end
+    image = map.image_for(sprite.value)
+    unless image
+      missing_image!(map, sprite)
+    end
+    if offset_x.unit_str == "%"
+      x = offset_x # CE: Shouldn't this be a percentage of the total width?
+    else
+      x = offset_x.value - image.left
+      x = Sass::Script::Number.new(x, x == 0 ? [] : ["px"])
+    end
+    y = offset_y.value - image.top
+    y = Sass::Script::Number.new(y, y == 0 ? [] : ["px"])
+    Sass::Script::List.new([x, y],:space)
+  end
+  Sass::Script::Functions.declare :sprite_position, [:map]
+  Sass::Script::Functions.declare :sprite_position, [:map, :sprite]
+  Sass::Script::Functions.declare :sprite_position, [:map, :sprite, :offset_x]
+  Sass::Script::Functions.declare :sprite_position, [:map, :sprite, :offset_x, :offset_y]
+
+  def sprite_image(*args)
+    raise Sass::SyntaxError, %Q(The sprite-image() function has been replaced by sprite(). See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
+  end
+
+protected
+
+  def convert_sprite_name(sprite)
+    if sprite.is_a?(Sass::Script::Color)
+      return Sass::Script::String.new(Sass::Script::Color::HTML4_COLORS_REVERSE[sprite.rgb])
+    end
+    sprite
+  end
+
+  def verify_map(map, error = "sprite")
+    unless map.is_a?(Compass::SassExtensions::Sprites::SpriteMap)
+      missing_sprite!(error)
+    end
+  end
+
+  def verify_sprite(sprite)
+    unless sprite.is_a?(Sass::Script::String)
+      raise Sass::SyntaxError, %Q(The second argument to sprite() must be a sprite name. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
+    end
+  end
+
+  def missing_image!(map, sprite)
+    raise Sass::SyntaxError, "No sprite called #{sprite} found in sprite map #{map.path}/#{map.name}. Did you mean one of: #{map.sprite_names.join(", ")}"
+  end
+
+  def missing_sprite!(function_name)
+    raise Sass::SyntaxError, %Q(The first argument to #{function_name}() must be a sprite map. See http://beta.compass-style.org/help/tutorials/spriting/ for more information.)
+  end
+
+end