Circular require

[paddor]

I'm getting this when I using this gem:

/home/user/.rubies/ruby-3.3.0/bin/ruby -I/home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib:/home/user/.gem/ruby/3.3.0/gems/rspec-support-3.12.1/lib /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/exe/rspec --pattern spec/\*\*\{,/\*/\*\*\}/\*_spec.rb
/home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover/cli.rb:3: warning: /home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover/cli.rb:3: warning: loading in progress, circular require considered harmful - /home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover.rb
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/exe/rspec:4:in  `<main>'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/runner.rb:45:in  `invoke'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/runner.rb:71:in  `run'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/runner.rb:86:in  `run'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/runner.rb:102:in  `setup'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/configuration.rb:1615:in  `load_spec_files'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/configuration.rb:1615:in  `each'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/configuration.rb:1617:in  `block in load_spec_files'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/configuration.rb:2117:in  `load_file_handling_errors'
        from /home/user/.gem/ruby/3.3.0/gems/rspec-core-3.12.2/lib/rspec/core/configuration.rb:2117:in  `load'
        from /home/user/dev/mygem/spec/actors/base_spec.rb:4:in  `<top (required)>'
        from /home/user/dev/mygem/spec/actors/base_spec.rb:4:in  `require'
        from /home/user/dev/mygem/spec/spec_helper.rb:10:in  `<top (required)>'
        from /home/user/dev/mygem/spec/spec_helper.rb:10:in  `require'
        from /home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover.rb:11:in  `<top (required)>'
        from /home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover.rb:11:in  `require'
        from /home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover/cli.rb:3:in  `<top (required)>'
        from /home/user/.gem/ruby/3.3.0/gems/undercover-0.5.0/lib/undercover/cli.rb:3:in  `require'

Maybe the cli.rb doesn't need to be loaded when running the specs, but only when actually running the undercover CLI?

[paddor]

My spec/spec_helper.rb does this:

if ENV['COVERAGE']
  require 'simplecov'
  require 'simplecov-lcov'

  SimpleCov.coverage_dir 'doc/coverage'
  SimpleCov::Formatter::LcovFormatter.config.report_with_single_file = true
  SimpleCov.formatter = SimpleCov::Formatter::LcovFormatter
  SimpleCov.start do
    add_filter 'spec'
    enable_coverage(:branch) # Report branch coverage to trigger branch-level undercover warnings

    add_group 'Actors',     'lib/mygem/actors'
    add_group 'Messaging',  'lib/mygem/messaging'
    # more add_group ....
  end

  require 'undercover'
end

[grodowski]

Hey @paddor! You shouldn't require undercover in the spec_helper.rb as the analysis is not tied to spec execution. The rest looks ok, so if you remove this line your specs will save coverage reports saved to /coverage/ on every run and then you'll be able to execute [bundle exec] undercover [-c master] to run the analysis. Let me know if that helps!