ceedling 1.2.1 → 1.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (545) hide show
  1. checksums.yaml +4 -4
  2. data/GIT_COMMIT_SHA +1 -1
  3. data/README.md +11 -9
  4. data/Rakefile +2 -1
  5. data/assets/features/ceedling +1 -1
  6. data/assets/fixtures/test_source_file_duplicate_basenames/test_calc_typo.c +14 -0
  7. data/assets/fixtures/tests_with_duplicate_test_names/test_foo.c +21 -0
  8. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.c +7 -0
  9. data/assets/fixtures/tests_with_partials_coverage/src/private_macro.h +5 -0
  10. data/assets/fixtures/tests_with_partials_coverage/src/tally.c +13 -0
  11. data/assets/fixtures/tests_with_partials_coverage/src/tally.h +4 -0
  12. data/assets/fixtures/tests_with_partials_coverage/test/test_private_macro.c +10 -0
  13. data/assets/fixtures/tests_with_partials_coverage/test/test_tally.c +9 -0
  14. data/bin/actionator.rb +6 -12
  15. data/bin/app_cfg.rb +14 -1
  16. data/bin/ceedling +13 -3
  17. data/bin/cli.rb +25 -6
  18. data/bin/cli_handler.rb +113 -73
  19. data/bin/cli_helper.rb +51 -78
  20. data/bin/installation_selector.rb +81 -0
  21. data/bin/launchinator.rb +69 -0
  22. data/bin/mixin_resolvinator.rb +26 -36
  23. data/bin/objects.yml +13 -0
  24. data/bin/path_validator.rb +25 -29
  25. data/bin/versionator.rb +47 -48
  26. data/ceedling.gemspec +19 -15
  27. data/docs/BreakingChanges.md +86 -1
  28. data/docs/Changelog.md +145 -3
  29. data/docs/KnownIssues.md +179 -6
  30. data/docs/ReleaseNotes.md +13 -0
  31. data/examples/wondrous_forest/README.md +29 -1
  32. data/examples/wondrous_forest/src/ForestUnits.h +23 -0
  33. data/examples/wondrous_forest/src/RainGauge.c +59 -0
  34. data/examples/wondrous_forest/src/RainGauge.h +39 -0
  35. data/examples/wondrous_forest/src/RainTipIsr.c +17 -0
  36. data/examples/wondrous_forest/src/RainTipIsr.h +14 -0
  37. data/examples/wondrous_forest/test/TestRainGauge.c +126 -0
  38. data/lib/ceedling/build_log_writer.rb +33 -0
  39. data/lib/ceedling/c_extractor/README.md +15 -7
  40. data/lib/ceedling/c_extractor/c_extractor.rb +25 -14
  41. data/lib/ceedling/c_extractor/c_extractor_code_text.rb +84 -54
  42. data/lib/ceedling/c_extractor/c_extractor_constants.rb +18 -7
  43. data/lib/ceedling/c_extractor/c_extractor_declarations.rb +319 -283
  44. data/lib/ceedling/c_extractor/c_extractor_declarator.rb +285 -0
  45. data/lib/ceedling/c_extractor/c_extractor_defined_type.rb +111 -0
  46. data/lib/ceedling/c_extractor/c_extractor_definitions.rb +174 -121
  47. data/lib/ceedling/c_extractor/c_extractor_functions.rb +191 -162
  48. data/lib/ceedling/c_extractor/c_extractor_preprocessing.rb +46 -55
  49. data/lib/ceedling/c_extractor/c_extractor_statement.rb +30 -0
  50. data/lib/ceedling/c_extractor/c_extractor_types.rb +63 -41
  51. data/lib/ceedling/c_extractor/c_module_edits.rb +48 -0
  52. data/lib/ceedling/c_identifier.rb +21 -0
  53. data/lib/ceedling/ceedling.h +8 -0
  54. data/lib/ceedling/config/build_root_policy.rb +70 -0
  55. data/lib/ceedling/config/configurator.rb +18 -19
  56. data/lib/ceedling/config/configurator_builder.rb +75 -28
  57. data/lib/ceedling/config/configurator_paths_validator.rb +179 -0
  58. data/lib/ceedling/config/configurator_plugins.rb +1 -1
  59. data/lib/ceedling/config/configurator_setup.rb +44 -33
  60. data/lib/ceedling/config/configurator_validator.rb +1 -110
  61. data/lib/ceedling/constants.rb +5 -1
  62. data/lib/ceedling/defaults.rb +35 -5
  63. data/lib/ceedling/dependencies/CACHE_SCHEMA.md +118 -0
  64. data/lib/ceedling/dependencies/README.md +18 -16
  65. data/lib/ceedling/dependencies/dependency_cache_store.rb +43 -21
  66. data/lib/ceedling/dependencies/dependency_hasher.rb +35 -1
  67. data/lib/ceedling/dependencies/dependency_tracker.rb +9 -3
  68. data/lib/ceedling/dependencies/dependinator.rb +13 -1
  69. data/lib/ceedling/diagnostics/DOCTOR.md +142 -0
  70. data/lib/ceedling/diagnostics/README.md +5 -0
  71. data/lib/ceedling/diagnostics/build_step_doctor.rb +110 -0
  72. data/lib/ceedling/diagnostics/duplicate_symbol_specialist.rb +108 -0
  73. data/lib/ceedling/diagnostics/guidance_phrases.rb +30 -0
  74. data/lib/ceedling/diagnostics/header_collision_guidance.rb +56 -0
  75. data/lib/ceedling/diagnostics/header_collision_specialist.rb +152 -0
  76. data/lib/ceedling/diagnostics/include_depth_specialist.rb +132 -0
  77. data/lib/ceedling/diagnostics/missing_symbol_specialist.rb +111 -0
  78. data/lib/ceedling/diagnostics/partial_name_specialist.rb +134 -0
  79. data/lib/ceedling/diagnostics/toolchain_output.rb +44 -0
  80. data/lib/ceedling/filename_extension.rb +7 -1
  81. data/lib/ceedling/filesystem/FILE_TREE.md +253 -0
  82. data/lib/ceedling/filesystem/PATH_HANDLING.md +360 -0
  83. data/lib/ceedling/filesystem/README.md +46 -0
  84. data/lib/ceedling/filesystem/build_roots.rb +105 -0
  85. data/lib/ceedling/filesystem/build_subpath.rb +187 -0
  86. data/lib/ceedling/filesystem/destination_collision.rb +25 -0
  87. data/lib/ceedling/{file_finder.rb → filesystem/file_finder.rb} +177 -156
  88. data/lib/ceedling/filesystem/file_finder_helper.rb +154 -0
  89. data/lib/ceedling/filesystem/file_path_collection_utils.rb +183 -0
  90. data/lib/ceedling/{file_path_utils.rb → filesystem/file_path_utils.rb} +200 -167
  91. data/lib/ceedling/{file_system_wrapper.rb → filesystem/file_system_wrapper.rb} +6 -5
  92. data/lib/ceedling/filesystem/file_tree.rb +241 -0
  93. data/lib/ceedling/{file_wrapper.rb → filesystem/file_wrapper.rb} +149 -65
  94. data/lib/ceedling/filesystem/path_exclusions.rb +30 -0
  95. data/lib/ceedling/{path_matcher.rb → filesystem/path_matcher.rb} +48 -23
  96. data/lib/ceedling/{path_mirror.rb → filesystem/path_mirror.rb} +19 -18
  97. data/lib/ceedling/filesystem/path_spellings.rb +55 -0
  98. data/lib/ceedling/filesystem/project_paths.rb +184 -0
  99. data/lib/ceedling/filesystem/test_build_layout.rb +114 -0
  100. data/lib/ceedling/filesystem/win_long_paths.rb +153 -0
  101. data/lib/ceedling/filesystem/win_path_limit.rb +83 -0
  102. data/lib/ceedling/filesystem/win_path_prober.rb +52 -0
  103. data/lib/ceedling/filesystem/working_dir.rb +40 -0
  104. data/lib/ceedling/generators/generator.rb +32 -70
  105. data/lib/ceedling/generators/generator_helper.rb +0 -44
  106. data/lib/ceedling/generators/generator_mocks.rb +5 -0
  107. data/lib/ceedling/generators/generator_partials.rb +306 -244
  108. data/lib/ceedling/generators/generator_test_results_backtrace.rb +7 -7
  109. data/lib/ceedling/generators/generator_test_runner.rb +5 -8
  110. data/lib/ceedling/generators/partial_header_writer.rb +95 -0
  111. data/lib/ceedling/generators/partial_source_writer.rb +137 -0
  112. data/lib/ceedling/handoff.rb +121 -0
  113. data/lib/ceedling/includes/header_search.rb +225 -0
  114. data/lib/ceedling/includes/include_factory.rb +9 -12
  115. data/lib/ceedling/includes/include_pathinator.rb +112 -33
  116. data/lib/ceedling/includes/includes.rb +150 -38
  117. data/lib/ceedling/installation.rb +92 -0
  118. data/lib/ceedling/library_resolver.rb +99 -0
  119. data/lib/ceedling/objects.yml +112 -6
  120. data/lib/ceedling/partials/README.md +110 -16
  121. data/lib/ceedling/partials/carry_plan.rb +71 -0
  122. data/lib/ceedling/partials/definition_head.rb +74 -0
  123. data/lib/ceedling/partials/include_groups.rb +37 -0
  124. data/lib/ceedling/partials/interface_extras.rb +25 -0
  125. data/lib/ceedling/partials/partializer.rb +603 -124
  126. data/lib/ceedling/partials/partializer_config.rb +8 -1
  127. data/lib/ceedling/partials/partializer_helper.rb +851 -145
  128. data/lib/ceedling/partials/partializer_reconciler.rb +174 -0
  129. data/lib/ceedling/partials/partializer_utils.rb +89 -109
  130. data/lib/ceedling/partials/partials.rb +153 -10
  131. data/lib/ceedling/partials/type_macros.rb +126 -0
  132. data/lib/ceedling/plugins/report_log_writer_plugin.rb +3 -5
  133. data/lib/ceedling/preprocess/README.md +43 -33
  134. data/lib/ceedling/preprocess/preprocessinator.rb +100 -186
  135. data/lib/ceedling/preprocess/preprocessinator_code_finder.rb +65 -72
  136. data/lib/ceedling/preprocess/preprocessinator_file_assembler.rb +32 -76
  137. data/lib/ceedling/preprocess/preprocessinator_includes_handler.rb +1 -1
  138. data/lib/ceedling/preprocess/preprocessinator_line_marker_includes_extractor.rb +1 -1
  139. data/lib/ceedling/preprocess/preprocessinator_reconstructor.rb +51 -14
  140. data/lib/ceedling/rake_app/rakefile_component_resolver.rb +10 -17
  141. data/lib/ceedling/rakefile.rb +15 -1
  142. data/lib/ceedling/rakefiles/base/tasks_base.rake +1 -1
  143. data/lib/ceedling/rakefiles/release/rules_release.rake +4 -7
  144. data/lib/ceedling/release_invoker/release_build_executor.rb +33 -44
  145. data/lib/ceedling/release_invoker/release_build_planner.rb +14 -6
  146. data/lib/ceedling/reportinator.rb +3 -4
  147. data/lib/ceedling/setupinator.rb +104 -87
  148. data/lib/ceedling/test_context_extractor.rb +5 -1
  149. data/lib/ceedling/test_invoker/HEADER_COLLISIONS.md +21 -7
  150. data/lib/ceedling/test_invoker/PIPELINE.md +62 -19
  151. data/lib/ceedling/test_invoker/README.md +1 -1
  152. data/lib/ceedling/test_invoker/derived_search_path_notices.rb +45 -0
  153. data/lib/ceedling/test_invoker/mock_locator.rb +175 -10
  154. data/lib/ceedling/test_invoker/partial_files_preprocessinator.rb +181 -0
  155. data/lib/ceedling/test_invoker/partials_manager.rb +271 -302
  156. data/lib/ceedling/test_invoker/standin_headerinator.rb +19 -17
  157. data/lib/ceedling/test_invoker/test_bare_includes_extractinator.rb +26 -3
  158. data/lib/ceedling/test_invoker/test_build_executor.rb +358 -234
  159. data/lib/ceedling/test_invoker/test_build_planner.rb +46 -33
  160. data/lib/ceedling/test_invoker/test_build_setup.rb +43 -18
  161. data/lib/ceedling/test_invoker/test_build_validations.rb +35 -47
  162. data/lib/ceedling/test_invoker/test_derived_search_paths.rb +189 -0
  163. data/lib/ceedling/test_invoker/test_file_preprocessinator.rb +2 -3
  164. data/lib/ceedling/test_invoker/test_includes_reconcilinator.rb +1 -1
  165. data/lib/ceedling/test_invoker/test_invoker.rb +6 -1
  166. data/lib/ceedling/test_invoker/test_invoker_types.rb +28 -20
  167. data/lib/ceedling/test_invoker/test_pipeline_helpers.rb +6 -4
  168. data/lib/ceedling/test_invoker/test_pipeline_manager.rb +25 -8
  169. data/lib/ceedling/test_invoker/test_runner_generatinator.rb +31 -3
  170. data/lib/ceedling/test_invoker/test_search_paths.rb +30 -8
  171. data/lib/ceedling/test_invoker/test_source_file_directive_resolver.rb +40 -20
  172. data/lib/ceedling/test_invoker/test_substitutions.rb +72 -0
  173. data/lib/ceedling/tools/shell_quoting.rb +45 -0
  174. data/lib/ceedling/{tool_executor.rb → tools/tool_executor.rb} +9 -3
  175. data/lib/ceedling/tools/tool_quoting.rb +79 -0
  176. data/lib/ceedling/{tool_validator.rb → tools/tool_validator.rb} +18 -7
  177. data/lib/ceedling/yaml_wrapper.rb +3 -2
  178. data/lib/version.rb +1 -1
  179. data/plugins/bullseye/bullseye.rake +1 -3
  180. data/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  181. data/plugins/bullseye/lib/bullseye.rb +24 -9
  182. data/plugins/command_hooks/lib/command_hooks.rb +1 -1
  183. data/plugins/cppcheck/config/defaults_cppcheck.rb +1 -1
  184. data/plugins/dependencies/config/defaults.yml +6 -6
  185. data/plugins/dependencies/dependencies.rake +4 -1
  186. data/plugins/dependencies/lib/dependencies.rb +18 -8
  187. data/plugins/dependencies/lib/dependency_spec.rb +17 -5
  188. data/plugins/fff/lib/fff.rb +79 -46
  189. data/plugins/fff/lib/fff_mock_generator.rb +12 -9
  190. data/plugins/fff/spec/fff_cmock_wrapper_spec.rb +262 -0
  191. data/plugins/fff/spec/fff_mock_header_generator_spec.rb +9 -0
  192. data/plugins/fff/spec/fff_mock_source_generator_spec.rb +20 -0
  193. data/plugins/gcov/config/defaults_gcov.rb +1 -1
  194. data/plugins/gcov/lib/console_reportinator.rb +28 -36
  195. data/plugins/gcov/lib/gcov.rb +9 -2
  196. data/plugins/gcov/lib/gcovr_reportinator.rb +8 -40
  197. data/plugins/gcov/lib/gcovr_thresholds.rb +74 -0
  198. data/plugins/gcov/lib/reportgenerator_reportinator.rb +3 -2
  199. data/plugins/module_generator/lib/module_generator.rb +3 -3
  200. data/plugins/report_tests_teamcity_stdout/lib/report_tests_teamcity_stdout.rb +53 -80
  201. data/plugins/sanitize/lib/sanitize_records.rb +3 -6
  202. data/plugins/valgrind/lib/valgrind.rb +14 -7
  203. data/site-local/404.html +2 -2
  204. data/site-local/assets/javascripts/{bundle.c21346df.min.js → bundle.a5f9d56c.min.js} +1 -1
  205. data/site-local/assets/javascripts/{bundle.c21346df.min.js.map → bundle.a5f9d56c.min.js.map} +2 -2
  206. data/site-local/configuration/environment-vars.html +2 -2
  207. data/site-local/configuration/global-collections.html +3 -3
  208. data/site-local/configuration/index.html +2 -2
  209. data/site-local/configuration/loading.html +2 -2
  210. data/site-local/configuration/mixins.html +2 -2
  211. data/site-local/configuration/parallel-builds.html +2 -2
  212. data/site-local/configuration/project-file.html +2 -2
  213. data/site-local/configuration/reference/cexception.html +2 -2
  214. data/site-local/configuration/reference/cmock.html +7 -3
  215. data/site-local/configuration/reference/defines.html +2 -2
  216. data/site-local/configuration/reference/environment.html +2 -2
  217. data/site-local/configuration/reference/extension.html +2 -2
  218. data/site-local/configuration/reference/files.html +65 -12
  219. data/site-local/configuration/reference/flags.html +2 -2
  220. data/site-local/configuration/reference/index.html +2 -2
  221. data/site-local/configuration/reference/libraries.html +23 -5
  222. data/site-local/configuration/reference/mixins.html +2 -2
  223. data/site-local/configuration/reference/partials.html +84 -2
  224. data/site-local/configuration/reference/paths.html +36 -8
  225. data/site-local/configuration/reference/plugins.html +2 -2
  226. data/site-local/configuration/reference/project.html +264 -12
  227. data/site-local/configuration/reference/release-build.html +4 -2
  228. data/site-local/configuration/reference/test-build.html +2 -2
  229. data/site-local/configuration/reference/test-runner.html +2 -2
  230. data/site-local/configuration/reference/tools.html +58 -4
  231. data/site-local/configuration/reference/unity.html +2 -2
  232. data/site-local/configuration/which-ceedling.html +379 -19
  233. data/site-local/development/index.html +2 -2
  234. data/site-local/development/plugins/configuration.html +2 -2
  235. data/site-local/development/plugins/index.html +2 -2
  236. data/site-local/development/plugins/plugin-subclass.html +5 -4
  237. data/site-local/development/plugins/rake-tasks.html +2 -2
  238. data/site-local/development/releases.html +7 -3
  239. data/site-local/development/workflow.html +50 -45
  240. data/site-local/getting-started/builds.html +4 -2
  241. data/site-local/getting-started/command-line.html +58 -6
  242. data/site-local/getting-started/example-projects/cipher-quest.html +2 -2
  243. data/site-local/getting-started/example-projects/index.html +2 -2
  244. data/site-local/getting-started/example-projects/temp-sensor.html +2 -2
  245. data/site-local/getting-started/example-projects/wondrous-forest.html +10 -2
  246. data/site-local/getting-started/index.html +2 -2
  247. data/site-local/getting-started/installation.html +2 -2
  248. data/site-local/getting-started/quick-start.html +2 -2
  249. data/site-local/help.html +2 -2
  250. data/site-local/index.html +2 -2
  251. data/site-local/overview/build-system.html +2 -2
  252. data/site-local/overview/index.html +2 -2
  253. data/site-local/overview/test-environments.html +2 -2
  254. data/site-local/overview/tools-and-frameworks.html +2 -2
  255. data/site-local/plugins/beep.html +2 -2
  256. data/site-local/plugins/bullseye/index.html +45 -38
  257. data/site-local/plugins/bullseye/licensing.html +2 -2
  258. data/site-local/plugins/command-hooks.html +4 -4
  259. data/site-local/plugins/compile-commands-json-db.html +2 -2
  260. data/site-local/plugins/cppcheck.html +2 -2
  261. data/site-local/plugins/dependencies.html +8 -5
  262. data/site-local/plugins/fff.html +58 -13
  263. data/site-local/plugins/gcov/examples.html +2 -2
  264. data/site-local/plugins/gcov/gcovr.html +23 -14
  265. data/site-local/plugins/gcov/index.html +2 -2
  266. data/site-local/plugins/gcov/overview.html +2 -2
  267. data/site-local/plugins/gcov/reportgenerator.html +18 -14
  268. data/site-local/plugins/gcov/reporting.html +2 -2
  269. data/site-local/plugins/gcov/setup.html +4 -3
  270. data/site-local/plugins/gcov/tool-versions.html +2 -2
  271. data/site-local/plugins/gcov/troubleshooting.html +2 -2
  272. data/site-local/plugins/index.html +2 -2
  273. data/site-local/plugins/module-generator.html +2 -2
  274. data/site-local/plugins/report-build-warnings-log.html +2 -2
  275. data/site-local/plugins/report-tests-gtestlike-stdout.html +2 -2
  276. data/site-local/plugins/report-tests-ide-stdout.html +2 -2
  277. data/site-local/plugins/report-tests-log-factory.html +2 -2
  278. data/site-local/plugins/report-tests-pretty-stdout.html +2 -2
  279. data/site-local/plugins/report-tests-raw-output-log.html +5 -3
  280. data/site-local/plugins/report-tests-teamcity-stdout.html +8 -5
  281. data/site-local/plugins/sanitize.html +9 -8
  282. data/site-local/plugins/valgrind.html +10 -9
  283. data/site-local/project/index.html +2 -2
  284. data/site-local/project/release-history.html +2 -2
  285. data/site-local/project/sbom.html +2 -2
  286. data/site-local/project/upgrade.html +5 -2
  287. data/site-local/reference/build-directives.html +2 -2
  288. data/site-local/reference/command-line.html +11 -4
  289. data/site-local/reference/environment-vars.html +2 -2
  290. data/site-local/reference/gcov-plugin.html +2 -2
  291. data/site-local/reference/global-collections.html +12 -12
  292. data/site-local/reference/index.html +2 -2
  293. data/site-local/reference/partials-macros.html +47 -2
  294. data/site-local/reference/project-configuration.html +2 -2
  295. data/site-local/sitemap.xml.gz +0 -0
  296. data/site-local/snapshot/examples/cipher_quest/index.html +2 -2
  297. data/site-local/snapshot/examples/temp_sensor/index.html +2 -2
  298. data/site-local/snapshot/examples/wondrous_forest/index.html +72 -15
  299. data/site-local/snapshot/plugins/bullseye/config/defaults_bullseye.rb +1 -1
  300. data/site-local/snapshot/plugins/gcov/config/defaults_gcov.rb +1 -1
  301. data/site-local/testing-guide/build-directives.html +2 -2
  302. data/site-local/testing-guide/conventions.html +113 -15
  303. data/site-local/testing-guide/frameworks.html +2 -2
  304. data/site-local/testing-guide/index.html +2 -2
  305. data/site-local/testing-guide/partials/configuration.html +31 -4
  306. data/site-local/testing-guide/partials/conventions.html +509 -8
  307. data/site-local/testing-guide/partials/directives.html +4 -3
  308. data/site-local/testing-guide/partials/example.html +2 -2
  309. data/site-local/testing-guide/partials/index.html +2 -2
  310. data/site-local/testing-guide/partials/overview.html +30 -12
  311. data/site-local/testing-guide/partials/variables.html +169 -4
  312. data/site-local/testing-guide/test-cases.html +2 -2
  313. data/site-local/testing-guide/test-sample.html +2 -2
  314. data/site-local/testing-guide/test-suite-anatomy.html +2 -2
  315. data/spec/integration/actionator_file_operations_spec.rb +91 -1
  316. data/spec/integration/build_step_doctor_spec.rb +270 -0
  317. data/spec/integration/c_extractor_composition_spec.rb +254 -4
  318. data/spec/integration/compile_commands_json_db_spec.rb +1 -1
  319. data/spec/integration/configurator_validation_spec.rb +1 -1
  320. data/spec/integration/dependencies/dependency_tracker_cache_hardening_spec.rb +26 -0
  321. data/spec/integration/dependencies/dependency_tracker_core_spec.rb +22 -0
  322. data/spec/integration/includes_extraction_spec.rb +27 -14
  323. data/spec/integration/launcher_handoff_spec.rb +297 -0
  324. data/spec/integration/mixin_loading_spec.rb +1 -1
  325. data/spec/integration/module_generator_spec.rb +3 -3
  326. data/spec/integration/nested_test_artifacts_spec.rb +99 -0
  327. data/spec/integration/partial_files_preprocessing_spec.rb +128 -0
  328. data/spec/integration/partials_carry_spec.rb +520 -0
  329. data/spec/integration/partials_declarations_spec.rb +655 -0
  330. data/spec/integration/partials_fallback_preprocessing_spec.rb +65 -0
  331. data/spec/integration/partials_function_pointers_spec.rb +277 -0
  332. data/spec/integration/partials_header_composition_spec.rb +268 -35
  333. data/spec/integration/partials_macro_decorators_spec.rb +267 -0
  334. data/spec/integration/partials_module_resolution_spec.rb +33 -23
  335. data/spec/integration/partials_symbol_linkage_spec.rb +13 -0
  336. data/spec/integration/path_intake_scenarios_spec.rb +101 -0
  337. data/spec/integration/path_length_reporting_spec.rb +64 -0
  338. data/spec/integration/path_scenarios_spec.rb +399 -0
  339. data/spec/integration/quote_include_isolator_spec.rb +57 -1
  340. data/spec/integration/report_build_warnings_log_spec.rb +1 -1
  341. data/spec/integration/report_tests_log_factory_spec.rb +1 -1
  342. data/spec/integration/test_build_parallel_barrier_spec.rb +1 -1
  343. data/spec/integration/test_executable_manifest_spec.rb +1 -1
  344. data/spec/integration/test_includes_extractinator_spec.rb +69 -3
  345. data/spec/integration/test_naming_spec.rb +201 -0
  346. data/spec/integration/test_source_file_checks_spec.rb +168 -0
  347. data/spec/integration/tool_executor_spec.rb +1 -1
  348. data/spec/integration/tool_validator_spec.rb +3 -3
  349. data/spec/integration/upgrade_docs_spec.rb +84 -0
  350. data/spec/integration/vendor_copy_transient_io_retry_spec.rb +74 -5
  351. data/spec/integration/win_long_paths_probe_spec.rb +46 -0
  352. data/spec/integration/win_path_limit_spec.rb +53 -0
  353. data/spec/integration/windows_registry_query_tool_spec.rb +41 -0
  354. data/spec/support/file_tree_helper.rb +88 -0
  355. data/spec/support/integration/configurator_integration_helper.rb +14 -9
  356. data/spec/support/integration/dependency_tracker_integration_helper.rb +1 -1
  357. data/spec/support/integration/partial_files_harness.rb +181 -0
  358. data/spec/support/integration/partials_generation_integration_helper.rb +239 -143
  359. data/spec/support/integration/path_scenario_harness.rb +175 -0
  360. data/spec/support/integration/spec_integration_helper.rb +9 -4
  361. data/spec/support/integration/test_includes_harness.rb +69 -37
  362. data/spec/support/integration/tool_executor_integration_helper.rb +14 -2
  363. data/spec/support/spec_helper.rb +2 -0
  364. data/spec/support/system/spec_system_helper.rb +7 -6
  365. data/spec/support/system/system_context.rb +21 -3
  366. data/spec/support/working_dir_tracking.rb +49 -0
  367. data/spec/system/build_output_mirroring_spec.rb +2 -2
  368. data/spec/system/bullseye_deployment_spec.rb +2 -0
  369. data/spec/system/conditional_mock_includes_spec.rb +1 -1
  370. data/spec/system/delta_builds_spec.rb +163 -23
  371. data/spec/system/encoding_stress_spec.rb +4 -4
  372. data/spec/system/example_wondrous_forest_spec.rb +2 -2
  373. data/spec/system/gcov_deployment_spec.rb +3 -0
  374. data/spec/system/header_include_path_validation_spec.rb +4 -4
  375. data/spec/system/header_search_paths_spec.rb +1083 -0
  376. data/spec/system/launcher_handoff_spec.rb +82 -0
  377. data/spec/system/mock_include_folders_spec.rb +212 -0
  378. data/spec/system/mockable_header_reassembly_spec.rb +184 -0
  379. data/spec/system/parent_directory_reference_spec.rb +5 -3
  380. data/spec/system/partials_carry_spec.rb +581 -0
  381. data/spec/system/partials_delta_builds_spec.rb +280 -0
  382. data/spec/system/partials_function_pointers_spec.rb +106 -0
  383. data/spec/system/partials_macro_decorators_spec.rb +127 -0
  384. data/spec/system/partials_module_disambiguation_spec.rb +125 -0
  385. data/spec/system/path_handling_probes_spec.rb +196 -0
  386. data/spec/system/pinned_thread_count_spec.rb +4 -4
  387. data/spec/system/preprocessing_fallback_conditionals_spec.rb +1 -1
  388. data/spec/system/preprocessing_parameterized_tests_spec.rb +1 -1
  389. data/spec/system/rake_release_task_path_disambiguation_spec.rb +6 -6
  390. data/spec/system/rake_test_task_path_disambiguation_spec.rb +85 -0
  391. data/spec/system/short_build_paths_spec.rb +87 -0
  392. data/spec/system/sibling_header_collision_spec.rb +30 -6
  393. data/spec/system/special_path_characters_spec.rb +86 -0
  394. data/spec/system/support/bullseye_common_test_cases.rb +42 -0
  395. data/spec/system/support/common_test_cases.rb +23 -21
  396. data/spec/system/support/gcov_common_test_cases.rb +37 -9
  397. data/spec/system/support/gcov_partials_test_cases.rb +48 -0
  398. data/spec/system/support/sanitize_common_test_cases.rb +2 -2
  399. data/spec/system/support/valgrind_common_test_cases.rb +12 -12
  400. data/spec/system/test_build_layout_spec.rb +209 -0
  401. data/spec/system/test_pipeline_stop_points_spec.rb +4 -4
  402. data/spec/system/test_runner_system_include_spec.rb +1 -1
  403. data/spec/system/test_source_file_directive_spec.rb +64 -5
  404. data/spec/units/bin/actionator_spec.rb +14 -17
  405. data/spec/units/bin/app_cfg_spec.rb +37 -0
  406. data/spec/units/bin/cli_handler_spec.rb +282 -6
  407. data/spec/units/bin/cli_helper_spec.rb +116 -45
  408. data/spec/units/bin/installation_selector_spec.rb +114 -0
  409. data/spec/units/bin/launchinator_spec.rb +171 -0
  410. data/spec/units/bin/path_validator_spec.rb +10 -0
  411. data/spec/units/bin/versionator_spec.rb +38 -6
  412. data/spec/units/build_log_writer_spec.rb +57 -0
  413. data/spec/units/c_extractor/c_extractor_code_text_spec.rb +67 -10
  414. data/spec/units/c_extractor/c_extractor_declarations_spec.rb +501 -4
  415. data/spec/units/c_extractor/c_extractor_declarator_spec.rb +245 -0
  416. data/spec/units/c_extractor/c_extractor_defined_type_spec.rb +45 -0
  417. data/spec/units/c_extractor/c_extractor_definitions_spec.rb +163 -3
  418. data/spec/units/c_extractor/c_extractor_functions_spec.rb +462 -21
  419. data/spec/units/c_extractor/c_extractor_preprocessing_spec.rb +39 -0
  420. data/spec/units/c_extractor/c_extractor_spec.rb +4 -4
  421. data/spec/units/c_extractor/c_extractor_types_spec.rb +163 -0
  422. data/spec/units/c_identifier_spec.rb +35 -0
  423. data/spec/units/config/build_root_policy_spec.rb +61 -0
  424. data/spec/units/config/configurator_builder_spec.rb +61 -6
  425. data/spec/units/config/configurator_paths_validator_spec.rb +292 -0
  426. data/spec/units/config/configurator_setup_spec.rb +80 -68
  427. data/spec/units/config/configurator_spec.rb +54 -6
  428. data/spec/units/config/configurator_validator_spec.rb +1 -172
  429. data/spec/units/dependencies/dependency_cache_store_spec.rb +98 -2
  430. data/spec/units/dependencies/dependency_debug_tree_spec.rb +1 -1
  431. data/spec/units/dependencies/dependency_hasher_spec.rb +42 -1
  432. data/spec/units/dependencies/dependency_path_normalizer_spec.rb +1 -1
  433. data/spec/units/dependencies/dependency_tracker_spec.rb +28 -1
  434. data/spec/units/dependencies/dependinator_spec.rb +17 -2
  435. data/spec/units/diagnostics/build_step_doctor_spec.rb +170 -0
  436. data/spec/units/diagnostics/duplicate_symbol_specialist_spec.rb +117 -0
  437. data/spec/units/diagnostics/header_collision_specialist_spec.rb +267 -0
  438. data/spec/units/diagnostics/include_depth_specialist_spec.rb +137 -0
  439. data/spec/units/diagnostics/missing_symbol_specialist_spec.rb +154 -0
  440. data/spec/units/diagnostics/partial_name_specialist_spec.rb +129 -0
  441. data/spec/units/diagnostics/toolchain_output_spec.rb +86 -0
  442. data/spec/units/encodinator_spec.rb +3 -4
  443. data/spec/units/filename_extension_spec.rb +11 -0
  444. data/spec/units/filesystem/build_roots_spec.rb +131 -0
  445. data/spec/units/filesystem/build_subpath_spec.rb +235 -0
  446. data/spec/units/filesystem/destination_collision_spec.rb +30 -0
  447. data/spec/units/{file_finder_helper_spec.rb → filesystem/file_finder_helper_spec.rb} +126 -1
  448. data/spec/units/filesystem/file_finder_spec.rb +845 -0
  449. data/spec/units/{file_path_collection_utils_spec.rb → filesystem/file_path_collection_utils_spec.rb} +181 -1
  450. data/spec/units/{file_path_utils_spec.rb → filesystem/file_path_utils_spec.rb} +435 -185
  451. data/spec/units/filesystem/file_system_wrapper_spec.rb +33 -0
  452. data/spec/units/filesystem/file_tree_spec.rb +511 -0
  453. data/spec/units/filesystem/file_tree_windows_spec.rb +78 -0
  454. data/spec/units/{file_wrapper_spec.rb → filesystem/file_wrapper_spec.rb} +286 -18
  455. data/spec/units/{path_matcher_spec.rb → filesystem/path_matcher_spec.rb} +48 -1
  456. data/spec/units/{path_mirror_spec.rb → filesystem/path_mirror_spec.rb} +32 -4
  457. data/spec/units/filesystem/project_paths_spec.rb +147 -0
  458. data/spec/units/filesystem/test_build_layout_spec.rb +216 -0
  459. data/spec/units/filesystem/win_long_paths_spec.rb +204 -0
  460. data/spec/units/filesystem/win_path_prober_spec.rb +158 -0
  461. data/spec/units/filesystem/working_dir_spec.rb +71 -0
  462. data/spec/units/generators/generator_helper_spec.rb +0 -60
  463. data/spec/units/generators/generator_mocks_spec.rb +13 -0
  464. data/spec/units/generators/generator_partials_spec.rb +656 -55
  465. data/spec/units/generators/generator_spec.rb +38 -6
  466. data/spec/units/generators/generator_test_results_backtrace_spec.rb +50 -46
  467. data/spec/units/generators/generator_test_results_spec.rb +1 -1
  468. data/spec/units/generators/generator_test_runner_spec.rb +9 -5
  469. data/spec/units/generators/partial_source_writer_spec.rb +129 -0
  470. data/spec/units/handoff_spec.rb +205 -0
  471. data/spec/units/includes/header_search_spec.rb +406 -0
  472. data/spec/units/includes/include_factory_spec.rb +23 -6
  473. data/spec/units/includes/include_pathinator_spec.rb +118 -8
  474. data/spec/units/includes/include_spec.rb +14 -0
  475. data/spec/units/includes/includes_spec.rb +176 -19
  476. data/spec/units/installation_spec.rb +228 -0
  477. data/spec/units/library_resolver_spec.rb +157 -0
  478. data/spec/units/loginator_spec.rb +31 -0
  479. data/spec/units/mock_locator_spec.rb +275 -6
  480. data/spec/units/partials/include_groups_spec.rb +42 -0
  481. data/spec/units/partials/partializer_config_spec.rb +32 -0
  482. data/spec/units/partials/partializer_helper_carry_spec.rb +661 -0
  483. data/spec/units/partials/partializer_helper_interface_extras_spec.rb +396 -0
  484. data/spec/units/partials/partializer_helper_spec.rb +529 -277
  485. data/spec/units/partials/partializer_reconciler_spec.rb +661 -0
  486. data/spec/units/partials/partializer_spec.rb +1579 -270
  487. data/spec/units/partials/partializer_utils_spec.rb +269 -232
  488. data/spec/units/partials/partials_rename_spec.rb +160 -0
  489. data/spec/units/partials_manager_spec.rb +561 -251
  490. data/spec/units/plugins/bullseye_spec.rb +49 -2
  491. data/spec/units/plugins/console_reportinator_spec.rb +73 -26
  492. data/spec/units/plugins/dependencies_spec.rb +33 -7
  493. data/spec/units/plugins/dependency_spec_spec.rb +17 -0
  494. data/spec/units/plugins/gcov_spec.rb +28 -3
  495. data/spec/units/plugins/gcovr_reportinator_spec.rb +19 -47
  496. data/spec/units/plugins/gcovr_thresholds_spec.rb +95 -0
  497. data/spec/units/plugins/module_generator_spec.rb +5 -5
  498. data/spec/units/plugins/report_build_warnings_log_spec.rb +3 -3
  499. data/spec/units/plugins/report_log_writer_plugin_spec.rb +10 -1
  500. data/spec/units/plugins/report_tests_raw_output_log_spec.rb +13 -2
  501. data/spec/units/plugins/report_tests_teamcity_stdout_spec.rb +77 -3
  502. data/spec/units/plugins/reportgenerator_reportinator_spec.rb +52 -4
  503. data/spec/units/plugins/sanitize_records_spec.rb +3 -1
  504. data/spec/units/plugins/sanitize_spec.rb +1 -1
  505. data/spec/units/plugins/valgrind_spec.rb +23 -8
  506. data/spec/units/preprocess/preprocessinator_code_finder_spec.rb +73 -10
  507. data/spec/units/preprocess/preprocessinator_comment_stripper_spec.rb +1 -1
  508. data/spec/units/preprocess/preprocessinator_file_assembler_spec.rb +125 -37
  509. data/spec/units/preprocess/preprocessinator_includes_handler_spec.rb +15 -0
  510. data/spec/units/preprocess/preprocessinator_reconstructor_spec.rb +197 -0
  511. data/spec/units/preprocess/preprocessinator_spec.rb +153 -95
  512. data/spec/units/rake_app/rakefile_component_resolver_spec.rb +21 -0
  513. data/spec/units/release_build_executor_spec.rb +53 -14
  514. data/spec/units/release_build_planner_spec.rb +15 -3
  515. data/spec/units/reportinator_spec.rb +5 -5
  516. data/spec/units/setupinator_spec.rb +51 -0
  517. data/spec/units/standin_headerinator_spec.rb +55 -9
  518. data/spec/units/test_build_executor_spec.rb +842 -166
  519. data/spec/units/test_build_planner_spec.rb +205 -15
  520. data/spec/units/test_build_setup_spec.rb +179 -30
  521. data/spec/units/test_context_extractor_spec.rb +36 -2
  522. data/spec/units/test_derived_search_paths_spec.rb +259 -0
  523. data/spec/units/test_file_preprocessinator_spec.rb +17 -1
  524. data/spec/units/test_includes_extractinator_spec.rb +61 -9
  525. data/spec/units/test_invoker/objects_wiring_spec.rb +24 -4
  526. data/spec/units/test_invoker/partial_files_preprocessinator_spec.rb +264 -0
  527. data/spec/units/test_invoker/test_substitutions_spec.rb +122 -0
  528. data/spec/units/test_invoker_spec.rb +14 -1
  529. data/spec/units/test_invoker_types_spec.rb +8 -7
  530. data/spec/units/test_pipeline_manager_spec.rb +54 -13
  531. data/spec/units/test_runner_generatinator_spec.rb +93 -1
  532. data/spec/units/test_search_paths_spec.rb +73 -5
  533. data/spec/units/test_source_file_directive_resolver_spec.rb +38 -7
  534. data/spec/units/tools/default_tools_quoting_spec.rb +117 -0
  535. data/spec/units/tools/shell_quoting_spec.rb +76 -0
  536. data/spec/units/{tool_executor_helper_spec.rb → tools/tool_executor_helper_spec.rb} +1 -1
  537. data/spec/units/{tool_executor_spec.rb → tools/tool_executor_spec.rb} +27 -1
  538. data/spec/units/{tool_validator_spec.rb → tools/tool_validator_spec.rb} +110 -1
  539. data/spec/units/windows_registry_query_tool_spec.rb +53 -0
  540. data/spec/units/yaml_wrapper_spec.rb +11 -0
  541. metadata +265 -36
  542. data/lib/ceedling/file_finder_helper.rb +0 -127
  543. data/lib/ceedling/file_path_collection_utils.rb +0 -164
  544. data/spec/units/file_finder_spec.rb +0 -495
  545. /data/lib/ceedling/{tool_executor_helper.rb → tools/tool_executor_helper.rb} +0 -0
