chriseppstein-compass 0.6.15 → 0.7.0

data/lib/compass/commands/watch_project.rb

@@ -7,45 +7,44 @@ module Compass
   module Commands
     class WatchProject < UpdateProject
 
-      attr_accessor :last_update_time
+      attr_accessor :last_update_time, :last_sass_files
 
       def perform
-        puts ">>> Compiling all stylesheets."
-        super
-        self.last_update_time = most_recent_update_time
-        puts ">>> Compass is now watching for changes. Press Ctrl-C to Stop."
+        Signal.trap("INT") do
+          puts ""
+          exit 0
+        end
+        puts ">>> Compass is watching for changes. Press Ctrl-C to Stop."
         loop do
           # TODO: Make this efficient by using filesystem monitoring.
-          begin
-            sleep 1
-          rescue Interrupt
-            puts ""
-            exit 0
-          end
-          file, t = should_update?
-          if t
-            begin
-              puts ">>> Change detected to: #{file}"
-              super
-            rescue StandardError => e
-              ::Compass::Exec.report_error(e, options)
-            end
-            self.last_update_time = t
-          end
+          compiler = new_compiler_instance(:quiet => true)
+          remove_obsolete_css(compiler)
+          recompile(compiler)
+          sleep 1
         end
       end
 
-      def most_recent_update_time
-        Dir.glob(separate("#{projectize(Compass.configuration.sass_dir)}/**/*.sass")).map {|sass_file| File.stat(sass_file).mtime}.max
+      def remove_obsolete_css(compiler)
+        sass_files = compiler.sass_files
+        deleted_sass_files = (last_sass_files || []) - sass_files
+        deleted_sass_files.each do |deleted_sass_file|
+          css_file = compiler.corresponding_css_file(deleted_sass_file)
+          remove(css_file) if File.exists?(css_file)
+        end
+        self.last_sass_files = sass_files
       end
 
-      def should_update?
-        t = most_recent_update_time
-        if t > last_update_time
-          file = Dir.glob(separate("#{projectize(Compass.configuration.sass_dir)}/**/*.sass")).detect {|sass_file| File.stat(sass_file).mtime >= t}
-          [file, t]
+      def recompile(compiler)
+        if file = compiler.out_of_date?
+          begin
+            puts ">>> Change detected to: #{file}"
+            compiler.run
+          rescue StandardError => e
+            ::Compass::Exec.report_error(e, options)
+          end
         end
       end
+
     end
   end
 end

data/lib/compass/commands/write_configuration.rb

@@ -12,13 +12,17 @@ module Compass
       end
 
       def perform
-        installer.write_configuration_files
+        installer.write_configuration_files(options[:configuration_file])
       end
 
       def installer_args
         [nil, project_directory, options]
       end
 
+      def explicit_config_file_must_be_readable?
+        false
+      end
+
     end
   end
 end

data/lib/compass/compiler.rb

@@ -22,15 +22,27 @@ module Compass
     end
 
     def css_files
-      @css_files || sass_files.map{|sass_file| "#{to}/#{stylesheet_name(sass_file)}.css"}
+      @css_files ||= sass_files.map{|sass_file| corresponding_css_file(sass_file)}
+    end
+
+    def corresponding_css_file(sass_file)
+      "#{to}/#{stylesheet_name(sass_file)}.css"
     end
 
     def target_directories
       css_files.map{|css_file| File.dirname(css_file)}.uniq.sort.sort_by{|d| d.length }
     end
 
+    def out_of_date?
+      Compass.configure_sass_plugin! unless Compass.sass_plugin_configured?
+      sass_files.zip(css_files).each do |sass_filename, css_filename|
+        return sass_filename if Sass::Plugin.exact_stylesheet_needs_update?(css_filename, sass_filename)
+      end
+      false
+    end
+
     def run
