flog 3.2.3 → 4.0.0

data/lib/flog_cli.rb

@@ -0,0 +1,237 @@
+require "rubygems"
+require "optparse"
+require "forwardable"
+
+require "flog"
+
+class FlogCLI
+  extend Forwardable
+
+  def_delegators :@flog, :average, :calculate, :each_by_score, :option
+  def_delegators :@flog, :method_locations, :method_scores, :reset, :scores
+  def_delegators :@flog, :threshold, :total_score, :no_method, :calculate_total_scores
+
+  ##
+  # Expands +*dirs+ to all files within that match ruby and rake extensions.
+  # --
+  # REFACTOR: from flay
+
+  def self.expand_dirs_to_files *dirs
+    extensions = %w[rb rake]
+
+    dirs.flatten.map { |p|
+      if File.directory? p then
+        Dir[File.join(p, '**', "*.{#{extensions.join(',')}}")]
+      else
+        p
+      end
+    }.flatten.sort
+  end
+
+  ##
+  # Loads all flog plugins. Files must be named "flog/*.rb".
+
+  def self.load_plugins
+    # TODO: I think I want to do this more like hoe's plugin system. Generalize?
+    loaded, found = {}, {}
+
+    Gem.find_files("flog/*.rb").reverse.each do |path|
+      found[File.basename(path, ".rb").intern] = path
+    end
+
+    found.each do |name, plugin|
+      next if loaded[name]
+      begin
+        warn "loading #{plugin}" # if $DEBUG
+        loaded[name] = load plugin
+      rescue LoadError => e
+        warn "error loading #{plugin.inspect}: #{e.message}. skipping..."
+      end
+    end
+
+    self.plugins.merge loaded
+
+    names = Flog.constants.map {|s| s.to_s}.reject {|n| n =~ /^[A-Z_]+$/}
+
+    names.each do |name|
+      # next unless Hoe.plugins.include? name.downcase.intern
+      mod = Flog.const_get(name)
+      next if Class === mod
+      warn "extend #{mod}" if $DEBUG
+      # self.extend mod
+    end
+  end
+
+  ##
+  # Parse options in +args+ (defaults to ARGV).
+
+  def self.parse_options args = ARGV
+    option = {
+      :quiet    => false,
+      :continue => false,
+      :parser   => RubyParser,
+    }
+
+    OptionParser.new do |opts|
+      opts.separator "Standard options:"
+
+      opts.on("-a", "--all", "Display all flog results, not top 60%.") do
+        option[:all] = true
+      end
+
+      opts.on("-b", "--blame", "Include blame information for methods.") do
+        option[:blame] = true
+      end
+
+      opts.on("-c", "--continue", "Continue despite syntax errors.") do
+        option[:continue] = true
+      end
+
+      opts.on("-d", "--details", "Show method details.") do
+        option[:details] = true
+      end
+
+      opts.on("-g", "--group", "Group and sort by class.") do
+        option[:group] = true
+      end
+
+      opts.on("-h", "--help", "Show this message.") do
+        puts opts
+        exit
+      end
+
+      opts.on("-I dir1,dir2,dir3", Array, "Add to LOAD_PATH.") do |dirs|
+        dirs.each do |dir|
+          $: << dir
+        end
+      end
+
+      opts.on("-m", "--methods-only", "Skip code outside of methods.") do
+        option[:methods] = true
+      end
+
+      opts.on("-q", "--quiet", "Don't show parse errors.") do
+        option[:quiet] = true
+      end
+
+      opts.on("-s", "--score", "Display total score only.") do
+        option[:score] = true
+      end
+
+      opts.on("-v", "--verbose", "Display progress during processing.") do
+        option[:verbose] = true
+      end
+
+      opts.on("--18", "Use a ruby 1.8 parser.") do
+        option[:parser] = Ruby18Parser
+      end
+
+      opts.on("--19", "Use a ruby 1.9 parser.") do
+        option[:parser] = Ruby19Parser
+      end
+
+      next if self.plugins.empty?
+      opts.separator "Plugin options:"
+
+      extra = self.method_scores.grep(/parse_options/) - %w(parse_options)
+
+      extra.sort.each do |msg|
+        self.send msg, opts, option
+      end
+
+    end.parse! Array(args)
+
+    option
+  end
+
+  ##
+  # The known plugins for Flog. See Flog.load_plugins.
+
+  def self.plugins
+    @plugins ||= {}
+  end
+
+  ##
+  # Flog the given files or directories. Smart. Deals with "-", syntax
+  # errors, and traversing subdirectories intelligently.
+
+  def flog(*files_or_dirs)
+    files = FlogCLI.expand_dirs_to_files(*files_or_dirs)
+    @flog.flog(*files)
+  end
+
+  ##
+  # Creates a new Flog instance with +options+.
+
+  def initialize options = {}
+    @flog = Flog.new options
+  end
+
+  ##
+  # Output the report up to a given max or report everything, if nil.
+
+  def output_details io, max = nil
+    io.puts
+
+    each_by_score max do |class_method, score, call_list|
+      return 0 if option[:methods] and class_method =~ /##{no_method}/
+
+      self.print_score io, class_method, score
+
+      if option[:details] then
+        call_list.sort_by { |k,v| -v }.each do |call, count|
+          io.puts "  %6.1f:   %s" % [count, call]
+        end
+        io.puts
+      end
+    end
+  end
+
+  ##
+  # Output the report, grouped by class/module, up to a given max or
+  # report everything, if nil.
+
+  def output_details_grouped io, threshold = nil
+    calculate
+
+    scores.sort_by { |_, n| -n }.each do |klass, total|
+      io.puts
+
+      io.puts "%8.1f: %s" % [total, "#{klass} total"]
+
+      method_scores[klass].each do |name, score|
+        self.print_score io, name, score
+      end
+    end
+  end
+
+  ##
+  # Print out one formatted score.
+
+  def print_score io, name, score
+    location = method_locations[name]
+    if location then
+      io.puts "%8.1f: %-32s %s" % [score, name, location]
+    else
+      io.puts "%8.1f: %s" % [score, name]
+    end
+  end
+
+  ##
+  # Report results to #io, STDOUT by default.
+
+  def report(io = $stdout)
+    io.puts "%8.1f: %s" % [total_score, "flog total"]
+    io.puts "%8.1f: %s" % [average, "flog/method average"]
+
+    return if option[:score]
+
+    if option[:group] then
+      output_details_grouped io, threshold
+    else
+      output_details io, threshold
+    end
+  ensure
+    self.reset
+  end
+end

