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
@@ -0,0 +1,661 @@
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
+ # What a Partial carries forward beyond the functions a test selected.
9
+ #
10
+ # A Partial's implementation source holds the selected functions. The module's code also
11
+ # relied on declarations of functions defined elsewhere and on small header helpers. These
12
+ # examples state which of those PartializerHelper#plan_carry keeps, and why. Each builds the
13
+ # module from real extractor structs, so origin and decorators read as production sets them.
14
+
15
+ require 'spec_helper'
16
+ require 'ceedling/partials/partializer_helper'
17
+ require 'ceedling/partials/partials'
18
+ require 'ceedling/c_extractor/c_extractor_types'
19
+
20
+ describe PartializerHelper do
21
+ before(:each) do
22
+ @helper = described_class.new(
23
+ {
24
+ :partializer_utils => double( 'PartializerUtils' ),
25
+ :c_extractor_declarations => double( 'CExtractorDeclarations' ),
26
+ :parsing_parcels => double( 'ParsingParcels' ),
27
+ :loginator => double( 'Loginator' ).as_null_object
28
+ }
29
+ )
30
+ end
31
+
32
+ # ---- builders --------------------------------------------------------------
33
+
34
+ def decl(signature, origin: :source)
35
+ name = signature[/(\w+)\s*\(/, 1]
36
+ decorators = signature.split( /\s+/ ).take_while { |t| %w[static inline extern __inline __inline__].include?( t ) }
37
+ CExtractorTypes::CFunctionDeclaration.new(
38
+ name: name, signature: signature, decorators: decorators,
39
+ signature_stripped: signature.sub( /\A(?:(?:static|inline|extern)\s+)+/, '' ), origin: origin
40
+ )
41
+ end
42
+
43
+ def defn(code_block, origin: :source, expanded_body: nil, line_num: 1)
44
+ signature = code_block[/\A[^{]*/].strip
45
+ name = signature[/(\w+)\s*\(/, 1]
46
+ decorators = signature.split( /\s+/ ).take_while { |t| %w[static inline extern __inline __inline__].include?( t ) }
47
+ CExtractorTypes::CFunctionDefinition.new(
48
+ name: name, signature: signature, decorators: decorators, code_block: code_block,
49
+ body: code_block[/\{.*\}/m], expanded_body: expanded_body, origin: origin,
50
+ line_num: line_num, source_filepath: (origin == :header ? 'src/engine.h' : 'src/engine.c')
51
+ )
52
+ end
53
+
54
+ def var(text, decorators: [])
55
+ CExtractorTypes::CVariableDeclaration.new( name: text[/(\w+)\s*(?:=|;|\[)/, 1], text: text, decorators: decorators )
56
+ end
57
+
58
+ # A macro definition or a bare macro invocation
59
+ def statement(text)
60
+ CExtractorTypes::CStatement.new( text: text )
61
+ end
62
+
63
+ def c_module(*items)
64
+ CExtractorTypes::CModule.new(
65
+ function_definitions: items.grep( CExtractorTypes::CFunctionDefinition ),
66
+ function_declarations: items.grep( CExtractorTypes::CFunctionDeclaration ),
67
+ variable_declarations: items.grep( CExtractorTypes::CVariableDeclaration ),
68
+ element_sequence: items
69
+ )
70
+ end
71
+
72
+ # Selected testable functions arrive transformed, as extract_implementation_functions returns them
73
+ def selected(*definitions)
74
+ definitions.map { |d| Partials.manufacture_function_definition( name: d.name, signature: d.signature_stripped, code_block: d.code_block ) }
75
+ end
76
+
77
+ def mocked(*names)
78
+ names.map { |n| Partials.manufacture_function_declaration( name: n, signature: "void #{n}(void)" ) }
79
+ end
80
+
81
+ def plan(mod, impl: [], interface: [], fallback: false, header_guarded: true)
82
+ @helper.plan_carry( c_module: mod, impl: impl, interface: interface, fallback: fallback, header_guarded: header_guarded )
83
+ end
84
+
85
+ def carried_prototypes(result)
86
+ result.prototypes.map { |c| c.item.signature }
87
+ end
88
+
89
+ def carried_helpers(result)
90
+ result.helpers.keys
91
+ end
92
+
93
+ # ---- externals: a module declares a function it doesn't define -------------
94
+
95
+ context 'external functions' do
96
+ it 'carries a prototype for a function defined elsewhere' do
97
+ get = defn( 'int engine_get(void) { return board_tick(); }' )
98
+ tick = decl( 'int board_tick(void);', origin: :header )
99
+
100
+ result = plan( c_module( tick, get ), impl: selected( get ) )
101
+
102
+ expect( carried_prototypes( result ) ).to eq( ['int board_tick(void);'] )
103
+ expect( result.prototypes.first.reason ).to eq( 'external: no body in module' )
104
+ end
105
+
106
+ # The prototype's whole job is to make this file hold the external definition, so an
107
+ # inline prototype can't depend on a use
108
+ it 'carries an extern inline prototype that nothing calls' do
109
+ get = defn( 'int engine_get(void) { return 1; }' )
110
+ twice = decl( 'extern inline int engine_get_twice(void);' )
111
+
112
+ result = plan( c_module( twice, get ), impl: selected( get ) )
113
+
114
+ expect( carried_prototypes( result ) ).to eq( ['extern inline int engine_get_twice(void);'] )
115
+ end
116
+
117
+ # C99 gives the external definition to a file declaring the function `extern` or without
118
+ # `inline`, so such a prototype can't depend on a use either
119
+ it 'carries a plain prototype of an inline function another header defines, unused' do
120
+ get = defn( 'int engine_get(void) { return 1; }' )
121
+ twice = decl( 'extern int engine_get_twice(void);' )
122
+ twice.inline_elsewhere = true
123
+
124
+ result = plan( c_module( twice, get ), impl: selected( get ) )
125
+
126
+ expect( carried_prototypes( result ) ).to eq( ['extern int engine_get_twice(void);'] )
127
+ end
128
+
129
+ it 'carries no prototype that nothing kept calls' do
130
+ get = defn( 'int engine_get(void) { return 1; }' )
131
+ unused = decl( 'int board_reset(void);', origin: :header )
132
+
133
+ expect( carried_prototypes( plan( c_module( unused, get ), impl: selected( get ) ) ) ).to be_empty
134
+ end
135
+
136
+ # The expanded body shows what the compiler calls. A macro that renames the call leaves no
137
+ # reference, and a carried prototype would only meet that macro again and break.
138
+ it 'carries no prototype whose call a macro replaced' do
139
+ get = defn( 'void *engine_buf(void) { return pool_alloc(4); }', expanded_body: '{ return pool_alloc_dbg((4),12); }' )
140
+ alloc = decl( 'void *pool_alloc(unsigned n);', origin: :header )
141
+
142
+ expect( carried_prototypes( plan( c_module( alloc, get ), impl: selected( get ) ) ) ).to be_empty
143
+ end
144
+
145
+ it 'counts a function whose address a body takes' do
146
+ get = defn( 'int engine_get(void) { return register_cb(&board_tick); }' )
147
+ tick = decl( 'int board_tick(void);', origin: :header )
148
+
149
+ expect( carried_prototypes( plan( c_module( tick, get ), impl: selected( get ) ) ) ).to eq( ['int board_tick(void);'] )
150
+ end
151
+
152
+ it 'counts a function a body passes by name as a callback' do
153
+ get = defn( 'int engine_start(void) { return register_cb(board_tick); }' )
154
+ tick = decl( 'int board_tick(void);', origin: :header )
155
+
156
+ expect( carried_prototypes( plan( c_module( tick, get ), impl: selected( get ) ) ) ).to eq( ['int board_tick(void);'] )
157
+ end
158
+
159
+ it 'never carries a static prototype without a body' do
160
+ get = defn( 'int engine_get(void) { return orphan(); }' )
161
+ orphan = decl( 'static int orphan(void);' )
162
+
163
+ expect( carried_prototypes( plan( c_module( orphan, get ), impl: selected( get ) ) ) ).to be_empty
164
+ end
165
+
166
+ it 'carries identical prototypes once' do
167
+ get = defn( 'int engine_get(void) { return board_tick(); }' )
168
+ in_header = decl( 'int board_tick(void);', origin: :header )
169
+ in_source = decl( 'int board_tick(void);', origin: :source )
170
+
171
+ result = plan( c_module( in_header, in_source, get ), impl: selected( get ) )
172
+
173
+ expect( result.prototypes.map( &:item ) ).to eq( [in_header] )
174
+ end
175
+
176
+ it 'carries compatible prototypes written differently, each as written' do
177
+ get = defn( 'int engine_get(void) { return board_tick(); }' )
178
+ plain = decl( 'int board_tick(void);', origin: :header )
179
+ extern = decl( 'extern int board_tick(void);', origin: :source )
180
+
181
+ expect( carried_prototypes( plan( c_module( plain, extern, get ), impl: selected( get ) ) ) )
182
+ .to eq( ['int board_tick(void);', 'extern int board_tick(void);'] )
183
+ end
184
+ end
185
+
186
+ # ---- selected functions are handled as they always were --------------------
187
+
188
+ context 'selected functions' do
189
+ it 'carries no prototype of a function selected to test' do
190
+ get = defn( 'int engine_get(void) { return 1; }' )
191
+ report = defn( 'int engine_report(void) { return engine_get() + 1; }' )
192
+ proto = decl( 'int engine_get(void);', origin: :header )
193
+
194
+ expect( carried_prototypes( plan( c_module( proto, get, report ), impl: selected( get, report ) ) ) ).to be_empty
195
+ end
196
+
197
+ it 'carries no prototype of a function selected to mock' do
198
+ get = defn( 'int engine_get(void) { engine_log(); return 1; }' )
199
+ log = defn( 'void engine_log(void) { }' )
200
+ prot = decl( 'void engine_log(void);', origin: :header )
201
+
202
+ result = plan( c_module( prot, log, get ), impl: selected( get ), interface: mocked( 'engine_log' ) )
203
+
204
+ expect( carried_prototypes( result ) ).to be_empty
205
+ end
206
+
207
+ it 'carries nothing for a selected static forward declaration' do
208
+ helper = defn( 'static int helper(void) { return 41; }' )
209
+ get = defn( 'int engine_get(void) { return helper() + 1; }' )
210
+ fwd = decl( 'static int helper(void);' )
211
+
212
+ result = plan( c_module( fwd, get, helper ), impl: selected( get, helper ) )
213
+
214
+ expect( carried_prototypes( result ) ).to be_empty
215
+ expect( carried_helpers( result ) ).to be_empty
216
+ end
217
+
218
+ # A header helper the test selects is written as a selected function, so carrying it too
219
+ # would define it twice
220
+ it 'carries neither the body nor the prototypes of a header helper selected to test' do
221
+ clamp = defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header )
222
+ fwd = decl( 'static inline int clamp(int v);', origin: :header )
223
+ get = defn( 'int engine_get(void) { return clamp(12); }' )
224
+
225
+ result = plan( c_module( fwd, clamp, get ), impl: selected( get, clamp ) )
226
+
227
+ expect( carried_helpers( result ) ).to be_empty
228
+ expect( carried_prototypes( result ) ).to be_empty
229
+ end
230
+ end
231
+
232
+ # ---- left out: the module defines it, but the test didn't select it --------
233
+
234
+ context 'left-out functions' do
235
+ it 'carries the prototype of a left-out function, so a test stub links' do
236
+ poll = defn( 'int engine_poll(void) { return 1; }' )
237
+ report = defn( 'int engine_report(void) { return engine_poll() + 1; }' )
238
+ proto = decl( 'int engine_poll(void);', origin: :header )
239
+
240
+ result = plan( c_module( proto, poll, report ), impl: selected( report ) )
241
+
242
+ expect( carried_prototypes( result ) ).to eq( ['int engine_poll(void);'] )
243
+ expect( result.prototypes.first.reason ).to eq( 'left out: body not selected' )
244
+ end
245
+
246
+ it 'carries no prototype of a left-out function nothing kept calls' do
247
+ poll = defn( 'int engine_poll(void) { return 1; }' )
248
+ get = defn( 'int engine_get(void) { return 1; }' )
249
+ proto = decl( 'int engine_poll(void);', origin: :header )
250
+
251
+ expect( carried_prototypes( plan( c_module( proto, poll, get ), impl: selected( get ) ) ) ).to be_empty
252
+ end
253
+
254
+ it 'carries no static prototype of an unselected source function' do
255
+ raw = defn( 'static void raw_write(void) { }' )
256
+ get = defn( 'int engine_get(void) { raw_write(); return 1; }' )
257
+ proto = decl( 'static void raw_write(void);', origin: :header )
258
+
259
+ expect( carried_prototypes( plan( c_module( proto, raw, get ), impl: selected( get ) ) ) ).to be_empty
260
+ end
261
+
262
+ it 'carries no inline prototype whose body was left out' do
263
+ fast = defn( 'int fast(void) { return 1; }' )
264
+ get = defn( 'int engine_get(void) { return fast(); }' )
265
+ proto = decl( 'extern inline int fast(void);' )
266
+
267
+ expect( carried_prototypes( plan( c_module( proto, fast, get ), impl: selected( get ) ) ) ).to be_empty
268
+ end
269
+
270
+ it 'carries the prototype but not the body of a plain function defined in the header' do
271
+ plain = defn( 'int plain(void) { return 1; }', origin: :header )
272
+ proto = decl( 'int plain(void);', origin: :header )
273
+ get = defn( 'int engine_get(void) { return plain(); }' )
274
+
275
+ result = plan( c_module( proto, plain, get ), impl: selected( get ) )
276
+
277
+ expect( carried_prototypes( result ) ).to eq( ['int plain(void);'] )
278
+ expect( carried_helpers( result ) ).to be_empty
279
+ end
280
+ end
281
+
282
+ # ---- helpers: static or inline bodies in the header --------------------------
283
+
284
+ context 'header helpers' do
285
+ let(:clamp) { defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header, line_num: 7 ) }
286
+
287
+ it 'carries a helper a selected body calls, with its reason' do
288
+ get = defn( 'int engine_get(void) { return clamp(12); }' )
289
+
290
+ result = plan( c_module( clamp, get ), impl: selected( get ) )
291
+
292
+ expect( carried_helpers( result ) ).to eq( ['clamp'] )
293
+ expect( result.helpers['clamp'].reason ).to eq( 'helper: referenced by `engine_get`' )
294
+ end
295
+
296
+ # A carried helper stays static inline and private to the implementation source
297
+ it 'carries the helper as written, with its location' do
298
+ get = defn( 'int engine_get(void) { return clamp(12); }' )
299
+
300
+ helper = plan( c_module( clamp, get ), impl: selected( get ) ).helper( 'clamp' )
301
+
302
+ expect( helper.code_block ).to eq( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }' )
303
+ expect( helper.line_num ).to eq( 7 )
304
+ expect( helper.source_filepath ).to eq( 'src/engine.h' )
305
+ end
306
+
307
+ it 'carries no helper that nothing kept references' do
308
+ get = defn( 'int engine_get(void) { return 1; }' )
309
+
310
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
311
+ end
312
+
313
+ # A helper's prototypes travel with its body, so a helper left behind takes them with it
314
+ it 'carries no prototype of a referenced helper it leaves behind' do
315
+ twice = defn( 'inline int twice(void) { return 2; }', origin: :header )
316
+ fwd = decl( 'int twice(void);', origin: :header )
317
+ get = defn( 'int engine_get(void) { return twice(); }' )
318
+
319
+ result = plan( c_module( fwd, twice, get ), impl: selected( get ), header_guarded: false )
320
+
321
+ expect( carried_prototypes( result ) ).to be_empty
322
+ end
323
+
324
+ it 'carries a carried helper\'s prototypes, static ones included' do
325
+ fwd = decl( 'static inline int clamp(int v);', origin: :header )
326
+ get = defn( 'int engine_get(void) { return clamp(12); }' )
327
+
328
+ expect( carried_prototypes( plan( c_module( fwd, clamp, get ), impl: selected( get ) ) ) )
329
+ .to eq( ['static inline int clamp(int v);'] )
330
+ end
331
+
332
+ # C99 gives a plain inline function its external definition through an extern inline
333
+ # prototype, so that prototype travels with the helper
334
+ it 'carries the source extern inline prototype of a plain inline helper' do
335
+ twice = defn( 'inline int engine_get_twice(void) { return 42; }', origin: :header )
336
+ proto = decl( 'extern inline int engine_get_twice(void);', origin: :source )
337
+ get = defn( 'int engine_get(void) { return engine_get_twice(); }' )
338
+
339
+ result = plan( c_module( twice, proto, get ), impl: selected( get ) )
340
+
341
+ expect( carried_helpers( result ) ).to eq( ['engine_get_twice'] )
342
+ expect( carried_prototypes( result ) ).to eq( ['extern inline int engine_get_twice(void);'] )
343
+ end
344
+
345
+ it 'ignores a helper name inside a string literal' do
346
+ get = defn( 'const char *engine_name(void) { return "clamp(1)"; }' )
347
+
348
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
349
+ end
350
+
351
+ # A quote inside a character literal starts no string, so the call between two of them counts
352
+ it 'reads past a quote inside a character literal' do
353
+ get = defn( %q{int engine_mark(void) { return '"' + clamp(1) + '"'; }} )
354
+
355
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
356
+ end
357
+
358
+ # A member or a local that shares a helper's name is not a use of the helper
359
+ it 'ignores a member access with a helper\'s name' do
360
+ size = defn( 'static inline int size(const buf_t *b) { return b->len; }', origin: :header )
361
+ get = defn( 'int engine_len(const buf_t *b) { return b->size(b) + b . size; }' )
362
+
363
+ expect( carried_helpers( plan( c_module( size, get ), impl: selected( get ) ) ) ).to be_empty
364
+ end
365
+
366
+ it 'ignores a local variable that shares a helper\'s name' do
367
+ get = defn( 'int engine_get(void) { int clamp = 3; return clamp; }' )
368
+
369
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
370
+ end
371
+
372
+ it 'ignores a local pointer that shares a helper\'s name' do
373
+ get = defn( 'int engine_get(const int *v) { const int *clamp = v; return *clamp; }' )
374
+
375
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
376
+ end
377
+
378
+ it 'ignores a loop variable that shares a helper\'s name' do
379
+ get = defn( 'int engine_sum(void) { int s = 0; for (int clamp = 0; clamp < 3; clamp++) { s += clamp; } return s; }' )
380
+
381
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
382
+ end
383
+
384
+ it 'ignores a parameter that shares a helper\'s name' do
385
+ get = defn( 'int engine_get(int clamp) { return 1 && clamp; }' )
386
+
387
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
388
+ end
389
+
390
+ # A bitwise and reads like taking an address, but the operand is still the parameter
391
+ it 'ignores a parameter after a bitwise and' do
392
+ get = defn( 'int engine_mask(int clamp) { return 0x0F & clamp; }' )
393
+
394
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
395
+ end
396
+
397
+ it 'ignores a struct tag that shares a helper\'s name' do
398
+ get = defn( 'int engine_size(void) { return (int)sizeof(struct clamp); }' )
399
+
400
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
401
+ end
402
+
403
+ it 'ignores a helper name inside a comment' do
404
+ get = defn( "int engine_get(void) { /* clamp(v) later */ return 1; // or clamp(v) now\n}" )
405
+
406
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
407
+ end
408
+
409
+ it 'counts a helper a body passes as a callback' do
410
+ cmp = defn( 'static inline int cmp(const void *a, const void *b) { return *(const int *)a - *(const int *)b; }', origin: :header )
411
+ get = defn( 'void engine_sort(int *v) { qsort(v, 4, sizeof(int), cmp); }' )
412
+
413
+ expect( carried_helpers( plan( c_module( cmp, get ), impl: selected( get ) ) ) ).to eq( ['cmp'] )
414
+ end
415
+
416
+ it 'counts a helper a body names in a designated initializer' do
417
+ add = defn( 'static inline int op_add(int a, int b) { return a + b; }', origin: :header )
418
+ get = defn( 'int engine_apply(void) { ops_t ops = { .fn = op_add }; return ops.fn(1, 2); }' )
419
+
420
+ expect( carried_helpers( plan( c_module( add, get ), impl: selected( get ) ) ) ).to eq( ['op_add'] )
421
+ end
422
+
423
+ it 'counts a helper whose name a quote in a comment does not hide' do
424
+ get = defn( "int engine_get(void) { /* don't */ return clamp(12); }" )
425
+
426
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
427
+ end
428
+
429
+ it 'counts a helper whose address a body takes' do
430
+ get = defn( 'int engine_get(void) { return apply(&clamp, 12); }' )
431
+
432
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
433
+ end
434
+
435
+ it 'matches a helper name only as a whole word' do
436
+ get = defn( 'int engine_get(void) { return clamp_count; }' )
437
+
438
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to be_empty
439
+ end
440
+
441
+ it 'finds a call that a macro hides, through the expanded body' do
442
+ get = defn( 'int engine_get(int v) { return CLAMP(v); }', expanded_body: '{ return clamp(v); }' )
443
+
444
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
445
+ end
446
+
447
+ it 'follows helpers that call helpers' do
448
+ bound = defn( 'static inline int bound(int v) { return clamp(v); }', origin: :header )
449
+ get = defn( 'int engine_get(void) { return bound(12); }' )
450
+
451
+ result = plan( c_module( clamp, bound, get ), impl: selected( get ) )
452
+
453
+ expect( carried_helpers( result ) ).to contain_exactly( 'bound', 'clamp' )
454
+ expect( result.helpers['clamp'].reason ).to eq( 'helper: referenced by `bound`' )
455
+ end
456
+
457
+ it 'follows a chain of helpers in the order each reaches the next' do
458
+ bound = defn( 'static inline int bound(int v) { return clamp(v); }', origin: :header )
459
+ scale = defn( 'static inline int scale(int v) { return bound(v * 2); }', origin: :header )
460
+ get = defn( 'int engine_get(void) { return scale(3); }' )
461
+
462
+ result = plan( c_module( clamp, bound, scale, get ), impl: selected( get ) )
463
+
464
+ expect( carried_helpers( result ) ).to eq( ['scale', 'bound', 'clamp'] )
465
+ expect( result.helpers['bound'].reason ).to eq( 'helper: referenced by `scale`' )
466
+ end
467
+
468
+ it 'carries a helper that calls itself once' do
469
+ walk = defn( 'static inline int walk(int n) { return n ? walk(n - 1) : 0; }', origin: :header )
470
+ get = defn( 'int engine_get(void) { return walk(3); }' )
471
+
472
+ expect( carried_helpers( plan( c_module( walk, get ), impl: selected( get ) ) ) ).to eq( ['walk'] )
473
+ end
474
+
475
+ it 'carries helpers that call each other once each' do
476
+ even = defn( 'static inline int is_even(int n) { return n ? is_odd(n - 1) : 1; }', origin: :header )
477
+ odd = defn( 'static inline int is_odd(int n) { return n ? is_even(n - 1) : 0; }', origin: :header )
478
+ get = defn( 'int engine_get(void) { return is_even(4); }' )
479
+
480
+ result = plan( c_module( even, odd, get ), impl: selected( get ) )
481
+
482
+ expect( carried_helpers( result ) ).to eq( ['is_even', 'is_odd'] )
483
+ expect( result.helpers['is_odd'].reason ).to eq( 'helper: referenced by `is_even`' )
484
+ end
485
+
486
+ it 'counts a reference from a variable written into the implementation source' do
487
+ table = var( 'int (*filters[1])(int) = { clamp };' )
488
+ get = defn( 'int engine_get(void) { return 1; }' )
489
+
490
+ expect( carried_helpers( plan( c_module( clamp, table, get ), impl: selected( get ) ) ) ).to eq( ['clamp'] )
491
+ end
492
+
493
+ it 'counts a reference from a bare macro invocation' do
494
+ call = statement( 'REGISTER(clamp)' )
495
+ get = defn( 'int engine_get(void) { return 1; }' )
496
+ mod = c_module( clamp, call, get )
497
+ mod.macro_invocations << call
498
+
499
+ expect( carried_helpers( plan( mod, impl: selected( get ) ) ) ).to eq( ['clamp'] )
500
+ end
501
+
502
+ it 'carries no helper selected for mocking' do
503
+ get = defn( 'int engine_get(void) { return clamp(12); }' )
504
+
505
+ expect( carried_helpers( plan( c_module( clamp, get ), impl: selected( get ), interface: mocked( 'clamp' ) ) ) ).to be_empty
506
+ end
507
+
508
+ it 'treats a static body in the source as left out, not as a helper' do
509
+ local = defn( 'static int local(void) { return 1; }', origin: :source )
510
+ get = defn( 'int engine_get(void) { return local(); }' )
511
+
512
+ expect( carried_helpers( plan( c_module( local, get ), impl: selected( get ) ) ) ).to be_empty
513
+ end
514
+ end
515
+
516
+ # ---- a module header without a guard ------------------------------------------
517
+
518
+ context 'a module header without an include guard' do
519
+ let(:clamp) { defn( 'static inline int clamp(int v) { return v; }', origin: :header ) }
520
+
521
+ # Another include may pull in the real header, whose helpers would then collide
522
+ it 'carries no referenced helper and names it as skipped' do
523
+ get = defn( 'int engine_get(void) { return clamp(1); }' )
524
+
525
+ result = plan( c_module( clamp, get ), impl: selected( get ), header_guarded: false )
526
+
527
+ expect( carried_helpers( result ) ).to be_empty
528
+ expect( result.skipped.map { |s| [s.item, s.kind] } ).to eq( [['clamp', :unguarded_helper]] )
529
+ end
530
+
531
+ it 'names no unreferenced helper' do
532
+ get = defn( 'int engine_get(void) { return 1; }' )
533
+
534
+ expect( plan( c_module( clamp, get ), impl: selected( get ), header_guarded: false ).skipped ).to be_empty
535
+ end
536
+
537
+ it 'still carries external prototypes' do
538
+ tick = decl( 'int board_tick(void);', origin: :header )
539
+ get = defn( 'int engine_get(void) { return board_tick(); }' )
540
+
541
+ expect( carried_prototypes( plan( c_module( tick, get ), impl: selected( get ), header_guarded: false ) ) )
542
+ .to eq( ['int board_tick(void);'] )
543
+ end
544
+ end
545
+
546
+ # ---- fallback preprocessing may leave alternatives behind ---------------------
547
+
548
+ context 'under fallback preprocessing' do
549
+ it 'carries neither of two conflicting prototypes and names the function' do
550
+ a = decl( 'int board_tick(int);', origin: :header )
551
+ b = decl( 'long board_tick(int);', origin: :header )
552
+ get = defn( 'int engine_get(void) { return (int)board_tick(1); }' )
553
+
554
+ result = plan( c_module( a, b, get ), impl: selected( get ), fallback: true )
555
+
556
+ expect( carried_prototypes( result ) ).to be_empty
557
+ expect( result.skipped.map { |s| [s.item, s.kind] } ).to eq( [['board_tick', :prototype_conflict]] )
558
+ end
559
+
560
+ it 'carries compatible prototypes' do
561
+ a = decl( 'int board_tick(void);', origin: :header )
562
+ b = decl( 'extern int board_tick(void);', origin: :source )
563
+ get = defn( 'int engine_get(void) { return board_tick(); }' )
564
+
565
+ expect( carried_prototypes( plan( c_module( a, b, get ), impl: selected( get ), fallback: true ) ).size ).to eq( 2 )
566
+ end
567
+
568
+ it 'carries neither of two different bodies for a referenced helper and names it' do
569
+ one = defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header )
570
+ two = defn( 'static inline int clamp(int v) { return v > 5 ? 5 : v; }', origin: :header )
571
+ get = defn( 'int engine_get(void) { return clamp(12); }' )
572
+
573
+ result = plan( c_module( one, two, get ), impl: selected( get ), fallback: true )
574
+
575
+ expect( carried_helpers( result ) ).to be_empty
576
+ expect( result.skipped.map { |s| [s.item, s.kind] } ).to eq( [['clamp', :helper_conflict]] )
577
+ end
578
+
579
+ it 'names no conflicting helper that nothing references' do
580
+ one = defn( 'static inline int clamp(int v) { return 9; }', origin: :header )
581
+ two = defn( 'static inline int clamp(int v) { return 5; }', origin: :header )
582
+ get = defn( 'int engine_get(void) { return 1; }' )
583
+
584
+ expect( plan( c_module( one, two, get ), impl: selected( get ), fallback: true ).skipped ).to be_empty
585
+ end
586
+
587
+ # Expansion is unreliable under fallback, so a macro definition's text counts as kept code
588
+ it 'finds a helper named only in a macro definition' do
589
+ clamp = defn( 'static inline int clamp(int v) { return v; }', origin: :header )
590
+ get = defn( 'int engine_get(int v) { return CLAMP(v); }' )
591
+ mod = c_module( clamp, get )
592
+ mod.macro_definitions << statement( '#define CLAMP(x) clamp(x)' )
593
+
594
+ expect( carried_helpers( plan( mod, impl: selected( get ), fallback: true ) ) ).to eq( ['clamp'] )
595
+ expect( carried_helpers( plan( mod, impl: selected( get ), fallback: false ) ) ).to be_empty
596
+ end
597
+ end
598
+
599
+ # ---- the running example from the design ---------------------------------------
600
+
601
+ it 'plans the running example' do
602
+ board_count = var( 'int board_count;', decorators: ['extern'] )
603
+ tick = decl( 'int board_tick(void);', origin: :header )
604
+ raw_proto = decl( 'static void raw_write(void);', origin: :header )
605
+ clamp = defn( 'static inline int clamp(int v) { return v > 9 ? 9 : v; }', origin: :header )
606
+ log_raw = defn( 'static inline void log_raw(void) { raw_write(); }', origin: :header )
607
+ get_proto = decl( 'int engine_get(void);', origin: :header )
608
+ poll_proto = decl( 'int engine_poll(void);', origin: :header )
609
+ twice = decl( 'extern inline int engine_get_twice(void);' )
610
+ raw = defn( 'static void raw_write(void) { }' )
611
+ get = defn( 'int engine_get(void) { return clamp(board_tick()); }' )
612
+ poll = defn( 'int engine_poll(void) { return engine_get(); }' )
613
+
614
+ mod = c_module( board_count, tick, raw_proto, clamp, log_raw, get_proto, poll_proto, twice, raw, get, poll )
615
+ result = plan( mod, impl: selected( get ) )
616
+
617
+ expect( carried_prototypes( result ) ).to contain_exactly(
618
+ 'int board_tick(void);', 'extern inline int engine_get_twice(void);'
619
+ )
620
+ expect( carried_helpers( result ) ).to eq( ['clamp'] )
621
+ expect( result.skipped ).to be_empty
622
+ end
623
+ end
624
+
625
+ describe Partials::CarryPlan do
626
+ let(:proto) { CExtractorTypes::CFunctionDeclaration.new( name: 'tick', signature: 'int tick(void);' ) }
627
+
628
+ # The generator walks element_sequence, which holds the very objects the plan chose
629
+ it 'recognizes a carried prototype by identity, not by equal content' do
630
+ plan = described_class.new
631
+ plan.add_prototype( proto, 'external: no body in module' )
632
+
633
+ expect( plan.prototype?( proto ) ).to be( true )
634
+ expect( plan.prototype?( proto.dup ) ).to be( false )
635
+ end
636
+
637
+ it 'records a prototype once' do
638
+ plan = described_class.new
639
+ 2.times { plan.add_prototype( proto, 'external: no body in module' ) }
640
+
641
+ expect( plan.prototypes.size ).to eq( 1 )
642
+ end
643
+
644
+ it 'keeps the first reason for a helper' do
645
+ plan = described_class.new
646
+ helper = Partials.manufacture_function_definition( name: 'clamp', signature: 'int clamp(int v)', code_block: '' )
647
+ plan.add_helper( helper, 'helper: referenced by `a`' )
648
+ plan.add_helper( helper, 'helper: referenced by `b`' )
649
+
650
+ expect( plan.helpers['clamp'].reason ).to eq( 'helper: referenced by `a`' )
651
+ expect( plan.helper( 'clamp' ) ).to equal( helper )
652
+ expect( plan.helper( 'other' ) ).to be_nil
653
+ end
654
+
655
+ it 'records a skipped name once per kind' do
656
+ plan = described_class.new
657
+ 2.times { plan.skip( 'clamp', :unguarded_helper ) }
658
+
659
+ expect( plan.skipped.map { |s| [s.item, s.kind] } ).to eq( [['clamp', :unguarded_helper]] )
660
+ end
661
+ end