-      Compass.configure_sass_plugin!
+      Compass.configure_sass_plugin! unless Compass.sass_plugin_configured?
       target_directories.each do |dir|
         directory dir
       end

data/lib/compass/configuration.rb

@@ -13,7 +13,9 @@ module Compass
       :javascripts_dir,
       :output_style,
       :environment,
-      :http_images_path
+      :http_images_path,
+      :additional_import_paths,
+      :sass_options
     ]
 
     attr_accessor *ATTRIBUTES
@@ -38,6 +40,10 @@ module Compass
         value = eval(prop.to_s, binding) rescue nil
         self.send("#{prop}=", value) if value
       end
+      if @added_import_paths
+        self.additional_import_paths ||= []
+        self.additional_import_paths += @added_import_paths
+      end
     end
 
     def set_all(options)
@@ -117,7 +123,50 @@ module Compass
       end
     end
 
+    def add_import_path(*paths)
+      # The @added_import_paths variable works around an issue where
+      # the additional_import_paths gets overwritten during parse
+      @added_import_paths ||= []
+      @added_import_paths += paths
+      self.additional_import_paths ||= []
+      self.additional_import_paths += paths
+    end
+
+    # When called with a block, defines the asset host url to be used.
+    # The block must return a string that starts with a protocol (E.g. http).
+    # The block will be passed the root-relative url of the asset.
+    # When called without a block, returns the block that was previously set.
+    def asset_host(&block)
+      if block_given?
+        @asset_host = block
+      else
+        @asset_host
+      end
+    end
+
+    # When called with a block, defines the cache buster strategy to be used.
+    # The block must return nil or a string that can be appended to a url as a query parameter.
+    # The returned string must not include the starting '?'.
+    # The block will be passed the root-relative url of the asset.
+    # If the block accepts two arguments, it will also be passed a File object
+    # that points to the asset on disk -- which may or may not exist.
+    # When called without a block, returns the block that was previously set.
+    def asset_cache_buster(&block)
+      if block_given?
+        @asset_cache_buster = block
+      else
+        @asset_cache_buster
+      end
+    end
+
+
     def serialize
+      if asset_cache_buster
+        raise Compass::Error, "Cannot serialize a configuration with asset_cache_buster set."
+      end
+      if asset_host
+        raise Compass::Error, "Cannot serialize a configuration with asset_host set."
+      end
       contents = ""
       required_libraries.each do |lib|
         contents << %Q{require '#{lib}'\n}
@@ -152,17 +201,31 @@ module Compass
       Compass::Frameworks::ALL.each do |framework|
         locations[framework.stylesheets_directory] = css_path || css_dir || "."
       end
+      resolve_additional_import_paths.each do |additional_path|
+        locations[additional_path] = File.join(css_path || css_dir || ".", File.basename(additional_path))
+      end
       plugin_opts = {:template_location => locations}
       plugin_opts[:style] = output_style if output_style
       plugin_opts[:line_comments] = default_line_comments if environment
+      plugin_opts.merge!(sass_options || {})
       plugin_opts
     end
 
+    def resolve_additional_import_paths
+      (additional_import_paths || []).map do |path|
+        if project_path && !absolute_path?(path)
+          File.join(project_path, path)
+        else
+          path
+        end
+      end
+    end
+
     def to_sass_engine_options
       engine_opts = {:load_paths => sass_load_paths}
       engine_opts[:style] = output_style if output_style
       engine_opts[:line_comments] = default_line_comments if environment
-      engine_opts
+      engine_opts.merge!(sass_options || {})
     end
 
     def sass_load_paths
@@ -171,6 +234,7 @@ module Compass
       Compass::Frameworks::ALL.each do |framework|
         load_paths << framework.stylesheets_directory
       end
+      load_paths += resolve_additional_import_paths
       load_paths
     end
 
@@ -179,6 +243,9 @@ module Compass
       ATTRIBUTES.each do |attr|
         send("#{attr}=", nil)
       end
