atoulme-Saikuro 1.1.2 → 1.2.1

data/README.rdoc

@@ -1,29 +1,15 @@
-Version 1.1.2
-
-Saikuro:
+=Saikuro
 Saikuro is a Ruby cyclomatic complexity analyzer.  When given Ruby
 source code Saikuro will generate a report listing the cyclomatic
 complexity of each method found.  In addition, Saikuro counts the
 number of lines per method and can generate a listing of the number of
 tokens on each line of code.
 
-License:
-Saikuro uses the BSD license.
-
-Installation:
-Option 1: Using setup.rb
-* login as root
-* run "ruby setup.rb all"
-
-Option 2: The manual way
-Saikuro is a single Ruby file that is executable.  You can run it where
-you unpacked it or you can move it your preferred location such as
-"/usr/local/bin" or "~/bin".
+==License:
+Saikuro uses the BSD license. See attached LICENSE file.
 
-Note:
-Ruby 1.8.5 has a bug in ri_options that will prevent Saikuro from
-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
+==Installation:
+Install atoulme-Saikuro using gem install and have at it.
 
 
 =Usage:
@@ -31,7 +17,7 @@ http://www.ruby-lang.org/cgi-bin/cvsweb.cgi/ruby/lib/rdoc/ri/ri_options.rb.diff?
 Running "saikuro -h" will output a usage statement describing all
 the various arguments you can pass to it.
 
-"saikuro -c -p tests/samples.rb"
+ saikuro -c -p tests/samples.rb
 
 The above command is a simple example that generates a cyclomatic
 complexity report on the samples.rb file, using the default filter,
@@ -40,7 +26,7 @@ directory.
 
 
 A more detailed example is
-"saikuro -c -t -i tests -y 0 -w 11 -e 16 -o out/"
+ saikuro -c -t -i tests -y 0 -w 11 -e 16 -o out/
 
 This will analyze all Ruby files found in the "tests/" directory.
 Saikuro will generate a token count report and a cyclomatic complexity
@@ -108,7 +94,7 @@ currently do not contribute to a method's complexity, although
 McCabe's paper listed above suggests doing so.
 
 
-#Example for "and" operator handling:
+ #Example for "and" operator handling:
 
  # Starting values for case 1 and 2
  x = false
@@ -145,6 +131,8 @@ please report them.
 =Contact:
 Saikuro is written by
 Zev Blut (zb at ubit dot com)
+Morton Jonuschat
+Antoine Toulme (antoine at lunar-ocean.com)
 
 =Acknowledgments:
 Thanks to Elbert Corpuz for writing the CSS for the HTML output!

data/bin/saikuro

@@ -90,5 +90,6 @@
 
 require 'saikuro'
 
-SaikuroCMDLineRunner.new.run
+saikuro = SaikuroCMDLineRunner.new(ARGV)
+saikuro.run!
 

data/lib/saikuro.rb

@@ -1,55 +1,8 @@
-# $Id$
-# == Usage
-#
-# saikuro [ -h ] [-o output_directory] [-f type] [ -c, -t ]
-# [ -y, -w, -e, -k, -s, -d - number ] ( -p file | -i directory )
-#
-# == Help
-#
-# -o, --output_directory (directory) : A directory to ouput the results in.
-# The current directory is used if this option is not passed.
-#
-# -h, --help : This help message.
-#
-# -f, --formater (html | text) : The format to output the results in.
-# The default is html
-#
-# -c, --cyclo : Compute the cyclomatic complexity of the input.
-#
-# -t, --token : Count the number of tokens per line of the input.
-#
-# -y, --filter_cyclo (number) : Filter the output to only include methods
-# whose cyclomatic complexity are greater than the passed number.
-#
-# -w, --warn_cyclo (number) : Highlight with a warning methods whose
-# cyclomatic complexity are greather than or equal to the passed number.
-#
-#
-# -e, --error_cyclo (number) : Highligh with an error methods whose
-# cyclomatic complexity are greather than or equal to the passed number.
-#
-#
-# -k, --filter_token (number) : Filter the output to only include lines
-# whose token count are greater than the passed number.
-#
-#
-# -s, --warn_token (number) : Highlight with a warning lines whose
-# token count are greater than or equal to the passed number.
-#
-#
-# -d, --error_token (number) : Highlight with an error lines whose
-# token count are greater than or equal to the passed number.
-#
-#
-# -p, --parse_file (file) : A file to use as input.
-#
-# -i, --input_directory (directory) : All ruby files found recursively
-# inside the directory are passed as input.
-
-
 # Saikruo uses the BSD license.
 #
 # Copyright (c) 2005, Ubiquitous Business Technology (http://ubit.com)