@@ -16,8 +16,8 @@ module TestInvokerTypes
16
16
  :testables, # Hash<Symbol, Testable> — accumulated across all stages
17
17
  :context,
18
18
  :options, # Array<Symbol> — pipeline-control flags (see TestPipelineManager)
19
- :partials_headers, # Array<PartialWork> — produced by T1; consumed by stages 6 & 7
20
- :partials_sources, # Array<PartialWork> — produced by T1; consumed by stages 6 & 7
19
+ :partials_headers, # Array<PartialWork> — produced by T1; consumed by stage 6
20
+ :partials_sources, # Array<PartialWork> — produced by T1; consumed by stage 7
21
21
  :mocks_list, # Array<MockWork> — produced by T2; consumed by stages 9 & 10
22
22
  :objects_list, # Array<ObjectWork> — produced by T3; consumed by stage 15
23
23
  :lock, # Mutex for thread-safe testable writes
@@ -36,20 +36,21 @@ module TestInvokerTypes
36
36
  # depending on whether mock preprocessing is enabled), and whether this
37
37
  # mock is Ceedling's own generated Partial content rather than a mock of a
38
38
  # real header (`partial`). `include_path` is the #include as the test wrote
39
- # it. It names the mock for CMock and the runner alike.
40
- MockDetails = Struct.new(:name, :filepath, :path, :source, :input, :partial, :include_path, keyword_init: true) unless const_defined?(:MockDetails, false)
39
+ # it. It names the mock for CMock and the runner alike. `header_include` is the
40
+ # respelling of CMock's text for the mock's real header
41
+ # (MockLocator#header_respelling), or nil where CMock's text stays. An FFF fake
42
+ # includes the header by it, and CMock does where its format takes it.
43
+ MockDetails = Struct.new(:name, :filepath, :path, :source, :input, :partial, :include_path, :header_include, keyword_init: true) unless const_defined?(:MockDetails, false)
41
44
 