+      @asset_cache_buster = nil
+      @asset_host = nil
+      @added_import_paths = nil
       self.required_libraries = []
     end
 
@@ -187,6 +254,10 @@ module Compass
       super
     end
 
+    def absolute_path?(path)
+      # This is only going to work on unix, gonna need a better implementation.
+      path.index(File::SEPARATOR) == 0
+    end
   end
 
   module ConfigHelpers
@@ -202,9 +273,14 @@ module Compass
     end
 
     def configure_sass_plugin!
+      @sass_plugin_configured = true
       Sass::Plugin.options.merge!(sass_plugin_configuration)
     end
 
+    def sass_plugin_configured?
+      @sass_plugin_configured
+    end
+
     def sass_engine_options
       configuration.to_sass_engine_options
     end

data/lib/compass/exec.rb

@@ -80,14 +80,24 @@ module Compass
 Usage: compass [options] [project]
 
 Description:
-  When project is given, generates a new project of that name as a subdirectory of
-  the current directory.
+  The compass command line tool will help you create and manage the stylesheets for your project.
   
-  If you change any source files, you can update your project using --update.
+  To get started on a stand-alone project based on blueprint:
 
-Options:
+    compass -f blueprint my_compass_project
+
+  When you change any sass files, you must recompile your project using --update or --watch.
 END
-        opts.on('-u', '--update', :NONE, 'Update the current project') do
+        opts.separator ''
+        opts.separator 'Mode Options(only specify one):'
+
+        opts.on('-i', '--install', :NONE, "Create a new compass project.",
+                                          "  The default mode when a project is provided.") do
+          self.options[:command] = :create_project
+        end
+
+        opts.on('-u', '--update', :NONE, 'Update the current project.',
+                                         '  This is the default when no project is provided.') do
           self.options[:command] = :update_project
         end
 
@@ -96,19 +106,58 @@ END
           self.options[:quiet] = true
         end
 
-        opts.on('-f FRAMEWORK', '--framework FRAMEWORK', 'Use the specified framework.') do |framework|
-          self.options[:framework] = framework
-        end
-
-        opts.on('-p', '--pattern PATTERN', 'Stamp out a pattern into the current project. Must be used in combination with -f.') do |pattern|
+        opts.on('-p', '--pattern PATTERN', 'Stamp out a pattern into the current project.',
+                                           '  Must be used with -f.') do |pattern|
           self.options[:command] = :stamp_pattern
           self.options[:pattern] = pattern
         end
 
-        opts.on('-n', '--pattern-name NAME', 'The name to use when stamping a pattern. Must be used in combination with -p.') do |name|
+        opts.on('--write-configuration', "Write the current configuration to the configuration file.") do
+          self.options[:command] = :write_configuration
+        end
+
+        opts.on('--list-frameworks', "List compass frameworks available to use.") do
+          self.options[:command] = :list_frameworks
+        end
+
+        opts.on('--validate', :NONE, 'Validate your project\'s compiled css. Requires Java.') do
+          self.options[:command] = :validate_project
+        end
+
+        opts.on('--grid-img [DIMENSIONS]', 'Generate a background image to test grid alignment.',
+                                           '  Dimension is given as <column_width>+<gutter_width>.',
+                                           '  Defaults to 30+10.') do |dimensions|
+          self.options[:grid_dimensions] = dimensions || "30+10"
+          unless self.options[:grid_dimensions] =~ /^\d+\+\d+$/
+            puts "Please enter your dimensions as <column_width>+<gutter_width>. E.g. 20+5 or 30+10."
+            exit
+          end
+          self.options[:command] = :generate_grid_background
+        end
+
+        opts.separator ''
+        opts.separator 'Install/Pattern Options:'
+
+        opts.on('-f FRAMEWORK', '--framework FRAMEWORK', 'Use the specified framework. Only one may be specified.') do |framework|
+          self.options[:framework] = framework
+        end
+
+        opts.on('-n', '--pattern-name NAME', 'The name to use when stamping a pattern.',
+                                             '  Must be used in combination with -p.') do |name|
           self.options[:pattern_name] = name
         end
 
