lib/simplabs/excellent/parsing/loc_parser.rb spec/data/loc_parser_1.rb spec/data/loc_parser_2.rb spec/data/loc_parser_3.rb spec/parsing/locparser_spec.rb @@ -46,7 +46,7 @@ To analyse all the models in your Rails application, just do in your <tt>RAILS_ROOT</tt>. You can also invoke analysation through the Simplabs::Excellent::Runner class. Excellent can also produce HTML output. To get a formatted HTML report, just specify <tt>html:<filename></tt>: - excellent html:out.html app/models + excellent -o out.html app/models You can also use Excellent in a Rake task: README.rdoc @@ -1,31 +1,49 @@ #!/usr/bin/env ruby -$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib")) - require 'simplabs/excellent' require 'pathname' +require 'optparse' -excellent = Simplabs::Excellent::Runner.new +options = {} -if ARGV.first =~ /html:[^\s]+/ - begin - output = File.open(ARGV.first.sub(/html:/, ''), 'w+') - formatter = Simplabs::Excellent::Formatters::Html.new(output) - ARGV.shift - rescue +optparse = OptionParser.new do |opt| + opt.banner = 'Usage: excellent [OPTIONS] <PATH1> [<PATH2> ...]' + opt.on('--output', '-o [FILE]', 'Write HTML output to [FILE].') do |target| + options[:output] = target + end + opt.on_tail('--help', '-h', 'Help') do + puts optparse + exit end -else - formatter = Simplabs::Excellent::Formatters::Text.new end -if ARGV.empty? +optparse.parse! + +target = options[:output] +paths = ARGV.dup + +if paths.empty? puts "\n You must specify one or more directories to analyse, e.g.:\n" - puts "\n excellent app/\n\n" + puts "\n excellent lib/\n\n" exit 1 end +if target + begin + fileio = File.open(target, 'w+') + formatter = Simplabs::Excellent::Formatters::Html.new(fileio) + rescue Errno::ENOENT + puts "\n #{target} cannot be opened for writing. Specify a file name like so:\n" + puts "\n excellent -o excellent.html lib/\n\n" + end +else + formatter = Simplabs::Excellent::Formatters::Text.new +end + +excellent = Simplabs::Excellent::Runner.new + begin - excellent.check_paths(ARGV, formatter) + excellent.check_paths(paths, formatter) rescue ArgumentError puts "\n** Excellent cannot find the paths specified!\n\n" exit 1 bin/excellent @@ -25,14 +25,7 @@ module Simplabs end def warning(warning) - lines = CodeRay.scan_file(warning.filename).html.split("\n") - from_line = [warning.line_number - 5, 0].max - to_line = [warning.line_number + 5, lines.count].min - i = from_line - highlighted = lines[from_line..to_line].map do |line| - %Q(<div#{' class="highlight"' if (i += 1) == warning.line_number}><span class="lineNumber">#{i}</span>#{line}</div>) - end.join("\n") - @stream.write(WARNING_TEMPLATE.sub('{{line_number}}', warning.line_number.to_s).sub('{{message}}', warning.message).sub('{{code}}', highlighted)) + @stream.write(WARNING_TEMPLATE.sub('{{line_number}}', warning.line_number.to_s).sub('{{message}}', warning.message)) end def end @@ -236,7 +229,6 @@ module Simplabs WARNING_TEMPLATE = <<-END <dd> <span class="lineNumber">Line <span class="number">{{line_number}}</span></span>{{message}} - <pre>{{code}}</pre> </dd> END lib/simplabs/excellent/formatters/html.rb cfddc0dfbeee1dec86c748c569c84e754717a68f 50506778e381abde7dd43dc21418f40b965a6ed2 Marco Otte-Witte marco.otte-witte@simplabs.com http://github.com/simplabs/excellent/commit/977d1406e68aab0c52e97d2e85ae2897d8888684 977d1406e68aab0c52e97d2e85ae2897d8888684 2009-10-14T13:11:23-07:00 2009-10-14T13:11:23-07:00 Merge branch 'integration' Conflicts: History.txt lib/simplabs/excellent/formatters/html.rb c5cc8159d97a03f8a3d07f34f722055b765b5d48 Marco Otte-Witte marco.otte-witte@simplabs.com