flog 2.2.0 → 2.3.0

data.tar.gz.sig

@@ -0,0 +1 @@
+����!�������K�4+5՞��d�l=yT�n�6\�aU���dq���>�'x�\�웍{ᷰеf[ɠlW���'�T�vV�h�|��s���o4�<"�8���15��Lʴ��n�����QO/�*ώ��To�tʲ�I'ߨ�tW<z$i���Kìă���V��	��G�I�ۗei

data/.autotest

@@ -0,0 +1,15 @@
+# -*- ruby -*-
+
+require 'autotest/restart'
+require 'autotest/rcov'
+
+Autotest.add_hook :initialize do |at|
+  at.order = :random
+
+  at.add_mapping(/^spec\/.*_spec\.rb$/) do |filename, _|
+    filename
+  end
+
+  at.libs << ':../../minitest/dev/lib'
+  at.testlib = "minitest/autorun"
+end

data/History.txt

@@ -1,3 +1,25 @@
+=== 2.3.0 / 2009-12-09
+
+* 1 major enhancement:
+
+  * Added file:line info to the flog report (Marty Andrews)
+
+* 13 minor enhancements:
+
+  * Added .autotest.
+  * Deleted pre-gauntlet scripts.
+  * Flog#method_name now at least tries show when it is a class method.
+  * Flog.parse_options now takes args directly.
+  * Removed Flog#increment_total_score_by.
+  * Removed Flog#output_summary.
+  * Removed Flog#process_attrset.
+  * Removed Flog#record_method_score.
+  * Removed Flog#summarize_method.
+  * Removed Flog::default_options.
+  * Renamed Flog#analyze_list to process_until_empty.
+  * Renamed Flog#options to #option
+  * Rewrote entire test suite (3100 lines down!). Cleaner and less brittle.
+
 === 2.2.0 / 2009-08-14
 
 * 1 minor enhancement:

data/Manifest.txt

@@ -1,26 +1,10 @@
+.autotest
 History.txt
 Manifest.txt
 README.txt
 Rakefile
 bin/flog
-gem_updater.rb
 lib/flog.rb
 lib/flog_task.rb
 lib/gauntlet_flog.rb
-unpack.rb
-update_scores.rb
-spec_fixtures/collection/bigger_example/acts/date_range.rb
-spec_fixtures/collection/bigger_example/acts/range.rb
-spec_fixtures/collection/bigger_example/association_extensions/date_ranged.rb
-spec_fixtures/collection/bigger_example/association_extensions/ranged.rb
-spec_fixtures/collection/bigger_example/reflection_extensions/ranged.rb
-spec_fixtures/directory/bot_filter.rb
-spec_fixtures/directory/bot_parser.rb
-spec_fixtures/directory/bot_parser_format.rb
-spec_fixtures/directory/bot_sender.rb
-spec_fixtures/empty/empty.rb
-spec_fixtures/simple/simple.rb
 test/test_flog.rb
-test/test_flog_command.rb
-test/test_flog_integration.rb
-test/test_helper.rb

data/bin/flog

@@ -3,7 +3,7 @@
 require 'optparse'
 require 'flog'
 
-options = Flog.parse_options
+options = Flog.parse_options ARGV
 
 ARGV << "-" if ARGV.empty?
 

data/lib/flog.rb

@@ -4,7 +4,7 @@ require 'ruby_parser'
 require 'optparse'
 
 class Flog < SexpProcessor
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 
   THRESHOLD = 0.60
   SCORES = Hash.new 1
@@ -69,14 +69,8 @@ class Flog < SexpProcessor
   @@no_method = :none
 
   attr_accessor :multiplier
-  attr_reader :calls, :options, :class_stack, :method_stack, :mass
-
-  def self.default_options
-    {
-      :quiet    => true,
-      :continue => false,
-    }
-  end
+  attr_reader :calls, :option, :class_stack, :method_stack, :mass
+  attr_reader :method_locations
 
   # REFACTOR: from flay
   def self.expand_dirs_to_files *dirs
@@ -91,27 +85,31 @@ class Flog < SexpProcessor
     }.flatten.sort
   end
 