+        opts.on('--rails', "Sets the project type to a rails project.") do
+          self.options[:project_type] = :rails
+        end
+
+        opts.separator ''
+        opts.separator 'Configuration Options:'
+
+        opts.on('-c', '--config CONFIG_FILE', 'Specify the location of the configuration file explicitly.') do |configuration_file|
+          self.options[:configuration_file] = configuration_file
+        end
+
         opts.on('--sass-dir SRC_DIR', "The source directory where you keep your sass stylesheets.") do |sass_dir|
           self.options[:sass_dir] = sass_dir
         end
@@ -117,30 +166,33 @@ END
           self.options[:css_dir] = css_dir
         end
 
-        opts.on('--list-frameworks', "List compass frameworks available to use.") do
-          self.options[:command] = :list_frameworks
+        opts.on('--images-dir IMAGES_DIR', "The directory where you keep your images.") do |images_dir|
+          self.options[:images_dir] = images_dir
         end
 
-        opts.on('-c', '--write-configuration', "Write the current configuration to the configuration file.") do
-          self.options[:command] = :write_configuration
+        opts.on('--javascripts-dir JS_DIR', "The directory where you keep your javascripts.") do |javascripts_dir|
+          self.options[:javascripts_dir] = javascripts_dir
         end
 
-        opts.on('-e ENV', '--environment ENV', [:development, :production], 'Use sensible defaults for your current environment: development, production (default)') do |env|
+        opts.on('-e ENV', '--environment ENV', [:development, :production], 'Use sensible defaults for your current environment.',
+                '  One of: development, production (default)') do |env|
           self.options[:environment] = env
         end
 
-        opts.on('-s STYLE', '--output-style STYLE', [:nested, :expanded, :compact, :compressed], 'Select a CSS output mode (nested, expanded, compact, compressed)') do |style|
+        opts.on('-s STYLE', '--output-style STYLE', [:nested, :expanded, :compact, :compressed], 'Select a CSS output mode.',
+                 '  One of: nested, expanded, compact, compressed') do |style|
           self.options[:output_style] = style
         end
 
-        opts.on('-r LIBRARY', '--require LIBRARY', "Require LIBRARY before running commands. This is used to access compass plugins.") do |library|
+        opts.separator ''
+        opts.separator 'General Options:'
+
+        opts.on('-r LIBRARY', '--require LIBRARY', "Require the given ruby LIBRARY before running commands.",
+                                                   "  This is used to access compass plugins without having a",
+                                                   "  project configuration file.") do |library|
           ::Compass.configuration.require library
         end
         
-        opts.on('--rails', "Sets the project type to a rails project.") do
-          self.options[:project_type] = :rails
-        end
-
         opts.on('-q', '--quiet', :NONE, 'Quiet mode.') do
           self.options[:quiet] = true
         end
@@ -153,11 +205,13 @@ END
           self.options[:trace] = true
         end
         
-        opts.on('--force', :NONE, 'Force. Allows some commands to succeed when they would otherwise fail.') do
+        opts.on('--force', :NONE, 'Force. Allows some failing commands to succeed instead.') do
           self.options[:force] = true
         end
 
-        opts.on('--imports', :NONE, 'Emit an import path suitable for use with the Sass command-line tool.') do
+        opts.on('--imports', :NONE, 'Emit an imports suitable for passing to the sass command-line.',
+                                    '  Example: sass `compass --imports`',
+                                    '  Note: Compass\'s Sass extensions will not be available.') do
           print ::Compass::Frameworks::ALL.map{|f| "-I #{f.stylesheets_directory}"}.join(' ')
           exit
         end
@@ -167,10 +221,6 @@ END
           exit
         end
 
-        opts.on('--validate', :NONE, 'Validate your project\'s compiled css. Requires Java.') do
-          self.options[:command] = :validate_project
-        end
-
         opts.on_tail("-?", "-h", "--help", "Show this message") do
           puts opts
           exit
@@ -180,15 +230,6 @@ END
           self.options[:command] = :print_version
         end
 
-        opts.on('--grid-img [DIMENSIONS]', 'Generate a background image to test grid alignment. Dimension is given as <column_width>+<gutter_width>. Defaults to 30+10.') do |dimensions|
-          self.options[:grid_dimensions] = dimensions || "30+10"
-          unless self.options[:grid_dimensions] =~ /^\d+\+\d+$/
-            puts "Please enter your dimensions as <column_width>+<gutter_width>. E.g. 20+5 or 30+10."
-            exit
-          end
-          self.options[:command] = :generate_grid_background
-        end
-
       end
       
       def do_command(command)

data/lib/compass/installers/base.rb

@@ -127,12 +127,14 @@ module Compass
       def stylesheet_links
         html = "<head>\n"
         manifest.each_stylesheet do |stylesheet|
+          # Skip partials.
+          next if File.basename(stylesheet.from)[0..0] == "_"
           media = if stylesheet.options[:media]
             %Q{ media="#{stylesheet.options[:media]}"}
           end
           ss_line = %Q{  <link href="/stylesheets/#{stylesheet.to.sub(/\.sass$/,'.css')}"#{media} rel="stylesheet" type="text/css" />}
-          if stylesheet.options[:ie]
-            ss_line = "  <!--[if IE]>\n    #{ss_line}\n  <![endif]-->"
+          if stylesheet.options[:condition]
+            ss_line = "  <!--[if #{stylesheet.options[:condition]}]>\n    #{ss_line}\n  <![endif]-->"
           end
           html << ss_line + "\n"
         end

data/lib/compass/installers/rails.rb

@@ -13,8 +13,9 @@ module Compass
         }
       end
 
-      def write_configuration_files
-        write_file targetize('config/compass.config'), config_contents
+      def write_configuration_files(config_file = nil)
+        config_file ||= targetize('config/compass.config')
+        write_file config_file, config_contents
         write_file targetize('config/initializers/compass.rb'), initializer_contents
       end
 

data/lib/compass/installers/stand_alone.rb

@@ -8,8 +8,9 @@ module Compass
         super
       end
 
-      def write_configuration_files
-        write_file targetize('config.rb'), config_contents
+      def write_configuration_files(config_file = nil)
+        config_file ||= targetize('config.rb')
+        write_file config_file, config_contents
       end
 
       def config_files_exist?

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

@@ -0,0 +1,22 @@
+module Compass::SassExtensions::Functions::Display
+  DEFAULT_DISPLAY = {
+    :block => %w{address blockquote center dir div dd dl dt fieldset form
+                 frameset h1 h2 h3 h4 h5 h6 hr isindex menu noframes
+                 noscript ol p pre ul},
+    :inline => %w{a abbr acronym b basefont bdo big br cite code dfn em
+                  font i img input kbd label q s samp select small span
+                  strike strong sub sup textarea tt u var},
+    :table => %w{table},
+    :"list-item" => %w{li},
+    :"table-row-group" => %w{tbody},
+    :"table-header-group" => %w{thead},
+    :"table-footer-group" => %w{tfoot},
+    :"table-row" => %w{tr},
+    :"table-cell" => %w{th td}
+  }
+
+  # returns a comma delimited string for all the elements according to their default css3 display value.
+  def elements_of_type(display)
+    Sass::Script::String.new(DEFAULT_DISPLAY.fetch(display.value.to_sym).join(", "))
+  end
+end

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