42
45
  # A test's generated Unity runner: the C file to be compiled (`output_filepath`)
43
46
  # and the (possibly preprocessed) test file it was generated from (`input_filepath`).
44
- RunnerInfo = Struct.new(:output_filepath, :input_filepath, keyword_init: true) unless const_defined?(:RunnerInfo, false)
47
+ # `includes` are the runner's #includes, spelled the first time stage 12 or 13 asks
48
+ RunnerInfo = Struct.new(:output_filepath, :input_filepath, :includes, keyword_init: true) unless const_defined?(:RunnerInfo, false)
45
49
 
46
- # One partial header or source file's own preprocessing work, flattened out of its
47
- # owning testable for parallel processing (T1). `preprocessed_target` and `stale` are
48
- # unset until the corresponding stage settles this target's staleness.
49
- PartialWork = Struct.new(
50
- :config, :testable, :directives_only_filepath, :preprocessed_target, :stale,
51
- keyword_init: true
52
- ) unless const_defined?(:PartialWork, false)
50
+ # One Partial header or source file to preprocess, flattened out of its owning testable
51
+ # for parallel processing (T1). `config` is the file's Partials::ConfigFileInfo, which
52
+ # preprocessing fills in for stage 8.
53
+ PartialWork = Struct.new( :config, :testable, keyword_init: true ) unless const_defined?(:PartialWork, false)
53
54
 