-  def self.parse_options
-    options = self.default_options
-    op = OptionParser.new do |opts|
+  def self.parse_options args = ARGV
+    option = {
+      :quiet    => true,
+      :continue => false,
+    }
+
+    OptionParser.new do |opts|
       opts.on("-a", "--all", "Display all flog results, not top 60%.") do
-        options[:all] = true
+        option[:all] = true
       end
 
       opts.on("-b", "--blame", "Include blame information for methods.") do
-        options[:blame] = true
+        option[:blame] = true
       end
 
       opts.on("-c", "--continue", "Continue despite syntax errors.") do
-        options[:continue] = true
+        option[:continue] = true
       end
 
       opts.on("-d", "--details", "Show method details.") do
-        options[:details] = true
+        option[:details] = true
       end
 
       opts.on("-g", "--group", "Group and sort by class.") do
-        options[:group] = true
+        option[:group] = true
       end
 
       opts.on("-h", "--help", "Show this message.") do
@@ -125,37 +123,34 @@ class Flog < SexpProcessor
         end
       end
 
-      opts.on("-m", "--methods-only", "Skip code outside of methods.") do |m|
-        options[:methods] = m
+      opts.on("-m", "--methods-only", "Skip code outside of methods.") do
+        option[:methods] = true
       end
 
-      opts.on("-q", "--quiet", "Don't show method details. [default]")  do |v|
-        options[:quiet] = v
+      opts.on("-q", "--quiet", "Don't show method details. [default]") do
+        option[:quiet] = true
       end
 
-      opts.on("-s", "--score", "Display total score only.")  do |s|
-        options[:score] = s
+      opts.on("-s", "--score", "Display total score only.") do
+        option[:score] = true
       end
 
-      opts.on("-v", "--verbose", "Display progress during processing.")  do |v|
-        options[:verbose] = v
+      opts.on("-v", "--verbose", "Display progress during processing.") do
+        option[:verbose] = true
       end
-    end.parse!
+    end.parse! Array(args)
 
-    options
+    option
   end
 
-  # TODO: rename options to option, you only deal with them one at a time...
-
   def add_to_score name, score = OTHER_SCORES[name]
-    @calls["#{klass_name}##{method_name}"][name] += score * @multiplier
+    @calls[signature][name] += score * @multiplier
   end
 
   ##
   # Process each element of #exp in turn.
-  # TODO: rename, bleed wasn't good, but this is actually worse
 
-  def analyze_list exp
+  def process_until_empty exp
     process exp.shift until exp.empty?
   end
 
@@ -171,7 +166,7 @@ class Flog < SexpProcessor
       begin
         # TODO: replace File.open to deal with "-"
         ruby = file == '-' ? $stdin.read : File.read(file)
-        warn "** flogging #{file}" if options[:verbose]
+        warn "** flogging #{file}" if option[:verbose]
 
         ast = @parser.process(ruby, file)
         next unless ast
@@ -182,7 +177,7 @@ class Flog < SexpProcessor
           warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
           warn "\n...stupid lemmings and their bad erb templates... skipping"
         else
-          raise e unless options[:continue]
+          raise e unless option[:continue]
           warn file
           warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
         end
@@ -190,6 +185,9 @@ class Flog < SexpProcessor
     end
   end
 
+  ##
+  # Adds name to the class stack, for the duration of the block
+
   def in_klass name
     @class_stack.unshift name
     yield
@@ -197,33 +195,30 @@ class Flog < SexpProcessor
   end
 
   ##
-  # Adds name to the list of methods, for the duration of the block
+  # Adds name to the method stack, for the duration of the block
 
-  def in_method name
+  def in_method(name, file, line)
     @method_stack.unshift name
+    # "#{klass_name}##{name}"
+    @method_locations[signature] = "#{file}:#{line}"
     yield
     @method_stack.shift
   end
 
-  def increment_total_score_by amount
-    raise "@total_score isn't even set yet... dumbass" unless @total_score
-    @total_score += amount
-  end
-
-  def initialize options = {}
+  def initialize option = {}
     super()
-    @options             = options
+    @option              = option
     @class_stack         = []
     @method_stack        = []
+    @method_locations    = {}
     @mass                = {}
     @parser              = RubyParser.new
     self.auto_shift_type = true