@@ -0,0 +1,6 @@
+module Compass::SassExtensions::Functions::Enumerate
+  def enumerate(prefix, from, through)
+    selectors = (from.value..through.value).map{|i| "#{prefix.value}-#{i}"}.join(", ")
+    Sass::Script::String.new(selectors)
+  end
+end

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

@@ -0,0 +1,88 @@
+module Compass::SassExtensions::Functions::ImageUrl
+  def image_url(path)
+    path = path.value # get to the string value of the literal.
+    # Short curcuit if they have provided an absolute url.
+    if absolute_path?(path)
+      puts "#{path} is absolute"
+      return Sass::Script::String.new("url(#{path})")
+    end
+
+    # Compute the path to the image, either root relative or stylesheet relative
+    # or nil if the http_images_path is not set in the configuration.
+    http_images_path = if relative?
+      compute_relative_path
+    else
+      Compass.configuration.http_images_path
+    end
+
+    # Compute the real path to the image on the file stystem if the images_dir is set.
+    real_path = if Compass.configuration.images_dir
+      File.join(Compass.configuration.project_path, Compass.configuration.images_dir, path)
+    end
+
+    # prepend the path to the image if there's one
+    if http_images_path
+      http_images_path = "#{http_images_path}/" unless http_images_path[-1..-1] == "/"
+      path = "#{http_images_path}#{path}"
+    end
+
+    # Compute the asset host unless in relative mode.
+    asset_host = (compute_asset_host(path) unless relative?)
+
+    # Compute and append the cache buster if there is one.
+    if buster = compute_cache_buster(path, real_path)
+      path += "?#{buster}"
+    end
+
+    # prepend the asset host if there is one.
+    path = "#{asset_host}#{'/' unless path[0..0] == "/"}#{path}" if asset_host
+
+    Sass::Script::String.new("url(#{path})")
+  end
+
+  private
+
+  def relative?
+    Compass.configuration.http_images_path == :relative
+  end
+
+  def absolute_path?(path)
+    path[0..0] == "/" || path[0..3] == "http"
+  end
+
+  def compute_relative_path
+    if (target_css_file = options[:css_filename])
+      images_path = File.join(Compass.configuration.project_path, Compass.configuration.images_dir)
+      Pathname.new(images_path).relative_path_from(Pathname.new(File.dirname(target_css_file))).to_s
+    end
+  end
+
+  def compute_cache_buster(path, real_path)
+    if Compass.configuration.asset_cache_buster
+      args = [path]
+      if Compass.configuration.asset_cache_buster.arity > 1
+        args << (File.new(real_path) if real_path)
+      end
+      Compass.configuration.asset_cache_buster.call(*args)
+    elsif real_path
+      default_cache_buster(path, real_path)
+    end
+  end
+
+  def default_cache_buster(path, real_path)
+    if File.readable?(real_path)
+      File.mtime(real_path).strftime("%s") 
+    else
+      $stderr.puts "WARNING: '#{File.basename(path)}' was not found (or cannot be read) in #{File.dirname(real_path)}"
+    end
+  end
+
+  def compute_asset_host(path)
+    if Compass.configuration.asset_host
+      Compass.configuration.asset_host.call(path)
+    else
+      nil
+    end
+  end
+
+end

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

@@ -0,0 +1,35 @@
+require 'base64'
+module Compass::SassExtensions::Functions::InlineImage
+
+  def inline_image(path, mime_type = nil)
+    path = path.value
+    real_path = File.join(Compass.configuration.project_path, Compass.configuration.images_dir, path)
+    url = "url('data:#{compute_mime_type(path,mime_type)};base64,#{data(real_path)}')"
+    Sass::Script::String.new(url)
+  end
+
+private
+  def compute_mime_type(path, mime_type)
+    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 /\.([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)
+      Base64.encode64(File.read(real_path)).gsub("\n","")
+    else
+      raise Compass::Error, "File not found or cannot be read: #{real_path}"
+    end
+  end
+end