flog 4.1.2 → 4.2.0

data/History.txt

@@ -1,3 +1,11 @@
+=== 4.2.0 / 2013-10-18
+
+* 3 minor enhancements:
+
+  * Added --extended / -e to put file:line output on next line (for rubymine & friends)
+  * Extracted MethodBasedSexpProcessor and pushed up to sexp_processor gem.
+  * Updated dependency on sexp_processor to ~> 4.4.
+
 === 4.1.2 / 2013-09-05
 
 * 2 bug fixes:

data/Rakefile

@@ -20,7 +20,7 @@ Hoe.spec 'flog' do
   self.flog_method = :max_method
   self.flog_threshold = timebomb 150, 50, '2013-11-01', '2012-11-01'
 
-  dependency "sexp_processor", "~> 4.0"
+  dependency "sexp_processor", "~> 4.4"
   dependency "ruby_parser",    ["~> 3.1", "> 3.1.0"]
 end
 

data/lib/flog.rb

@@ -10,8 +10,8 @@ class File
   end
 end
 
-class Flog < SexpProcessor
-  VERSION = "4.1.2" # :nodoc:
+class Flog < MethodBasedSexpProcessor
+  VERSION = "4.2.0" # :nodoc:
 
   ##
   # Cut off point where the report should stop unless --all given.
@@ -93,13 +93,10 @@ class Flog < SexpProcessor
 
   SCORES.merge!(:inject => 2)
 
-  @@no_class  = :main
-  @@no_method = :none
-
   # :stopdoc:
   attr_accessor :multiplier
-  attr_reader :calls, :option, :class_stack, :method_stack, :mass, :sclass
-  attr_reader :method_locations, :method_scores, :scores
+  attr_reader :calls, :option, :mass
+  attr_reader :method_scores, :scores
   attr_reader :total_score, :totals
 
   # :startdoc:
@@ -227,49 +224,12 @@ class Flog < SexpProcessor
     process ast
   end
 
-  ##
-  # Adds name to the class stack, for the duration of the block
-
-  def in_klass name
-    if Sexp === name then
-      name = case name.first
-             when :colon2 then
-               name = name.flatten
-               name.delete :const
-               name.delete :colon2
-               name.join("::")
-             when :colon3 then
-               name.last.to_s
-             else
-               raise "unknown type #{name.inspect}"
-             end
-    end
-
-    @class_stack.unshift name
-    yield
-    @class_stack.shift
-  end
-
-  ##
-  # Adds name to the method stack, for the duration of the block
-
-  def in_method(name, file, line)
-    method_name = Regexp === name ? name.inspect : name.to_s
-    @method_stack.unshift method_name
-    @method_locations[signature] = "#{file}:#{line}"
-    yield
-    @method_stack.shift
-  end
-
   ##
   # Creates a new Flog instance with +options+.
 
   def initialize option = {}
     super()
     @option              = option
-    @sclass              = []
-    @class_stack         = []
-    @method_stack        = []
     @method_locations    = {}
     @mass                = {}
     @parser              = nil
@@ -277,22 +237,6 @@ class Flog < SexpProcessor
     self.reset
   end
 
-  ##
-  # Returns the first class in the list, or @@no_class if there are
-  # none.
-
-  def klass_name
-    name = @class_stack.first
-
-    if Sexp === name then
-      raise "you shouldn't see me"
-    elsif @class_stack.any?
-      @class_stack.reverse.join("::").sub(/\([^\)]+\)$/, '')
-    else
-      @@no_class
-    end
-  end
-
   ##
   # Returns the method/score pair of the maximum score.
 
@@ -307,16 +251,6 @@ class Flog < SexpProcessor
     max_method.last
   end
 
-  ##
-  # 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 =~ /::/
-    m
-  end
-
   ##
   # For the duration of the block the complexity factor is increased
   # by #bonus This allows the complexity of sub-expressions to be
@@ -329,13 +263,6 @@ 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
-
   ##
   # Reset score data
 
