compass-edge 0.9.1

data/lib/compass.rb

@@ -0,0 +1,22 @@
+module Compass
+end
+
+%w(dependencies sass_extensions core_ext version errors).each do |lib|
+  require "compass/#{lib}"
+end
+
+module Compass
+  extend Compass::Version
+  VERSION = "#{version[:major]}.#{version[:minor]}.#{version[:patch]}"
+  def base_directory
+    File.expand_path(File.join(File.dirname(__FILE__), '..'))
+  end
+  def lib_directory
+    File.expand_path(File.join(File.dirname(__FILE__)))
+  end
+  module_function :base_directory, :lib_directory
+end
+
+%w(configuration frameworks app_integration).each do |lib|
+  require "compass/#{lib}"
+end

data/lib/compass/actions.rb

@@ -0,0 +1,116 @@
+module Compass
+  module Actions
+
+    attr_writer :logger
+
+    def logger
+      @logger ||= Logger.new
+    end
+
+    # copy/process a template in the compass template directory to the project directory.
+    def copy(from, to, options = nil, binary = false)
+      options ||= self.options if self.respond_to?(:options)
+      contents = File.new(from).read
+      write_file to, contents, options, binary
+    end
+
+    # create a directory and all the directories necessary to reach it.
+    def directory(dir, options = nil)
+      options ||= self.options if self.respond_to?(:options)
+      if File.exists?(dir) && File.directory?(dir)
+          logger.record :exists, basename(dir) unless options[:quiet]
+      elsif File.exists?(dir)
+        msg = "#{basename(dir)} already exists and is not a directory."
+        raise Compass::FilesystemConflict.new(msg)
+      else
+        logger.record :directory, separate("#{basename(dir)}/")
+        FileUtils.mkdir_p(dir) unless options[:dry_run]
+      end
+    end
+
+    # Write a file given the file contents as a string
+    def write_file(file_name, contents, options = nil, binary = false)
+      options ||= self.options if self.respond_to?(:options)
+      skip_write = options[:dry_run]
+      contents = process_erb(contents, options[:erb]) if options[:erb]
+      if File.exists?(file_name)
+        existing_contents = IO.read(file_name)
+        if existing_contents == contents
+          logger.record :identical, basename(file_name)
+          skip_write = true
+        elsif options[:force]
+          logger.record :overwrite, basename(file_name)
+        else
+          msg = "File #{basename(file_name)} already exists. Run with --force to force overwrite."
+          raise Compass::FilesystemConflict.new(msg)
+        end
+      else
+        logger.record :create, basename(file_name)
+      end
+      if skip_write
+        FileUtils.touch file_name unless options[:dry_run]
+      else
+        mode = "w"
+        mode << "b" if binary
+        open(file_name, mode) do |file|
+          file.write(contents)
+        end
+      end
+    end
+
+    def process_erb(contents, ctx = nil)
+      ctx = Object.new.instance_eval("binding") unless ctx.is_a? Binding
+      ERB.new(contents).result(ctx)
+    end
+
+    # Compile one Sass file
+    def compile(sass_filename, css_filename, options)
+      if options[:force] || Sass::Plugin.exact_stylesheet_needs_update?(css_filename, sass_filename)
+        logger.record :compile, basename(sass_filename) unless options[:quiet]
+        engine = ::Sass::Engine.new(open(sass_filename).read,
+                                    :filename => sass_filename,
+                                    :line_comments => options[:line_comments],
+                                    :style => options[:style],
+                                    :css_filename => css_filename,
+                                    :load_paths => options[:load_paths],
+                                    :cache_location => options[:cache_location])
+        css_content = engine.render
+        write_file(css_filename, css_content, options.merge(:force => true))
+      else
+        logger.record :unchanged, basename(sass_filename) unless options[:quiet]
+      end
+    end
+
+    def remove(file_name)
+      if File.exists?(file_name)
+        File.unlink file_name
+        logger.record :remove, basename(file_name)
+      end
+    end
+
+    def basename(file)
+      relativize(file) {|f| File.basename(file)}
+    end
+
+    def relativize(path)
+      if path.index(working_path+File::SEPARATOR) == 0
+        path[(working_path+File::SEPARATOR).length..-1]
+      elsif block_given?
+        yield path
+      else
+        path
+      end
+    end
+
+    # Write paths like we're on unix and then fix it
+    def separate(path)
+      path.gsub(%r{/}, File::SEPARATOR)
+    end
+
+    # Removes the trailing separator, if any, from a path.
+    def strip_trailing_separator(path)
+      (path[-1..-1] == File::SEPARATOR) ? path[0..-2] : path
+    end
+
+  end
+end

