flog 3.0.0 → 3.1.0

data/History.txt

@@ -1,3 +1,17 @@
+=== 3.1.0 / 2012-11-16
+
+* 4 minor enhancements:
+
+  * --quiet option is now false by default, and changed to silence parse warnings.
+  * Added max_score and max_method. (aselder)
+  * FlogTask can now take a method to use to figure out score, allowing for total or max_score.
+  * Switched to capturing RubyParser::SyntaxError (RP 3.0 change).
+
+* 2 bug fixes:
+
+  * Avoid redefined warning for File::RUBY19. (svendahlstrand)
+  * Fixed flog to default to RubyParser if not specified. Allows cleaner programmatic access.
+
 === 3.0.0 / 2012-11-02
 
 * 1 minor enhancement:

data/Rakefile

@@ -17,6 +17,9 @@ Hoe.spec 'flog' do
 
   self.rubyforge_name = 'seattlerb'
 
+  self.flog_method = :max_method
+  self.flog_threshold = timebomb 150, 50, '2013-11-01', '2012-11-01'
+
   dependency 'sexp_processor', '~> 4.0'
   dependency 'ruby_parser',    '~> 3.0.0'
 end

data/lib/flog.rb

@@ -5,7 +5,7 @@ require 'optparse'
 require 'timeout'
 
 class File
-  RUBY19 = "<3".respond_to? :encoding
+  RUBY19 = "<3".respond_to? :encoding unless defined? RUBY19
 
   class << self
     alias :binread :read unless RUBY19
@@ -13,7 +13,7 @@ class File
 end
 
 class Flog < SexpProcessor
-  VERSION = '3.0.0'
+  VERSION = '3.1.0'
 
   THRESHOLD = 0.60
   SCORES = Hash.new 1
@@ -132,7 +132,7 @@ class Flog < SexpProcessor
 
   def self.parse_options args = ARGV
     option = {
-      :quiet    => true,
+      :quiet    => false,
       :continue => false,
       :parser   => RubyParser,
     }
@@ -175,7 +175,7 @@ class Flog < SexpProcessor
         option[:methods] = true
       end
 
-      opts.on("-q", "--quiet", "Don't show method details. [default]") do
+      opts.on("-q", "--quiet", "Don't show parse errors.") do
         option[:quiet] = true
       end
 
@@ -256,7 +256,7 @@ class Flog < SexpProcessor
         ruby = file == '-' ? $stdin.read : File.binread(file)
         warn "** flogging #{file}" if option[:verbose]
 
-        @parser = option[:parser].new
+        @parser = (option[:parser] || RubyParser).new
 
         begin
           ast = @parser.process(ruby, file)
@@ -267,18 +267,21 @@ class Flog < SexpProcessor
         next unless ast
         mass[file] = ast.mass
         process ast
-      rescue RegexpError, SyntaxError, Racc::ParseError => e
+      rescue RubyParser::SyntaxError, Racc::ParseError => e
+        q = option[:quiet]
         if e.inspect =~ /<\%|%\>/ or ruby =~ /<\%|%\>/ then
+          return if q
           warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
           warn "\n...stupid lemmings and their bad erb templates... skipping"
         else
-          warn "ERROR: parsing ruby file #{file}"
+          warn "ERROR: parsing ruby file #{file}" unless q
           unless option[:continue] then
             warn "ERROR! Aborting. You may want to run with --continue."
             raise e
           end
-          warn "#{e.class}: #{e.message.strip} at:"
-          warn "  #{e.backtrace.first(5).join("\n  ")}"
+          return if q
+          warn "%s: %s at:\n  %s" % [e.class, e.message.strip,
+                                     e.backtrace.first(5).join("\n  ")]
         end
       end
     end
@@ -487,6 +490,14 @@ class Flog < SexpProcessor
     @total_score
   end
 
+  def max_score
+    max_method.last
+  end
+
+  def max_method
+    totals.max_by { |_, score| score }
+  end
+
   ##
   # Return the total score and populates @totals.
 

data/lib/flog_task.rb

@@ -3,11 +3,13 @@ class FlogTask < Rake::TaskLib
   attr_accessor :dirs
   attr_accessor :threshold
   attr_accessor :verbose
+  attr_accessor :method
 
-  def initialize name = :flog, threshold = 200, dirs = nil
+  def initialize name = :flog, threshold = 200, dirs = nil, method = nil
     @name      = name
     @dirs      = dirs || %w(app bin lib spec test)
     @threshold = threshold
+    @method    = method || :total
     @verbose   = Rake.application.options.trace
 
     yield self if block_given?
@@ -21,13 +23,18 @@ class FlogTask < Rake::TaskLib
     desc "Analyze for code complexity in: #{dirs.join(', ')}"
     task name do
       require "flog"
-      flog = Flog.new
+      flog = Flog.new :continue => true, :quiet => true
       flog.flog(*dirs)
+
+      desc, score = flog.send method
+      desc, score = "total", desc unless score # total only returns a number
+
       flog.report if verbose
 
-      raise "Flog total too high! #{flog.total} > #{threshold}" if
-        flog.total > threshold
+      raise "Flog score for #{desc} is too high! #{score} > #{threshold}" if
+        score > threshold
     end
+
     self
   end
 end

data/test/test_flog.rb

@@ -1,6 +1,10 @@
 require 'minitest/autorun'
 require 'flog'
 
+class Flog
+  attr_writer :calls
+end
+
 class TestFlog < MiniTest::Unit::TestCase
   def setup
     @flog = Flog.new :parser => RubyParser
@@ -37,7 +41,7 @@ class TestFlog < MiniTest::Unit::TestCase
   def test_cls_parse_options
     # defaults
     opts = Flog.parse_options
-    assert_equal true,  opts[:quiet]
+    assert_equal false,  opts[:quiet]
     assert_equal false, opts[:continue]
 
     {
@@ -672,6 +676,26 @@ class TestFlog < MiniTest::Unit::TestCase
     assert_equal 2.0, @flog.total
   end
 
+  def test_max_method
+    @flog.calls = {
+      "main#none" => {"foo" => 2.0, "bar" => 4.0},
+      "main#meth_one" => {"foo" => 1.0, "bar" => 1.0},
+      "main#meth_two" => {"foo" => 2.0, "bar" => 14.0},
+    }
+
+    assert_equal ["main#meth_two", 16.0], @flog.max_method
+  end
+
+  def test_max_score
+    @flog.calls = {
+      "main#none"     => {"foo" => 2.0, "bar" => 4.0},
+      "main#meth_one" => {"foo" => 1.0, "bar" => 1.0},
+      "main#meth_two" => {"foo" => 2.0, "bar" => 14.0},
+    }
+
+    assert_equal 16.0, @flog.max_score
+  end
+
   def util_process sexp, score = -1, hash = {}
     setup
     @flog.process sexp

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: flog
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 3
   prerelease: 
   segments: 
   - 3
+  - 1
   - 0
-  - 0
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors: 
 - Ryan Davis
@@ -36,7 +36,7 @@ cert_chain:
   FBHgymkyj/AOSqKRIpXPhjC6
   -----END CERTIFICATE-----
 
-date: 2012-11-02 00:00:00 Z
+date: 2012-11-17 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: sexp_processor
@@ -77,11 +77,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 31
         segments: 
         - 4
-        - 1
-        version: "4.1"
+        - 2
+        version: "4.2"
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -107,11 +107,11 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 5
+        hash: 1
         segments: 
         - 3
-        - 1
-        version: "3.1"
+        - 3
+        version: "3.3"
   type: :development
   version_requirements: *id005
 description: |-