@@ -345,7 +272,7 @@ class Flog < SexpProcessor
     @calls            = Hash.new { |h,k| h[k] = Hash.new 0 }
     @method_scores    = Hash.new { |h,k| h[k] = [] }
     @scores           = Hash.new 0
-    @method_locations = {}
+    method_locations.clear
   end
 
   ##
@@ -363,13 +290,6 @@ class Flog < SexpProcessor
     Math.sqrt(a*a + b*b + c*c)
   end
 
-  ##
-  # Returns the method signature for the current method.
-
-  def signature
-    "#{klass_name}#{method_name}"
-  end
-
   ##
   # Final threshold that is used for report
 
@@ -487,13 +407,12 @@ class Flog < SexpProcessor
   end
 
   def process_class(exp)
-    in_klass exp.shift do
+    super do
       penalize_by 1.0 do
         process exp.shift # superclass expression
       end
       process_until_empty exp
     end
-    s()
   end
 
   def process_dasgn_curr(exp) # FIX: remove
@@ -505,22 +424,6 @@ class Flog < SexpProcessor
   alias :process_iasgn :process_dasgn_curr
   alias :process_lasgn :process_dasgn_curr
 
-  def process_defn(exp)
-    name = @sclass.empty? ? exp.shift : "::#{exp.shift}"
-    in_method name, exp.file, exp.line do
-      process_until_empty exp
-    end
-    s()
-  end
-
-  def process_defs(exp)
-    process exp.shift # recv
-    in_method "::#{exp.shift}", exp.file, exp.line do
-      process_until_empty exp
-    end
-    s()
-  end
-
   # TODO:  it's not clear to me whether this can be generated at all.
   def process_else(exp)
     add_to_score :branch
@@ -605,20 +508,13 @@ class Flog < SexpProcessor
     s()
   end
 
-  def process_module(exp)
-    in_klass exp.shift do
-      process_until_empty exp
-    end
-    s()
-  end
-
   def process_sclass(exp)
-    @sclass.push(true)
-    penalize_by 0.5 do
-      process exp.shift # recv
-      process_until_empty exp
+    super do
+      penalize_by 0.5 do
+        process exp.shift # recv
+        process_until_empty exp
+      end
     end
-    @sclass.pop
 
     add_to_score :sclass
     s()

data/lib/flog_cli.rb

@@ -115,6 +115,10 @@ class FlogCLI
         option[:quiet] = true
       end
 
+      opts.on("-e", "--extended", "Put file:line on a separate line (for rubymine & friends).") do
+        option[:extended] = true
+      end
+
       opts.on("-s", "--score", "Display total score only.") do
         option[:score] = true
       end
@@ -210,7 +214,9 @@ class FlogCLI
   def print_score io, name, score
     location = method_locations[name]
     if location then
-      io.puts "%8.1f: %-32s %s" % [score, name, location]
+      sep = " "
+      sep = "%-11s" % "\n" if option[:extended]
+      io.puts "%8.1f: %-32s%s%s" % [score, name, sep, location]
     else
       io.puts "%8.1f: %s" % [score, name]
     end

data/test/test_flog.rb

@@ -80,64 +80,6 @@ class TestFlog < FlogTest
     $stdin = old_stdin
   end
 
-  def test_in_klass
-    assert_empty @flog.class_stack
-
-    @flog.in_klass "xxx::yyy" do
-      assert_equal ["xxx::yyy"], @flog.class_stack
-    end
-
-    assert_empty @flog.class_stack
-  end
-
-  def test_in_method
-    assert_empty @flog.method_stack
-
-    @flog.in_method "xxx", "file.rb", 42 do
-      assert_equal ["xxx"], @flog.method_stack
-    end
-
-    assert_empty @flog.method_stack
-
-    expected = {"main#xxx" => "file.rb:42"}
-    assert_equal expected, @flog.method_locations
-  end
-
-  def test_klass_name
-    assert_equal :main, @flog.klass_name
-
-    @flog.class_stack << "whatevs" << "flog"
-    assert_equal "flog::whatevs", @flog.klass_name
-  end
-
-  def test_klass_name_sexp
-    @flog.in_klass s(:colon2, s(:const, :X), :Y) do
-      assert_equal "X::Y", @flog.klass_name
-    end
-
-    @flog.in_klass s(:colon3, :Y) do
-      assert_equal "Y", @flog.klass_name
-    end
-  end
-
-  def test_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
-
-    @flog.method_stack << "::whatevs"
-    assert_equal "::whatevs", @flog.method_name
-  end
-
-  # def test_process_until_empty
-  #   flunk "no"
-  # end
-
   def test_penalize_by
     assert_equal 1, @flog.multiplier
     @flog.penalize_by 2 do