data/lib/compass/app_integration.rb

@@ -0,0 +1,3 @@
+%w(stand_alone rails merb).each do |lib|
+  require "compass/app_integration/#{lib}"
+end

data/lib/compass/app_integration/merb.rb

@@ -0,0 +1 @@
+require 'compass/app_integration/merb/runtime' if defined?(Merb::Plugins)

data/lib/compass/app_integration/merb/runtime.rb

@@ -0,0 +1,63 @@
+# To configure Merb to use compass do the following:
+# 
+# Add dependencies to config/dependencies.rb
+# 
+# dependency "haml", ">=2.2.0" 
+# dependency "merb-haml", merb_gems_version
+# dependency "chriseppstein-compass", :require_as => 'compass'
+# 
+# 
+# To use a different sass stylesheets locations as is recommended by compass
+# add this configuration to your configuration block:
+#
+# Merb::BootLoader.before_app_loads do
+#   Merb::Plugins.config[:compass] = {
+#     :stylesheets => "app/stylesheets",
+#     :compiled_stylesheets => "public/stylesheets/compiled"
+#   }
+# end
+# 
+module Compass
+  def self.setup_template_location
+    # default the compass configuration if they didn't set it up yet.
+    Merb::Plugins.config[:compass] ||= {}
+
+    # default sass stylesheet location unless configured to something else
+    Merb::Plugins.config[:compass][:stylesheets] ||= Merb.dir_for(:stylesheet) / "sass"
+
+    # default sass css location unless configured to something else
+    Merb::Plugins.config[:compass][:compiled_stylesheets] ||= Merb.dir_for(:stylesheet)
+
+    #define the template hash for the project stylesheets as well as the framework stylesheets.
+    template_location = {
+      Merb::Plugins.config[:compass][:stylesheets] => Merb::Plugins.config[:compass][:compiled_stylesheets]
+    }
+    Compass::Frameworks::ALL.each do |framework|
+      template_location[framework.stylesheets_directory] = Merb::Plugins.config[:compass][:compiled_stylesheets]
+    end
+
+    # merge existing template locations if present
+    if Merb::Plugins.config[:sass][:template_location].is_a?(Hash)
+      template_location.merge!(Merb::Plugins.config[:sass][:template_location])
+      Merb::Plugins.config[:sass][:template_location] = template_location
+    end
+
+    #configure Sass to know about all these sass locations.
+    Sass::Plugin.options[:template_location] = template_location
+  end
+end
+
+Merb::BootLoader.after_app_loads do
+  #set up sass if haml load didn't do it -- this happens when using a non-default stylesheet location.
+  unless defined?(Sass::Plugin)
+    require "sass/plugin" 
+    if Merb::Plugins.config[:sass]
+      Sass::Plugin.options = Merb::Plugins.config[:sass] 
+    # support old (deprecatd Merb::Config[:sass] option)
+    elsif Merb::Config[:sass] 
+      Sass::Plugin.options = Merb::Config[:sass] 
+    end
+  end
+
+  Compass.setup_template_location
+end

data/lib/compass/app_integration/rails.rb

@@ -0,0 +1,8 @@
+%w(configuration_defaults installer).each do |lib|
+  require "compass/app_integration/rails/#{lib}"
+end
+
+require 'compass/app_integration/rails/runtime' if defined?(ActionController::Base)
+
+
+

data/lib/compass/app_integration/rails/action_controller.rb

@@ -0,0 +1,15 @@
+# :stopdoc:
+module ActionController
+  class Base
+    def process_with_compass(*args)
+      Sass::Plugin.rails_controller = self
+      begin
+        process_without_compass(*args)
+      ensure
+        Sass::Plugin.rails_controller = nil
+      end
+    end
+    alias_method_chain :process, :compass
+  end
+end
+# :startdoc:

data/lib/compass/app_integration/rails/configuration_defaults.rb

@@ -0,0 +1,29 @@
+module Compass
+  module AppIntegration
+    module Rails
+      module ConfigurationDefaults
+
+        def default_images_dir
+          File.join("public", "images")
+        end
+
+        def default_javascripts_dir
+          File.join("public", "javascripts")
+        end
+
+        def default_http_images_path
+          "/images"
+        end
+
+        def default_http_javascripts_path
+          "/javascripts"
+        end
+
+        def default_http_stylesheets_path
+          "/stylesheets"
+        end
+
+      end
+    end
+  end
+end

data/lib/compass/app_integration/rails/installer.rb

@@ -0,0 +1,127 @@
+module Compass
+  module Installers
+    class Base
+    end
+  end
+
+  module AppIntegration
+    module Rails    
+      class Installer < Compass::Installers::Base
+
+        def default_configuration
+          Compass::Configuration::Data.new.extend(ConfigurationDefaults)
+        end
+
+        def completed_configuration
+          config = {}
+          config[:sass_dir] = prompt_sass_dir unless sass_dir_without_default
+          config[:css_dir] = prompt_css_dir unless css_dir_without_default
+          config unless config.empty?
+        end
+
+        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
+
+        def config_files_exist?
+          File.exists?(targetize('config/compass.config')) &&
+          File.exists?(targetize('config/initializers/compass.rb'))
+        end
+
+        def prepare
+          write_configuration_files unless config_files_exist?
+        end
+
+        def finalize(options = {})
+          if options[:create]
+            puts <<-NEXTSTEPS
+
+  Congratulations! Your rails project has been configured to use Compass.
+  Sass will automatically compile your stylesheets during the next
+  page request and keep them up to date when they change.
+  Make sure you restart your server!
+  NEXTSTEPS
+          end
+          if manifest.has_stylesheet?
+            puts "\nNext add these lines to the head of your layouts:\n\n"
+            puts stylesheet_links
+            puts "\n(You are using haml, aren't you?)"
+          end
+        end
+
+
+        def install_location_for_html(to, options)
+          separate("public/#{pattern_name_as_dir}#{to}")
+        end
+
+        def prompt_sass_dir
+          recommended_location = separate('app/stylesheets')
+          default_location = separate('public/stylesheets/sass')
+          print %Q{Compass recommends that you keep your stylesheets in #{recommended_location}
+  instead of the Sass default location of #{default_location}.
+  Is this OK? (Y/n) }
+          answer = gets.downcase[0]
+          answer == ?n ? default_location : recommended_location
+        end
+
+        def prompt_css_dir
+          recommended_location = separate("public/stylesheets/compiled")
+          default_location = separate("public/stylesheets")
+          puts
+          print %Q{Compass recommends that you keep your compiled css in #{recommended_location}/
+  instead the Sass default of #{default_location}/.
+  However, if you're exclusively using Sass, then #{default_location}/ is recommended.
+  Emit compiled stylesheets to #{recommended_location}/? (Y/n) }
+          answer = gets.downcase[0]
+          answer == ?n ? default_location : recommended_location
+        end
+
+        def config_contents
+          Compass.configuration.serialize do |prop, value|
+            if prop == :project_path
+              "project_path = RAILS_ROOT if defined?(RAILS_ROOT)\n"
+            elsif prop == :output_style
+              ""
+            end
+          end
+        end
+
+        def initializer_contents
+          %Q{require 'compass'
+  # If you have any compass plugins, require them here.
+  Compass.configuration.parse(File.join(RAILS_ROOT, "config", "compass.config"))
+  Compass.configuration.environment = RAILS_ENV.to_sym
+  Compass.configure_sass_plugin!
+  }
+        end
+
+        def stylesheet_prefix
+          if css_dir.length >= 19
+            "#{css_dir[19..-1]}/"
+          else
+            nil
+          end
+        end
+
+        def stylesheet_links
+          html = "%head\n"
+          manifest.each_stylesheet do |stylesheet|
+            # Skip partials.
+            next if File.basename(stylesheet.from)[0..0] == "_"
+            ss_line = "  = stylesheet_link_tag '#{stylesheet_prefix}#{stylesheet.to.sub(/\.sass$/,'.css')}'"
+            if stylesheet.options[:media]
+              ss_line += ", :media => '#{stylesheet.options[:media]}'"
+            end
+            if stylesheet.options[:condition]
+              ss_line = "  /[if #{stylesheet.options[:condition]}]\n  " + ss_line
+            end
+            html << ss_line + "\n"
+          end
+          html
+        end
+      end
+    end
+  end
+end

data/lib/compass/app_integration/rails/runtime.rb

@@ -0,0 +1,14 @@
+unless defined?(Compass::RAILS_LOADED)
+  Compass::RAILS_LOADED = true
+
+  %w(action_controller sass_plugin urls).each do |lib|
+    require "compass/app_integration/rails/#{lib}"
+  end
+
+  # Wierd that this has to be re-included to pick up sub-modules. Ruby bug?
+  class Sass::Script::Functions::EvaluationContext
+    include Sass::Script::Functions
+    private
+    include ActionView::Helpers::AssetTagHelper
+  end
+end

data/lib/compass/app_integration/rails/sass_plugin.rb

@@ -0,0 +1,5 @@
+module Sass::Plugin
+  class << self
+    attr_accessor :rails_controller
+  end
+end

data/lib/compass/app_integration/rails/templates/compass-install-rails.rb

@@ -0,0 +1,80 @@
+# =================================================================
+# Compass Ruby on Rails Installer (template) v.1.0
+# written by Derek Perez (derek@derekperez.com)
+# -----------------------------------------------------------------
+# NOTE: This installer is designed to work as a Rails template,
+# and can only be used with Rails 2.3+.
+# -----------------------------------------------------------------
+# Copyright (c) 2009 Derek Perez
+#
+# Permission is hereby granted, free of charge, to any person
+# obtaining a copy of this software and associated documentation
+# files (the "Software"), to deal in the Software without
+# restriction, including without limitation the rights to use,
+# copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the
+# Software is furnished to do so, subject to the following
+# conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+# OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+# HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+# WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+# OTHER DEALINGS IN THE SOFTWARE.
+# =================================================================
+puts "==================================================="
+puts "Welcome to the Compass Installer for Ruby on Rails!"
+puts "==================================================="
+puts
+
+# css framework prompt
+css_framework = ask("What CSS Framework do you want to use with Compass? (default: 'blueprint')")
+css_framework = "blueprint" if css_framework.blank?
+
+# sass storage prompt
+sass_dir = ask("Where would you like to keep your sass files within your project? (default: 'app/stylesheets')")
+sass_dir = "app/stylesheets" if sass_dir.blank?
+
+# compiled css storage prompt
+css_dir = ask("Where would you like Compass to store your compiled css files? (default: 'public/stylesheets/compiled')")
+css_dir = "public/stylesheets/compiled" if css_dir.blank?
+
+# define dependencies
+gem "haml", :lib => "haml", :version => ">=2.2.0"
+gem "chriseppstein-compass", :source => "http://gems.github.com/", :lib => "compass"
+
+# install and unpack
+rake "gems:install GEM=haml", :sudo => true
+rake "gems:install GEM=chriseppstein-compass", :sudo => true
+rake "gems:unpack GEM=chriseppstein-compass"
+
+# load any compass framework plugins
+if css_framework =~ /960/
+  gem "chriseppstein-compass-960-plugin", :source => "http://gems.github.com", :lib => "ninesixty"
+  rake "gems:install GEM=chriseppstein-compass-960-plugin", :sudo => true
+  rake "gems:unpack GEM=chriseppstein-compass-960-plugin"
+  css_framework = "960" # rename for command
+  plugin_require = "-r ninesixty"
+end
+
+# build out compass command
+compass_command = "compass --rails -f #{css_framework} . --css-dir=#{css_dir} --sass-dir=#{sass_dir} "
+compass_command << plugin_require if plugin_require
+
+# Require compass during plugin loading
+file 'vendor/plugins/compass/init.rb', <<-CODE
+# This is here to make sure that the right version of sass gets loaded (haml 2.2) by the compass requires.
+require 'compass'
+CODE
+
+# integrate it!
+run "haml --rails ."
+run compass_command
+
+puts "Compass (with #{css_framework}) is all setup, have fun!"