condition_coverage 0.0.2 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b23a1bb5174201acad8b95876d179f5d7e818bea50eeca8799e189e41ae4014
-  data.tar.gz: 0527c568699e2fb994438308eeeafaf7b1183a3cbbb632d85efe60e7c482acbd
+  metadata.gz: eb36ad570a0050db876bba37548a59c929604eb35b88ed4b8ac4a155dde4db6e
+  data.tar.gz: 77f2dd1b7da7815a216fac0bee73f251f1c8d2c9490ad416d26125ac1adcfbe8
 SHA512:
-  metadata.gz: 0d7593c42bfeb6e8a319e92740786829d7be675e5c2c66a9b96ced249cc811c5a8dc3ae0cae05d40afec05d650fc0d11e75db4171924a25435c88750967d1a41
-  data.tar.gz: 7831a347fae127eb253f7d806eb2d7ba3594718266d952da88e0030fd66027ab09d4936598efb04a23eef53c0ed070c082216aa4491964ae4ea96c3991652839
+  metadata.gz: 5571a2753478ab9ed18b6a1e04b47df6f4f96b03f10637ac9bf8e0ad4149b8a02d6b6abf754b45e533c0eb37a417fffe9a7a937c3c86a6bf15b51fe13d2bed03
+  data.tar.gz: 5d97b90e7c1bff46242a833f234ef1a5ef62e8732bd2a2fe3f9b1f65fe441b0bcad5da1eeaf2ad0912ae7406ce3baf1c77067571b0751e6a9c6f602e831eca62

data/README.md

@@ -3,7 +3,7 @@
 Condition coverage for Ruby, to run alongside SimpleCov's line and branch
 coverage.
 
-Status: 0.0.2 covers `&&`, `||`, `and` and `or`: each leaf operand of a
+Status: 0.0.4 covers `&&`, `||`, `and` and `or`: each leaf operand of a
 condition, however its operators are chained, nested or grouped. Decisions
 hidden inside calls come next (see Roadmap).
 
@@ -75,6 +75,15 @@ A chain of one operator is flat; a change of operator, by precedence or by
 parentheses, nests. Parentheses are not part of the tree, since they decide
 nothing.
 
+An operand whose form allows one outcome only needs only to be evaluated:
+its other outcome is impossible, not a gap. `Foo.new`, literals (`'s'`,
+`1`, `:k`, `[]`, `{}`, `true`) and lambdas can only be truthy; `nil` and
+`false` only falsy:
+
+```ruby
+@clock = options[:clock] || MonotonicClock.new  # operand 1: never evaluated, or no gap
+```
+
 - `:html` writes `index.html` to `coverage_dir`: the covered files with
   their sites, outcomes seen (with a percent) and outcomes missing, each
   column sortable. Each file name opens `files/<path>.html`, the file's
@@ -96,11 +105,15 @@ the file:
 ```ruby
 ok?(id) && new?(id)
 # compiles as
-ConditionCoverage.record("k.rb:2:2", 0, (ok?(id))) && ConditionCoverage.record("k.rb:2:2", 1, (new?(id)))
+ConditionCoverage.record("k.rb:2:2", 0, ok?(id)) && ConditionCoverage.record("k.rb:2:2", 1, new?(id))
 ```
 
-Each operand gets parentheses of its own, since one such as `ok? id` (after
-`and`) is not valid as a bare argument.
+A command call such as `ok? id` (after `and`) is not valid as a bare
+argument, so that operand alone gets parentheses of its own. No other operand
+does: parentheses make a statement, and a statement on a continuation line
+gives that line a line-coverage count of its own, which would change
+SimpleCov's line totals. With that one exception, an instrumented file has
+the same relevant lines as an uninstrumented one.
 
 `record` counts whether the operand was truthy or falsy and returns it
 unchanged, so short-circuiting and the value of the expression are

data/lib/condition_coverage/condition.rb

@@ -1,8 +1,16 @@
 module ConditionCoverage
   # One site's condition as the manifest found it: its operator
   # and its operands, each the byte range of a leaf or a nested