data/lib/flog_task.rb

@@ -1,12 +1,35 @@
 require 'rake/tasklib'
 
 class FlogTask < Rake::TaskLib
+  ##
+  # The name of the task. Defaults to :flog
+
   attr_accessor :name
+
+  ##
+  # What directories to operate on. Sensible defaults.
+
   attr_accessor :dirs
+
+  ##
+  # Threshold to fail the task at. Default 200.
+
   attr_accessor :threshold
+
+  ##
+  # Verbosity of output. Defaults to rake's trace (-t) option.
+
   attr_accessor :verbose
+
+  ##
+  # Method to use to score. Defaults to :total
+
   attr_accessor :method
 
+  ##
+  # Creates a new FlogTask instance with given +name+, +threshold+,
+  # +dirs+, and +method+.
+
   def initialize name = :flog, threshold = 200, dirs = nil, method = nil
     @name      = name
     @dirs      = dirs || %w(app bin lib spec test)
@@ -21,6 +44,9 @@ class FlogTask < Rake::TaskLib
     define
   end
 
+  ##
+  # Defines the flog task.
+
   def define
     desc "Analyze for code complexity in: #{dirs.join(', ')}"
     task name do

data/lib/gauntlet_flog.rb

@@ -10,6 +10,7 @@ require 'flog'
 require 'gauntlet'
 require 'pp'
 
+# :stopdoc:
 class FlogGauntlet < Gauntlet
   $owners       = {}
   $score_file   = 'flog-scores.yml'
@@ -17,7 +18,7 @@ class FlogGauntlet < Gauntlet
   $syntax_error = {:total => -2, :average => -2, :methods => {}}
   $no_gem       = {:total => -4, :average => -4, :methods => {}}
 