54
55
  # One mock's own preprocessing/generation work, flattened out of its owning testable
55
56
  # for parallel processing (T2). `details` is this mock's own MockDetails; `preprocessed_target`
@@ -74,6 +75,10 @@ module TestInvokerTypes
74
75
  # into search_paths so a mock is still findable
75
76
  # by however little path its own #include wrote
76
77
  :search_paths,
78
+ :derived_search_paths, # Array — directories the #includes of headers no
79
+ # search path lists imply, after every configured path
80
+ :search_path_refusals, # Hash — header query → why its #include gets no
81
+ # derived directory, for the error its failed lookup raises
77
82
  :compile_flags, :preprocess_flags, :assembler_flags, :link_flags,
78
83
  :compile_defines, :preprocess_defines,
79
84
  :runner, # RunnerInfo
@@ -86,19 +91,22 @@ module TestInvokerTypes
86
91
  # then the executable has already been marked fresh (if it
87
92
  # was rebuilt), so a fresh staleness query would always
88
93
  # answer false regardless of what actually happened.
89
- :isolated_headers_path, # String — set by stage 15's own sibling-header isolation
90
- # (TestBuildExecutor#isolate_sibling_headers) the first time
91
- # this test's own file compile finds a real header sharing a
92
- # directory with a mocked/Partialized header. Scoped to this
93
- # one test's whole build rather than any single object, so
94
- # every object compiled afterward sees the same corrected
95
- # search paths; nil until (if ever) that happens, and read
96
- # once more at the very end of stage 15 to know what to clean up.
94
+ :header_isolation, # QuoteIncludeIsolator::Isolation — set by stage 15's own
95
+ # sibling-header isolation (TestBuildExecutor#isolate_sibling_headers)
96
+ # when this test's own file compile finds a real header sharing a
97
+ # directory with one CMock copies by name. Scoped to this one
98
+ # test's whole build rather than any single object, so every
99
+ # object compiled afterward sees the same corrected search paths
100
+ # and maps its copies back to their originals; nil until (if ever)
101
+ # that happens, and read once more at the end of stage 15 to know
102
+ # what to clean up.
97
103
  keyword_init: true
