condition_coverage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8fbd7cd27ab04963d5c91539a6accc52d6f178eef85858b48e6b553dd51f39de
+  data.tar.gz: 59cebe77670d20308973d24f96712368a204adfb32ac90a7e0497f78aabf9331
+SHA512:
+  metadata.gz: ff8f96409d90bb54be22e3755e461849c2f9dfaf5a0ca0fbf5bb685b64c2066a22385e5cf7bfec2bcebd12ddf8687555d56112e107f5c242a33e7a5156977ce5
+  data.tar.gz: 86324f587f50156ff2ae9049f7d019fd1eb17b984f4ac0b45a2e0ecbccd114b1d849d9e8cdde4dd824d7e5e047e153f7e9d622474f811e9bcaeb471b38159179

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2026, [CyberDojo Foundation](http://blog.cyber-dojo.org/2015/08/cyber-dojo-foundation.html)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+Redistributions of source code must retain the above copyright notice, this
+list of conditions and the following disclaimer.
+Redistributions in binary form must reproduce the above copyright notice,
+this list of conditions and the following disclaimer in the documentation
+and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,75 @@
+# condition_coverage
+
+Status: an outline of the idea. No working code is published yet.
+
+Condition coverage for Ruby, to run alongside SimpleCov's line and branch
+coverage.
+
+## The gap it fills
+
+Ruby's built-in `Coverage` (which SimpleCov reads) tracks branches, not the
+conditions inside them:
+
+```ruby
+if a || b || c
+```
+
+is two branches. Tests that reach both can still leave `b` never true and `c`
+never evaluated, and branch coverage reports 100%.
+
+## How it works
+
+At load time, each file under the covered root is parsed with Prism and each
+`&&` / `||` operand is wrapped in a recorder call, before compilation:
+
+```ruby
+if __cc(7, 0, a) || __cc(7, 1, b) || __cc(7, 2, c)
+```
+
+The recorder notes whether the operand was truthy or falsy and returns it
+unchanged, so short-circuiting and the value of the expression are preserved.
+The rewrite happens in memory only; no file on disk changes.
+
+A static manifest of every site (file, line, column, operand count) is built
+by scanning the covered files, so an operand that never ran, or a file never
+loaded, is reported as missed rather than silently absent.
+
+## Beyond and/or
+
+The same hook can record decisions hidden inside calls, each with its own
+outcome classes:
+
+- `any?` / `all?` / `none?`: empty, decided by the first item, decided later,
+  never decided
+- `find` / `detect`: found vs nil
+- `fetch(k, default)`, `dig`, `Hash#[]` with a default: present vs default
+- `x || default` in value context, `&.` safe navigation: nil vs not nil
+- ternaries, `unless`, modifier `if`, `case`/`when` and `in` patterns
+- regex matches: nil vs MatchData
+
+## Reporting
+
+Gaps only, in the style of a Missing column. Each site shows its source line
+with a caret under each operand that was never true, never false, or never
+evaluated, plus a JSON form of the same data. An HTML view underlines each
+operand in its own colour.
+
+## Intended use
+
+```ruby
+# test coverage config, before any application code is required
+require 'simplecov'
+require 'condition_coverage'
+SimpleCov.start do
+  # ...
+end
+ConditionCoverage.start(root: APP_DIR, cover: 'source/**/*.rb')
+```
+
+The figure is gathered and reported, not gated.
+
+## Constraints
+
+- CRuby only: the hook is `RubyVM::InstructionSequence.load_iseq`.
+- That hook has a single slot, which Bootsnap also uses, so the two cannot
+  both be active in one process.

data/lib/condition_coverage.rb

@@ -0,0 +1,3 @@
+module ConditionCoverage
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: condition_coverage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jon Jagger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Placeholder release outlining the idea; see the README.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- lib/condition_coverage.rb
+homepage: https://github.com/cyber-dojo/condition_coverage
+licenses:
+- BSD-2-Clause
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Condition coverage for Ruby, alongside SimpleCov branch coverage
+test_files: []