Report directory structure when comparing branches seems off

[dsager]

When running rubycritic in CI mode, the report-folder seems to be weirdly nested.

After executing the following command (while on a branch called test-123):

$ rubycritic --mode-ci=develop --format=json app

I get the following directory structure:

tmp/rubycritic/
├── build_number.txt
└── compare
    ├── build_details.txt
    └── develop
        ├── compare
        │   └── test-123
        │       ├── compare
        │       │   └── report.json
        │       └── report.json
        └── report.json

I would expect the structure to be this:

tmp/rubycritic/
├── build_number.txt
└── compare
    ├── build_details.txt
    ├── develop
    │   └── report.json
    ├── test-123
    │   └── report.json
    └── report.json

Actually, when generating a HTML report, the links in the top right corner also seem to expect this structure.

	Version
Ruby	2.3.7
RubyCritic	3.5.2

I am happy to create a PR for this, jut wanted to confirm first if this is an actual issue. I think the problem is that Config.root is overwritten in two places during the branch comparison and not reset to its initial value: here and here.

While at it, I have two additional questions regarding the CI mode (happy to create separate issues if preferred):

• The help (and also the readme) states that the CI mode will be faster. This currently seems to not be the case, as it runs a full analysis of both branches, and then looks at the diff. So it's about twice as slow as the normal run. Maybe I am doing something wrong (see command above)?
• Wouldn't it make more sense to include the information stored in build_details.txt in the json output, so that it can be easily parsed?

[GeoffTidey]

I can confirm (one year on) that I'm seeing the same issue as @dsager

We're using ruby 2.7 & rubycritic 4.3.1 &

rubycritic app -p $CIRCLE_ARTIFACTS/rubycritic --mode-ci -f html --no-browser

An example of an actual file on disk is: /tmp/circleci-artifacts/rubycritic/compare/master/compare/staging/overview.html

whilst the link in the top right corner is pointing at:

/tmp/circleci-artifacts/rubycritic/compare/staging/overview.html

[denny]

And another year on, this confused me briefly last week 🙂

ETA: By the way, this isn't unique to CI mode - I didn't have CI mode configured, I just had branch: main at the top-level of my config file.

[etagwerker]

@dsager I think it makes sense to restructure the directories the way you would expect them. If you submit a PR I'd be happy to review it.

The help (and also the readme) states that the CI mode will be faster. This currently seems to not be the case, as it runs a full analysis of both branches, and then looks at the diff. So it's about twice as slow as the normal run. Maybe I am doing something wrong (see command above)?

Not sure why it says that, comparing two branches will always take longer than running just one analysis. Maybe it should be corrected in the documentation?

Wouldn't it make more sense to include the information stored in build_details.txt in the json output, so that it can be easily parsed?

I think that is a good idea. 👍

[dsager]

Hi @etagwerker , we no longer use RubyCritic. I am afraid I lost the context for this issue over time and have to retract my offer of making a PR to fix this :laughing:

Not sure why it says that, comparing two branches will always take longer than running just one analysis. Maybe it should be corrected in the documentation?

Maybe I'm not thinking this through entirely, but I think running an analysis of just the affected files should work and be faster?

[denny]

@GeoffTidey If you have the time and you're still interested, could you check whether my PR merged above has fixed this for you? Thanks 🙂