simplabs-excellent 1.2.2 → 1.3.0

data/History.txt

@@ -1,3 +1,7 @@
+= 1.3.0
+
+* added formatters (currently text and HTML formatting is supported, see README)
+
 = 1.2.2
 
 * fixed specs

data/README.rdoc

@@ -17,7 +17,10 @@ To analyse all the models in your Rails application, just do
 
   excellent app/models
 
-in your <tt>RAILS_ROOT</tt>. You can also invoke analysation through the Simplabs::Excellent::Runner class.
+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 html:<filename>:
+
+  excellent html:out.html app/models
 
 == Static analysis
 

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
 :major: 1
-:minor: 2
-:patch: 2
+:minor: 3
+:patch: 0

data/bin/excellent

@@ -7,29 +7,29 @@ require 'pathname'
 
 excellent = Simplabs::Excellent::Runner.new
 
+if ARGV.first =~ /html:[^\s]+/
+  begin
+    output = File.open(ARGV.first.sub(/html:/, ''), 'w+')
+    formatter = Simplabs::Excellent::Formatters::Html.new(output)
+    ARGV.shift
+  rescue
+  end
+else
+  formatter = Simplabs::Excellent::Formatters::Text.new
+end
+
 if ARGV.empty?
   puts "\n  You must specify one or more directories to analyse, e.g.:\n"
   puts "\n    excellent app/\n\n"
   exit 1
 end
 
-ARGV.each do |arg|
-  if File.file?(arg)
-    excellent.check_file(arg)
-  elsif File.directory?(arg)
-    Dir.glob("#{arg}/**/*.rb").each { |file| excellent.check_file(file) }
-  else
-    puts "\n** Excellent cannot find '#{arg}'\n\n"
-    exit 1
-  end
-end
-
-unless excellent.warnings.empty?
-  puts "\n  Warnings:\n\n"
-  excellent.warnings.each do |warning|
-    puts "  * File #{warning.filename}, line #{warning.line_number}: #{warning.message}"
-  end
+begin
+  excellent.check_paths(ARGV, formatter)
+rescue ArgumentError => ex
+  puts "EXCEPTION: #{ex.message}"
+  puts "\n** Excellent cannot find the paths specified!\n\n"
+  exit 1
 end
-puts "\n  Found #{excellent.warnings.size} warnings.\n\n"
 
 exit 0

data/lib/simplabs/excellent.rb

@@ -1,5 +1,7 @@
 require 'simplabs/excellent/checks'
 require 'simplabs/excellent/parsing'
+require 'simplabs/excellent/formatters'
+require 'simplabs/excellent/runner'
 require 'rubygems'
 require 'sexp'
 
@@ -7,7 +9,7 @@ module Simplabs #:nodoc:
 
   module Excellent #:nodoc:
 
-    VERSION = '1.2.2'
+    VERSION = '1.3.0'
 
   end
 

data/lib/simplabs/excellent/checks/base.rb

@@ -42,6 +42,10 @@ module Simplabs
           @warnings << Simplabs::Excellent::Warning.new(klass, message, context.file, context.line + offset, info)
         end
   
+        def warnings_for(filename) #:nodoc:
+          warnings.select { |warning| warning.filename == filename }
+        end
+  
       end
 
     end

data/lib/simplabs/excellent/extensions/string.rb

@@ -14,6 +14,11 @@ module Simplabs
             downcase
         end
 
+        def lpad(to, with = ' ')
+          return self if self.length >= to
+          "#{with * (to - self.length)}#{self}"
+        end
+
       end
 
     end

data/lib/simplabs/excellent/parsing.rb

@@ -8,5 +8,3 @@ module Simplabs
   end
 
 end
-
-require 'simplabs/excellent/runner'

data/lib/simplabs/excellent/runner.rb

@@ -39,7 +39,7 @@ module Simplabs
       #
       # ==== Parameters
       #
-      # * <tt>checks</tt> - The checks to apply - passed instances of the various check classes. If no checks are specified, all checks will be applied.
+      # * <tt>checks</tt> - The checks to apply - pass instances of the various check classes. If no checks are specified, all checks will be applied.
       def initialize(*checks)
         @config = DEFAULT_CONFIG
         @checks = checks unless checks.empty?
@@ -77,6 +77,21 @@ module Simplabs
         check(filename, File.read(filename))
       end
 
+      # Processes the passed +paths+
+      #
+      # ==== Parameters
+      #
+      # * <tt>paths</tt> - The paths to process (specify file names or directories; will recursively process all ruby files if a directory are given).
+      # * <tt>formatter</tt> - The formatter to use. If a formatter is specified, its +start+, +file+, +warning+ and +end+ methods will be called
+      def check_paths(paths, formatter = nil)
+        formatter.start if formatter
+        collect_files(paths).each do |path|
+          check_file(path)
+          format_file_and_warnings(formatter, path) if formatter
+        end
+        formatter.end if formatter
+      end
+
       # Gets the warnings that were produced by the checks.
       def warnings
         @checks ||= []
@@ -98,6 +113,29 @@ module Simplabs
           check_objects
         end
 
+        def collect_files(paths)
+          files = []
+          paths.each do |path|
+            if File.file?(path)
+              files << path
+            elsif File.directory?(path)
+              files += Dir.glob(File.join(path, '**/*.rb'))
+            else
+              raise ArgumentError.new("#{path} is neither a File nor a directory!")
+            end
+          end
+          files
+        end
+
+        def format_file_and_warnings(formatter, filename)
+          warnings = @checks.map { |check| check.warnings_for(filename) }.flatten
+          if warnings.length > 0
+            formatter.file(filename) do |formatter|
+              warnings.sort { |x, y| x.line_number <=> y.line_number }.each { |warning| formatter.warning(warning) }
+            end
+          end
+        end
+
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplabs-excellent
 version: !ruby/object:Gem::Version 
-  version: 1.2.2
+  version: 1.3.0
 platform: ruby
 authors: 
 - Marco Otte-Witte