ruby-coverage 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 420658ecf7eaba010ff32a306f8b815d9bbff44aa298e013525ff9d8a824783b
-  data.tar.gz: 1fa3fdb480edcc4c34281d26a64f9d96fe655d49fa2329b14a7e93b91ef794d0
+  metadata.gz: 93f33127bec2d7de586f680a5acf8f503b36aa8e7ee2df6eea853e92ebd729ae
+  data.tar.gz: aa04f0bba17db2605b2a6991f5d74d77ca298a4683f191314f40498c829bab7e
 SHA512:
-  metadata.gz: b82b95ce1e7691d91ab98983f46eaa6e936681a299dc81720aced4cb8399ae145adb44b0921cc208b2da88cb5250886e28748435733e92b3d90bd30288b6bb00
-  data.tar.gz: 65889110740406d87938f686382d1e6f3209a21fc18e427f7f1eb7086bb5e7b9ccd42049506f149e964e20d5ee28bbff429a4a7357c55bed50ba2d04f91818cc
+  metadata.gz: '0517386659ee37d81045946119c8a4bbbdccbe7d529e1345cb8316d15e47886a8da4674bbe968aedd4ffdebe2d77b5cea502b73c29e091af65894f0f3e7418e4'
+  data.tar.gz: 3c52e2649e49a8d92a42c484249b5c91c918901bceb534757c61590c07765484a789b357460b904828ffec2b0e86c00900d7a6f31a0013c4cfedc162af59cbc2

data/ext/extconf.rb

@@ -27,7 +27,7 @@ if ENV.key?("RUBY_SANITIZE")
 	$LDFLAGS << " -fsanitize=address -fsanitize=undefined"
 end
 
-have_func("rb_tracearg_instruction_sequence", "ruby/debug.h")
+have_func("rb_tracearg_instruction_sequence((rb_trace_arg_t *)0)", "ruby/debug.h")
 
 create_header
 

data/ext/ruby/coverage/tracer.c