@@ -525,19 +467,6 @@ class TestFlog < FlogTest
                                          :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_score
     @flog.add_to_score "blah", 2
     @flog.calculate_total_scores

data/test/test_flog_cli.rb

@@ -40,6 +40,8 @@ class TestFlogCLI < FlogTest
       "--methods-only" => :methods,
       "-q"             => :quiet,
       "--quiet"        => :quiet,
+      "-e"             => :extended,
+      "--extended"     => :extended,
       "-s"             => :score,
       "--score"        => :score,
       "-v"             => :verbose,

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flog
 version: !ruby/object:Gem::Version 
-  hash: 63
+  hash: 55
   prerelease: 
   segments: 
   - 4
-  - 1
   - 2
-  version: 4.1.2
+  - 0
+  version: 4.2.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -16,9 +16,9 @@ bindir: bin
 cert_chain: 
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBADANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBATANBgkqhkiG9w0BAQUFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTA5MDMwNjE4NTMxNVoXDTEwMDMwNjE4NTMxNVowRTETMBEGA1UE
+  GRYDY29tMB4XDTEzMDkxNjIzMDQxMloXDTE0MDkxNjIzMDQxMlowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -28,15 +28,15 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBBQUAA4IB
-  AQAY59gYvDxqSqgC92nAP9P8dnGgfZgLxP237xS6XxFGJSghdz/nI6pusfCWKM8m
-  vzjjH2wUMSSf3tNudQ3rCGLf2epkcU13/rguI88wO6MrE0wi4ZqLQX+eZQFskJb/
-  w6x9W1ur8eR01s397LSMexySDBrJOh34cm2AlfKr/jokKCTwcM0OvVZnAutaovC0
-  l1SVZ0ecg88bsWHA0Yhh7NFxK1utWoIhtB6AFC/+trM0FQEB/jZkIS8SaNzn96Rl
-  n0sZEf77FLf5peR8TP/PtmIg7Cyqz23sLM4mCOoTGIy5OcZ8TdyiyINUHtb5ej/T
-  FBHgymkyj/AOSqKRIpXPhjC6
+  AQCFZ7JTzoy1gcG4d8A6dmOJy7ygtO5MFpRIz8HuKCF5566nOvpy7aHhDDzFmQuu
+  FX3zDU6ghx5cQIueDhf2SGOncyBmmJRRYawm3wI0o1MeN6LZJ/3cRaOTjSFy6+S6
+  zqDmHBp8fVA2TGJtO0BLNkbGVrBJjh0UPmSoGzWlRhEVnYC33TpDAbNA+u39UrQI
+  ynwhNN7YbnmSR7+JU2cUjBFv2iPBO+TGuWC+9L2zn3NHjuc6tnmSYipA9y8Hv+As
+  Y4evBVezr3SjXz08vPqRO5YRdO3zfeMT8gBjRqZjWJGMZ2lD4XNfrs7eky74CyZw
+  xx3n58i0lQkBE1EpKE0lFu/y
   -----END CERTIFICATE-----
 
-date: 2013-09-05 00:00:00 Z
+date: 2013-10-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sexp_processor
@@ -46,11 +46,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 27
+        hash: 19
         segments: 
         - 4
-        - 0
-        version: "4.0"
+        - 4
+        version: "4.4"
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency