constable-rails 1.4.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04f058e6367c5b8a7739a80141601c3db8fc4f088ff1a040353cad17c435e4f8
-  data.tar.gz: 18ab049c33174d1028c94352c20612fb79c39ed6aee70bce6a462321a4916d32
+  metadata.gz: 4ee7e9d9303ba3b3e4977f529ab515059faa946e96209dae4e80dbef42d2930c
+  data.tar.gz: feadad150285bf9d68b11cc671b7c1bc13188c39a0b6c76317aef1a7a6ca9c70
 SHA512:
-  metadata.gz: 3f1e99fc5bbf329fc0bff1bfd9b35afb396ae1ac2f23a1db8f75be493507dce586ff604bf016749975e384f764637c79dfa53e44092f417f582fd63d6009e38f
-  data.tar.gz: 18ff4465d65894ee18dbe1e5d116ae1a4128798ed759d41dd894135dd0b30554ab95329301c2559079e35066ce8cfc489ec88fe40760ef6eeedcbfa7f547972c
+  metadata.gz: 71adc2fab90c1ce4b1239159f7000c2b2200dc7f6becc3d365f6c935dc1702a9c012557b4602c909de880f2728433cfdfc9b4bd1524b8ec25581459c4a4f415a
+  data.tar.gz: 70fd3761fed31d90e365e1b24940025ddd14dc6f80f0761d004cdfe6c69145b4f1806f4fe49753a61af4137677cc2313c9a3f7cd0ce2f284e121ada1e75d0fdf

data/CHANGELOG.md

@@ -5,6 +5,90 @@ All notable changes to this project are documented here. This project adheres to
 
 ## [Unreleased]
 
+## [2.0.0]
+
+A tidy-up release. The API you write — `investigate`, `witness`, `briefing`, `docket`,
+`attest` — has not changed, and no case file or config key needs editing. The major
+version is for one removed accessor and for the behaviour change in 1.4.0, both below.
+
+### `constable modernize --cold`
+
+A conversion that comes back flagged is **not runnable**: the flagged constructs are left
+verbatim, so `let!` stays `let!` and the class body raises the moment it loads. That is
+deliberate — what a `let!` should become is a decision, not a rewrite — but it leaves a
+file stranded in `spec/` when the goal is one tree.
+
+```console
+$ constable modernize spec/models/tag_spec.rb --cold
+```
+
+writes `spec/models/tag_case.rb` as a cold case: one line at the top, the body byte for
+byte, run through real RSpec. Move it into `test/cases/` and the file is ported without
+being converted. Verified end to end — a `let!`-using spec that cannot convert runs 9/9
+from `test/` untouched.
+
+So a port is now: `modernize` a file, convert it if it comes back clean, `--cold` it if it
+does not, and revisit later. Nothing has to stay behind.
+
+### A case file that will not load says why
+
+A half-converted case still containing `let!` reported:
+
+```
+no tests matched test/cases/tmp
+```
+
+A file that raises while loading registers no investigations, so the selection came back
+empty and the empty-selection guard — added in 1.0.0 to catch mistyped paths — claimed
+the path was wrong. For a file that was right there and broken. It now reports the real
+error:
+
+```
+NoMethodError: undefined method `let!' for TagCase:Class
+This file never ran. Nothing in it was tested.
+```
+
+### `constable jail release --all`
+
+Emptying the docket took one command per test, which is unusable at the scale a docket
+reaches — before 1.4.0 a pass/fail flip jailed a test by itself, and one real suite put 29
+on the docket from a single run.
+
+Releasing is safe, and that is the point: a jailed test is *skipped*, so a docket full of
+tests nobody nominated is silently reducing what the suite covers. A bare `release` with
+no locator stays a usage error rather than an implicit "everything".
+
+### Removed: `Result#coverage`
+
+**Breaking, and why the major.** It was never written or read anywhere in the gem, and it
+did not survive `to_h`/`from_h` — so a value set on it vanished crossing the pipe from a
+parallel worker, silently, and only in parallel. An attribute that loses data is worse
+than no attribute. Coverage has always travelled separately and still does.
+
+### Also breaking, from 1.4.0
+
+`jail_flakes` defaults to **false**: a test that passed last run and failed this one is no
+longer jailed automatically. Jailing skips the test on every later run, and doing that to
+a test nobody nominated is how a suite quietly stops testing things. `--jail` is
+unaffected.
+
+### Test coverage
+
+The suite is now **1,025 runs**, up from 738 at 1.0.0. This release adds permanent tests
+for the three areas that had none and carried the most risk:
+
+- **`Result`** — the wire format between a worker and the parent. Every attribute is
+  asserted to survive a real `Marshal` round trip, because anything that does not is data
+  lost only in parallel runs, which is the worst way to find out. That is how the
+  `coverage` bug above was found.
+- **Cold-case shapes** — 17 real-world files run end to end through both engines: pending
+  and `xit`, `before`/`around` hooks, tags, aggregate failures, a raising hook, shared
+  examples, `RSpec.configure` inside a spec, deep nesting, the same file twice, and seven
+  Minitest arrangements. Every serious bug this project has had lived in these adapters.
+- **`Identity`** — stability under reformatting and comments, distinctness on real change,
+  unicode, cold-case keys, and the disambiguation added in 1.0.0.
+
+
 ## [1.4.2]
 
 ### Cold cases run inside a parallel worker
@@ -745,7 +829,8 @@ Initial release.
 - Diff-based coverage gate — only lines changed in the current diff are held to the
   threshold. `constable beat` for the full picture, `--html` for a browsable report.
 
-[Unreleased]: https://github.com/Ray-Hughes/constable/compare/v1.4.2...HEAD
+[Unreleased]: https://github.com/Ray-Hughes/constable/compare/v1.4.3...HEAD
+[1.4.3]: https://github.com/Ray-Hughes/constable/compare/v1.4.2...v1.4.3
 [1.4.2]: https://github.com/Ray-Hughes/constable/compare/v1.4.1...v1.4.2
 [1.4.1]: https://github.com/Ray-Hughes/constable/compare/v1.4.0...v1.4.1
 [1.4.0]: https://github.com/Ray-Hughes/constable/compare/v1.3.3...v1.4.0

data/README.md

@@ -393,7 +393,7 @@ worse than one that resets.
 | `constable test PATH[:LINE]` | One file, or one investigation at that line |
 | `constable test --unsafe` | Cold cases only |
 | `constable test --jail` | The full run, in jail mode |
-| `constable jail [run\|parole\|release]` | The docket |
+| `constable jail [run\|parole\|release]` | The docket. `release --all` empties it |
 | `constable warrants [release]` | Outstanding warrants |
 | `constable watchlist` | Everything under supervision right now |
 | `constable status` | How the suite is doing over time |
@@ -402,7 +402,7 @@ worse than one that resets.
 | `constable prepare [--workers N]` | Build the per-worker test databases `worker_databases: reuse` needs |
 | `constable prune [--dry-run]` | Forget docket rows and warrants for tests that no longer exist |
 | `constable import --from=rspec` | Adopt an existing suite as cold cases |
-| `constable modernize PATH` | Opt-in AST rewrite into the native DSL |
+| `constable modernize PATH [--cold]` | Opt-in AST rewrite into the native DSL. `--cold` moves it verbatim instead |
 
 Flags: `--full --unsafe --jail --warrants --coverage --seed N --workers N --verbose --tier T\n--expanded --concise --output MODE --no-color`.
 

data/lib/constable/cli.rb

@@ -197,6 +197,8 @@ module Constable
     DESC
     option :alongside, type: :boolean, default: false, desc: "Write PATH_case.rb beside the original"
     option :"in-place", type: :boolean, default: false, desc: "Overwrite the file"
+    option :cold, type: :boolean, default: false,
+                  desc: "Move it verbatim as a cold case instead of converting"
     option :"show-source", type: :boolean, default: false, desc: "Print the rewritten source"
     def modernize(*paths)
       if paths.empty?
@@ -205,6 +207,7 @@ module Constable
       end
 
       mode = if options[:"in-place"] then :in_place
+             elsif options[:cold] then :cold
              elsif options[:alongside] then :alongside
              else :none
              end
@@ -312,13 +315,48 @@ module Constable
         say "Paroled. It runs normally now; one failure sends it straight back."
       end
 
-      desc "release PATH:LINE", "Fully release a test, no supervision"
-      def release(locator)
+      desc "release [PATH:LINE]", "Fully release a test, no supervision"
+      long_desc <<~DESC
+        Takes one test off the docket. `--all` empties it.
+
+        Emptying is the right move after a docket that filled up on its own -- before
+        1.4.0 a pass/fail flip jailed a test automatically, and a suite with
+        order-dependent tests could put dozens on it that nobody chose. Releasing is safe:
+        anything genuinely broken fails again on the next run, in the open.
+      DESC
+      option :all, type: :boolean, default: false, desc: "Release every test on the docket"
+      def release(locator = nil)
+        return release_all if options[:all]
+
+        if locator.nil?
+          CLI.complain("release needs a PATH:LINE, or --all to empty the docket")
+          exit(EXIT_USAGE)
+        end
+
         act(locator) { |jail, identity| jail.release(identity) }
         say "Released."
       end
 
       no_commands do
+        # Emptying the docket in one go. Right after a docket that filled up on its own --
+        # before 1.4.0 a pass/fail flip jailed a test automatically, and a suite with
+        # order-dependent tests could put dozens on it that nobody chose. Releasing is
+        # safe: anything genuinely broken fails again on the next run, in the open.
+        def release_all
+          jail = Jail.new(config: Constable.config, storage: Constable.storage)
+          entries = jail.entries
+
+          if entries.empty?
+            say "The docket is already empty."
+            return 0
+          end
+
+          entries.each { |entry| jail.release(entry.identity) }
+          say "Released #{entries.size} #{entries.size == 1 ? "test" : "tests"}. The docket is empty."
+          say "Anything genuinely broken will fail on the next run, where you can see it."
+          0
+        end
+
         def act(locator)
           jail = Jail.new(config: Constable.config, storage: Constable.storage)
           refuse_ambiguous(locator, jail.candidates(locator), "on the docket")

data/lib/constable/importer/modernizer.rb

@@ -28,7 +28,7 @@ module Constable
       # :none      -- dry run. Report only. The default.
       # :alongside -- write foo_spec.rb's conversion to foo_case.rb, never clobbering.
       # :in_place  -- overwrite the original file.
-      WRITE_MODES = %i[none alongside in_place].freeze
+      WRITE_MODES = %i[none alongside in_place cold].freeze
 
       GROUP_METHODS       = %i[describe context xdescribe xcontext fdescribe fcontext feature].freeze
       EXAMPLE_METHODS     = %i[it specify example scenario].freeze
@@ -175,9 +175,60 @@ module Constable
           File.join(dir, "#{base}_case.rb")
         end
 
+        # `--cold`: move the file into the native tree without converting a line of it.
+        #
+        # A conversion that comes back flagged is not runnable -- the flagged constructs
+        # are left verbatim, so `let!` stays `let!` and the class body raises the moment it
+        # loads. That is deliberate: what a `let!` should become is a decision, not a
+        # rewrite. But it leaves a file stuck in spec/ when the goal is one tree.
+        #
+        # A cold case is the answer that already exists: one line at the top, the body
+        # untouched, run through real RSpec, results folded into the same report. This
+        # writes exactly that, so a port can move every file and convert the ones worth
+        # converting on its own schedule.
+        def cold_wrap(result, root)
+          target = alongside_path(result.path)
+          if File.exist?(target)
+            result.error = "refusing to overwrite #{target.delete_prefix("#{root}/")}"
+            return
+          end
+
+          FileUtils.mkdir_p(File.dirname(target))
+          File.write(target, cold_source(result))
+          result.written_to = target.delete_prefix("#{root}/")
+        end
+
+        # The original bytes, between a header line and a final `end`. Nothing inside is
+        # parsed, reindented or touched -- that is the whole promise of a cold case.
+        def cold_source(result)
+          <<~RUBY
+            # frozen_string_literal: true
+
+            # Moved verbatim from #{result.relative_path}. Runs through real RSpec, with its
+            # results folded into Constable's reporting, flake history and CI gate.
+            #
+            # Nothing inside has been converted, so every RSpec feature still works --
+            # `let!`, `before(:all)`, shared examples, rspec-mocks. Convert it with
+            # `constable modernize` when it is worth doing; there is no deadline.
+            class #{cold_class_name(result)} < Constable::ColdCase::RSpec
+            #{indent(result.original.to_s.rstrip)}
+            end
+          RUBY
+        end
+
+        def cold_class_name(result)
+          base = File.basename(result.path, ".rb").sub(/_(?:spec|test)\z/, "")
+          "Legacy#{base.split(%r{[_/]}).map(&:capitalize).join}Spec"
+        end
+
+        def indent(source)
+          source.lines.map { |line| line.strip.empty? ? line : "  #{line}" }.join
+        end
+
         private
 
         def persist(result, root, write)
+          return cold_wrap(result, root) if write == :cold
           return unless result.ok? && result.changed?
 
           case write

data/lib/constable/result.rb

@@ -18,7 +18,7 @@ module Constable
 
     attr_reader :identity, :case_name, :description, :file, :line, :kind, :tier
     attr_accessor :status, :duration, :failure, :warnings, :retries, :jail_reason,
-                  :parole_day, :times_jailed, :seed, :coverage
+                  :parole_day, :times_jailed, :seed
 
     def initialize(identity:, case_name:, description:, file:, line:, kind: :native, tier: nil,
                    status: :passed, duration: 0.0, failure: nil, warnings: [], retries: [])

data/lib/constable/runner.rb

@@ -231,6 +231,12 @@ module Constable
     def refuse_empty_selection!(items)
       return unless items.empty?
       return unless @selection.explicit?
+      # A file that raised while loading registers no investigations, so the selection
+      # comes back empty and this guard would report "no tests matched" -- burying the
+      # actual error, which is already captured and about to be reported as a failure.
+      # "Your path is wrong" is the wrong thing to say about a file that is right there
+      # and broken.
+      return if load_errors.any?
 
       raise Constable::Error, @selection.empty_selection_message
     end

data/lib/constable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Constable
-  VERSION = "1.4.2"
+  VERSION = "2.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: constable-rails
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Ray Hughes