Sampling a gem via its test suite

[stevegeek]

Currently when adding type_fusion to a test suite of a gem, no samples are captured for the gem under test, as the sampler only selects any files that are in the gem_path https://github.com/marcoroth/type_fusion/blob/main/lib/type_fusion/sampler.rb#L137.

I guess this is so that only gems that are released to rubygems are sampled, but running the test suite of a gem itself seems like a nice way to collect type info, rather that needing an application or script as a sort of harness to exercise the gem in.

I managed to sample a gem via running its test suite, by simply modifying the test helper to require the released and installed gem, rather than including the local lib/ directory.

However while messing around trying to get the sampling to work I seem to have also sent samples for the test classes themselves, sorry about that. See https://gem.sh/gems/typed_operation/v1.0.0.pre3/types .. would it be possible to reject any samples for code that is defined in files that are not in the actual build/released gem?

This gem is a very neat idea!

[marcoroth]

Hey @stevegeek, thanks for giving TypeFusion a shot!

I also noticed this yesterday when I tried to setup TypeFusion in a gem's test suite. I started this here (2b28657) to account for those cases, but this isn't complete yet since in those cases we can't look at the path to determine the gem and version a sample call is for.

I was wondering if we should try to read the gemspec file and read that info from there, but I didn't want to introduce more complexity into each sample call. So I'm not 100% certain how to proceed with this.

However while messing around trying to get the sampling to work I seem to have also sent samples for the test classes themselves, sorry about that.

I don't really think that's an issue. Ironically gem.sh currently also shows all classes/modules found in test files.

[stevegeek]

Ah ok cool, good to know its potentially going to be a supported use-case. Maybe if 'local gem mode' is enabled the sampler can be provided at initialization with the context (eg version) from a local gemspec file (eg in current working directory), including its path, such that at runtime sampling the path to source file could be used as a way of finding that preloaded context. Would have to make assumptions, eg that the root path to source file being sampled is same as root path to gemspec, but I guess thats ok?

[stevegeek]

Ah just saw the PR above :)