flog 4.7.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bde1a28d5e030ce021a8f20e9d7e877714e2c91e030b7560c3da7337a8a1e916
-  data.tar.gz: 6b4dffe1d2a47f688deb1665a0a31a4c9ef5b901add108aac37489c97cb8f7ee
+  metadata.gz: 7262d5d6a50a7734f984039e83079bdd31f2b58f1c43325485b8a19288b1fe04
+  data.tar.gz: f4049fc93e849c6c3c9f08c0778dd5f0e46dece30a65bbb44ffa2aa4b07d15c7
 SHA512:
-  metadata.gz: 56c6a3005252c00d8d61257f35f6eb9bf3d07b232acb316ebf5807dee9144c6bc76f24478ba64a000885677e1ba04d3d0af5ad8677934f90a5f8a965a2227f87
-  data.tar.gz: 876c48e4a05cf087fb924f5c10977870facdec0f07c3cabd09eccee03360fca82d19a3b5a708e2a9bd51cd57f109d525b29cc50d22399fac17df3062b0d3c272
+  metadata.gz: b6974339f191d9f1ac348707fd6e5efcf5fbf5bb453aa53d91d91f4933fe18f07f47cca5065a378da049c3703cc399edccc3ff621bc714c04e366d0da9036e62
+  data.tar.gz: 998f2be74a01618e3187d94340c97e0149dff71a02e5924dab23f6519fa5c905d601ba7cc7dfcdcb25fc4b39329bfaaf62a78fef672eea06a50f62cba9bd259d

data/History.rdoc

@@ -1,3 +1,21 @@
+=== 4.9.0 / 2025-12-11
+
+* 2 minor enhancements:
+
+  * Bumped path_expander to 2.0.0.
+  * Switched to prism for ruby parsing. Use --legacy for RubyParser.
+
+=== 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:

data/Rakefile

@@ -24,8 +24,8 @@ Hoe.spec 'flog' do
   license "MIT"
 
   dependency "sexp_processor", "~> 4.8"
-  dependency "ruby_parser",    ["~> 3.1", "> 3.1.0"]
-  dependency "path_expander", "~> 1.0"
+  dependency "prism",          "~> 1.5"
+  dependency "path_expander",  "~> 2.0"
 
   dependency "minitest",       "~> 5.0", :dev
 end
@@ -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/bin/flog

@@ -1,6 +1,6 @@
-#!/usr/local/bin/ruby -w
+#!/usr/bin/env -S ruby -w
 
-require "flog_cli"
+require_relative "../lib/flog_cli"
 
 FlogCLI.run
 

data/lib/flog.rb

@@ -1,17 +1,24 @@
 require "sexp_processor"
-require "ruby_parser"
+require "prism"
+require "prism/translation/ruby_parser"
 require "timeout"
 
-class File
-  RUBY19 = "<3".respond_to? :encoding unless defined? RUBY19 # :nodoc:
-
-  class << self
-    alias :binread :read unless RUBY19
-  end
+class Prism::Translation::RubyParser # compatibility layer
+  def process(ruby, file, timeout=nil) =
+    Timeout.timeout(timeout) { parse ruby, file }
 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.7.0" # :nodoc:
+  VERSION = "4.9.0" # :nodoc:
 
   ##
   # Cut off point where the report should stop unless --all given.
@@ -208,7 +215,7 @@ class Flog < MethodBasedSexpProcessor
   # methods. Does not handle timeouts or syntax errors. See #flog_ruby.
 
   def flog_ruby! ruby, file="-", timeout = 10
-    @parser = (option[:parser] || RubyParser).new
+    @parser = option[:parser].new
 
     warn "** flogging #{file}" if option[:verbose]
 
@@ -229,6 +236,7 @@ class Flog < MethodBasedSexpProcessor
     @mass                = {}
     @parser              = nil
     @threshold           = option[:threshold] || DEFAULT_THRESHOLD
+    option[:parser]    ||= Prism::Translation::RubyParser
     self.auto_shift_type = true
     self.reset
   end

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
+    files = expander.process.to_a
 
-    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,
-    }
+      :parser   => nil,
+    }.merge extra_options
 
     OptionParser.new do |opts|
       opts.separator "Standard options:"
@@ -123,6 +130,11 @@ class FlogCLI
         option[:score] = true
       end
 
