atoulme-Saikuro 1.1.1 → 1.1.2

data/{README → README.rdoc}

@@ -1,4 +1,4 @@
-Version 0.2
+Version 1.1.2
 
 Saikuro:
 Saikuro is a Ruby cyclomatic complexity analyzer.  When given Ruby
@@ -26,8 +26,8 @@ running.  If you are using 1.8.5 please apply this patch :
 http://www.ruby-lang.org/cgi-bin/cvsweb.cgi/ruby/lib/rdoc/ri/ri_options.rb.diff?r1=1.2.2.13;r2=1.2.2.14
 
 
-Usage:
-Saikuro is a command line program.
+=Usage:
+==Saikuro is a command line program.
 Running "saikuro -h" will output a usage statement describing all
 the various arguments you can pass to it.
 
@@ -50,8 +50,23 @@ will mark all methods with a complexity of 11 or higher with a
 warning.  Finally, "-e 16" will flag all methods with a complexity of
 16 or higher with an error.
 
+==Saikuro is also a Ruby library.
 
-About Cyclomatic Complexity:
+You can call it from your application to run metrics. 
+It's perfectly suited for a Rake task, right in the middle of your build.
+An example from Buildr:
+ gem 'atoulme-Saikuro'
+ require 'saikuro'
+ output_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "_reports", "saikuro"))
+ base_dir = Pathname.new(File.expand_path(File.join(File.dirname(__FILE__), "..")))
+ rb_files = ["lib", "addon"].collect { |folder| 
+   FileList[File.expand_path(File.join(File.dirname(__FILE__), "..", folder, "**", "*.rb"))]
+ }.flatten.collect {|path| 
+   Pathname.new(path).relative_path_from(base_dir).to_s
+ }
+ SaikuroRunner.new.run(rb_files, output_dir)
+
+=About Cyclomatic Complexity:
 
 The following document provides a very good and detailed description
 by the author of cyclomatic complexity.
@@ -121,20 +136,20 @@ Mainly, because we have not gotten around to it.  We are wondering if
 this would increase the noise more than it should.
 
 
-Tests:
+=Tests:
 In the test directory is a sample file that has examples of the
 various possible cases that we examined and documented the expected
 cyclomatic complexity result.  If you find mistakes or missing tests
 please report them.
 
-Contact:
+=Contact:
 Saikuro is written by
 Zev Blut (zb at ubit dot com)
 
-Acknowledgments:
+=Acknowledgments:
 Thanks to Elbert Corpuz for writing the CSS for the HTML output!
 
-Other metric tools for Ruby:
+=Other metric tools for Ruby:
 Ryan Davis has an abc metric program as an example in his ParseTree
 product:  http://www.zenspider.com/ZSS/Products/ParseTree/
 

data/lib/saikuro.rb

@@ -730,80 +730,66 @@ end
 
 module HTMLStyleSheet
   def HTMLStyleSheet.style_sheet
