simplabs-excellent 1.3.0 → 1.3.1

data/History.txt

@@ -1,3 +1,7 @@
+= 1.3.1
+
+* FIX (forgot files in gemspec on 1.3.0)
+
 = 1.3.0
 
 * added formatters (currently text and HTML formatting is supported, see README)

data/README.rdoc

@@ -18,7 +18,7 @@ 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. Excellent can also produce HTML output. To
-get a formatted HTML report, just specify html:<filename>:
+get a formatted HTML report, just specify <tt>html:<filename></tt>:
 
   excellent html:out.html app/models
 

data/VERSION.yml

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

data/lib/simplabs/excellent.rb

@@ -9,7 +9,7 @@ module Simplabs #:nodoc:
 
   module Excellent #:nodoc:
 
-    VERSION = '1.3.0'
+    VERSION = '1.3.1'
 
   end
 

data/lib/simplabs/excellent/command_line_runner.rb

@@ -0,0 +1,37 @@
+require 'simplabs/excellent/runner'
+require 'simplabs/excellent/formatters'
+
+module Simplabs
+
+  module Excellent
+
+    class CommandLineRunner < Runner #:nodoc:
+
+      def initialize(*checks)
+        super
+        @formatter = Formatters::Text.new
+        @formatter.start
+      end
+
+      def check_paths(paths)
+        paths.each do |path|
+          if File.file?(path)
+            check_file(path)
+          elsif File.directory?(path)
+            Dir.glob(File.join(path, '**/*.rb')).each { |file| check_file(file) }
+          else
+            next
+          end
+        end
+      end
+
+      def check_file(filename)
+        super
+        @formatter.file(filename, (@checks || []).collect { |check| check.warnings }.flatten)
+      end
+
+    end
+
+  end
+
+end

data/lib/simplabs/excellent/formatters.rb

@@ -0,0 +1,13 @@
+module Simplabs
+
+  module Excellent
+
+    module Formatters #:nodoc:
+    end
+
+  end
+
+end
+
+require 'simplabs/excellent/formatters/text'
+require 'simplabs/excellent/formatters/html'

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

@@ -0,0 +1,49 @@
+module Simplabs
+
+  module Excellent
+
+    module Formatters
+
+      # The base class for all formatters.
+      class Base
+
+        # Initializes the formatter.
+        #
+        # Always call +super+ in custom formatters!
+        def initialize(stream)
+          @stream = stream
+        end
+
+        # Called when the Simplabs::Excellent::Runner starts processing code.
+        #
+        # The text formatter renders the heading here ('Excellent result')
+        def start
+        end
+
+        # Called whenever the Simplabs::Excellent::Runner processes a file. Yields the formatter
+        #
+        # You have to <tt>yield self</tt> in custom formatters. +file+ is called like that by the runner:
+        #
+        #  formatter.file(filename) do |formatter|
+        #    warnings.each { |warning| formatter.warning(warning) }
+        #  end
+        def file(filename)
+        end
+
+        # Called when the Simplabs::Excellent::Runner found a warning. This warning will always refer to the last filename, +file+ was invoked with.
+        def warning(warning)
+        end
+
+        # Called when the Simplabs::Excellent::Runner ends processing code.
+        #
+        # The text formatter renders the footer here ('Found <x> warnings').
+        def end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/simplabs/excellent/formatters/html.rb