+      opts.on "--legacy" "Use RubyParser for parsing." do
+        require "ruby_parser"
+        option[:parser] = RubyParser
+      end
+
       opts.on("-tN", "--threshold=N", Integer, "Set the report cutoff threshold (def: 60%).") do |n|
         option[:threshold] = n / 100.0
       end

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

metadata

@@ -1,18 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: flog
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.9.0
 platform: ruby
 authors:
 - Ryan Davis
-autorequire:
 bindir: bin
 cert_chain:
 - |
   -----BEGIN CERTIFICATE-----
-  MIIDPjCCAiagAwIBAgIBBzANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
+  MIIDPjCCAiagAwIBAgIBCTANBgkqhkiG9w0BAQsFADBFMRMwEQYDVQQDDApyeWFu
   ZC1ydWJ5MRkwFwYKCZImiZPyLGQBGRYJemVuc3BpZGVyMRMwEQYKCZImiZPyLGQB
-  GRYDY29tMB4XDTIzMDEwMTA3NTExN1oXDTI0MDEwMTA3NTExN1owRTETMBEGA1UE
+  GRYDY29tMB4XDTI1MDEwNjIzMjcwMVoXDTI2MDEwNjIzMjcwMVowRTETMBEGA1UE
   AwwKcnlhbmQtcnVieTEZMBcGCgmSJomT8ixkARkWCXplbnNwaWRlcjETMBEGCgmS
   JomT8ixkARkWA2NvbTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALda
   b9DCgK+627gPJkB6XfjZ1itoOQvpqH1EXScSaba9/S2VF22VYQbXU1xQXL/WzCkx
@@ -22,14 +21,14 @@ cert_chain:
   qhtV7HJxNKuPj/JFH0D2cswvzznE/a5FOYO68g+YCuFi5L8wZuuM8zzdwjrWHqSV
   gBEfoTEGr7Zii72cx+sCAwEAAaM5MDcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAw
   HQYDVR0OBBYEFEfFe9md/r/tj/Wmwpy+MI8d9k/hMA0GCSqGSIb3DQEBCwUAA4IB
-  AQAkg3y+PBnBAPWdxxITm5sPHqdWQgSyCpRA20o4LTuWr8BWhSXBkfQNa7cY6fOn
-  xyM34VPzBFbExv6XOGDfOMFBVaYTHuN9peC/5/umL7kLl+nflXzL2QA7K6LYj5Bg
-  sM574Onr0dZDM6Vn69bzQ7rBIFDfK/OhlPzqKZad4nsdcsVH8ODCiT+ATMIZyz5K
-  WCnNtqlyiWXI8tdTpahDgcUwfcN/oN7v4K8iU5IbLJX6HQ5DKgmKjfb6XyMth16k
-  ROfWo9Uyp8ba/j9eVG14KkYRaLydAY1MNQk2yd3R5CGfeOpD1kttxjoypoUJ2dOG
-  nsNBRuQJ1UfiCG97a6DNm+Fr
+  AQAC0WQJcPOWPFwkojhzweilRVjTJ19UiLhiBTw3C1wJO3LVdBkWDmnnhAmKuX4D
+  r7vjQvESlABGIPdutI1Yl7mrHQzTkfLfXvNN6MT0nLChPyIYauT6SZZxubwJrUfA
+  7R0c2CJTIboZ0XaGpLsXqHEF1c29H7TV1QvVuqKAN2mCjh4N82QVn+ZKtys28AwT
+  6GfQX2fqLoi4KSc7xIzHKaNzqxeOICmJofk9w5VZ2rRN6yes8jvFYwz9HR41wdj8
+  bwfinv7Yp5fA6AysuZLhCykyfDuZVRrUp0Vb68YCKsLjJly/Theak+euNTxvHsB+
+  al9oSgPPHICMEX65qvLywitx
   -----END CERTIFICATE-----
-date: 2023-07-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sexp_processor
@@ -46,39 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.8'
 - !ruby/object:Gem::Dependency
-  name: ruby_parser
+  name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: path_expander
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -119,14 +112,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '4.3'
 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.
@@ -158,7 +151,6 @@ licenses:
 metadata:
   homepage_uri: http://ruby.sadi.st/
   source_code_uri: https://github.com/seattlerb/flog
-post_install_message:
 rdoc_options:
 - "--main"
 - README.rdoc
@@ -175,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Flog reports the most tortured code in an easy to read pain report
 test_files: []