-    out = StringIO.new
-
-    out.puts "<style>"
-    out.puts 'body {'
-    out.puts '	margin: 20px;'
-    out.puts '	padding: 0;'
-    out.puts '	font-size: 12px;'
-    out.puts '	font-family: bitstream vera sans, verdana, arial, sans serif;'
-    out.puts '	background-color: #efefef;'
-    out.puts '}'
-    out.puts ''
-    out.puts 'table {	'
-    out.puts '	border-collapse: collapse;'
-    out.puts '	/*border-spacing: 0;*/'
-    out.puts '	border: 1px solid #666;'
-    out.puts '	background-color: #fff;'
-    out.puts '	margin-bottom: 20px;'
-    out.puts '}'
-    out.puts ''
-    out.puts 'table, th, th+th, td, td+td  {'
-    out.puts '	border: 1px solid #ccc;'
-    out.puts '}'
-    out.puts ''
-    out.puts 'table th {'
-    out.puts '	font-size: 12px;'
-    out.puts '	color: #fc0;'
-    out.puts '	padding: 4px 0;'
-    out.puts '	background-color: #336;'
-    out.puts '}'
-    out.puts ''
-    out.puts 'th, td {'
-    out.puts '	padding: 4px 10px;'
-    out.puts '}'
-    out.puts ''
-    out.puts 'td {	'
-    out.puts '	font-size: 13px;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.class_name {'
-    out.puts '	font-size: 17px;'
-    out.puts '	margin: 20px 0 0;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.class_complexity {'
-    out.puts 'margin: 0 auto;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.class_complexity>.class_complexity {'
-    out.puts '	margin: 0;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.class_total_complexity, .class_total_lines, .start_token_count, .file_count {'
-    out.puts '	font-size: 13px;'
-    out.puts '	font-weight: bold;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.class_total_complexity, .class_total_lines {'
-    out.puts '	color: #c00;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.start_token_count, .file_count {'
-    out.puts '	color: #333;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.warning {'
-    out.puts '	background-color: yellow;'
-    out.puts '}'
-    out.puts ''
-    out.puts '.error {'
-    out.puts '	background-color: #f00;'
-    out.puts '}'
-    out.puts "</style>"
-
-    out.string
+<<-CSS
+<style>
+body {
+	margin: 20px;
+	padding: 0;
+	font-size: 12px;
+	font-family: bitstream vera sans, verdana, arial, sans serif;
+	background-color: #efefef;
+}
+table {	
+	border-collapse: collapse;
+	/*border-spacing: 0;*/
+	border: 1px solid #666;
+	background-color: #fff;
+	margin-bottom: 20px;
+}
+table, th, th+th, td, td+td  {
+	border: 1px solid #ccc;
+}
+table th {
+	font-size: 12px;
+	color: #fc0;
+	padding: 4px 0;
+	background-color: #336;
+}
+th, td {
+	padding: 4px 10px;
+}
+td {	
+	font-size: 13px;
+}
+.class_name {
+	font-size: 17px;
+	margin: 20px 0 0;
+}
+.class_complexity {
+margin: 0 auto;
+}
+.class_complexity>.class_complexity {
+	margin: 0;
+}
+.class_total_complexity, .class_total_lines, .start_token_count, .file_count {
+	font-size: 13px;
+	font-weight: bold;
+}
+.class_total_complexity, .class_total_lines {
+	color: #c00;
+}
+.start_token_count, .file_count {
+	color: #333;
+}
+.warning {
+	background-color: yellow;
+}
+.error {
+	background-color: #f00;
+}
+</style>
+
+CSS
   end
 
   def style_sheet
@@ -818,9 +804,7 @@ class HTMLTokenCounterFormater < TokenCounterFormater
   def start(new_out=nil)
     reset_data
     @out = new_out if new_out
-    @out.puts "<html>"
-    @out.puts style_sheet
-    @out.puts "<body>"
+    @out.puts "<html>#{style_sheet}<body>"
   end
 
   def start_count(number_of_files)
@@ -853,8 +837,7 @@ class HTMLTokenCounterFormater < TokenCounterFormater
   end
 
   def end
-    @out.puts "</body>"
-    @out.puts "</html>"
+    @out.puts "</body>\n</html>"
   end
 end
 
@@ -1226,21 +1209,91 @@ class SaikuroCMDLineRunner
 
 end
 
+#
+# A runner to call from Ruby code
+# Perfect for the inpromptue Rake task.
+# 
+#
 class SaikuroRunner
   include ResultIndexGenerator
   
-  def run(files, output_dir, formater = "html")
-    state_filter = Filter.new(5) # Not configurable for now.
-    token_filter = Filter.new(10, 25, 50) # Not configurable for now.
-    if formater =~ /html/i
-      state_formater = StateHTMLComplexityFormater.new(STDOUT,state_filter)
-      token_count_formater = HTMLTokenCounterFormater.new(STDOUT,token_filter)
+  # :call-seq:
+  #  run(*args)
+  # Either runs the Saikuro analyzer over a configuration hash (see run_with_config)
+  # Or runs with standard options (in which case you need to pass files and output_dir, see run_with_standard_options)
+  def run(*args)
+    if args.size == 1
+      run_with_config(*args)
     else
