compass 0.8.17 → 0.10.0.pre1

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

@@ -0,0 +1,28 @@
+module Compass
+  module AppIntegration
+    module StandAlone
+      module ConfigurationDefaults
+        def default_project_type
+          :stand_alone
+        end
+
+        def sass_dir_without_default
+          "src"
+        end
+
+        def javascripts_dir_without_default
+          "javascripts"
+        end
+
+        def css_dir_without_default
+          "stylesheets"
+        end
+
+        def images_dir_without_default
+          "images"
+        end
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,83 @@
+module Compass
+  module Installers
+    class Base
+    end
+    class ManifestInstaller < Base
+    end
+  end
+
+  module AppIntegration
+    module StandAlone
+      class Installer < Compass::Installers::ManifestInstaller
+
+        def init
+          directory targetize("")
+          super
+        end
+
+        def write_configuration_files(config_file = nil)
+          config_file ||= targetize('config.rb')
+          write_file config_file, config_contents
+        end
+
+        def config_files_exist?
+          File.exists? targetize('config.rb')
+        end
+
+        def config_contents
+          project_path, Compass.configuration.project_path = Compass.configuration.project_path, nil
+          Compass.configuration.serialize
+        ensure
+          Compass.configuration.project_path = project_path
+        end
+
+        def prepare
+          write_configuration_files unless config_files_exist? || !@manifest.generate_config?
+        end
+
+        def completed_configuration
+          nil
+        end
+
+        def finalize(options = {})
+          if options[:create] && !manifest.welcome_message_options[:replace]
+            puts <<-NEXTSTEPS
+
+*********************************************************************
+Congratulations! Your compass project has been created.
+
+You may now add and edit sass stylesheets in the #{Compass.configuration.sass_dir} subdirectory of your project.
+
+Sass files beginning with an underscore are called partials and won't be
+compiled to CSS, but they can be imported into other sass stylesheets.
+
+You can configure your project by editing the config.rb configuration file.
+
+You must compile your sass stylesheets into CSS when they change.
+This can be done in one of the following ways:
+  1. To compile on demand:
+     compass compile [path/to/project]
+  2. To monitor your project for changes and automatically recompile:
+     compass watch [path/to/project]
+
+More Resources:
+  * Wiki: http://wiki.github.com/chriseppstein/compass
+  * Sass: http://sass-lang.com
+  * Community: http://groups.google.com/group/compass-users/
+
+NEXTSTEPS
+          end
+          puts manifest.welcome_message if manifest.welcome_message
+          if manifest.has_stylesheet? && !manifest.welcome_message_options[:replace]
+            puts "\nTo import your new stylesheets add the following lines of HTML (or equivalent) to your webpage:"
+            puts stylesheet_links
+          end
+        end
+
+        def compilation_required?
+          @manifest.compile?
+        end
+      end
+    end
+  end
+end

data/lib/compass/commands.rb

@@ -0,0 +1,11 @@
+module Compass::Commands
+end
+
+require 'compass/commands/registry'
+
+%w(base generate_grid_background help list_frameworks project_base
+   update_project watch_project create_project installer_command
+   print_version project_stats stamp_pattern validate_project
+   write_configuration interactive).each do |lib|
+  require "compass/commands/#{lib}"
+end

data/lib/compass/commands/base.rb

@@ -1,6 +1,9 @@
 module Compass
   module Commands
     class Base
+      def self.register(command_name)
+        Compass::Commands[command_name] = self
+      end
 
       include Actions
 
@@ -30,4 +33,4 @@ module Compass
 
     end
   end
-end
+end

data/lib/compass/commands/create_project.rb

@@ -1,13 +1,116 @@
 require 'fileutils'
-require File.join(File.dirname(__FILE__), 'stamp_pattern')
-require File.join(File.dirname(__FILE__), 'update_project')
+require 'compass/commands/stamp_pattern'
 
 module Compass
   module Commands
