flog 4.6.5 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57b6b9d470979f410d87a27dd593d85a9c3b526f65bc519d8795a5c0703a7b74
-  data.tar.gz: 3d0ad63ea53a0e69f3768ef311f981239fe3397d53b7c2514d97cc453f895d88
+  metadata.gz: bde1a28d5e030ce021a8f20e9d7e877714e2c91e030b7560c3da7337a8a1e916
+  data.tar.gz: 6b4dffe1d2a47f688deb1665a0a31a4c9ef5b901add108aac37489c97cb8f7ee
 SHA512:
-  metadata.gz: 5615430b290aa01b6fd46b0154fdec668561ec0f0c044807ea09a0373a78b74984ad68504034fd99b75d307128bf4c21e187810aba5165cc257c582bf19b1e8d
-  data.tar.gz: 7b862060c2c4489cd4e43e38c5be5cdfbc79afc871feee741ada47d1a45d4bd590b2fcc01c0f3982d39ef305d2b76dc7417fbcd67c66bfcad758e6611523f7bb
+  metadata.gz: 56c6a3005252c00d8d61257f35f6eb9bf3d07b232acb316ebf5807dee9144c6bc76f24478ba64a000885677e1ba04d3d0af5ad8677934f90a5f8a965a2227f87
+  data.tar.gz: 876c48e4a05cf087fb924f5c10977870facdec0f07c3cabd09eccee03360fca82d19a3b5a708e2a9bd51cd57f109d525b29cc50d22399fac17df3062b0d3c272

checksums.yaml.gz.sig