-  # copied straight from hoedown.rb 
+  # copied straight from hoedown.rb
   my_projects = %w[InlineFortran ParseTree RubyInline RubyToC
                    ZenHacks ZenTest bfts box_layout
                    change_class flay flog gauntlet heckle
@@ -55,7 +56,7 @@ class FlogGauntlet < Gauntlet
       puts "avg methods / gem : %8.2f (%8.2f stddev)" % [method_counts.average, method_counts.stddev]
       puts "avg flog / gem    : %8.2f (%8.2f stddev)" % [flog_numbers.average, flog_numbers.stddev]
     end
-    
+
     worst = scores.sort_by { |k,v| -v[:total] }.first(max)
     report_worst "Worst Projects EVAR", worst do |project, score|
       owner = $owners[project].join(', ') rescue nil
@@ -119,7 +120,7 @@ class FlogGauntlet < Gauntlet
     topN = Hash[*methods.sort_by { |k,v| -v }.first(n).flatten]
     {
       :max     => methods.values.max,
-      :total   => flogger.total,
+      :total   => flogger.total_score,
       :size    => methods.size,
       :average => flogger.average,
       :stddev  => flogger.stddev,
@@ -191,3 +192,4 @@ filter  = Regexp.new filter if filter
 flogger = FlogGauntlet.new
 flogger.run_the_gauntlet filter
 flogger.display_report max
+# :startdoc:

data/test/test_flog.rb

@@ -1,20 +1,30 @@
-require 'minitest/autorun'
-require 'flog'
+require "minitest/autorun"
+require "flog"
 
 class Flog
   attr_writer :calls
 end
 
-class TestFlog < MiniTest::Unit::TestCase
+class FlogTest < MiniTest::Unit::TestCase
+  def setup_flog
+    old_stdin = $stdin
+    $stdin = StringIO.new "2 + 3"
+    $stdin.rewind
+
+    @flog.flog "-"              # @flog can be Flog or FlogCLI
+  ensure
+    $stdin = old_stdin
+  end
+end
+
+class TestFlog < FlogTest
   def setup
     @flog = Flog.new :parser => RubyParser
   end
 
   def test_add_to_score
     assert_empty @flog.calls
-    @flog.class_stack  << "Base" << "MyKlass"
-    @flog.method_stack << "mymethod"
-    @flog.add_to_score "blah", 42
+    setup_my_klass
 
     expected = {"MyKlass::Base#mymethod" => {"blah" => 42.0}}
     assert_equal expected, @flog.calls
@@ -31,100 +41,27 @@ class TestFlog < MiniTest::Unit::TestCase
     assert_equal 1.0, @flog.average
   end
 
-  def test_cls_expand_dirs_to_files
-    expected = %w(lib/flog.rb lib/flog_task.rb lib/gauntlet_flog.rb)
-    assert_equal expected, Flog.expand_dirs_to_files('lib')
-    expected = %w(Rakefile)
-    assert_equal expected, Flog.expand_dirs_to_files('Rakefile')
-  end
-
-  def test_cls_parse_options
-    # defaults
-    opts = Flog.parse_options
-    assert_equal false,  opts[:quiet]
-    assert_equal false, opts[:continue]
-
-    {
-      "-a"             => :all,
-      "--all"          => :all,
-      "-b"             => :blame,
-      "--blame"        => :blame,
-      "-c"             => :continue,
-      "--continue"     => :continue,
-      "-d"             => :details,
-      "--details"      => :details,
-      "-g"             => :group,
-      "--group"        => :group,
-      "-m"             => :methods,
-      "--methods-only" => :methods,
-      "-q"             => :quiet,
-      "--quiet"        => :quiet,
-      "-s"             => :score,
-      "--score"        => :score,
-      "-v"             => :verbose,
-      "--verbose"      => :verbose,
-    }.each do |key, val|
-      assert_equal true, Flog.parse_options(key)[val]
-    end
-  end
-
-  def test_cls_parse_options_path
-    old_path = $:.dup
-    Flog.parse_options("-Ia,b,c")
-    assert_equal old_path + %w(a b c), $:
-
-    Flog.parse_options(["-I", "d,e,f"])
-    assert_equal old_path + %w(a b c d e f), $:
-
-    Flog.parse_options(["-I", "g", "-Ih"])
-    assert_equal old_path + %w(a b c d e f g h), $:
-  ensure
-    $:.replace old_path
-  end
-
-  def test_cls_parse_options_help
-    def Flog.exit
-      raise "happy"
-    end
-
-    ex = nil
-    o, e = capture_io do
-      ex = assert_raises RuntimeError do
-        Flog.parse_options "-h"
-      end
-    end
-
-    assert_equal "happy", ex.message
-    assert_match(/methods-only/, o)
-    assert_equal "", e
-  end
-
   def test_flog
-    old_stdin = $stdin
-    $stdin = StringIO.new "2 + 3"
-    $stdin.rewind
-
-    @flog.flog "-"
+    setup_flog
 
     exp = { "main#none" => { :+ => 1.0, :lit_fixnum => 0.6 } }
     assert_equal exp, @flog.calls
 
-    assert_equal 1.6, @flog.total unless @flog.option[:methods]
+    assert_equal 1.6, @flog.total_score unless @flog.option[:methods]
     assert_equal 3, @flog.mass["-"]
-  ensure
-    $stdin = old_stdin
   end
-  
+
   def test_flog_ruby
     ruby = "2 + 3"
     file = "sample.rb"
 
     @flog.flog_ruby ruby, file
+    @flog.calculate_total_scores
 
     exp = { "main#none" => { :+ => 1.0, :lit_fixnum => 0.6 } }
     assert_equal exp, @flog.calls
 
-    assert_equal 1.6, @flog.total unless @flog.option[:methods]
+    assert_equal 1.6, @flog.total_score unless @flog.option[:methods]
     assert_equal 3, @flog.mass[file]
   end
 
@@ -197,66 +134,6 @@ class TestFlog < MiniTest::Unit::TestCase
     assert_equal "::whatevs", @flog.method_name
   end
 
-  def test_output_details
-    @flog.option[:all] = true
-    test_flog
-
-    @flog.totals["main#something"] = 42.0
-
-    o = StringIO.new
-    @flog.output_details o
-
-    expected = "\n     1.6: main#none\n"
-
-    assert_equal expected, o.string
-    assert_equal 1.6, @flog.totals["main#none"]
-  end
-
-  def test_output_details_grouped
-    test_flog
-
-    o = StringIO.new
-    @flog.output_details_grouped o
-
-    expected = "\n     1.6: main total\n     1.6: main#none\n"
-
-    assert_equal expected, o.string
-  end
-
-  def test_output_details_methods
-    @flog.option[:methods] = true
-
-    test_flog
-
-    @flog.totals["main#something"] = 42.0 # TODO: no sense... why no output?
-
-    o = StringIO.new
-    @flog.output_details o
-
-    # HACK assert_equal "", o.string
-    assert_equal 0, @flog.totals["main#none"]
-  end
-
-  def test_output_details_detailed
-    @flog.option[:details] = true
-
-    test_flog
-
-    @flog.totals["main#something"] = 42.0
-
-    o = StringIO.new
-    @flog.output_details o, nil
-
-    expected = "\n     1.6: main#none
-     1.0:   +
-     0.6:   lit_fixnum
-
-"
-
-    assert_equal expected, o.string
-    assert_equal 1.6, @flog.totals["main#none"]
-  end
-
   # def test_process_until_empty
   #   flunk "no"
   # end
@@ -420,11 +297,29 @@ class TestFlog < MiniTest::Unit::TestCase
 
     setup
     @flog.process sexp
+    @flog.calculate_total_scores
 
     exp = {'main::x' => {:lit_fixnum => 0.375}, 'main#none' => {:sclass => 5.0}}
     assert_equal exp, @flog.calls
 
-    assert_in_delta 5.375, @flog.total
+    assert_in_delta 5.375, @flog.total_score
+  end
+
+  def test_process_defn_in_self_after_self
+    sexp = s(:sclass, s(:self),
+             s(:sclass, s(:self), s(:self)),
+             s(:defn, :x,
+               s(:args, :y),
+                 s(:lit, 42)))
+
+    setup
+    @flog.process sexp
+    @flog.calculate_total_scores
+
+    exp = {'main::x' => {:lit_fixnum => 0.375}, 'main#none' => {:sclass => 12.5}}
+    assert_equal exp, @flog.calls
+
+    assert_in_delta 12.875, @flog.total_score
   end
 
   def test_process_defs
@@ -536,9 +431,10 @@ class TestFlog < MiniTest::Unit::TestCase
 
     setup
     @flog.process sexp
+    @flog.calculate_total_scores
 
     assert_equal hash, @flog.calls
-    assert_in_delta score, @flog.total
+    assert_in_delta score, @flog.total_score
   end
 
   def test_process_lit
@@ -613,71 +509,6 @@ class TestFlog < MiniTest::Unit::TestCase
     util_process sexp, 1.50, :yield => 1.0, :lit_fixnum => 0.50
   end
 
-  def test_report
-    test_flog
-
-    o = StringIO.new
-    @flog.report o
-
-    expected = "     1.6: flog total
-     1.6: flog/method average
-
-     1.6: main#none
-"
-
-    assert_equal expected, o.string
-  end
-
-  def test_report_all
-    old_stdin = $stdin
-    $stdin = StringIO.new "2 + 3"
-    $stdin.rewind
-
-    @flog.flog "-"
-    @flog.totals["main#something"] = 42.0
-
-    exp = { "main#none" => { :+ => 1.0, :lit_fixnum => 0.6 } }
-    assert_equal exp, @flog.calls
-
-    @flog.option[:all] = true
-
-    assert_equal 1.6, @flog.total unless @flog.option[:methods]
-    assert_equal 3, @flog.mass["-"]
-
-    o = StringIO.new
-    @flog.report o
-
-    expected = "     1.6: flog total
-     1.6: flog/method average
-
-     1.6: main#none
-"
-
-    assert_equal expected, o.string
-    # FIX: add thresholded output
-  ensure
-    $stdin = old_stdin
-  end
-
-  def test_report_group
-    # TODO: add second group to ensure proper output
-    @flog.option[:group] = true
-
-    test_flog
-
-    o = StringIO.new
-    @flog.report o
-
-    expected = "     1.6: flog total
-     1.6: flog/method average
-
-     1.6: main total
-     1.6: main#none
-"
-
-    assert_equal expected, o.string
-  end
-
   def test_score_method
     assert_equal 3.0, @flog.score_method(:blah       => 3.0)
     assert_equal 4.0, @flog.score_method(:assignment => 4.0)
@@ -699,9 +530,11 @@ class TestFlog < MiniTest::Unit::TestCase
     assert_equal "main#y", @flog.signature
   end
 
-  def test_total
+  def test_total_score
     @flog.add_to_score "blah", 2
-    assert_equal 2.0, @flog.total
+    @flog.calculate_total_scores
+
+    assert_equal 2.0, @flog.total_score
   end
 
   def test_max_method
@@ -711,6 +544,7 @@ class TestFlog < MiniTest::Unit::TestCase
       "main#meth_two" => {"foo" => 2.0, "bar" => 14.0},
     }
 
+    @flog.calculate_total_scores
     assert_equal ["main#meth_two", 16.0], @flog.max_method
   end
 
@@ -720,6 +554,7 @@ class TestFlog < MiniTest::Unit::TestCase
       "main#meth_one" => {"foo" => 1.0, "bar" => 1.0},
       "main#meth_two" => {"foo" => 2.0, "bar" => 14.0},
     }
+    @flog.calculate_total_scores
 
     assert_equal 16.0, @flog.max_score
   end
@@ -736,6 +571,34 @@ class TestFlog < MiniTest::Unit::TestCase
       assert_equal exp, @flog.calls
     end
 
-    assert_in_delta score, @flog.total
+    @flog.calculate_total_scores
+
+    assert_in_delta score, @flog.total_score
+  end
+
+  def test_threshold
+    test_flog
+    assert_equal Flog::THRESHOLD * 1.6, @flog.threshold
+  end
+
+  def test_no_threshold
+    @flog.option[:all] = true
+    assert_equal nil, @flog.threshold
+  end
+
+  def test_calculate
+    setup_my_klass
+
+    @flog.calculate_total_scores
+    @flog.calculate
+
+    assert_equal({ 'MyKlass' => 42.0 }, @flog.scores)
+    assert_equal({ 'MyKlass' => [["MyKlass::Base#mymethod", 42.0]] }, @flog.method_scores)
+  end
+
+  def setup_my_klass
+    @flog.class_stack  << "Base" << "MyKlass"
+    @flog.method_stack << "mymethod"
+    @flog.add_to_score "blah", 42
   end
 end