98
104
  ) do
99
105
  def initialize(**kwargs)
100
106
  kwargs[:partials] ||= TestablePartials.new(configs: {}, tests: [], mocks: [])
101
107
  kwargs[:mock_search_paths] ||= []
108
+ kwargs[:derived_search_paths] ||= []
109
+ kwargs[:search_path_refusals] ||= {}
102
110
  super(**kwargs)
103
111
  end
104
112
  end unless const_defined?(:Testable, false)
@@ -5,7 +5,7 @@
5
5
  # SPDX-License-Identifier: MIT
6
6
  # =========================================================================
7
7
 
8
- require 'ceedling/path_mirror'
8
+ require 'ceedling/filesystem/path_mirror'
9
9
 
10
10
  # Small helpers shared by more than one test pipeline stage class. Relies on
11
11
  # `@reportinator`/`@loginator` already being present via whichever including
@@ -56,11 +56,13 @@ module TestPipelineHelpers
56
56
  # between runs, with nothing else changed, should still invalidate whatever a
57
57
  # preprocessing pass produced.
58
58
  #
59
- # `partials:` is left out of the returned hash entirely when not given, so a
60
- # caller with nothing to do with Partials never carries a meaningless `nil`.
61
- def dependency_meta(flags:, defines:, search_paths:, tools: [], preprocess_force_fallback: @configurator.test_build_preprocess_force_fallback, partials: nil)
59
+ # `partials:` and `isolated:` are left out of the returned hash entirely when not given,
60
+ # so a caller with nothing to do with Partials or header isolation never carries a
61
+ # meaningless `nil`.
62
+ def dependency_meta(flags:, defines:, search_paths:, tools: [], preprocess_force_fallback: @configurator.test_build_preprocess_force_fallback, partials: nil, isolated: nil)
62
63
  meta = { flags: flags, defines: defines, search_paths: search_paths, tools: tools, preprocess_force_fallback: preprocess_force_fallback }