-  # Condition.
-  Condition = Data.define(:operator, :operands) do
+  # Condition. A site's commands are the byte ranges of its
+  # leaves that are command calls, eg `ok? id`; its fixed are
+  # { byte range => :truthy } for leaves that can have that one
+  # outcome only, eg `Clock.new`.
+  Condition = Data.define(:operator, :operands, :commands, :fixed) do
+    # A condition with no command-call or fixed leaves by default.
+    def initialize(operator:, operands:, commands: [], fixed: {})
+      super
+    end
+
     # The byte range of every leaf operand, left to right; a
     # leaf's index here is the index it is recorded under.
     def leaves

data/lib/condition_coverage/gaps.rb

@@ -25,9 +25,11 @@ module ConditionCoverage
       end
     end
 
-    # The one outcome this operand is missing, if any.
+    # The one outcome this operand is missing, if any; a fixed
+    # leaf, which can have one outcome only, needs only to run.
     def self.operand_gap(counts)
       return ['never evaluated'] if never_ran?(counts)
+      return [] if counts[:only]
       return ['never true'] if counts[:truthy].zero?
       return ['never false'] if counts[:falsy].zero?
 

data/lib/condition_coverage/kernel.rb

@@ -1,3 +1,4 @@
+require 'fileutils'
 require_relative 'configuration'
 require_relative 'gaps'
 require_relative 'html_report'
@@ -73,10 +74,12 @@ module ConditionCoverage
   end
 
   # Writes the JSON report, then runs the chosen reporters, for
-  # every covered file whether or not the run loaded it.
+  # every covered file whether or not the run loaded it, into
+  # coverage_dir, created first if need be.
   def self.report(config)
     files = parsed_files(config)
     result = Result.new(merged_sites(files), @recorder.counts)
+    FileUtils.mkdir_p(config.output_dir)
     JsonWriter.write(result, config.json_path)
     run_reporters(result, files, config)
   end

data/lib/condition_coverage/manifest.rb

@@ -19,6 +19,7 @@ module ConditionCoverage
       def initialize(path)
         @path = path
         @sites = {}
+        @notes = nil
         super()
       end
 
@@ -43,7 +44,11 @@ module ConditionCoverage
       def add_site(node)
         site = Site.of(@path, node)
         @sites[site] = nil
-        @sites[site] = condition_of(node)
+        outer = @notes
+        @notes = { commands: [], fixed: {} }
+        condition = condition_of(node)
+        @sites[site] = condition.with(**@notes)
+        @notes = outer
       end
 
       # node as a Condition, operands and all, named by its
@@ -72,11 +77,43 @@ module ConditionCoverage
       end
 
       # The byte range of a leaf operand, once any site inside
-      # it is noted too.
+      # it is noted too, and the range noted among its site's
+      # commands and fixed leaves where it is one.
       def leaf(operand)
         operand.accept(self)
         loc = operand.location
-        loc.start_offset...loc.end_offset
+        range = loc.start_offset...loc.end_offset
+        @notes[:commands] << range if command?(operand)
+        outcome = fixed_outcome(operand)
+        @notes[:fixed][range] = outcome if outcome
+        range
+      end
+
+      TRUTHY_TYPES = %i[
+        string_node integer_node symbol_node array_node hash_node
+        true_node lambda_node
+      ].freeze
+      FALSY_TYPES = %i[nil_node false_node].freeze
+
+      # The one outcome a leaf can have, eg :truthy for `Clock.new`
+      # or a literal, :falsy for `nil`; nil for a leaf that can
+      # have either.
+      def fixed_outcome(node)
+        return :falsy if FALSY_TYPES.include?(node.type)
+
+        :truthy if TRUTHY_TYPES.include?(node.type) || new_call?(node)
+      end
+
+      # True for a call to new, eg `Clock.new`.
+      def new_call?(node)
+        node.type == :call_node && node.name == :new
+      end
+
+      # True for a call to a named method with arguments and no
+      # parentheses, eg `id.include? 'N'`, but not `id.size == 6`.
+      def command?(node)
+        node.type == :call_node && node.arguments &&
+          node.opening_loc.nil? && node.name.match?(/\A[a-z_]/i)
       end
 
       # The one statement inside a parenthesised operand, or the

data/lib/condition_coverage/result.rb

@@ -13,16 +13,26 @@ module ConditionCoverage
     end
 
     # { site => [counts of operand 0, counts of operand 1, ...] },
-    # with zero counts for an operand that never ran.
+    # with zero counts for an operand that never ran, and
+    # only: naming the one outcome a fixed leaf can have.
     def operands
       @sites.to_h do |site, condition|
-        size = condition.leaves.size
-        [site, Array.new(size) { |i| counts_of(site, i) }]
+        leaves = condition.leaves.each_with_index.map do |range, i|
+          leaf(site, condition, range, i)
+        end
+        [site, leaves]
       end
     end
 
     private
 
+    # The counts of one leaf, with only: when it is fixed.
+    def leaf(site, condition, range, index)
+      counts = counts_of(site, index)
+      only = condition.fixed[range]
+      only ? counts.merge(only:) : counts
+    end
+
     # The recorded counts of one operand, or zeros.
     def counts_of(site, index)
       @counts.fetch([site, index], NEVER_RAN)

data/lib/condition_coverage/rewriter.rb

@@ -9,18 +9,21 @@ module ConditionCoverage
     def self.rewrite(source, sites)
       inserts = sites.flat_map do |site, condition|
         condition.leaves.each_with_index.flat_map do |range, index|
-          wrap(site, index, range)
+          command = condition.commands.include?(range)
+          wrap(site, index, range, command)
         end
       end
       apply(source.dup, inserts)
     end
 
-    # The two inserts that wrap one operand in a record call.
-    # The operand gets parentheses of its own, since one such
-    # as `ok? id` is not valid as a bare argument.
-    def self.wrap(site, index, range)
-      call = "ConditionCoverage.record(#{site.inspect}, #{index}, ("
-      [[range.begin, call], [range.end, '))']]
+    # The two inserts that wrap one operand in a record call. A
+    # command call is parenthesised, as it is no bare argument;
+    # nothing else is, since parentheses make a statement, which
+    # gives its line a line-coverage count of its own.
+    def self.wrap(site, index, range, command)
+      open, close = command ? ['(', '))'] : ['', ')']
+      call = "ConditionCoverage.record(#{site.inspect}, #{index}, "
+      [[range.begin, call + open], [range.end, close]]
     end
 
     # Splices each [offset, text] insert into source,

data/lib/condition_coverage/source_lines.rb

@@ -1,3 +1,5 @@
+require_relative 'gaps'
+
 module ConditionCoverage
   # The lines of one file's page, each with the status of the
   # conditions on it.
@@ -58,14 +60,10 @@ module ConditionCoverage
       [one, other].include?(:gaps) ? :gaps : :covered
     end
 
-    # :covered when every operand was seen both ways, else :gaps.
+    # :covered when no operand has a gap, else :gaps.
     def self.status_of(counts)
-      counts.all? { |operand| seen_both?(operand) } ? :covered : :gaps
-    end
-
-    # True when the operand was seen both true and false.
-    def self.seen_both?(counts)
-      counts[:truthy].positive? && counts[:falsy].positive?
+      gaps = counts.flat_map { |operand| Gaps.operand_gap(operand) }
+      gaps.empty? ? :covered : :gaps
     end
 
     # The line a site starts on, from its path:line:column name.

data/lib/condition_coverage/summary.rb

@@ -10,7 +10,7 @@ module ConditionCoverage
     # The summary row of one file's sites.
     def self.row(path, sites)
       operands = sites.flat_map { |_, counts| counts }
-      outcomes = operands.size * 2
+      outcomes = operands.sum { |counts| counts[:only] ? 1 : 2 }
       seen = operands.sum { |counts| seen_in(counts) }
       {
         path:, sites: sites.size, seen:, outcomes:,

data/lib/condition_coverage/version.rb

@@ -1,3 +1,3 @@
 module ConditionCoverage
-  VERSION = '0.0.2'.freeze
+  VERSION = '0.0.4'.freeze
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: condition_coverage
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.4
 platform: ruby
 authors:
 - Jon Jagger
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-10-31 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: prism
@@ -26,7 +25,6 @@ dependencies:
         version: '1.0'
 description: Records whether each operand of every &&, ||, and and or condition was
   seen both true and false, and reports the gaps in the terminal and as HTML.
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -62,7 +60,6 @@ licenses:
 - BSD-2-Clause
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -77,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 4.0.23
 specification_version: 4
 summary: Condition coverage for Ruby, alongside SimpleCov branch coverage
 test_files: []