-    self.require_empty   = false # HACK
     self.reset
   end
 
   ##
-  # returns the first class in the list, or @@no_class if there are
+  # Returns the first class in the list, or @@no_class if there are
   # none.
 
   def klass_name
@@ -236,7 +231,7 @@ class Flog < SexpProcessor
                name.delete :colon2
                name.join("::")
              when :colon3 then
-               name.last
+               name.last.to_s
              else
                name
              end
@@ -245,18 +240,20 @@ class Flog < SexpProcessor
   end
 
   ##
-  # returns the first method in the list, or @@no_method if there are
+  # Returns the first method in the list, or @@no_method if there are
   # none.
 
   def method_name
-    @method_stack.first || @@no_method
+    m = @method_stack.first || @@no_method
+    m = "##{m}" unless m =~ /::/ unless m == @@no_method # FIX
+    m
   end
 
   def output_details(io, max = nil)
     my_totals = totals
     current = 0
 
-    if options[:group] then
+    if option[:group] then
       scores = Hash.new 0
       methods = Hash.new { |h,k| h[k] = [] }
 
@@ -273,7 +270,12 @@ class Flog < SexpProcessor
         io.puts
         io.puts "%8.1f: %s" % [total, "#{klass} total"]
         methods[klass].each do |name, score|
-          io.puts "%8.1f: %s" % [score, name]
+          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
       end
     else
@@ -286,21 +288,25 @@ class Flog < SexpProcessor
   end
 
   def output_method_details(io, class_method, call_list)
-    return 0 if options[:methods] and class_method =~ /##{@@no_method}/
+    return 0 if option[:methods] and class_method =~ /##{@@no_method}/
 
     total = totals[class_method]
-    io.puts "%8.1f: %s" % [total, class_method]
 
-    call_list.sort_by { |k,v| -v }.each do |call, count|
-      io.puts "  %6.1f: %s" % [count, call]
-    end if options[:details]
+    location = @method_locations[class_method]
+    if location then
+      io.puts "%8.1f: %-32s %s" % [total, class_method, location]
+    else
+      io.puts "%8.1f: %s" % [total, class_method]
+    end
 
-    total
-  end
+    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
 
-  def output_summary(io)
-    io.puts "%8.1f: %s" % [total, "flog total"]
-    io.puts "%8.1f: %s" % [average, "flog/method average"]
+    total
   end
 
   ##
@@ -315,19 +321,16 @@ class Flog < SexpProcessor
     @multiplier -= bonus
   end
 
-  def record_method_score(method, score)
-    @totals ||= Hash.new(0)
-    @totals[method] = score
-  end
-
   ##
   # Report results to #io, STDOUT by default.
 
   def report(io = $stdout)
-    output_summary(io)
-    return if options[:score]
+    io.puts "%8.1f: %s" % [total, "flog total"]
+    io.puts "%8.1f: %s" % [average, "flog/method average"]
+
+    return if option[:score]
 
-    if options[:all] then # TODO: fix - use option[:all] and THRESHOLD directly
+    if option[:all] then
       output_details(io)
     else
       output_details(io, total * THRESHOLD)
@@ -354,14 +357,13 @@ class Flog < SexpProcessor
     Math.sqrt(a*a + b*b + c*c)
   end
 
-  def summarize_method(meth, tally)
-    return if options[:methods] and meth =~ /##{@@no_method}$/
-    score = score_method(tally)
-    record_method_score(meth, score)
-    increment_total_score_by score
+  def signature
+    m = method_name
+    m = "#none" if m == @@no_method
+    "#{klass_name}#{m}" # FIX: ugly
   end
 
-  def total
+  def total # FIX: I hate this indirectness
     totals unless @total_score # calculates total_score as well
 
     @total_score
@@ -374,10 +376,16 @@ class Flog < SexpProcessor
     unless @totals then
       @total_score = 0
       @totals = Hash.new(0)
+
       calls.each do |meth, tally|
-        summarize_method(meth, tally)
+        next if option[:methods] and meth =~ /##{@@no_method}$/
+        score = score_method(tally)
+
+        @totals[meth] = score
+        @total_score += score
       end
     end