@@ -0,0 +1,132 @@
+require 'simplabs/excellent/formatters/base'
+
+module Simplabs
+
+  module Excellent
+
+    module Formatters
+
+      class Html < Base #:nodoc:
+
+        def initialize(stream = $stdout)
+          super
+        end
+
+        def start
+          @stream.write(HEADER_TEMPLATE)
+        end
+
+        def file(filename)
+          @stream.write(START_FIlE_TAMPLATE.sub('{{filename}}', filename))
+          yield self
+          @stream.write(END_FIlE_TAMPLATE)
+        end
+
+        def warning(warning)
+          @stream.write(WARNING_TEMPLATE.sub('{{line_number}}', warning.line_number.to_s).sub('{{message}}', warning.message))
+        end
+
+        def end
+          @stream.write(FOOTER_TEMPLATE)
+        end
+
+        HEADER_TEMPLATE = <<-END
+          <?xml version="1.0" encoding="UTF-8"?>
+          <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+          <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+          	<head>
+            	<title>Excellent result</title>
+            	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+            	<style type="text/css">
+            		body {
+              		margin: 0;
+              		padding: 0;
+              		background: #fff;
+              		font-size: 80%;
+          				font-family: "Lucida Grande", Helvetica, sans-serif;
+            		}
+
+          			#header {
+            			background: #ccc;
+          				color: #000;
+          				height: 4em;
+          			}
+
+          			#header h1 {
+          				font-size: 1.8em;
+          				margin: 0px 10px 0px 10px;
+          				padding: 10px;
+          				position: absolute;
+          			}
+
+          			#results {
+          				margin: 0px 10px 5px;
+          			}
+
+          			dt {
+          				background: #ccc;
+          				padding: 5px;
+          				font-weight: bold;
+          				margin: 30px 0 0 0;
+          			}
+
+          			dd {
+          				margin: 5px 0px 5px 20px;
+          			}
+
+          			dd.warning {
+          				background: #faf834;
+          			}
+
+          			dd.warning span.lineNumber {
+          				background: #ccc;
+          				font-weight: bold;
+          				padding: 3px;
+          				display: inline-block;
+          				margin: 0 10px 0 0;
+          			}
+
+          			dd.warning span.number {
+          				width: 30px;
+          				text-align: right;
+          				display: inline-block;
+          			}
+            	</style>
+          	</head>
+          	<body>
+          		<div id="header">
+           			<div id="label">
+             			<h1>Excellent result</h1>
+           			</div>
+          		</div>
+          		<div id="results">
+        END
+
+        START_FIlE_TAMPLATE = <<-END
+          <div class="file">
+     				<dl>
+     				  <dt>{{filename}}</dt>
+        END
+
+        END_FIlE_TAMPLATE = <<-END
+            </dl>
+  			  </div>
+        END
+
+        WARNING_TEMPLATE = <<-END
+          <dd class="warning"><span class="lineNumber">Line <span class="number">{{line_number}}</span></span>{{message}}</dd>
+        END
+
+        FOOTER_TEMPLATE = <<-END
+              </div>
+      	    </body>
+          </html>
+        END
+
+      end
+
+    end
+
+  end
+
+end

data/lib/simplabs/excellent/formatters/text.rb

@@ -0,0 +1,40 @@
+require 'simplabs/excellent/formatters/base'
+
+module Simplabs
+
+  module Excellent
+
+    module Formatters
+
+      class Text < Base #:nodoc:
+
+        def initialize(stream = $stdout)
+          super
+          @total_warnings = 0
+        end
+
+        def start
+          @stream.puts "\n  Excellent result:\n"
+        end
+
+        def file(filename)
+          @stream.puts "\n  #{filename}\n"
+          yield self
+        end
+
+        def warning(warning)
+          @stream.puts "    * Line #{warning.line_number.to_s.lpad(3)}: \e[33m#{warning.message}\e[0m"
+          @total_warnings += 1
+        end
+
+        def end
+          @stream.puts "\n  Found #{@total_warnings} warnings.\n\n"
+        end
+
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: simplabs-excellent
 version: !ruby/object:Gem::Version 
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors: 
 - Marco Otte-Witte
@@ -75,8 +75,13 @@ files:
 - lib/simplabs/excellent/checks/rails.rb
 - lib/simplabs/excellent/checks/singleton_variable_check.rb
 - lib/simplabs/excellent/checks.rb
+- lib/simplabs/excellent/command_line_runner.rb
 - lib/simplabs/excellent/extensions/sexp.rb
 - lib/simplabs/excellent/extensions/string.rb
+- lib/simplabs/excellent/formatters/base.rb
+- lib/simplabs/excellent/formatters/html.rb
+- lib/simplabs/excellent/formatters/text.rb
+- lib/simplabs/excellent/formatters.rb
 - lib/simplabs/excellent/parsing/abc_measure.rb
 - lib/simplabs/excellent/parsing/block_context.rb
 - lib/simplabs/excellent/parsing/call_context.rb