63
64
  meta[:partials] = partials unless partials.nil?
65
+ meta[:isolated] = isolated unless isolated.nil?
64
66
  meta
65
67
  end
66
68
 
@@ -21,6 +21,7 @@ class TestPipelineManager
21
21
  :test_build_setup,
22
22
  :test_includes_extractinator,
23
23
  :test_build_planner,
24
+ :partial_files_preprocessinator,
24
25
  :partials_manager,
25
26
  :test_build_executor,
26
27
  :test_file_preprocessinator,
@@ -166,6 +167,13 @@ class TestPipelineManager
166
167
  body: ->(s) { @test_build_setup.stage_ingest_configurations(s) }
167
168
  ),
168
169
 
170
+ # Transform 1: Set header copies aside while stage 4 preprocesses each test through its
171
+ # mock root. Transform 4 puts back those a current mock writes.
172
+ stage(transform: true,
173
+ condition: ->(s) { use_preprocessing.call(s) && use_mocks.call(s) },
174
+ body: ->(s) { @test_build_executor.stage_hold_header_copies(s) }
175
+ ),
176
+
169
177
  # Stage 4
170
178
  stage("Collecting More Test Context",
171
179
  condition: use_preprocessing,
@@ -178,7 +186,7 @@ class TestPipelineManager
178
186
  body: ->(s) { @test_build_planner.stage_determine_files(s) }
179
187
  ),
180
188
 
181
- # Transform 1: Prepare partials parallel processing
189
+ # Transform 2: Prepare partials parallel processing
182
190
  stage(transform: true,
183
191
  condition: use_partials,
184
192
  body: ->(s) { @test_build_planner.stage_flatten_partials_lists(s) }
@@ -189,7 +197,7 @@ class TestPipelineManager
189
197
  condition: use_partials,
190
198
  empty_condition: ->(s) { s.partials_headers.empty? },
191
199
  empty_notice: "no Partials to process",
192
- body: ->(s) { @partials_manager.stage_preprocess_partial_headers(s) }
200
+ body: ->(s) { @partial_files_preprocessinator.preprocess_headers(s) }
193
201
  ),
194
202
 
195
203
  # Stage 7
@@ -197,7 +205,7 @@ class TestPipelineManager
197
205
  condition: use_partials,
198
206
  empty_condition: ->(s) { s.partials_sources.empty? },
199
207
  empty_notice: "no Partials to process",
200
- body: ->(s) { @partials_manager.stage_preprocess_partial_sources(s) }
208
+ body: ->(s) { @partial_files_preprocessinator.preprocess_sources(s) }
201
209
  ),
202
210
 
203
211
  # Stage 8
@@ -208,17 +216,26 @@ class TestPipelineManager
208
216
  body: ->(s) { @partials_manager.stage_generate_partials(s) }
209
217
  ),
210
218
 
211
- # Transform 2: Prepare mocks for parallel processing
219
+ # Transform 3: Prepare mocks for parallel processing
212
220
  stage(transform: true,
213
221
  condition: use_mocks,
214
222
  body: ->(s) { @test_build_planner.stage_flatten_mocks_list(s) }
215
223
  ),
216
224
 
217
- # Stage 9
225
+ # Transform 4: Put back the header copies a current mock writes and prune the rest, before
226
+ # stage 10 regenerates mocks beside them. The test's own compile searches the mock root, so
227
+ # a stale copy would shadow its header. Runs when this run has no mocks too, since a test's
228
+ # mock root stays on its search path.
229
+ stage(transform: true,
230
+ condition: use_mocks,
231
+ body: ->(s) { @test_build_executor.stage_prune_header_copies(s) }
232
+ ),
233
+
234
+ # Stage 9 — a Partial mock needs no preprocessing, so Partial mocks alone leave it empty.
218
235
  stage("Preprocessing for Mocks",
219
236
  condition: use_mocks_preproc,
220
- empty_condition: ->(s) { s.mocks_list.empty? },
221
- empty_notice: "no mocks to process",
237
+ empty_condition: ->(s) { s.mocks_list.all? { |mock| mock.details.partial } },
238
+ empty_notice: "no mocks need preprocessing",
222
239
  body: ->(s) { @test_build_executor.stage_preprocess_mocks(s) }
223
240
  ),
224
241
 
@@ -256,7 +273,7 @@ class TestPipelineManager
256
273
  body: ->(s) { @test_build_planner.stage_determine_artifacts(s) }
257
274
  ),
258
275
 
259
- # Transform 3: Prepare objects for parallel processing — skipped under
276
+ # Transform 5: Prepare objects for parallel processing — skipped under
260
277
  # :mocking or :test_runner.
261
278
  stage(transform: true,
262
279
  condition: ->(s) { not_mocking.call(s) && not_test_runner.call(s) },
@@ -6,6 +6,7 @@
6
6
  # =========================================================================
7
7
 
8
8
  require 'ceedling/constants'
9
+ require 'ceedling/includes/includes'
9
10
  require 'ceedling/test_invoker/test_pipeline_helpers'
10
11
 
11
12
  # Stages 12 and 13: each test's Unity runner. Stage 12 parses test case names from the
@@ -32,7 +33,8 @@ class TestRunnerGeneratinator
32
33
  :batchinator,
33
34
  :generator,
34
35
  :test_context_extractor,
35
- :dependinator
36
+ :dependinator,
37
+ :mock_locator
36
38
  )
37
39
 
38
40
  def setup()
@@ -80,7 +82,7 @@ class TestRunnerGeneratinator
80
82
  @generator.generate_test_runner(
81
83
  context: state.context,
82
84
  mocks: @context_extractor.lookup_mock_header_includes_list( testable.filepath ),
83
- includes: @context_extractor.lookup_nonmock_header_includes_list( testable.filepath ),
85
+ includes: runner_includes( testable ),
84
86
  test_filepath: testable.filepath,
85
87
  input_filepath: testable.runner.input_filepath,
86
88
  runner_filepath: testable.runner.output_filepath
@@ -98,8 +100,34 @@ class TestRunnerGeneratinator
98
100
  unity: @configurator.get_unity_config,
99
101
  test_preprocessor_tests: @configurator.project_use_test_preprocessor_tests,
100
102
  mocks: @context_extractor.lookup_mock_header_includes_list( testable.filepath ).map( &:filepath ),
101
- includes: @context_extractor.lookup_nonmock_header_includes_list( testable.filepath ).map( &:filepath )
103
+ includes: runner_includes( testable ).map { |include| include.include_path || include.filepath }
102
104
  }
103
105
  end
104
106
 
107
+ # The test's #includes as its runner writes them. A user #include is spelled as the text
108
+ # through which the test's search paths find its header first, its filename whenever that
109
+ # does, so the runner includes the header the test does (see Include#spelled_by). One whose
110
+ # header no search path reaches, whether preprocessing entered it or it sits beside the test,
111
+ # is spelled by that header's absolute path, unless the header is in the build root. One whose
112
+ # header isn't found keeps its filename. Both stages' staleness checks and the runner itself
113
+ # ask, and each test's list is settled by then, so it is spelled once.
114
+ def runner_includes(testable)
115
+ return testable.runner.includes ||= spelled_includes( testable )
116
+ end
117
+
118
+ # A preprocessed test's #includes hold the paths the compiler found their headers by. Without
119
+ # test preprocessing they are as written, beside the test file first.
120
+ def spelled_includes(testable)
121
+ search = @mock_locator.header_search( testable )
122
+ resolved = @configurator.project_use_test_preprocessor_tests
123
+ from = File.dirname( testable.filepath )
124
+
125
+ return @context_extractor.lookup_nonmock_header_includes_list( testable.filepath ).map do |include|
126
+ next include if include.is_a?( SystemInclude )
127
+
128
+ spelled = include.spelled_by( search, from: from, resolved: resolved )
129
+ spelled.equal?( include ) ? UserInclude.new( include.filepath ) : UserInclude.new( include.filepath, include_path: spelled.include_path )
130
+ end
131
+ end
132
+
105
133
  end