+
     @totals
   end
 
@@ -409,15 +417,9 @@ class Flog < SexpProcessor
     s()
   end
 
-  def process_attrset(exp)
-    add_to_score :assignment
-    raise exp.inspect
-    s()
-  end
-
   def process_block(exp)
     penalize_by 0.1 do
-      analyze_list exp
+      process_until_empty exp
     end
     s()
   end
@@ -461,7 +463,7 @@ class Flog < SexpProcessor
     add_to_score :branch
     process exp.shift # recv
     penalize_by 0.1 do
-      analyze_list exp
+      process_until_empty exp
     end
     s()
   end
@@ -469,14 +471,14 @@ class Flog < SexpProcessor
   def process_class(exp)
     in_klass exp.shift do
       penalize_by 1.0 do
-        supr = process exp.shift
+        process exp.shift # superclass expression
       end
-      analyze_list exp
+      process_until_empty exp
     end
     s()
   end
 
-  def process_dasgn_curr(exp)
+  def process_dasgn_curr(exp) # FIX: remove
     add_to_score :assignment
     exp.shift # name
     process exp.shift # assigment, if any
@@ -486,16 +488,16 @@ class Flog < SexpProcessor
   alias :process_lasgn :process_dasgn_curr
 
   def process_defn(exp)
-    in_method exp.shift do
-      analyze_list exp
+    in_method exp.shift, exp.file, exp.line do
+      process_until_empty exp
     end
     s()
   end
 
   def process_defs(exp)
-    process exp.shift
-    in_method exp.shift do
-      analyze_list exp
+    recv = process exp.shift
+    in_method "::#{exp.shift}", exp.file, exp.line do
+      process_until_empty exp
     end
     s()
   end
@@ -504,7 +506,7 @@ class Flog < SexpProcessor
   def process_else(exp)
     add_to_score :branch
     penalize_by 0.1 do
-      analyze_list exp
+      process_until_empty exp
     end
     s()
   end
@@ -523,15 +525,17 @@ class Flog < SexpProcessor
 
   def process_iter(exp)
     context = (self.context - [:class, :module, :scope])
-    if context.uniq.sort_by {|s|s.to_s} == [:block, :iter] then
+    if context.uniq.sort_by { |s| s.to_s } == [:block, :iter] then
       recv = exp.first
+
+      # DSL w/ names. eg task :name do ... end
       if (recv[0] == :call and recv[1] == nil and recv.arglist[1] and
           [:lit, :str].include? recv.arglist[1][0]) then
         msg = recv[2]
         submsg = recv.arglist[1][1]
-        in_method submsg do
-          in_klass msg do
-            analyze_list exp
+        in_klass msg do                           # :task
+          in_method submsg, exp.file, exp.line do # :name
+            process_until_empty exp
           end
         end
         return s()
@@ -540,12 +544,12 @@ class Flog < SexpProcessor
 
     add_to_score :branch
 
-    exp.delete 0
+    exp.delete 0 # TODO: what is this?
 
     process exp.shift # no penalty for LHS
 
     penalize_by 0.1 do
-      analyze_list exp
+      process_until_empty exp
     end
 
     s()
@@ -568,13 +572,13 @@ class Flog < SexpProcessor
 
   def process_masgn(exp)
     add_to_score :assignment
-    analyze_list exp
+    process_until_empty exp
     s()
   end
 
   def process_module(exp)
     in_klass exp.shift do
-      analyze_list exp
+      process_until_empty exp
     end
     s()
   end
@@ -582,7 +586,7 @@ class Flog < SexpProcessor
   def process_sclass(exp)
     penalize_by 0.5 do
       recv = process exp.shift
-      analyze_list exp
+      process_until_empty exp
     end
 
     add_to_score :sclass
@@ -591,7 +595,7 @@ class Flog < SexpProcessor
 
   def process_super(exp)
     add_to_score :super
-    analyze_list exp
+    process_until_empty exp
     s()
   end
 
@@ -608,7 +612,7 @@ class Flog < SexpProcessor
 
   def process_yield(exp)
     add_to_score :yield
-    analyze_list exp
+    process_until_empty exp
     s()
   end
 end