@@ -291,9 +291,6 @@ static void Ruby_Coverage_Tracer_on_line(VALUE data, const rb_trace_arg_t *trace
 
 static VALUE Ruby_Coverage_Tracer_start(VALUE self)
 {
-	struct Ruby_Coverage_Tracer *tracer;
-	TypedData_Get_Struct(self, struct Ruby_Coverage_Tracer, &Ruby_Coverage_Tracer_type, tracer);
-
 	#ifdef HAVE_RB_TRACEARG_INSTRUCTION_SEQUENCE
 	rb_add_event_hook2(
 		(rb_event_hook_func_t)Ruby_Coverage_Tracer_on_script_compiled,
@@ -302,6 +299,9 @@ static VALUE Ruby_Coverage_Tracer_start(VALUE self)
 		RUBY_EVENT_HOOK_FLAG_SAFE | RUBY_EVENT_HOOK_FLAG_RAW_ARG
 	);
 	#else
+	struct Ruby_Coverage_Tracer *tracer;
+	TypedData_Get_Struct(self, struct Ruby_Coverage_Tracer, &Ruby_Coverage_Tracer_type, tracer);
+
 	if (NIL_P(tracer->script_compiled_tracepoint)) {
 		RB_OBJ_WRITE(self, &tracer->script_compiled_tracepoint,
 			rb_tracepoint_new(Qnil, RUBY_EVENT_SCRIPT_COMPILED,

data/lib/ruby/coverage/version.rb

@@ -7,6 +7,6 @@
 module Ruby
 	# @namespace
 	module Coverage
-		VERSION = "0.1.1"
+		VERSION = "0.1.2"
 	end
 end

data/readme.md

@@ -8,7 +8,7 @@ A native reimplementation of Ruby's built-in `Coverage` module, backed by `rb_ad
 
 Ruby's built-in `Coverage` module ties its counter store to the ISeq. When a file is re-evaluated under the same path — for example when a test framework loads a file into a fresh anonymous module via `module_eval` — Ruby allocates a fresh counter array and discards the previous one. Any coverage accumulated before the re-eval is lost.
 
-`Ruby::Coverage` owns its own counter store. Re-evaluating a file under the same path simply continues incrementing the same counters. The `covered` gem can optionally use `Ruby::Coverage` in place of `::Coverage` to get correct results in test suites that load files multiple times.
+`Ruby::Coverage` owns its own counter store. Re-evaluating a file under the same path simply continues incrementing the same counters, which gives path-oriented reporting tools stable results when test suites load files multiple times. In addition, multiple `Ruby::Coverage::Tracer` instances can be active at the same time, so tools can collect independent coverage streams such as per-test coverage without fighting over Ruby's global `Coverage` state.
 
 ## Usage
 
@@ -16,56 +16,61 @@ Please see the [project documentation](https://socketry.github.io/ruby-coverage/
 
   - [Getting Started](https://socketry.github.io/ruby-coverage/guides/getting-started/index) - This guide explains how to use `ruby-coverage` to collect coverage for code that may be evaluated multiple times under the same path.
 
-### Drop-in module API
+## Releases
 
-``` ruby
-require "ruby/coverage"
+Please see the [project releases](https://socketry.github.io/ruby-coverage/releases/index) for all releases.
 
-Ruby::Coverage.start
+### v0.1.2
 
-# ... run code ...
+  - Fix native extension builds on Windows when `rb_tracearg_instruction_sequence` is not declared by Ruby's public headers, and avoid an unused variable compiler warning.
 
-result = Ruby::Coverage.result
-# => { "/path/to/file.rb" => { lines: [nil, 3, 1, nil, 0, ...] }, ... }
-```
+### v0.1.1
 
-### Low-level `Tracer`
+  - Fix an unused variable compiler warning in the native extension.
 
-`Ruby::Coverage::Tracer` is the primitive that the module API is built on. It accepts a block that is called once each time execution enters a new file. The block receives the absolute path and must return a Ruby `Array` to use as the line-count store for that file, or `nil` to skip tracking it.
+### v0.1.0
 
-The block controls the caching strategy: returning the same `Array` for the same path accumulates counts across re-evals; returning a fresh `Array` each time gives per-ISeq isolation.
+  - Improve line-count performance by resizing coverage count arrays in one step.
+  - Improve the line-count hot path by updating the internal count array directly while keeping counts as saturated Fixnums.
+  - Support accumulating coverage counts independently of Ruby's standard `Coverage` module.
+  - Use raw trace arguments for line coverage where available.
+  - Add benchmark coverage for tracer load and hot-loop overhead, including comparisons with Ruby's standard `Coverage` module.
+  - Improve test coverage around count preparation and subprocess coverage collection.
 
-``` ruby
-files = {}
+### v0.0.1
 
-tracer = Ruby::Coverage::Tracer.new do |path|
-	# Accumulate across re-evals of the same path:
-	files[path] ||= []
-end
+  - Initial release.
 
-tracer.start
-# ... run tests ...
-tracer.stop
+## Contributing
 
-# files is now populated with line-count arrays keyed by path.
-```
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
 
-## Integration with `covered`
+### Running Tests
 
-`covered` multiplexes between `Ruby::Coverage` and `::Coverage` internally. Add `ruby-coverage` to your `Gemfile` and `covered` will prefer it automatically.
+To run the test suite:
 
-``` ruby
-# gems.rb / Gemfile
-gem "ruby-coverage"
-gem "covered"
+``` shell
+bundle exec sus
 ```
 
-## Releases
+### Making Releases
 
-Please see the [project releases](https://socketry.github.io/ruby-coverage/releases/index) for all releases.
+To make a new release:
 
-### v0.0.1
+``` shell
+bundle exec bake gem:release:patch # or minor or major
+```
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-## See Also
+### Community Guidelines
 
-  - [covered](https://github.com/socketry/covered) — the coverage reporting gem that uses this library.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -1,3 +1,22 @@
 # Releases
 
+## v0.1.2
+
+  - Fix native extension builds on Windows when `rb_tracearg_instruction_sequence` is not declared by Ruby's public headers, and avoid an unused variable compiler warning.
+
+## v0.1.1
+
+  - Fix an unused variable compiler warning in the native extension.
+
+## v0.1.0
+
+  - Improve line-count performance by resizing coverage count arrays in one step.
+  - Improve the line-count hot path by updating the internal count array directly while keeping counts as saturated Fixnums.
+  - Support accumulating coverage counts independently of Ruby's standard `Coverage` module.
+  - Use raw trace arguments for line coverage where available.
+  - Add benchmark coverage for tracer load and hot-loop overhead, including comparisons with Ruby's standard `Coverage` module.
+  - Improve test coverage around count preparation and subprocess coverage collection.
+
 ## v0.0.1
+
+  - Initial release.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-coverage
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Samuel Williams