Restructure the existing command line code to allow for the new sub-command based CLI.
This commit is contained in:
Chris Eppstein
parent
772a58de41
commit
4cc569586b
2
Rakefile
2
Rakefile
@ -110,7 +110,7 @@ task :examples do
|
||||
puts "=" * "Compiling #{example}".length
|
||||
Dir.chdir example do
|
||||
load "bootstrap.rb" if File.exists?("bootstrap.rb")
|
||||
Compass::Exec::Compass.new(["--force"]).run!
|
||||
Compass::Exec::SwitchUI.new(["--force"]).run!
|
||||
end
|
||||
# compile any haml templates to html
|
||||
FileList["#{example}/**/*.haml"].each do |haml_file|
|
||||
|
||||
29
bin/compass
29
bin/compass
@ -1,19 +1,26 @@
|
||||
#!/usr/bin/env ruby
|
||||
# The compass command line utility
|
||||
|
||||
begin
|
||||
# This allows compass to run easily from a git checkout without install.
|
||||
def fallback_load_path(path)
|
||||
retried = false
|
||||
require 'compass'
|
||||
require 'compass/exec'
|
||||
rescue LoadError
|
||||
if retried
|
||||
begin
|
||||
yield
|
||||
rescue LoadError
|
||||
unless retried
|
||||
$: << path
|
||||
retried = true
|
||||
retry
|
||||
end
|
||||
raise
|
||||
else
|
||||
$: << File.join(File.dirname(__FILE__), '..', 'lib')
|
||||
retried = true
|
||||
retry
|
||||
end
|
||||
end
|
||||
|
||||
command = Compass::Exec::Compass.new(ARGV)
|
||||
exit command.run!
|
||||
fallback_load_path(File.join(File.dirname(__FILE__), '..', 'lib')) do
|
||||
require 'compass'
|
||||
require 'compass/exec'
|
||||
end
|
||||
|
||||
|
||||
command_line_class = Compass::Exec::Helpers.select_appropriate_command_line_ui(ARGV)
|
||||
exit command_line_class.new(ARGV).run!
|
||||
|
||||
10
lib/compass/commands.rb
Normal file
10
lib/compass/commands.rb
Normal file
@ -0,0 +1,10 @@
|
||||
module Compass::Commands
|
||||
end
|
||||
|
||||
require 'compass/commands/registry'
|
||||
|
||||
%w(base generate_grid_background list_frameworks project_base
|
||||
update_project watch_project create_project installer_command
|
||||
print_version stamp_pattern validate_project write_configuration).each do |lib|
|
||||
require "compass/commands/#{lib}"
|
||||
end
|
||||
@ -1,6 +1,11 @@
|
||||
module Compass
|
||||
module Commands
|
||||
class Base
|
||||
def self.inherited(command_class)
|
||||
if command_class.respond_to? :name
|
||||
Compass::Commands[command_class.name] = command_class
|
||||
end
|
||||
end
|
||||
|
||||
include Actions
|
||||
|
||||
|
||||
19
lib/compass/commands/registry.rb
Normal file
19
lib/compass/commands/registry.rb
Normal file
@ -0,0 +1,19 @@
|
||||
module Compass::Commands
|
||||
module Registry
|
||||
def register(name, command_class)
|
||||
@commands ||= Hash.new
|
||||
@commands[name.to_sym] = command_class
|
||||
end
|
||||
def get(name)
|
||||
@commands ||= Hash.new
|
||||
@commands[name.to_sym]
|
||||
end
|
||||
def command_exists?(name)
|
||||
@commands ||= Hash.new
|
||||
@commands.has_key?(name.to_sym)
|
||||
end
|
||||
alias_method :[], :get
|
||||
alias_method :[]=, :register
|
||||
end
|
||||
extend Registry
|
||||
end
|
||||
@ -3,250 +3,13 @@ require 'optparse'
|
||||
require 'compass/logger'
|
||||
require 'compass/errors'
|
||||
require 'compass/actions'
|
||||
require 'compass/commands'
|
||||
|
||||
module Compass
|
||||
module Exec
|
||||
|
||||
def report_error(e, options)
|
||||
$stderr.puts "#{e.class} on line #{get_line e} of #{get_file e}: #{e.message}"
|
||||
if options[:trace]
|
||||
e.backtrace[1..-1].each { |t| $stderr.puts " #{t}" }
|
||||
else
|
||||
$stderr.puts "Run with --trace to see the full backtrace"
|
||||
end
|
||||
end
|
||||
|
||||
def get_file(exception)
|
||||
exception.backtrace[0].split(/:/, 2)[0]
|
||||
end
|
||||
|
||||
def get_line(exception)
|
||||
exception.backtrace[0].scan(/:(\d+)/)[0]
|
||||
end
|
||||
module_function :report_error, :get_file, :get_line
|
||||
|
||||
class Compass
|
||||
|
||||
attr_accessor :args, :options, :opts
|
||||
|
||||
def initialize(args)
|
||||
self.args = args
|
||||
self.options = {}
|
||||
parse!
|
||||
end
|
||||
|
||||
def run!
|
||||
begin
|
||||
perform!
|
||||
rescue Exception => e
|
||||
raise e if e.is_a? SystemExit
|
||||
if e.is_a?(::Compass::Error) || e.is_a?(OptionParser::ParseError)
|
||||
$stderr.puts e.message
|
||||
else
|
||||
::Compass::Exec.report_error(e, @options)
|
||||
end
|
||||
return 1
|
||||
end
|
||||
return 0
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def perform!
|
||||
if options[:command]
|
||||
do_command(options[:command])
|
||||
else
|
||||
puts self.opts
|
||||
end
|
||||
end
|
||||
|
||||
def parse!
|
||||
self.opts = OptionParser.new(&method(:set_opts))
|
||||
self.opts.parse!(self.args)
|
||||
if self.args.size > 0
|
||||
self.options[:project_name] = trim_trailing_separator(self.args.shift)
|
||||
end
|
||||
self.options[:command] ||= self.options[:project_name] ? :create_project : :update_project
|
||||
self.options[:framework] ||= :compass
|
||||
end
|
||||
|
||||
def trim_trailing_separator(path)
|
||||
path[-1..-1] == File::SEPARATOR ? path[0..-2] : path
|
||||
end
|
||||
|
||||
def set_opts(opts)
|
||||
opts.banner = <<END
|
||||
Usage: compass [options] [project]
|
||||
|
||||
Description:
|
||||
The compass command line tool will help you create and manage the stylesheets for your project.
|
||||
|
||||
To get started on a stand-alone project based on blueprint:
|
||||
|
||||
compass -f blueprint my_compass_project
|
||||
|
||||
When you change any sass files, you must recompile your project using --update or --watch.
|
||||
END
|
||||
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
|
||||
|
||||
opts.on('-w', '--watch', :NONE, 'Monitor the current project for changes and update') do
|
||||
self.options[:command] = :watch_project
|
||||
self.options[:quiet] = true
|
||||
end
|
||||
|
||||
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('--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>x<height>.',
|
||||
' Defaults to 30+10x20. Height is optional.') do |dimensions|
|
||||
self.options[:grid_dimensions] = dimensions || "30+10"
|
||||
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 app type to a rails project (same as --app rails).") do
|
||||
self.options[:project_type] = :rails
|
||||
end
|
||||
|
||||
opts.on('--app APP_TYPE', 'Specify the kind of application to integrate with.') do |project_type|
|
||||
self.options[:project_type] = project_type.to_sym
|
||||
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
|
||||
|
||||
opts.on('--css-dir CSS_DIR', "The target directory where you keep your css stylesheets.") do |css_dir|
|
||||
self.options[:css_dir] = css_dir
|
||||
end
|
||||
|
||||
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('--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.',
|
||||
' 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.',
|
||||
' One of: nested, expanded, compact, compressed') do |style|
|
||||
self.options[:output_style] = style
|
||||
end
|
||||
|
||||
opts.on('--relative-assets', :NONE, 'Make compass asset helpers generate relative urls to assets.') do
|
||||
self.options[:relative_assets] = true
|
||||
end
|
||||
|
||||
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('-q', '--quiet', :NONE, 'Quiet mode.') do
|
||||
self.options[:quiet] = true
|
||||
end
|
||||
|
||||
opts.on('--dry-run', :NONE, 'Dry Run. Tells you what it plans to do.') do
|
||||
self.options[:dry_run] = true
|
||||
end
|
||||
|
||||
opts.on('--trace', :NONE, 'Show a full stacktrace on error') do
|
||||
self.options[:trace] = true
|
||||
end
|
||||
|
||||
opts.on('--force', :NONE, 'Force. Allows some failing commands to succeed instead.') do
|
||||
self.options[:force] = true
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
opts.on('--install-dir', :NONE, 'Emit the location where compass is installed.') do
|
||||
puts ::Compass.base_directory
|
||||
exit
|
||||
end
|
||||
|
||||
opts.on_tail("-?", "-h", "--help", "Show this message") do
|
||||
puts opts
|
||||
exit
|
||||
end
|
||||
|
||||
opts.on_tail("-v", "--version", "Print version") do
|
||||
self.options[:command] = :print_version
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
def do_command(command)
|
||||
command_class_name = command.to_s.split(/_/).map{|p| p.capitalize}.join('')
|
||||
command_class = eval("::Compass::Commands::#{command_class_name}")
|
||||
command_class.new(Dir.getwd, options).execute
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
module Compass::Exec
|
||||
end
|
||||
|
||||
%w(base generate_grid_background list_frameworks project_base
|
||||
update_project watch_project create_project installer_command
|
||||
print_version stamp_pattern validate_project write_configuration).each do |lib|
|
||||
require "compass/commands/#{lib}"
|
||||
end
|
||||
require 'compass/exec/helpers'
|
||||
require 'compass/exec/switch_ui'
|
||||
require 'compass/exec/sub_command_ui'
|
||||
|
||||
|
||||
|
||||
28
lib/compass/exec/helpers.rb
Normal file
28
lib/compass/exec/helpers.rb
Normal file
@ -0,0 +1,28 @@
|
||||
module Compass::Exec
|
||||
module Helpers
|
||||
extend self
|
||||
def select_appropriate_command_line_ui(arguments)
|
||||
if Compass::Commands.command_exists? arguments.first
|
||||
SubCommandUI
|
||||
else
|
||||
SwitchUI
|
||||
end
|
||||
end
|
||||
def report_error(e, options)
|
||||
$stderr.puts "#{e.class} on line #{get_line e} of #{get_file e}: #{e.message}"
|
||||
if options[:trace]
|
||||
e.backtrace[1..-1].each { |t| $stderr.puts " #{t}" }
|
||||
else
|
||||
$stderr.puts "Run with --trace to see the full backtrace"
|
||||
end
|
||||
end
|
||||
|
||||
def get_file(exception)
|
||||
exception.backtrace[0].split(/:/, 2)[0]
|
||||
end
|
||||
|
||||
def get_line(exception)
|
||||
exception.backtrace[0].scan(/:(\d+)/)[0]
|
||||
end
|
||||
end
|
||||
end
|
||||
0
lib/compass/exec/sub_command_ui.rb
Normal file
0
lib/compass/exec/sub_command_ui.rb
Normal file
219
lib/compass/exec/switch_ui.rb
Normal file
219
lib/compass/exec/switch_ui.rb
Normal file
@ -0,0 +1,219 @@
|
||||
module Compass::Exec
|
||||
class SwitchUI
|
||||
|
||||
attr_accessor :args, :options, :opts
|
||||
|
||||
def initialize(args)
|
||||
self.args = args
|
||||
self.options = {}
|
||||
parse!
|
||||
end
|
||||
|
||||
def run!
|
||||
begin
|
||||
perform!
|
||||
rescue Exception => e
|
||||
raise e if e.is_a? SystemExit
|
||||
if e.is_a?(::Compass::Error) || e.is_a?(OptionParser::ParseError)
|
||||
$stderr.puts e.message
|
||||
else
|
||||
::Compass::Exec::Helpers.report_error(e, @options)
|
||||
end
|
||||
return 1
|
||||
end
|
||||
return 0
|
||||
end
|
||||
|
||||
protected
|
||||
|
||||
def perform!
|
||||
if options[:command]
|
||||
do_command(options[:command])
|
||||
else
|
||||
puts self.opts
|
||||
end
|
||||
end
|
||||
|
||||
def parse!
|
||||
self.opts = OptionParser.new(&method(:set_opts))
|
||||
self.opts.parse!(self.args)
|
||||
if self.args.size > 0
|
||||
self.options[:project_name] = trim_trailing_separator(self.args.shift)
|
||||
end
|
||||
self.options[:command] ||= self.options[:project_name] ? :create_project : :update_project
|
||||
self.options[:framework] ||= :compass
|
||||
end
|
||||
|
||||
def trim_trailing_separator(path)
|
||||
path[-1..-1] == File::SEPARATOR ? path[0..-2] : path
|
||||
end
|
||||
|
||||
def set_opts(opts)
|
||||
opts.banner = <<END
|
||||
Usage: compass [options] [project]
|
||||
|
||||
Description:
|
||||
The compass command line tool will help you create and manage the stylesheets for your project.
|
||||
|
||||
To get started on a stand-alone project based on blueprint:
|
||||
|
||||
compass -f blueprint my_compass_project
|
||||
|
||||
When you change any sass files, you must recompile your project using --update or --watch.
|
||||
END
|
||||
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
|
||||
|
||||
opts.on('-w', '--watch', :NONE, 'Monitor the current project for changes and update') do
|
||||
self.options[:command] = :watch_project
|
||||
self.options[:quiet] = true
|
||||
end
|
||||
|
||||
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('--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>x<height>.',
|
||||
' Defaults to 30+10x20. Height is optional.') do |dimensions|
|
||||
self.options[:grid_dimensions] = dimensions || "30+10"
|
||||
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 app type to a rails project (same as --app rails).") do
|
||||
self.options[:project_type] = :rails
|
||||
end
|
||||
|
||||
opts.on('--app APP_TYPE', 'Specify the kind of application to integrate with.') do |project_type|
|
||||
self.options[:project_type] = project_type.to_sym
|
||||
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
|
||||
|
||||
opts.on('--css-dir CSS_DIR', "The target directory where you keep your css stylesheets.") do |css_dir|
|
||||
self.options[:css_dir] = css_dir
|
||||
end
|
||||
|
||||
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('--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.',
|
||||
' 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.',
|
||||
' One of: nested, expanded, compact, compressed') do |style|
|
||||
self.options[:output_style] = style
|
||||
end
|
||||
|
||||
opts.on('--relative-assets', :NONE, 'Make compass asset helpers generate relative urls to assets.') do
|
||||
self.options[:relative_assets] = true
|
||||
end
|
||||
|
||||
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('-q', '--quiet', :NONE, 'Quiet mode.') do
|
||||
self.options[:quiet] = true
|
||||
end
|
||||
|
||||
opts.on('--dry-run', :NONE, 'Dry Run. Tells you what it plans to do.') do
|
||||
self.options[:dry_run] = true
|
||||
end
|
||||
|
||||
opts.on('--trace', :NONE, 'Show a full stacktrace on error') do
|
||||
self.options[:trace] = true
|
||||
end
|
||||
|
||||
opts.on('--force', :NONE, 'Force. Allows some failing commands to succeed instead.') do
|
||||
self.options[:force] = true
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
opts.on('--install-dir', :NONE, 'Emit the location where compass is installed.') do
|
||||
puts ::Compass.base_directory
|
||||
exit
|
||||
end
|
||||
|
||||
opts.on_tail("-?", "-h", "--help", "Show this message") do
|
||||
puts opts
|
||||
exit
|
||||
end
|
||||
|
||||
opts.on_tail("-v", "--version", "Print version") do
|
||||
self.options[:command] = :print_version
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
def do_command(command)
|
||||
command_class_name = command.to_s.split(/_/).map{|p| p.capitalize}.join('')
|
||||
command_class = eval("::Compass::Commands::#{command_class_name}")
|
||||
command_class.new(Dir.getwd, options).execute
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@ -91,6 +91,6 @@ module Compass::CommandLineHelper
|
||||
end
|
||||
|
||||
def execute(*arguments)
|
||||
Compass::Exec::Compass.new(arguments).run!
|
||||
Compass::Exec::SwitchUI.new(arguments).run!
|
||||
end
|
||||
end
|
||||
Loading…
Reference in New Issue
Block a user