flog 2.3.0 → 2.4.0

data.tar.gz.sig

@@ -1 +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
+|D�u�c�I(h��$�7U�|V��

data/History.txt

@@ -1,3 +1,16 @@
+=== 2.4.0 / 2009-12-15
+
+* 4 minor enhancements:
+
+  * Cleaned method_name to return "#method" or "::method".
+  * DSL reporting now handles regexp literals for 'method' names (Marty Andrews)
+  * Improved tests for process_iter's myriad complexities.
+  * More doco!
+
+* 1 bug fix:
+
+  * Fixed DSL reporting excluding solo-blocks. (eg a single rake task)
+
 === 2.3.0 / 2009-12-09
 
 * 1 major enhancement:

data/lib/flog.rb

@@ -4,14 +4,14 @@ require 'ruby_parser'
 require 'optparse'
 
 class Flog < SexpProcessor
-  VERSION = '2.3.0'
+  VERSION = '2.4.0'
 
   THRESHOLD = 0.60
   SCORES = Hash.new 1
   BRANCHING = [ :and, :case, :else, :if, :or, :rescue, :until, :when, :while ]
 
   ##
-  # various non-call constructs
+  # Various non-call constructs
 
   OTHER_SCORES = {
     :alias          => 2,
@@ -28,7 +28,7 @@ class Flog < SexpProcessor
   }
 
   ##
-  # eval forms
+  # Eval forms
 
   SCORES.merge!(:define_method => 5,
                 :eval          => 5,
@@ -37,7 +37,7 @@ class Flog < SexpProcessor
                 :instance_eval => 5)
 
   ##
-  # various "magic" usually used for "clever code"
+  # Various "magic" usually used for "clever code"
 
   SCORES.merge!(:alias_method               => 2,
                 :extend                     => 2,
@@ -61,7 +61,7 @@ class Flog < SexpProcessor
                 :undef_method               => 2)
 
   ##
-  # calls I don't like and usually see being abused
+  # Calls that are ALMOST ALWAYS ABUSED!
 
   SCORES.merge!(:inject => 2)
 
@@ -143,22 +143,27 @@ class Flog < SexpProcessor
     option
   end
 
+  ##
+  # Add a score to the tally. Score can be predetermined or looked up
+  # automatically. Uses multiplier for additional spankings.
+  # Spankings!
+
   def add_to_score name, score = OTHER_SCORES[name]
     @calls[signature][name] += score * @multiplier
   end
 
   ##
-  # Process each element of #exp in turn.
-
-  def process_until_empty exp
-    process exp.shift until exp.empty?
-  end
+  # really?
 
   def average
     return 0 if calls.size == 0
     total / calls.size
   end
 
+  ##
+  # Flog the given files or directories. Smart. Deals with "-", syntax
+  # errors, and traversing subdirectories intelligently.
+
   def flog(*files_or_dirs)
     files = Flog.expand_dirs_to_files(*files_or_dirs)
 
@@ -198,8 +203,8 @@ class Flog < SexpProcessor
   # Adds name to the method stack, for the duration of the block
 
   def in_method(name, file, line)
-    @method_stack.unshift name
-    # "#{klass_name}##{name}"
+    method_name = Regexp === name ? name.inspect : name.to_s
+    @method_stack.unshift method_name
     @method_locations[signature] = "#{file}:#{line}"
     yield
     @method_stack.shift
@@ -240,15 +245,18 @@ 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 "#none" if there are
   # none.
 
   def method_name
     m = @method_stack.first || @@no_method
-    m = "##{m}" unless m =~ /::/ unless m == @@no_method # FIX
+    m = "##{m}" unless m =~ /::/
     m
   end
 
+  ##
+  # Output the report up to a given max or report everything, if nil.
+
   def output_details(io, max = nil)
     my_totals = totals
     current = 0
@@ -287,13 +295,16 @@ class Flog < SexpProcessor
     end
   end
 
+  ##
+  # Output the details for a method
+
   def output_method_details(io, class_method, call_list)
     return 0 if option[:methods] and class_method =~ /##{@@no_method}/
 
     total = totals[class_method]
 
     location = @method_locations[class_method]
-    if location then
+    if location then # REFACTOR
       io.puts "%8.1f: %-32s %s" % [total, class_method, location]
     else
       io.puts "%8.1f: %s" % [total, class_method]
@@ -321,6 +332,13 @@ class Flog < SexpProcessor
     @multiplier -= bonus
   end
 
+  ##
+  # Process each element of #exp in turn.
+
+  def process_until_empty exp
+    process exp.shift until exp.empty?
+  end
+
   ##
   # Report results to #io, STDOUT by default.
 
@@ -339,12 +357,18 @@ class Flog < SexpProcessor
     self.reset
   end
 
+  ##
+  # Reset score data
+
   def reset
     @totals     = @total_score = nil
     @multiplier = 1.0
     @calls      = Hash.new { |h,k| h[k] = Hash.new 0 }
   end
 
+  ##
+  # Compute the distance formula for a given tally
+
   def score_method(tally)
     a, b, c = 0, 0, 0
     tally.each do |cat, score|
@@ -358,9 +382,7 @@ class Flog < SexpProcessor
   end
 
   def signature
-    m = method_name
-    m = "#none" if m == @@no_method
-    "#{klass_name}#{m}" # FIX: ugly
+    "#{klass_name}#{method_name}"
   end
 
   def total # FIX: I hate this indirectness
@@ -525,7 +547,9 @@ 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
+    context = context.uniq.sort_by { |s| s.to_s }
+
+    if context == [:block, :iter] or context == [:iter] then
       recv = exp.first
 
       # DSL w/ names. eg task :name do ... end

data/test/test_flog.rb

@@ -167,14 +167,14 @@ class TestFlog < MiniTest::Unit::TestCase
   end
 
   def test_method_name
-    assert_equal :none, @flog.method_name
+    assert_equal "#none", @flog.method_name
 
     @flog.method_stack << "whatevs"
     assert_equal "#whatevs", @flog.method_name
   end
 
   def test_method_name_cls
-    assert_equal :none, @flog.method_name
+    assert_equal "#none", @flog.method_name
 
     @flog.method_stack << "::whatevs"
     assert_equal "::whatevs", @flog.method_name
@@ -403,6 +403,36 @@ class TestFlog < MiniTest::Unit::TestCase
     util_process sexp, 2.326, :loop => 1.0, :branch => 2.1
   end
 
+  def test_process_iter_dsl
+    # task :blah do
+    #   something
+    # end
+
+    sexp = s(:iter,
+             s(:call, nil, :task, s(:arglist, s(:lit, :blah))),
+             nil,
+             s(:call, nil, :something, s(:arglist)))
+
+    @klass, @meth = "task", "#blah"
+
+    util_process sexp, 2.0, :something => 1.0, :task => 1.0
+  end
+
+  def test_process_iter_dsl_regexp
+    # task /regexp/ do
+    #   something
+    # end
+
+    sexp = s(:iter,
+             s(:call, nil, :task, s(:arglist, s(:lit, /regexp/))),
+             nil,
+             s(:call, nil, :something, s(:arglist)))
+
+    @klass, @meth = "task", "#/regexp/"
+
+    util_process sexp, 2.0, :something => 1.0, :task => 1.0
+  end
+
   def test_process_lit
     sexp = s(:lit, :y)
     util_process sexp, 0.0
@@ -513,6 +543,19 @@ class TestFlog < MiniTest::Unit::TestCase
                                          :branch     => 4.0)
   end
 
+  def test_signature
+    assert_equal "main#none", @flog.signature
+
+    @flog.class_stack << "X"
+    assert_equal "X#none", @flog.signature
+
+    @flog.method_stack << "y"
+    assert_equal "X#y", @flog.signature
+
+    @flog.class_stack.shift
+    assert_equal "main#y", @flog.signature
+  end
+
   def test_total
     @flog.add_to_score "blah", 2
     assert_equal 2.0, @flog.total

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flog
 version: !ruby/object:Gem::Version 
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -30,7 +30,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2009-12-09 00:00:00 -08:00
+date: 2009-12-15 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency