The abstract base class for Sass executables.
Parses the command-line arguments and runs the executable. This does not handle exceptions or exit the program.
@see parse!
# File lib/sass/exec/base.rb, line 36 def parse @opts = OptionParser.new(&method(:set_opts)) @opts.parse!(@args) process_result @options end
Parses the command-line arguments and runs the executable. Calls `Kernel#exit` at the end, so it never returns.
@see parse
# File lib/sass/exec/base.rb, line 16 def parse! # rubocop:disable RescueException begin parse rescue Exception => e raise e if @options[:trace] || e.is_a?(SystemExit) $stderr.print "#{e.class}: " unless e.class == RuntimeError $stderr.puts "#{e.message}" $stderr.puts " Use --trace for backtrace." exit 1 end exit 0 # rubocop:enable RescueException end
Wraps the given string in terminal escapes causing it to have the given color. If terminal esapes aren’t supported on this platform, just returns the string instead.
@param color [Symbol] The name of the color to use.
Can be `:red`, `:green`, or `:yellow`.
@param str [String] The string to wrap in the given color. @return [String] The wrapped string.
# File lib/sass/exec/base.rb, line 147 def color(color, str) raise "[BUG] Unrecognized color #{color}" unless COLORS[color] # Almost any real Unix terminal will support color, # so we just filter for Windows terms (which don't set TERM) # and not-real terminals, which aren't ttys. return str if ENV["TERM"].nil? || ENV["TERM"].empty? || !STDOUT.tty? "\e[#{COLORS[color]}m#{str}\e[0m" end
Set an option for specifying `Encoding.default_external`.
@param opts [OptionParser]
# File lib/sass/exec/base.rb, line 80 def encoding_option(opts) encoding_desc = if Sass::Util.ruby1_8? 'Does not work in Ruby 1.8.' else 'Specify the default encoding for input files.' end opts.on('-E', '--default-encoding ENCODING', encoding_desc) do |encoding| if Sass::Util.ruby1_8? $stderr.puts "Specifying the encoding is not supported in ruby 1.8." exit 1 else Encoding.default_external = encoding end end end
Finds the line of the source template on which an exception was raised.
@param exception [Exception] The exception @return [String] The line number
# File lib/sass/exec/base.rb, line 57 def get_line(exception) # SyntaxErrors have weird line reporting # when there's trailing whitespace if exception.is_a?(::SyntaxError) return (exception.message.scan(/:(\d+)/).first || ["??"]).first end (exception.backtrace[0].scan(/:(\d+)/).first || ["??"]).first end
Processes the options set by the command-line arguments. In particular, sets `@options` and `@options` to appropriate IO streams.
This is meant to be overridden by subclasses so they can run their respective programs.
# File lib/sass/exec/base.rb, line 101 def process_result input, output = @options[:input], @options[:output] args = @args.dup input ||= begin filename = args.shift @options[:filename] = filename open_file(filename) || $stdin end @options[:output_filename] = args.shift output ||= @options[:output_filename] || $stdout @options[:input], @options[:output] = input, output end
Same as `Kernel.puts`, but doesn’t print anything if the `–quiet` option is set.
@param args [Array] Passed on to `Kernel.puts`
# File lib/sass/exec/base.rb, line 133 def puts(*args) return if @options[:for_engine][:quiet] Kernel.puts(*args) end
Prints a status message about performing the given action, colored using the given color (via terminal escapes) if possible.
@param name [to_s] A short name for the action being performed.
Shouldn't be longer than 11 characters.
@param color [Symbol] The name of the color to use for this action.
Can be `:red`, `:green`, or `:yellow`.
# File lib/sass/exec/base.rb, line 124 def puts_action(name, color, arg) return if @options[:for_engine][:quiet] printf color(color, "%11s %s\n"), name, arg STDOUT.flush end
Tells optparse how to parse the arguments available for all executables.
This is meant to be overridden by subclasses so they can add their own options.
@param opts [OptionParser]
# File lib/sass/exec/base.rb, line 73 def set_opts(opts) Sass::Util.abstract(this) end
Generated with the Darkfish Rdoc Generator 2.