-      state_formater = ParseStateFormater.new(STDOUT,state_filter)
-      token_count_formater = TokenCounterFormater.new(STDOUT,token_filter)
+      run_with_standard_options(*args)
     end
-    idx_states, idx_tokens = Saikuro.analyze(files, state_formater, token_count_formater, output_dir)
-    write_cyclo_index(idx_states, output_dir)
-    write_token_index(idx_tokens, output_dir)
   end
+    
+  # :call-seq:
+  #  run(files, output_dir, formater)
+  # Runs the Saikuro analyzer over the files, and persists the information
+  # in output_dir
+  #
+  def run_with_standard_options(files, output_dir, formater = "html")
+    run({:formater => formater, :output_directory => output_dir, :code_dirs => files})
+  end
+  
+  # :call-seq:
+  #  run(options)
+  # Runs the Saikuro analyzer over a configuration hash, which takes those arguments:
+  # - output_directory
+  #    Where the analysis will be written out
+  # - filter_cyclo
+  # - warn_cyclo
+  # - error_cyclo
+  #
+  # - filter_token
+  # - warn_token
+  # - error_token
+  #
+  # - formater
+  # text or html. By default html.
+  #
+  # - code_dirs
+  # The directories containing code to look into.
+  #
+  def run_with_config(options)
+
+        rm_rf options[:output_directory]
+
+        state_filter = Filter.new(5)
+        token_filter = Filter.new(10, 25, 50)
+
+        state_filter.limit = options[:filter_cyclo] if options[:filter_cyclo]
+        state_filter.warn = options[:warn_cyclo] if options[:warn_cyclo]
+        state_filter.error = options[:error_cyclo] if options[:error_cyclo]
+
+        token_filter.limit = options[:filter_token] if options[:filter_token]
+        token_filter.warn = options[:warn_token] if options[:warn_token]
+        token_filter.error = options[:error_token] if options[:error_token]
+
+        formater = options[:formater] || "html"
+        if formater =~ /html/i
+          state_formater = StateHTMLComplexityFormater.new(STDOUT,state_filter)
+          token_count_formater = HTMLTokenCounterFormater.new(STDOUT,token_filter)
+        else
+          state_formater = ParseStateFormater.new(STDOUT,state_filter)
+          token_count_formater = TokenCounterFormater.new(STDOUT,token_filter)
+        end
+
+        idx_states, idx_tokens = Saikuro.analyze(
+          files_in_dirs(options[:code_dirs]),
+          state_formater,
+          token_count_formater,
+          options[:output_directory]
+        )
+
+        write_cyclo_index(idx_states, options[:output_directory])
+        write_token_index(idx_tokens, options[:output_directory])
+      end
+
+      def files_in_dirs(code_dirs)
+        code_dirs = [code_dirs].flatten
+        code_dirs.collect {|dir| File.directory?(dir) ? Dir["#{dir}/**/*.rb"] : dir}.flatten
+      end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: atoulme-Saikuro
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 1
-  - 1
-  version: 1.1.1
+  - 2
+  version: 1.1.2
 platform: ruby
 authors: 
 - Zev Blut, Antoine Toulme
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-22 00:00:00 -07:00
+date: 2010-07-23 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -26,14 +26,14 @@ executables:
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 files: 
 - bin/saikuro
 - lib/saikuro/usage.rb
 - lib/saikuro.rb
 - tests/large_example.rb
 - tests/samples.rb
-- README
+- README.rdoc
 has_rdoc: true
 homepage: http://saikuro.rubyforge.org/
 licenses: []