+# Copyright (c) 2010, Morton Jonuschat (http://www.github.com/yabawock)
+# Copyright (c) 2010, Antoine Toulme (http://www.lunar-ocean.com)
 # All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
@@ -85,6 +38,8 @@
 #
 # == Author
 # Zev Blut (zb@ubit.com)
+# Morton Jonuschat
+# Antoine Toulme (antoine@lunar-ocean.com)
 
 require 'irb/ruby-lex'
 require 'yaml'
@@ -419,8 +374,8 @@ class ParseState
   def end_debug
     STDOUT.puts "got an end: #{@name} in #{self.class.name}" if $VERBOSE
     if @parent.nil?
-      STDOUT.puts "DEBUG: Line #{@lexer.line_no}"
-      STDOUT.puts "DEBUG: #{@name}; #{self.class}"
+      STDOUT.puts "DEBUG: Line #{@lexer.line_no}" if $VERBOSE
+      STDOUT.puts "DEBUG: #{@name}; #{self.class}" if $VERBOSE
       # to_yaml can cause an infinite loop?
       #STDOUT.puts "TOP: #{@@top_state.to_yaml}"
       #STDOUT.puts "TOP: #{@@top_state.inspect}"
@@ -1098,17 +1053,10 @@ end
 
 class SaikuroCMDLineRunner
   require 'stringio'
-  require 'getoptlong'
+  require 'optparse'
   require 'fileutils'
   require 'find'
 
-  def initialize
-    # modification to RDoc.usage that allows main_program_file to be set
-    # for RDoc.usage
-    require 'saikuro/usage'
-    RDoc::main_program_file = __FILE__
-  end
-
   include ResultIndexGenerator
 
   def get_ruby_files(path)
@@ -1122,91 +1070,126 @@ class SaikuroCMDLineRunner
     end
     files
   end
+  
+  def parse(args)
+    # Set up reasonable defaults for options.
+    options = {}
+    options[:files] = Array.new
+    options[:output_dir] = './'
+    options[:formater] = 'html'
+    options[:state_filter] = Filter.new(5)
+    options[:token_filter] = Filter.new(10, 25, 50)
+    options[:comp_state] = false
+    options[:comp_token] = false
+
+    # Parse the command-line arguments.
+    @opts = OptionParser.new do |opts|
+      opts.banner = 'Usage: saikuro [ -h ] [-o output_directory] [-f type] [ -c, -t ] [ -y, -w, -e, -k, -s, -d - number ] ( -p file | -i directory )'
+
+      opts.separator ''
+      opts.separator 'Specific options:'
+
+      opts.on('-v', '--verbose', 'Verbose output.') do
+        options[:verbose] = true
+        $VERBOSE = true
+      end
 