@@ -7,21 +7,37 @@
7
7
 
8
8
  # A test's compiler search paths, in the order the compiler searches them. Generated
9
9
  # directories come first, so a test's mocks and Partials shadow the real headers they
10
- # stand in for, then TEST_INCLUDE_PATH() entries, then the project's configured paths.
10
+ # stand in for, then TEST_INCLUDE_PATH() entries, then the project's configured paths,
11
+ # then the directories the test's #includes imply for headers no search path lists.
11
12
  class TestSearchPaths
12
13
 
13
14
  constructor :configurator, :include_pathinator, :test_context_extractor
14
15
 
15
- # `paths` is a Testable's paths Hash. `mock_search_paths` are its mocks' mirrored
16
- # directories, which sit right after the flat mock root.
17
- def compose(filepath, paths, mock_search_paths = [])
18
- return (generated_paths( filepath, paths, mock_search_paths ) + configured_paths( filepath )).uniq
16
+ # `mock_search_paths` are the test's mocks' mirrored directories, which sit right after
17
+ # the flat mock root. They default to the Testable's own.
18
+ def compose(testable, mock_search_paths = testable.mock_search_paths)
19
+ filepath = testable.filepath
20
+ return (generated_paths( filepath, testable.paths, mock_search_paths ) + configured_paths( filepath ) + testable.derived_search_paths).uniq
21
+ end
22
+
23
+ # The paths a test's real headers are found through: its search paths without the
24
+ # directories its mocks and Partials are generated in
25
+ def header_paths(testable)
26
+ return (configured_paths( testable.filepath ) + testable.derived_search_paths).uniq
27
+ end
28
+
29
+ # The paths mock preprocessing reads a mocked header through: the header paths with the test's
30
+ # Partial directories ahead of them, as `compose` orders them. Partials are generated before mocks
31
+ # are preprocessed, so they are current then. The mock directories hold CMock's copies of headers,
32
+ # which mock generation brings up to date only afterward, so they are left out.
33
+ def mock_preprocess_paths(testable)
34
+ return (partial_paths( testable.filepath, testable.paths ) + header_paths( testable )).uniq
19
35
  end
20
36
 
21
37
  # Sets a test's mock search paths and composes its search paths around them. `lock`
22
38
  # guards the write, since other threads read the Testable.
23
39
  def assign_mock_search_paths(testable, mock_search_paths, lock)
24
- paths = compose( testable.filepath, testable.paths, mock_search_paths )
40
+ paths = compose( testable, mock_search_paths )
25
41
  lock.synchronize do
26
42
  testable.mock_search_paths = mock_search_paths
27
43
  testable.search_paths = paths
@@ -35,8 +51,14 @@ class TestSearchPaths
35
51
  _paths = []
36
52
  _paths << paths[:mocks] if paths[:mocks]
37
53
  _paths += mock_search_paths
38
- _paths << paths[:partials] if paths[:partials]
39
- return _paths + partial_search_paths( filepath, paths )
54
+ return _paths + partial_paths( filepath, paths )
55
+ end
56
+
57
+ # The Partials root, then each Partialized module's own directory below it
58
+ def partial_paths(filepath, paths)
59
+ return [] unless paths[:partials]
60
+
61
+ return [paths[:partials]] + partial_search_paths( filepath, paths )
40
62
  end
41
63
 
42
64
  # TEST_INCLUDE_PATH() entries, then the project's configured paths
@@ -7,9 +7,8 @@
7
7
 
8
8
  require 'ceedling/constants'
9
9
  require 'ceedling/exceptions'
10
- require 'ceedling/file_path_utils'
11
- require 'ceedling/path_matcher'
12
- require 'ceedling/test_invoker/test_build_validations'
10
+ require 'ceedling/filesystem/file_path_utils'
11
+ require 'ceedling/filesystem/path_matcher'
13
12
 
14
13
  # Owns everything about the TEST_SOURCE_FILE() build directive's own path
15
14
  # content: collecting a test's raw directive strings, telling additive
@@ -20,8 +19,6 @@ require 'ceedling/test_invoker/test_build_validations'
20
19
  # becomes a real filepath.
21
20
  class TestSourceFileDirectiveResolver
22
21
 
23
- include TestBuildValidations
24
-
25
22
  constructor :test_context_extractor, :file_finder, :configurator, :loginator
26
23
 
27
24
  # Splits a test's TEST_SOURCE_FILE() entries into files to add and files to
@@ -33,31 +30,33 @@ class TestSourceFileDirectiveResolver
33
30
  def resolve(test_filepath, context)
34
31
  raw = @test_context_extractor.lookup_build_directive_sources_list( test_filepath )
35
32
  additive, subtractive = raw.partition { |source| FilePathUtils.add_path?( source ) }
36
-
37
- # A directive's own text is written directly in the test file, so its `..`, if
38
- # any, is anchored to that same test file's own directory -- exactly as a
39
- # directory-relative #include would be.
40
33
  anchor = File.dirname( test_filepath )
41
34
 
42
- find = -> (source) {
43
- stripped = FilePathUtils.no_aggregation_decorators( source )
44
- @file_finder.find_build_input_file(
45
- filepath: PathMatcher.resolve_relative( stripped, anchor: anchor ),
46
- complain: :ignore,
47
- context: context
48
- )
49
- }
50
-
51
- additive_sources = additive.map(&find).compact
35
+ additive_sources = additive.filter_map { |source| locate( source, anchor: anchor, context: context ) }
52
36
 
53
37
  subtractive_sources = subtractive.each_with_object({}) do |source, hash|
54
- resolved = find.call( source )
38
+ resolved = locate( source, anchor: anchor, context: context )
55
39
  hash[resolved] = source unless resolved.nil?
56
40
  end
57
41
 
58
42
  return [additive_sources, subtractive_sources]
59
43
  end
60
44
 
45
+ # A TEST_SOURCE_FILE() entry must name a real, recognized file whether it adds or removes.
46
+ # A typo fails loudly on either side of the +:/-: convention, naming the test that holds
47
+ # it. Entries are found exactly as `resolve` finds them, so any entry a build uses passes.
48
+ def validate!(test:, test_filepath:, context:)
49
+ anchor = File.dirname( test_filepath )
50
+
51
+ @test_context_extractor.lookup_build_directive_sources_list( test_filepath ).each do |entry|
52
+ source = FilePathUtils.no_aggregation_decorators( entry )
53
+ validate_extension!( test, source )
54
+ next unless locate( entry, anchor: anchor, context: context ).nil?
55
+
56
+ raise CeedlingException.new( "File '#{source}' specified with TEST_SOURCE_FILE() in #{test} cannot be found in the source file collection" )
57
+ end
58
+ end
59
+
61
60
  # Applies this test's TEST_SOURCE_FILE("-:...") entries against the fully
62
61
  # assembled source list, regardless of how each removed file originally got
63
62
  # there -- the implicit header/source convention, a positive directive, or
@@ -75,4 +74,25 @@ class TestSourceFileDirectiveResolver
75
74
  return sources - subtractive.keys
76
75
  end
77
76
 
77
+ private
78
+
79
+ # An entry's text is written in its test file, so its `..`, if any, is anchored to that
80
+ # test file's directory, as a directory-relative #include is
81
+ def locate(entry, anchor:, context:)
82
+ stripped = FilePathUtils.no_aggregation_decorators( entry )
83
+ return @file_finder.find_build_input_file(
84
+ filepath: PathMatcher.resolve_relative( stripped, anchor: anchor ), complain: :ignore, context: context
85
+ )
86
+ end
87
+
88
+ def validate_extension!(test, source)
89
+ assembly = @configurator.test_build_use_assembly
90
+ return if @configurator.extension_source.match?( source )
91
+ return if assembly && @configurator.extension_assembly.match?( source )
92
+
93
+ extensions = @configurator.extension_source.to_s
94
+ extensions += " or #{@configurator.extension_assembly}" if assembly
95
+ raise CeedlingException.new( "File '#{source}' specified with TEST_SOURCE_FILE() in #{test} is not a #{extensions} source file" )
96
+ end
97
+
78
98
  end