@@ -1 +1 @@
-�.�![m�0H�;�/�ᐘF�t�s��L�	�vʀ�����
F?c�*���lMWĜ��K�ҘM�%F��>a��[T>;4$-_<�S:�m�/祼���I�_I}�c����Ȟ��x�r��~~oC���rR��i�:�ס� ���}��f�̞d��[�y/bw	D)IF>3Dc3<�M+��qԥ�捌�%n��P( ��-y
+-�2�\��*��&�+��)�	������C���fY�v��B��g `\5;K��M�'�O+������	�ns�{Je�.�dw�q{h����g�	�~*������;����/�/ɄD�)X#�pz�o��δ(������\��w���$n��zG3>3_\f�$ǘ.y��ymaeȽɰ YGW���:�>.�r�k�yh�M�(���Y:�1�P��6�j��OP�/����i����~HS0L�

data/History.rdoc

@@ -1,3 +1,22 @@
+=== 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:
+
+  * Added support for to_proc w/ hash(?!?). (t-kinoshita)
+
+* 2 bug fixes:
+
+  * Removed to_proc_normal (eg &:sym/call) as benchmarks are much better.
+  * ruby3: Fixed anonymous block pass. (prtngn)
+
 === 4.6.5 / 2022-04-09
 
 * 1 minor enhancement:

data/Rakefile

@@ -54,9 +54,12 @@ task :debug do
       exit 0
     end
     flog.flog file
-  else
+  elsif ruby
     flog.flog_ruby ruby, "-"
     flog.calculate_total_scores
+  else
+    flog.flog
+    flog.calculate_total_scores
   end
 
   flog.report

data/lib/flog.rb

@@ -11,7 +11,7 @@ class File
 end
 
 class Flog < MethodBasedSexpProcessor
-  VERSION = "4.6.5" # :nodoc:
+  VERSION = "4.7.0" # :nodoc:
 
   ##
   # Cut off point where the report should stop unless --all given.
@@ -40,21 +40,11 @@ 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,
     :to_proc_lasgn  => 15,
-    :to_proc_normal => case RUBY_VERSION
-                       when /^1\.8\.7/ then
-                         2
-                       when /^1\.9/ then
-                         1.5
-                       when /^[23]\./ then
-                         1
-                       else
-                         raise "Unhandled version #{RUBY_VERSION}"
-                       end,
     :yield          => 1,
   }
 
@@ -176,9 +166,9 @@ class Flog < MethodBasedSexpProcessor
 
   def flog(*files)
     files.each do |file|
-      next unless file == '-' or File.readable? file
+      next unless file == "-" or File.readable? file
 
-      ruby = file == '-' ? $stdin.read : File.binread(file)
+      ruby = file == "-" ? $stdin.read : File.binread(file)
 
       flog_ruby ruby, file
     end
@@ -199,7 +189,7 @@ class Flog < MethodBasedSexpProcessor
     q = option[:quiet]
     if e.inspect =~ /<\%|%\>/ or ruby =~ /<\%|%\>/ then
       return if q
-      warn "#{e.inspect} at #{e.backtrace.first(5).join(', ')}"
+      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}" unless q
@@ -365,18 +355,23 @@ class Flog < MethodBasedSexpProcessor
 
     add_to_score :block_pass
 
+    return s() unless arg
+
     case arg.sexp_type
     when :lvar, :dvar, :ivar, :cvar, :self, :const, :colon2, :nil then # f(&b)
       # do nothing
-    when :lit, :call then                                              # f(&:b)
-      add_to_score :to_proc_normal
+    when :lit then                                                     # f(&:b)
+      # do nothing -- this now costs about the same as a block
+    when :call then                                                    # f(&x.b)
+      # do nothing -- I don't like the indirection, but that's already scored
     when :lasgn then                                                   # f(&l=b)
       add_to_score :to_proc_lasgn
-    when :iter, :dsym, :dstr, *BRANCHING then                          # below
+    when :iter, :dsym, :dstr, :hash, *BRANCHING then                   # below
       # f(&proc { ... })
       # f(&"#{...}")
       # f(&:"#{...}")
       # f(&if ... then ... end") and all other branching forms
+      # f(&{ a: 42 })  WHY?!?
       add_to_score :to_proc_icky!
     else
       raise({:block_pass_even_ickier! => arg}.inspect)
@@ -513,9 +508,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/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]
@@ -127,25 +127,24 @@ class TestFlog < FlogTest
     assert_process sexp, 1.1, :branch => 1.1 # 10% penalty over process_and
   end
 
-  def test_process_block_pass
+  def test_process_block_pass__call
     sexp = s(:call, nil, :a,
              s(:block_pass,
                s(:call, nil, :b)))
 
-    bonus = case RUBY_VERSION
-            when /^1\.8\.7/ then 0.4
-            when /^1\.9/    then 0.3
-            when /^[23]\./  then 0.2
-            else raise "Unhandled version #{RUBY_VERSION}"
-            end
+    assert_process(sexp, 3.4,
+                   :a              => 1.0,
+                   :block_pass     => 1.2,
+                   :b              => 1.2)
+  end
 
-    bonus += Flog::OTHER_SCORES[:to_proc_normal]
+  def test_process_block_pass__to_proc
+    sexp = s(:call, nil, :a,
+             s(:block_pass, s(:lit, :to_i)))
 
-    assert_process(sexp, 3.4 + bonus,
+    assert_process(sexp, 2.2,
                    :a              => 1.0,
-                   :block_pass     => 1.2,
-                   :b              => 1.2,
-                   :to_proc_normal => 0.0 + bonus)
+                   :block_pass     => 1.2)
   end
 
   def test_process_block_pass_colon2
@@ -158,12 +157,23 @@ class TestFlog < FlogTest
                    :block_pass     => 1.2)
   end
 
+  def test_process_block_pass__hash_wtf
+    sexp = s(:call, nil, :a,
+             s(:block_pass,
+               s(:hash, s(:lit, :a), s(:lit, :b))))
+
+    assert_process(sexp, 14.2,
+                   :a              => 1.0,
+                   :block_pass     => 1.2,
+                   :to_proc_icky!  => 12.0)
+  end
+
   def test_process_block_pass_iter
     sexp = s(:block_pass,
              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,
@@ -177,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,
@@ -185,6 +195,13 @@ class TestFlog < FlogTest
                    :to_proc_lasgn => 15.0)
   end
 
+  def test_process_block_pass__nil
+    sexp = s(:block_pass)
+
+    assert_process(sexp, 1.0,
+                   :block_pass    =>  1.0)
+  end
+
   def test_process_call
     sexp = s(:call, nil, :a)                                       # a
     assert_process sexp, 1.0, :a => 1.0
@@ -233,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:
@@ -258,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
@@ -271,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
@@ -288,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
@@ -303,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?
@@ -369,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
@@ -406,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" => {
@@ -429,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)
@@ -458,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
@@ -471,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
@@ -488,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
@@ -600,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)
@@ -622,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

data.tar.gz.sig

@@ -1 +1 @@
-	�&�ȣ�#�X�M�����b�����=���֭+h_���1����(yb1�F	W@V�!��r*fp?0(.O�9'��K�K<M�����6m�N�D���n�J��n����y]cfx�SI�����N����)D7/���+b���Q�W:������LDE��%��v>��"8S�T���C�����f��a��0-���s�J]Lz�	X'c5t ��(C��jY3n�λC���a�q�E�ˑ��^1�Qi�
+��k>`DQL�kߓO1�ߜ�=�2�w��ͺ�N�#���0${���CL�w6��w���{�$z{�pKOE�5a� ��pX֘)A<��}	�'<�y���=\d՚.������ɡ@j+���m���<�TX�BW5#��4�RuG��W�hEN�T+�ۏ�>�����l���!5WUH�/�/��	�74̃)�&��1{[��L�+(`6AQ?��ZFP7�P~Rv��G�z�g�����1�#&�K�v1�ڔ��

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flog
 version: !ruby/object:Gem::Version
-  version: 4.6.5
+  version: 4.7.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-04-09 00:00:00.000000000 Z
+date: 2023-07-18 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.23'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.23'
+        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.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Flog reports the most tortured code in an easy to read pain report