flog 4.6.6 → 4.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6889c4ee131417e7461cd689e54af4a037d36ee3a854e037c9e453e7a19dee0
-  data.tar.gz: ee5fc40d4423a82b4b48db87b9bd02fac8006f4b5ac6e6f4701005a82412b451
+  metadata.gz: ad09cd2ae98738c0d08e2e366636604774c3ae81a38c15e1feec23220b392243
+  data.tar.gz: b5e85e4f01c0d0297a3c929c93bab48bf393d813a048e34a6808353c1f56cfaf
 SHA512:
-  metadata.gz: a6b0a38246e5869182caf800b6e1bacb4bd442c06746d8aac8c4223528d58bf8c588909689f5424f05de6cfbe1ed97f12d89025fe2d3a2b195ea6508326d8691
-  data.tar.gz: 485e289aec33bf39a30b8361d42eaec662de13bbca5c72b3058a9f0e31375ce1b55cacb270b00551b671e59f031f9b861af50b03abeb155af4d079d0f325dbbf
+  metadata.gz: 51a2c880e819dc4e31e62a94b990176f2d83fb755b78c5e0c84dcefa95ee1a87b5f4a2e610ad5af2e0e9986921c01b5e528f0e452c788e3c940c579e1b6a0273
+  data.tar.gz: b01ab52f28fcf8ee2c57927586abfc8e7c36bbb982e1e4c0ab2a8a8c1c367c00a48b0bd81c1f1ba96425c39f57bca5923e8a5a0d365af2453fec8cc93e24f8bf

data/History.rdoc

@@ -1,3 +1,22 @@
+=== 4.8.0 / 2023-09-28
+
+* 2 minor enhancements:
+
+  * Added ability to pass down option overrides through Flog.run.
+  * Removed ancient File.binread alias.
+
+* 1 bug fix:
+
+  * Added missing rdoc.
+
+=== 4.7.0 / 2023-07-18
+
+* 3 minor enhancements:
+
+  * Extend flog to process complex numbers. (petergoldstein)
+  * Only penalize magic numbers if they're not assigned to a const (excludes 0/-1).
+  * Renamed :lit_fixnum to :magic_number.
+
 === 4.6.6 / 2022-07-03
 
 * 1 minor enhancement:

data/Rakefile

@@ -40,17 +40,19 @@ task :debug do
   file = ENV["F"]
   ruby = ENV["R"]
   details = ENV["D"]
+  continue = ENV["C"]
 
   flog = FlogCLI.new :parser => RubyParser
 
   flog.option[:details] = true if details
+  flog.option[:continue] = true if continue
 
   if file then
     if File.directory? file then # quick hack to get directory scanning going
       argv = [file]
       argv.unshift "-v" if ENV["V"]
 
-      FlogCLI.run argv
+      FlogCLI.run argv, flog.option
       exit 0
     end
     flog.flog file

data/lib/flog.rb

@@ -2,16 +2,17 @@ require "sexp_processor"
 require "ruby_parser"
 require "timeout"
 
-class File
-  RUBY19 = "<3".respond_to? :encoding unless defined? RUBY19 # :nodoc:
-
-  class << self
-    alias :binread :read unless RUBY19
-  end
-end
+##
+# Flog is a SexpProcessor that calculates a ABC (assignments,
+# branches, conditionals) complexity metric with some ruby-aware
+# enhancements and a compounding penalty for increasing depth.
+#
+# In essence, this calculates the most tortured code. The higher the
+# score, the more pain the code is in and the harder it is to
+# thoroughly test.
 
 class Flog < MethodBasedSexpProcessor
-  VERSION = "4.6.6" # :nodoc:
+  VERSION = "4.8.0" # :nodoc:
 
   ##
   # Cut off point where the report should stop unless --all given.
@@ -40,7 +41,7 @@ class Flog < MethodBasedSexpProcessor
     :block_pass     => 1,
     :block_call     => 1,
     :branch         => 1,
-    :lit_fixnum     => 0.25,
+    :magic_number   => 0.25,
     :sclass         => 5,
     :super          => 1,
     :to_proc_icky!  => 10,
@@ -508,9 +509,9 @@ class Flog < MethodBasedSexpProcessor
     when 0, -1 then
       # ignore those because they're used as array indicies instead of
       # first/last
-    when Integer, Rational then
-      add_to_score :lit_fixnum
-    when Float, Symbol, Regexp, Range then
+    when Integer, Float, Rational, Complex then
+      add_to_score :magic_number unless context[1] == :cdecl
+    when Symbol, Regexp, Range then
       # do nothing
     else
       raise "Unhandled lit: #{value.inspect}:#{value.class}"

data/lib/flog_cli.rb

@@ -5,6 +5,10 @@ require "forwardable"
 require "path_expander"
 require "flog"
 
+##
+# This is the CLI interface for Flog, responsible for processing
+# options, finding files, loading plugins, and reporting results.
+
 class FlogCLI
   extend Forwardable
 
@@ -13,13 +17,16 @@ class FlogCLI
   def_delegators :@flog, :threshold, :total_score, :no_method, :calculate_total_scores
   def_delegators :@flog, :max_method
 
-  def self.run args = ARGV
+  ##
+  # This kicks off the whole thing.
+
+  def self.run args = ARGV, extra = {}
     load_plugins
 
     expander = PathExpander.new args, "**/*.{rb,rake}"
     files = expander.process
 
-    options = parse_options args
+    options = parse_options args, extra
 
     abort "no files or stdin (-) to process, aborting." if
       files.empty? and args.empty?
@@ -66,12 +73,12 @@ class FlogCLI
   ##
   # Parse options in +args+ (defaults to ARGV).
 
-  def self.parse_options args = ARGV
+  def self.parse_options args = ARGV, extra_options = {}
     option = {
       :quiet    => false,
       :continue => false,
       :parser   => RubyParser,
-    }
+    }.merge extra_options
 
     OptionParser.new do |opts|
       opts.separator "Standard options:"

data/lib/flog_task.rb

@@ -1,5 +1,9 @@
 require 'rake/tasklib'
 
+##
+# A rake front-end for flog, allowing task creation with options for
+# verbosity, reporting, and a failure threshold.
+
 class FlogTask < Rake::TaskLib
   ##
   # The name of the task. Defaults to :flog

data/test/test_flog.rb

@@ -44,7 +44,7 @@ class TestFlog < FlogTest
   def test_flog
     setup_flog
 
-    exp = { "main#none" => { :+ => 1.0, :lit_fixnum => 0.6 } }
+    exp = { "main#none" => { :+ => 1.0, :magic_number => 0.6 } }
     assert_equal exp, @flog.calls
 
     assert_in_epsilon 1.6, @flog.total_score unless @flog.option[:methods]
@@ -58,7 +58,7 @@ class TestFlog < FlogTest
     @flog.flog_ruby ruby, file
     @flog.calculate_total_scores
 
-    exp = { "main#none" => { :+ => 1.0, :lit_fixnum => 0.6 } }
+    exp = { "main#none" => { :+ => 1.0, :magic_number => 0.6 } }
     assert_equal exp, @flog.calls
 
     assert_in_epsilon 1.6, @flog.total_score unless @flog.option[:methods]
@@ -173,7 +173,7 @@ class TestFlog < FlogTest
              s(:iter, s(:call, nil, :lambda), nil, s(:lit, 1)))
 
     assert_process(sexp, 12.316,
-                   :lit_fixnum    =>  0.275,
+                   :magic_number    =>  0.275,
                    :block_pass    =>  1.0,
                    :lambda        =>  1.0,
                    :block_call    =>  1.0,
@@ -187,7 +187,7 @@ class TestFlog < FlogTest
                s(:iter, s(:call, nil, :lambda), nil, s(:lit, 1))))
 
     assert_process(sexp, 17.333,
-                   :lit_fixnum    =>  0.275,
+                   :magic_number    =>  0.275,
                    :block_pass    =>  1.0,
                    :lambda        =>  1.0,
                    :assignment    =>  1.0,
@@ -250,7 +250,7 @@ class TestFlog < FlogTest
              s(:colon2, s(:const, :X), :Y), nil,
              s(:scope, s(:lit, 42)))
 
-    assert_process sexp, 0.25, :lit_fixnum => 0.25
+    assert_process sexp, 0.25, :magic_number => 0.25
   end
 
   # TODO:
@@ -275,7 +275,7 @@ class TestFlog < FlogTest
                s(:block,
                  s(:lit, 42))))
 
-    assert_process sexp, 0.275, :lit_fixnum => 0.275
+    assert_process sexp, 0.275, :magic_number => 0.275
   end
 
   def test_process_defn_in_self
@@ -288,7 +288,7 @@ class TestFlog < FlogTest
     @flog.process sexp
     @flog.calculate_total_scores
 
-    exp = {'main::x' => {:lit_fixnum => 0.375}, 'main#none' => {:sclass => 5.0}}
+    exp = {'main::x' => {:magic_number => 0.375}, 'main#none' => {:sclass => 5.0}}
     assert_equal exp, @flog.calls
 
     assert_in_delta 5.375, @flog.total_score
@@ -305,7 +305,7 @@ class TestFlog < FlogTest
     @flog.process sexp
     @flog.calculate_total_scores
 