-  def run
-    files = Array.new
-    output_dir = "./"
-    formater = "html"
-    state_filter = Filter.new(5)
-    token_filter = Filter.new(10, 25, 50)
-    comp_state = comp_token = false
-    begin
-      opt = GetoptLong.new(
-                           ["-o","--output_directory", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-h","--help", GetoptLong::NO_ARGUMENT],
-                           ["-f","--formater", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-c","--cyclo", GetoptLong::NO_ARGUMENT],
-                           ["-t","--token", GetoptLong::NO_ARGUMENT],
-                           ["-y","--filter_cyclo", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-k","--filter_token", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-w","--warn_cyclo", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-s","--warn_token", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-e","--error_cyclo", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-d","--error_token", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-p","--parse_file", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-i","--input_directory", GetoptLong::REQUIRED_ARGUMENT],
-                           ["-v","--verbose", GetoptLong::NO_ARGUMENT]
-                           )
-
-      opt.each do |arg,val|
-        case arg
-        when "-o"
-          output_dir = val
-        when "-h"
-          RDoc.usage('help')
-        when "-f"
-          formater = val
-        when "-c"
-          comp_state = true
-        when "-t"
-          comp_token = true
-        when "-k"
-          token_filter.limit = val.to_i
-        when "-s"
-          token_filter.warn = val.to_i
-        when "-d"
-          token_filter.error = val.to_i
-        when "-y"
-          state_filter.limit = val.to_i
-        when "-w"
-          state_filter.warn = val.to_i
-        when "-e"
-          state_filter.error = val.to_i
-        when "-p"
-          files<< val
-        when "-i"
-          files.concat(get_ruby_files(val))
-        when "-v"
-          STDOUT.puts "Verbose mode on"
-          $VERBOSE = true
-        end
+      opts.on('-o', '--output_directory DIRECTORY', 'A directory to ouput the results in. The current directory is used if this option is not passed.') do |output_dir|
+        options[:output_dir] = output_dir
+      end
 
+      opts.on('-f', '--formater (html | text)', 'The format to output the results in. The default is html') do |formater|
+        options[:formater] = formater
+      end
+
+      opts.on('-c', '--cyclo', 'Compute the cyclomatic complexity of the input.') do
+        options[:comp_state] = true
+      end
+
+      opts.on('-t', '--token', 'Count the number of tokens per line of the input.') do
+        options[:comp_token] = true
+      end
+
+      opts.on('-y', '--filter_cyclo NUMBER', 'Filter the output to only include methods whose cyclomatic complexity are greater than the passed number.') do |number|
+        options[:state_filter].limit = number.to_i
+      end
+
+      opts.on('-w', '--warn_cyclo NUMBER', 'Highlight with a warning methods whose cyclomatic complexity are greather than or equal to the passed number.') do |number|
+        options[:state_filter].warn = number.to_i
+      end
+
+      opts.on('-e', '--error_cyclo NUMBER', 'Highlight with a error methods whose cyclomatic complexity are greather than or equal to the passed number.') do |number|
+        options[:state_filter].error = number.to_i
+      end
+
+      opts.on('-k', '--filter_token NUMBER', 'Filter the output to only include lines whose token count are greater than the passed number.') do |number|
+        options[:token_filter].limit = number.to_i
+      end
+
+      opts.on('-s', '--warn_token NUMBER', 'Highlight with a warning lines whose token count are greather than or equal to the passed number.') do |number|
+        options[:token_filter].warn = number.to_i
+      end
+
+      opts.on('-d', '--error_token NUMBER', 'Highlight with a error lines whose token count are greather than or equal to the passed number.') do |number|
+        options[:token_filter].error = number.to_i
+      end
+
+      opts.on('-p', '--parse_file FILE', 'A file to use as input.') do |file|
+        options[:files] << file
+      end
+
+      opts.on('-i', '--input_directory DIRECTORY', 'All ruby files found recursively inside the directory are passed as input.') do |directory|
+        options[:files].concat(get_ruby_files(directory))
+      end
+
+      opts.separator ''
+
+      # No argument, shows at tail.  This will print an options summary.
+      # Try it and see!
+      opts.on_tail('-h', '--help', 'Show this message') do
+        puts opts
+        exit
       end
-      RDoc.usage if !comp_state && !comp_token
-    rescue => err
-      RDoc.usage
     end
 
-    if formater =~ /html/i
-      state_formater = StateHTMLComplexityFormater.new(STDOUT,state_filter)
-      token_count_formater = HTMLTokenCounterFormater.new(STDOUT,token_filter)
+    @opts.parse! args
+    options
+  end
+
+  def initialize(args="-h")
+    @options = parse(args)
+    show_help_message("No input files specified") if @options[:files].empty?
+    show_help_message('Please choose token or cyclo mode') if !@options[:comp_state] && !@options[:comp_token]
+  end
+
+  def run!
+    if @options[:formater] =~ /html/i
+      state_formater = StateHTMLComplexityFormater.new(STDOUT,@options[:state_filter])
+      token_count_formater = HTMLTokenCounterFormater.new(STDOUT,@options[:token_filter])
     else
-      state_formater = ParseStateFormater.new(STDOUT,state_filter)
-      token_count_formater = TokenCounterFormater.new(STDOUT,token_filter)
+      state_formater = ParseStateFormater.new(STDOUT,@options[:state_filter])
+      token_count_formater = TokenCounterFormater.new(STDOUT,@options[:token_filter])
     end
 
-    state_formater = nil if !comp_state
-    token_count_formater = nil if !comp_token
+    state_formater = nil if !@options[:comp_state]
+    token_count_formater = nil if !@options[:comp_token]
 
-    idx_states, idx_tokens = Saikuro.analyze(files,
+    idx_states, idx_tokens = Saikuro.analyze(@options[:files],
                                              state_formater,
                                              token_count_formater,
-                                             output_dir)
+                                             @options[:output_dir])
 
-    write_cyclo_index(idx_states, output_dir)
-    write_token_index(idx_tokens, output_dir)
+    write_cyclo_index(idx_states, @options[:output_dir])
+    write_token_index(idx_tokens, @options[:output_dir])
   end
 
+  private
+  
+    def show_help_message(msg)
+      puts "Error starting script: #{msg}\n\n"
+      puts @opts.help
+      exit
+    end
 end
 
 #

metadata

@@ -1,26 +1,26 @@
 --- !ruby/object:Gem::Specification 
 name: atoulme-Saikuro
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 29
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 1
+  version: 1.2.1
 platform: ruby
 authors: 
-- Zev Blut, Antoine Toulme
+- Zev Blut, Morton Jonuschat, Antoine Toulme
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-23 00:00:00 -07:00
+date: 2010-07-24 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
 description: 
-email: zb@ubit.com
+email: antoine@lunar-ocean.com
 executables: 
 - saikuro
 extensions: []
@@ -29,13 +29,12 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - bin/saikuro
-- lib/saikuro/usage.rb
 - lib/saikuro.rb
 - tests/large_example.rb
 - tests/samples.rb
 - README.rdoc
 has_rdoc: true
-homepage: http://saikuro.rubyforge.org/
+homepage: http://www.github.com/atoulme/Saikuro
 licenses: []
 
 post_install_message: 
@@ -63,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: "0"
 requirements: []
 
-rubyforge_project: saikuro
+rubyforge_project: 
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3

data/lib/saikuro/usage.rb

@@ -1,39 +0,0 @@
-# This is a patch to RDoc so that when saikuro is installed as a
-# RubyGem usage will read the proper file.
-
-require 'rdoc/usage'
-
-module RDoc
-
-  def RDoc.main_program_file=(file)
-    @@main_program_file = file
-  end
-
-  # Display usage
-  def RDoc.usage_no_exit(*args)
-    @@main_program_file ||= caller[-1].sub(/:\d+$/, '')
-    comment = File.open(@@main_program_file) do |file|
-      find_comment(file)
-    end
-
-    comment = comment.gsub(/^\s*#/, '')
-
-    markup = SM::SimpleMarkup.new
-    flow_convertor = SM::ToFlow.new
-
-    flow = markup.convert(comment, flow_convertor)
-
-    format = "plain"
-
-    unless args.empty?
-      flow = extract_sections(flow, args)
-    end
-
-    options = RI::Options.instance
-    if args = ENV["RI"]
-      options.parse(args.split)
-    end
-    formatter = options.formatter.new(options, "")
-    formatter.display_flow(flow)
-  end
-end