+    module CreateProjectOptionsParser
+      def set_options(opts)
+
+        if $command == "create"
+          opts.banner = %Q{
+            Usage: compass create path/to/project [options]
+
+            Description:
+            Create a new compass project at the path specified.
+
+            Options:
+          }.split("\n").map{|l| l.gsub(/^ */,'')}.join("\n")
+
+          opts.on_tail("--bare", "Don't generate any Sass or CSS files.") do
+            self.options[:bare] = true
+          end
+        else
+          opts.banner = %Q{
+            Usage: compass init project_type path/to/project [options]
+
+            Description:
+            Initialize an existing project at the path specified.
+
+            Supported Project Types:
+            * rails
+
+            Options:
+          }.split("\n").map{|l| l.gsub(/^ */,'')}.join("\n").strip
+        end
+
+        opts.on("--using FRAMEWORK", "Framework to use when creating the project.") do |framework|
+          framework = framework.split('/', 2)
+          self.options[:framework] = framework[0]
+          self.options[:pattern] = framework[1]
+        end
+
+        super
+      end
+    end
+
     class CreateProject < StampPattern
 
-      def initialize(working_path, options)
-        super(working_path, options.merge(:pattern => "project", :pattern_name => nil))
+      register :create
+      register :init
+
+      class << self
+        def option_parser(arguments)
+          parser = Compass::Exec::CommandOptionParser.new(arguments)
+          parser.extend(Compass::Exec::GlobalOptionsParser)
+          parser.extend(Compass::Exec::ProjectOptionsParser)
+          parser.extend(CreateProjectOptionsParser)
+        end
+
+        def usage
+          option_parser([]).to_s
+        end
+
+        def description(command)
+          if command.to_sym == :create
+            "Create a new compass project"
+          else
+            "Initialize an existing project"
+          end
+        end
+
+        def primary; true; end
+
+        def parse!(arguments)
+          parser = option_parser(arguments)
+          parse_options!(parser, arguments)
+          parse_arguments!(parser, arguments)
+          if parser.options[:framework] && parser.options[:bare]
+            raise Compass::Error, "A bare project cannot be created when a framework is specified."
+          end
+          set_default_arguments(parser)
+          parser.options
+        end
+
+        def parse_init!(arguments)
+          parser = option_parser(arguments)
+          parse_options!(parser, arguments)
+          if arguments.size > 0
+            parser.options[:project_type] = arguments.shift.to_sym
+          end
+          parse_arguments!(parser, arguments)
+          set_default_arguments(parser)
+          parser.options
+        end
+
+        def parse_options!(parser, arguments)
+          parser.parse!
+          parser
+        end
+
+        def parse_arguments!(parser, arguments)
+          if arguments.size == 1
+            parser.options[:project_name] = arguments.shift
+          elsif arguments.size == 0
+            # default to the current directory.
+          else
+            raise Compass::Error, "Too many arguments were specified."
+          end
+        end
+
+        def set_default_arguments(parser)
+          parser.options[:framework] ||= :compass
+          parser.options[:pattern] ||= "project"
+        end
       end
 
       def is_project_creation?
@@ -16,4 +119,4 @@ module Compass
 
     end
   end
-end
+end

data/lib/compass/commands/generate_grid_background.rb

@@ -1,19 +1,86 @@
-require File.join(File.dirname(__FILE__), 'project_base')
-require File.join(File.dirname(__FILE__), 'update_project')
-require File.join(File.dirname(__FILE__), '..', 'grid_builder')
+require 'compass/commands/project_base'
+require 'compass/commands/update_project'
+require 'compass/grid_builder'
 
 module Compass
   module Commands
+    module GridBackgroundOptionsParser
+      def set_options(opts)
+        banner = %Q{Usage: compass grid-img W+GxH [path/to/grid.png]
+
+Description:
+  Generates a background image that can be used to check grid alignment.
+
+  Height is optional and defaults to 20px
+
+  By default, the image generated will be named "grid.png"
+  and be found in the images directory.
+
+  This command requires that you have both ImageMagick and RMagick installed.
+
+Examples:
+
+  compass grid-img 40+10 # 40px column, 10px gutter, 20px height
+  compass grid-img 40+20x28 # 40px column, 20px gutter, 28px height
+  compass grid-img 60+20x28 images/wide_grid.png
+
+Options:
+}
+        opts.banner = banner
+
+        super
+      end
+    end
     class GenerateGridBackground < ProjectBase
+
       include Actions
+
+      register :"grid-img"
+
+      class << self
+        def option_parser(arguments)
+          parser = Compass::Exec::CommandOptionParser.new(arguments)
+          parser.extend(Compass::Exec::GlobalOptionsParser)
+          parser.extend(GridBackgroundOptionsParser)
+        end
+
+        def usage
+          option_parser([]).to_s
+        end
+
+        def description(command)
+          "Generates a grid background image."
+        end
+
+        def parse!(arguments)
+          parser = option_parser(arguments)
+          parser.parse!
+          if arguments.size == 0
+            raise OptionParser::ParseError, "Please specify the grid dimensions."
+          end
+          parser.options[:grid_dimensions] = arguments.shift
+          parser.options[:grid_filename] = arguments.shift
+          parser.options
+        end
+      end
       def initialize(working_path, options)
         super
         assert_project_directory_exists!
+        Compass.add_configuration(options, 'command_line')
       end
 
       def perform
-        column_width, gutter_width = options[:grid_dimensions].split(/\+/).map{|d| d.to_i}
-        unless GridBuilder.new(options.merge(:column_width => column_width, :gutter_width => gutter_width, :output_path => projectize(project_images_subdirectory), :working_path => self.working_path)).generate!
+        unless options[:grid_dimensions] =~ /^(\d+)\+(\d+)(?:x(\d+))?$/
+          puts "ERROR: '#{options[:grid_dimensions]}' is not valid."
+          puts "Dimensions should be specified like: 30+10x20"
+          puts "where 30 is the column width, 10 is the gutter width, and 20 is the (optional) height."
+          return
+        end
+        column_width = $1.to_i
+        gutter_width = $2.to_i
+        height = $3.to_i if $3
+        filename = options[:grid_filename] || projectize("#{project_images_subdirectory}/grid.png")
+        unless GridBuilder.new(options.merge(:column_width => column_width, :gutter_width => gutter_width, :height => height, :filename => filename, :working_path => self.working_path)).generate!
           puts "ERROR: Some library dependencies appear to be missing."
           puts "Have you installed rmagick? If not, please run:"
           puts "sudo gem install rmagick"
@@ -21,4 +88,4 @@ module Compass
       end
     end
   end
-end
+end

data/lib/compass/commands/help.rb

@@ -0,0 +1,89 @@
+module Compass
+  module Commands
+    module HelpOptionsParser
+      def set_options(opts)
+        banner = %Q{Usage: compass help [command]
+
+Description:
+  The Compass Stylesheet Authoring Framework helps you
+  build and maintain your stylesheets and makes it easy
+  for you to use stylesheet libraries provided by others.
+
+To get help on a particular command please specify the command.
+
+}
+        
+        primary_commands = Compass::Commands.all.select do |c|
+          cmd = Compass::Commands[c]
+          cmd.respond_to?(:primary) && cmd.primary
+        end
+        other_commands = Compass::Commands.all - primary_commands
+
+        banner << command_list("Primary Commands:", primary_commands)
+        banner << command_list("Other Commands:", other_commands)
+ 
+        banner << "\nAvailable Frameworks & Patterns:\n\n"
+        Compass::Frameworks::ALL.each do |framework|
+          banner << "  * #{framework.name}\n"
+          framework.template_directories.each do |pattern|
+            banner << "    - #{framework.name}/#{pattern}"
+            if description = framework.manifest(pattern).description
+              banner << "\t- #{description}"
+            end
+            banner << "\n"
+          end
+        end
+
+        opts.banner = banner
+
+        super
+      end
+
+      def command_list(header, commands)
+        list = "#{header}\n"
+        commands.sort_by{|c| c.to_s}.each do |command|
+          list << "  * #{command}"
+          if Compass::Commands[command].respond_to? :description
+            list << "\t- #{Compass::Commands[command].description(command)}"
+          end
+          list << "\n"
+        end
+        list
+      end
+    end
+    class Help < Base
+      register :help
+      
+      class << self
+        def option_parser(arguments)
+          parser = Compass::Exec::CommandOptionParser.new(arguments)
+          parser.extend(HelpOptionsParser)
+        end
+        def usage
+          option_parser([]).to_s
+        end
+        def description(command)
+          "Get help on a compass command or extension"
+        end
+        def parse!(arguments)
+          parser = option_parser(arguments)
+          parser.parse!
+          parser.options[:help_command] = arguments.shift || 'help'
+          parser.options
+        end
+      end
+
+      def execute
+        if Compass::Commands.command_exists? options[:help_command]
+          $command = options[:help_command]
+          puts Compass::Commands[options[:help_command]].usage
+          $command = "help"
+        elsif Compass::Frameworks.template_exists? options[:help_command]
+          puts Compass::Frameworks.template_usage(options[:help_command])
+        else
+          raise OptionParser::ParseError, "No such command: #{options[:help_command]}"
+        end
+      end
+    end
+  end
+end