-    exp = {'main::x' => {:lit_fixnum => 0.375}, 'main#none' => {:sclass => 12.5}}
+    exp = {'main::x' => {:magic_number => 0.375}, 'main#none' => {:sclass => 12.5}}
     assert_equal exp, @flog.calls
 
     assert_in_delta 12.875, @flog.total_score
@@ -320,7 +320,7 @@ class TestFlog < FlogTest
                s(:block,
                  s(:lit, 42))))
 
-    assert_process sexp, 0.275, :lit_fixnum => 0.275
+    assert_process sexp, 0.275, :magic_number => 0.275
   end
 
   # FIX: huh? over-refactored?
@@ -386,7 +386,7 @@ class TestFlog < FlogTest
 
     @klass, @meth = "task", "#woot"
 
-    assert_process sexp, 2.3, :something => 1.0, :task => 1.0, :lit_fixnum => 0.3
+    assert_process sexp, 2.3, :something => 1.0, :task => 1.0, :magic_number => 0.3
   end
 
   def test_process_iter_dsl_hash_when_hash_empty
@@ -423,7 +423,7 @@ class TestFlog < FlogTest
     hash  = {
       "namespace(blah)::task#woot" => {
         :something  => 1.0,
-        :lit_fixnum => 0.3,
+        :magic_number => 0.3,
         :task       => 1.0,
       },
       "namespace#blah" => {
@@ -446,14 +446,29 @@ class TestFlog < FlogTest
 
   def test_process_lit_int
     sexp = s(:lit, 42)
-    assert_process sexp, 0.25, :lit_fixnum => 0.25
+    assert_process sexp, 0.25, :magic_number => 0.25
+  end
+
+  def test_process_lit_int__const
+    sexp = s(:cdecl, :X, s(:lit, 42))
+    assert_process sexp, 0.0
   end
 
   def test_process_lit_float # and other lits
-    sexp = s(:lit, 3.1415) # TODO: consider penalizing floats if not in cdecl
+    sexp = s(:lit, 3.1415)
+    assert_process sexp, 0.25, :magic_number => 0.25
+  end
+
+  def test_process_lit_float__const
+    sexp = s(:cdecl, :X, s(:lit, 3.1415))
     assert_process sexp, 0.0
   end
 
+  def test_process_lit_complex
+    sexp = s(:lit, (0+1i))
+    assert_process sexp, 0.25
+  end
+
   def test_process_lit_bad
     assert_raises RuntimeError do
       @flog.process s(:lit, Object.new)
@@ -475,12 +490,12 @@ class TestFlog < FlogTest
              s(:colon2, s(:const, :X), :Y),
              s(:scope, s(:lit, 42)))
 
-    assert_process sexp, 0.25, :lit_fixnum => 0.25
+    assert_process sexp, 0.25, :magic_number => 0.25
   end
 
   def test_process_sclass
     sexp = s(:sclass, s(:self), s(:scope, s(:lit, 42)))
-    assert_process sexp, 5.375, :sclass => 5.0, :lit_fixnum => 0.375
+    assert_process sexp, 5.375, :sclass => 5.0, :magic_number => 0.375
   end
 
   def test_process_super
@@ -488,7 +503,7 @@ class TestFlog < FlogTest
     assert_process sexp, 1.0, :super => 1.0
 
     sexp = s(:super, s(:lit, 42))
-    assert_process sexp, 1.25, :super => 1.0, :lit_fixnum => 0.25
+    assert_process sexp, 1.25, :super => 1.0, :magic_number => 0.25
   end
 
   def test_process_while
@@ -505,10 +520,10 @@ class TestFlog < FlogTest
     assert_process sexp, 1.00, :yield => 1.0
 
     sexp = s(:yield, s(:lit, 4))
-    assert_process sexp, 1.25, :yield => 1.0, :lit_fixnum => 0.25
+    assert_process sexp, 1.25, :yield => 1.0, :magic_number => 0.25
 
     sexp = s(:yield, s(:lit, 42), s(:lit, 24))
-    assert_process sexp, 1.50, :yield => 1.0, :lit_fixnum => 0.50
+    assert_process sexp, 1.50, :yield => 1.0, :magic_number => 0.50
   end
 
   def test_score_method
@@ -617,7 +632,7 @@ class TestFlog < FlogTest
     @flog.calculate_total_scores
     @flog.calculate
 
-    assert_equal({ 'User#blah' => 'user.rb:3-4' }, @flog.method_locations)
+    assert_equal({ 'User#blah' => 'user.rb:3-5' }, @flog.method_locations)
     assert_equal({ "User#blah" => 2.2 }, @flog.totals)
     assert_in_epsilon(2.2, @flog.total_score)
     assert_in_epsilon(1.0, @flog.multiplier)
@@ -639,7 +654,7 @@ class TestFlog < FlogTest
     @flog.calculate_total_scores
     @flog.calculate
 
-    assert_equal({ 'Coder#happy?' => 'coder.rb:3-4' }, @flog.method_locations)
+    assert_equal({ 'Coder#happy?' => 'coder.rb:3-5' }, @flog.method_locations)
     assert_equal({ "Coder#happy?" => 1.0 }, @flog.totals)
     assert_in_epsilon(1.0, @flog.total_score)
     assert_in_epsilon(1.0, @flog.multiplier)

data/test/test_flog_cli.rb

@@ -135,7 +135,7 @@ class TestFlogCLI < FlogTest
 
     expected = "\n     1.6: main#none
      1.0:   +
-     0.6:   lit_fixnum
+     0.6:   magic_number
 
 "
 
@@ -165,7 +165,7 @@ class TestFlogCLI < FlogTest
 
     @flog.flog "-"
 
-    exp = { "main#none" => { :+ => 1.0, :lit_fixnum => 0.6 } }
+    exp = { "main#none" => { :+ => 1.0, :magic_number => 0.6 } }
     assert_equal exp, @flog.calls
 
     @flog.option[:all] = true

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flog
 version: !ruby/object:Gem::Version
-  version: 4.6.6
+  version: 4.8.0
 platform: ruby
 authors:
 - Ryan Davis
@@ -10,9 +10,9 @@ bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBBjANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBBzANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTIxMTIyMzIzMTkwNFoXDTIyMTIyMzIzMTkwNFowRTETMBEGA1UE
+  GRYDY29tMB4XDTIzMDEwMTA3NTExN1oXDTI0MDEwMTA3NTExN1owRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +22,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
-  AQCKB5jfsuSnKb+t/Wrh3UpdkmX7TrEsjVmERC0pPqzQ5GQJgmEXDD7oMgaKXaAq
-  x2m+KSZDrqk7c8uho5OX6YMqg4KdxehfSLqqTZGoeV78qwf/jpPQZKTf+W9gUSJh
-  zsWpo4K50MP+QtdSbKXZwjAafpQ8hK0MnnZ/aeCsW9ov5vdXpYbf3dpg6ADXRGE7
-  lQY2y1tJ5/chqu6h7dQmnm2ABUqx9O+JcN9hbCYoA5i/EeubUEtFIh2w3SpO6YfB
-  JFmxn4h9YO/pVdB962BdBNNDia0kgIjI3ENnkLq0dKpYU3+F3KhEuTksLO0L6X/V
-  YsuyUzsMz6GQA4khyaMgKNSD
+  AQAkg3y+PBnBAPWdxxITm5sPHqdWQgSyCpRA20o4LTuWr8BWhSXBkfQNa7cY6fOn
+  xyM34VPzBFbExv6XOGDfOMFBVaYTHuN9peC/5/umL7kLl+nflXzL2QA7K6LYj5Bg
+  sM574Onr0dZDM6Vn69bzQ7rBIFDfK/OhlPzqKZad4nsdcsVH8ODCiT+ATMIZyz5K
+  WCnNtqlyiWXI8tdTpahDgcUwfcN/oN7v4K8iU5IbLJX6HQ5DKgmKjfb6XyMth16k
+  ROfWo9Uyp8ba/j9eVG14KkYRaLydAY1MNQk2yd3R5CGfeOpD1kttxjoypoUJ2dOG
+  nsNBRuQJ1UfiCG97a6DNm+Fr
   -----END CERTIFICATE-----
-date: 2022-07-04 00:00:00.000000000 Z
+date: 2023-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -119,14 +119,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.24'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.24'
+        version: '4.0'
 description: |-
   Flog reports the most tortured code in an easy to read pain
   report. The higher the score, the more pain the code is in.
@@ -175,7 +175,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.12
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Flog reports the most tortured code in an easy to read pain report

metadata.gz.sig

@@ -1,2 +1,3 @@
-�|�f�(��
U��z{|��-
4¡��&�/w*���TL�Ai'�(T��]�:��F���Y[�R�����@����]Lɵ�AF�0%_�4�����|��O���6Q%`;d��/K$&�*��|�5Ͻ�i��Mג$VG���S.xq�<��B���WZG�����D���
-�Y�<��.�qEN�c���j��&��������D��P�H��f�1ɤ	I�[����t�B]����y�#��ؙMK�ӷl�J�>P�7�
+&&���I[�	���W��nCf<�������Lf(�/J���ЮY���uI��S�ީI�V�Һ����RJ?�
+"�l)�,*IS8�`J��+Ҙ���r�Q�O�Fh` 
+�0�r��:�a7����1��A�w���`?�P��T��}��h�D*�NU�	Iu�f*ק@e)s�04