@@ -0,0 +1,72 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/constants'
9
+
10
+ # Knows which real headers a test substitutes and where Ceedling's own content lives.
11
+ #
12
+ # Sibling-header isolation and the build step doctor's collision diagnoses both weigh a
13
+ # test's reachable headers against these answers (see HEADER_COLLISIONS.md). The class
14
+ # keeps no state, so one instance serves every thread.
15
+ class TestSubstitutions
16
+
17
+ constructor :configurator
18
+
19
+ # `{ basename => real path }` for every real header this test substitutes: each
20
+ # CMock mock of a real header, and each Partialized module's header. A mock Partial's
21
+ # `source` is its generated interface header, not a project header, so it is left out.
22
+ def real_headers(testable)
23
+ return mocked_headers( testable ).merge( partialized_headers( testable ) )
24
+ end
25
+
26
+ # `{ basename => real path }` for every mocked header CMock also writes under its own
27
+ # name. With `:treat_inlines: :include`, CMock writes an inline-stripped copy of each real
28
+ # header it mocks into the mocks directory, ahead of the real header on the search path.
29
+ # These are the only headers a quoted #include can reach in place of the real one.
30
+ def shadowed_headers(testable)
31
+ return {} unless @configurator.project_use_mocks
32
+ return {} unless @configurator.cmock_treat_inlines == :include
33
+
34
+ return mocked_headers( testable )
35
+ end
36
+
37
+ # Whether `real_path` is a header this test Partializes, rather than mocks
38
+ def partialized?(testable, real_path)
39
+ return partialized_headers( testable ).value?( real_path )
40
+ end
41
+
42
+ # Directory roots holding only Ceedling's generated or vendored content for this test.
43
+ # Several files routinely share each one, such as a Partial's types, interface, and
44
+ # implementation headers, so sharing a directory there is no quote-include risk.
45
+ def generated_dirs(testable)
46
+ return [
47
+ testable.paths[:mocks],
48
+ testable.paths[:partials],
49
+ PROJECT_BUILD_VENDOR_UNITY_PATH,
50
+ PROJECT_BUILD_VENDOR_CMOCK_PATH,
51
+ PROJECT_BUILD_VENDOR_CEXCEPTION_PATH,
52
+ @configurator.project_build_vendor_ceedling_path
53
+ ].compact
54
+ end
55
+
56
+ ### Private ###
57
+
58
+ private
59
+
60
+ def mocked_headers(testable)
61
+ sources = (testable.mocks || {}).each_value.reject( &:partial ).filter_map( &:source )
62
+ return by_basename( sources )
63
+ end
64
+
65
+ def partialized_headers(testable)
66
+ return by_basename( testable.partials.configs.each_value.filter_map { |config| config.header.filepath } )
67
+ end
68
+
69
+ def by_basename(filepaths)
70
+ return filepaths.to_h { |filepath| [File.basename( filepath ), filepath] }
71
+ end
72
+ end
@@ -0,0 +1,45 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/constants'
9
+
10
+ # Reads the quoting in one piece of a command line as the shell running it will.
11
+ #
12
+ # A tool's command reaches the shell as one string, so a quote one piece leaves open pairs
13
+ # with a quote in a later piece and the command's words shift. A typographic quote looks
14
+ # like a quote but is an ordinary character to every shell.
15
+ module ShellQuoting
16
+
17
+ TYPOGRAPHIC = %w[“ ” „ ‟ ‘ ’ ‚ ‛ « » ‹ ›].freeze
18
+
19
+ # Each alternative consumes one escaped character or one closed span, in that order, so a
20
+ # quote matched alone is one that never closes. A backslash escapes the character after
21
+ # it, except inside single quotes.
22
+ SPANS = /\\.|"(?:\\.|[^"\\])*"|'[^']*'|["']/m
23
+
24
+ # cmd.exe treats a single quote as an ordinary character
25
+ WINDOWS_SPANS = /\\.|"(?:\\.|[^"\\])*"|"/m
26
+
27
+ # The quote character `text` leaves open, or nil when every quote closes
28
+ def self.unclosed(text, windows:)
29
+ return scannable( text ).scan( windows ? WINDOWS_SPANS : SPANS ).find { |span| span == '"' or span == "'" }
30
+ end
31
+
32
+ # The distinct typographic quotes in `text`, in the order they first appear
33
+ def self.typographic(text)
34
+ return scannable( text ).each_char.select { |char| TYPOGRAPHIC.include?( char ) }.uniq
35
+ end
36
+
37
+ # `text` with invalid bytes replaced and everything from its first Ruby expansion through
38
+ # its last removed, since an expansion's own quotes are Ruby's, not the shell's. A quote
39
+ # between two expansions goes unread, so a mistake there is missed rather than invented.
40
+ def self.scannable(text)
41
+ return text.scrub.gsub( PATTERNS::RUBY_STRING_REPLACEMENT, '' )
42
+ end
43
+ private_class_method :scannable
44
+
45
+ end
@@ -189,8 +189,8 @@ class ToolExecutor
189
189
 
190
190
  # Handle array or anything else passed into method to be expanded in place of replacement operators
191
191
  case (to_process)
192
- when Array then to_process.each {|value| build_string.concat( "#{element.sub(match, value.to_s)} " ) } if (to_process.size > 0)
193
- else build_string.concat( element.sub(match, to_process.to_s) )
192
+ when Array then to_process.each {|value| build_string.concat( "#{substitute( element, match, value )} " ) } if (to_process.size > 0)
193
+ else build_string.concat( substitute( element, match, to_process ) )
194
194
  end
195
195
 
196
196
  # Handle inline ruby string substitution
@@ -256,7 +256,7 @@ class ToolExecutor
256
256
  # expand elements (whether string or array) into substitution string & replace escaped '\$'
257
257
  elements.flatten!
258
258
  elements.each do |element|
259
- build_string.concat( substitution.sub(/([^\\]*)\$/, "\\1#{element}") ) # don't replace escaped '\$' but allow us to replace just a lonesome '$'
259
+ build_string.concat( substitute( substitution, /(?<!\\)\$/, element ) ) # don't replace escaped '\$' but allow us to replace just a lonesome '$'
260
260
  build_string.gsub!(/\\\$/, '$')
261
261
  build_string.concat(' ')
262
262
  end
@@ -264,6 +264,12 @@ class ToolExecutor
264
264
  return build_string.strip
265
265
  end
266
266
 
267
+ # Replaces the first match of pattern in template with value, taken literally. A
268
+ # replacement string would read a path's `\0`, `\1` or `\\` as a back-reference.
269
+ def substitute(template, pattern, value)
270
+ return template.sub( pattern ) { value.to_s }
271
+ end
272
+
267
273
  def pretty_tool_name(command)
268
274
  # Titleize command's name -- each word capitalized plus underscores replaced with spaces
269
275
  name = "#{command[:name].split(/ |\_/).map(&:capitalize).join(" ")}"
@@ -0,0 +1,79 @@
1
+ # =========================================================================
2
+ # Ceedling - Test-Centered Build System for C
3
+ # ThrowTheSwitch.org
4
+ # Copyright (c) 2010-26 Mike Karlesky, Mark VanderVoord, & Greg Williams
5
+ # SPDX-License-Identifier: MIT
6
+ # =========================================================================
7
+
8
+ require 'ceedling/tools/shell_quoting'
9
+
10
+ # Finds the quoting problems in a tool definition, one entry at a time.
11
+ #
12
+ # Each entry that reaches the shell must close its own quotes, since a quote left open pairs
13
+ # with one in a later entry. A typographic quote is only a warning, since it may be meant
14
+ # literally, as in a string a define holds.
15
+ module ToolQuoting
16
+
17
+ # `error` is false for a warning
18
+ Finding = Struct.new( :field, :message, :error, keyword_init: true ) do
19
+ # An executable whose quote is unclosed names no file that can be looked for
20
+ def unclosed_executable?
21
+ return (error and field == :executable)
22
+ end
23
+ end
24
+
25
+ # The findings for `tool`'s :executable and arguments, in order
26
+ def self.findings(tool, name:, windows:)
27
+ return entries( tool ).filter_map { |field, text| finding( name, field, text, windows ) }
28
+ end
29
+
30
+ # Each [field, text] pair the command line is built from
31
+ def self.entries(tool)
32
+ arguments = [tool[:arguments]].flatten.flat_map { |element| expanded( element ) }
33
+ entries = [[:executable, tool[:executable]]] + arguments.map { |argument| [:arguments, argument] }
34
+
35
+ return entries.select { |_, text| text.is_a?( String ) }
36
+ end
37
+
38
+ # The text one argument contributes, as ToolExecutor expands it. A string is itself the
39
+ # text. A hash contributes its first key, the substitution string, and each string among
40
+ # that key's values. Anything else adds nothing to the command line.
41
+ def self.expanded(element)
42
+ return [element] if element.is_a?( String )
43
+ return [] unless element.is_a?( Hash ) and element.any?
44
+
45
+ substitution, values = element.first
46
+ return [substitution.to_s, *[values].flatten.grep( String )]
47
+ end
48
+
49
+ def self.finding(name, field, text, windows)
50
+ location = "#{name} ↳ :#{field} ➡️ `#{text}`"
51
+ quote = ShellQuoting.unclosed( text, windows: windows )
52
+ typographic = ShellQuoting.typographic( text )
53
+
54
+ return unclosed( location, field, quote, typographic ) if quote
55
+ return nil if typographic.empty?
56
+
57
+ message = "#{location} holds #{phrase( typographic )} Use \" or ' unless the characters are meant literally."
58
+ return Finding.new( field: field, message: message, error: false )
59
+ end
60
+
61
+ # An unclosed quote's error names any typographic quote as its likely cause
62
+ def self.unclosed(location, field, quote, typographic)
63
+ subject = (field == :executable) ? 'executable' : 'argument'
64
+ message = "#{location} leaves a #{quote} quote unclosed. Enclose the #{subject} with #{quote} quotes."
65
+ message += " It holds #{phrase( typographic )} Replace it with #{quote}." if typographic.any?
66
+
67
+ return Finding.new( field: field, message: message, error: true )
68
+ end
69
+
70
+ # The typographic quotes found, and what a shell makes of them
71
+ def self.phrase(typographic)
72
+ return "#{typographic.first}, a typographic quote that a shell treats as an ordinary character." if typographic.one?
73
+
74
+ return "#{typographic.join( ' ' )}, typographic quotes that a shell treats as ordinary characters."
75
+ end
76
+
77
+ private_class_method :entries, :expanded, :finding, :unclosed, :phrase
78
+
79
+ end