ratatui_ruby 1.3.0 → 1.4.0

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 (263) hide show
  1. checksums.yaml +4 -4
  2. data/ext/ratatui_ruby/Cargo.lock +2 -1
  3. data/ext/ratatui_ruby/Cargo.toml +2 -1
  4. data/ext/ratatui_ruby/src/events.rs +157 -18
  5. data/lib/ratatui_ruby/test_helper/snapshot.rb +58 -10
  6. data/lib/ratatui_ruby/test_helper/subprocess_timeout.rb +35 -0
  7. data/lib/ratatui_ruby/test_helper.rb +2 -0
  8. data/lib/ratatui_ruby/version.rb +1 -1
  9. metadata +17 -270
  10. data/.builds/ruby-3.2.yml +0 -54
  11. data/.builds/ruby-3.3.yml +0 -54
  12. data/.builds/ruby-3.4.yml +0 -54
  13. data/.builds/ruby-4.0.0.yml +0 -54
  14. data/.pre-commit-config.yaml +0 -16
  15. data/.rubocop.yml +0 -10
  16. data/AGENTS.md +0 -147
  17. data/CHANGELOG.md +0 -771
  18. data/README.md +0 -187
  19. data/README.rdoc +0 -302
  20. data/Rakefile +0 -11
  21. data/Steepfile +0 -50
  22. data/doc/concepts/application_architecture.md +0 -321
  23. data/doc/concepts/application_testing.md +0 -193
  24. data/doc/concepts/async.md +0 -190
  25. data/doc/concepts/custom_widgets.md +0 -247
  26. data/doc/concepts/debugging.md +0 -401
  27. data/doc/concepts/event_handling.md +0 -162
  28. data/doc/concepts/interactive_design.md +0 -146
  29. data/doc/contributors/auditing/parity.md +0 -239
  30. data/doc/contributors/design/ruby_frontend.md +0 -448
  31. data/doc/contributors/design/rust_backend.md +0 -434
  32. data/doc/contributors/design.md +0 -11
  33. data/doc/contributors/developing_examples.md +0 -400
  34. data/doc/contributors/documentation_style.md +0 -121
  35. data/doc/contributors/index.md +0 -21
  36. data/doc/contributors/releasing.md +0 -215
  37. data/doc/contributors/todo/align/api_completeness_audit-finished.md +0 -381
  38. data/doc/contributors/todo/align/api_completeness_audit-unfinished.md +0 -200
  39. data/doc/contributors/todo/align/term.md +0 -351
  40. data/doc/contributors/todo/align/terminal.md +0 -647
  41. data/doc/contributors/todo/future_work.md +0 -169
  42. data/doc/contributors/upstream_requests/paragraph_span_rects.md +0 -259
  43. data/doc/contributors/upstream_requests/tab_rects.md +0 -173
  44. data/doc/contributors/upstream_requests/title_rects.md +0 -132
  45. data/doc/custom.css +0 -22
  46. data/doc/getting_started/quickstart.md +0 -291
  47. data/doc/getting_started/why.md +0 -93
  48. data/doc/images/app_all_events.png +0 -0
  49. data/doc/images/app_cli_rich_moments.gif +0 -0
  50. data/doc/images/app_color_picker.png +0 -0
  51. data/doc/images/app_debugging_showcase.gif +0 -0
  52. data/doc/images/app_debugging_showcase.png +0 -0
  53. data/doc/images/app_external_editor.gif +0 -0
  54. data/doc/images/app_login_form.png +0 -0
  55. data/doc/images/app_stateful_interaction.png +0 -0
  56. data/doc/images/verify_quickstart_dsl.png +0 -0
  57. data/doc/images/verify_quickstart_layout.png +0 -0
  58. data/doc/images/verify_quickstart_lifecycle.png +0 -0
  59. data/doc/images/verify_readme_usage.png +0 -0
  60. data/doc/images/widget_barchart.png +0 -0
  61. data/doc/images/widget_block.png +0 -0
  62. data/doc/images/widget_box.png +0 -0
  63. data/doc/images/widget_calendar.png +0 -0
  64. data/doc/images/widget_canvas.png +0 -0
  65. data/doc/images/widget_cell.png +0 -0
  66. data/doc/images/widget_center.png +0 -0
  67. data/doc/images/widget_chart.png +0 -0
  68. data/doc/images/widget_gauge.png +0 -0
  69. data/doc/images/widget_layout_split.png +0 -0
  70. data/doc/images/widget_line_gauge.png +0 -0
  71. data/doc/images/widget_list.png +0 -0
  72. data/doc/images/widget_map.png +0 -0
  73. data/doc/images/widget_overlay.png +0 -0
  74. data/doc/images/widget_popup.png +0 -0
  75. data/doc/images/widget_ratatui_logo.png +0 -0
  76. data/doc/images/widget_ratatui_mascot.png +0 -0
  77. data/doc/images/widget_rect.png +0 -0
  78. data/doc/images/widget_render.png +0 -0
  79. data/doc/images/widget_rich_text.png +0 -0
  80. data/doc/images/widget_scroll_text.png +0 -0
  81. data/doc/images/widget_scrollbar.png +0 -0
  82. data/doc/images/widget_sparkline.png +0 -0
  83. data/doc/images/widget_style_colors.png +0 -0
  84. data/doc/images/widget_table.png +0 -0
  85. data/doc/images/widget_tabs.png +0 -0
  86. data/doc/images/widget_text_width.png +0 -0
  87. data/doc/index.md +0 -34
  88. data/doc/troubleshooting/async.md +0 -4
  89. data/doc/troubleshooting/terminal_limitations.md +0 -131
  90. data/doc/troubleshooting/tui_output.md +0 -197
  91. data/examples/app_all_events/README.md +0 -114
  92. data/examples/app_all_events/app.rb +0 -98
  93. data/examples/app_all_events/model/app_model.rb +0 -159
  94. data/examples/app_all_events/model/event_color_cycle.rb +0 -43
  95. data/examples/app_all_events/model/event_entry.rb +0 -94
  96. data/examples/app_all_events/model/msg.rb +0 -39
  97. data/examples/app_all_events/model/timestamp.rb +0 -56
  98. data/examples/app_all_events/update.rb +0 -75
  99. data/examples/app_all_events/view/app_view.rb +0 -80
  100. data/examples/app_all_events/view/controls_view.rb +0 -54
  101. data/examples/app_all_events/view/counts_view.rb +0 -61
  102. data/examples/app_all_events/view/live_view.rb +0 -72
  103. data/examples/app_all_events/view/log_view.rb +0 -57
  104. data/examples/app_all_events/view.rb +0 -9
  105. data/examples/app_cli_rich_moments/README.md +0 -81
  106. data/examples/app_cli_rich_moments/app.rb +0 -189
  107. data/examples/app_color_picker/README.md +0 -156
  108. data/examples/app_color_picker/app.rb +0 -76
  109. data/examples/app_color_picker/clipboard.rb +0 -86
  110. data/examples/app_color_picker/color.rb +0 -193
  111. data/examples/app_color_picker/controls.rb +0 -92
  112. data/examples/app_color_picker/copy_dialog.rb +0 -168
  113. data/examples/app_color_picker/export_pane.rb +0 -128
  114. data/examples/app_color_picker/harmony.rb +0 -58
  115. data/examples/app_color_picker/input.rb +0 -176
  116. data/examples/app_color_picker/main_container.rb +0 -180
  117. data/examples/app_color_picker/palette.rb +0 -111
  118. data/examples/app_debugging_showcase/README.md +0 -119
  119. data/examples/app_debugging_showcase/app.rb +0 -318
  120. data/examples/app_external_editor/README.md +0 -62
  121. data/examples/app_external_editor/app.rb +0 -344
  122. data/examples/app_login_form/README.md +0 -58
  123. data/examples/app_login_form/app.rb +0 -109
  124. data/examples/app_stateful_interaction/README.md +0 -35
  125. data/examples/app_stateful_interaction/app.rb +0 -328
  126. data/examples/timeout_demo.rb +0 -45
  127. data/examples/verify_quickstart_dsl/README.md +0 -55
  128. data/examples/verify_quickstart_dsl/app.rb +0 -49
  129. data/examples/verify_quickstart_layout/README.md +0 -77
  130. data/examples/verify_quickstart_layout/app.rb +0 -73
  131. data/examples/verify_quickstart_lifecycle/README.md +0 -68
  132. data/examples/verify_quickstart_lifecycle/app.rb +0 -62
  133. data/examples/verify_readme_usage/README.md +0 -49
  134. data/examples/verify_readme_usage/app.rb +0 -42
  135. data/examples/verify_website_managed/README.md +0 -48
  136. data/examples/verify_website_managed/app.rb +0 -36
  137. data/examples/verify_website_menu/README.md +0 -60
  138. data/examples/verify_website_menu/app.rb +0 -84
  139. data/examples/verify_website_spinner/README.md +0 -44
  140. data/examples/verify_website_spinner/app.rb +0 -34
  141. data/examples/widget_barchart/README.md +0 -58
  142. data/examples/widget_barchart/app.rb +0 -240
  143. data/examples/widget_block/README.md +0 -44
  144. data/examples/widget_block/app.rb +0 -258
  145. data/examples/widget_box/README.md +0 -54
  146. data/examples/widget_box/app.rb +0 -255
  147. data/examples/widget_calendar/README.md +0 -48
  148. data/examples/widget_calendar/app.rb +0 -115
  149. data/examples/widget_canvas/README.md +0 -31
  150. data/examples/widget_canvas/app.rb +0 -130
  151. data/examples/widget_cell/README.md +0 -45
  152. data/examples/widget_cell/app.rb +0 -112
  153. data/examples/widget_center/README.md +0 -33
  154. data/examples/widget_center/app.rb +0 -118
  155. data/examples/widget_chart/README.md +0 -50
  156. data/examples/widget_chart/app.rb +0 -220
  157. data/examples/widget_gauge/README.md +0 -50
  158. data/examples/widget_gauge/app.rb +0 -229
  159. data/examples/widget_layout_split/README.md +0 -53
  160. data/examples/widget_layout_split/app.rb +0 -260
  161. data/examples/widget_line_gauge/README.md +0 -50
  162. data/examples/widget_line_gauge/app.rb +0 -219
  163. data/examples/widget_list/README.md +0 -58
  164. data/examples/widget_list/app.rb +0 -382
  165. data/examples/widget_map/README.md +0 -48
  166. data/examples/widget_map/app.rb +0 -95
  167. data/examples/widget_overlay/README.md +0 -45
  168. data/examples/widget_overlay/app.rb +0 -250
  169. data/examples/widget_popup/README.md +0 -45
  170. data/examples/widget_popup/app.rb +0 -106
  171. data/examples/widget_ratatui_logo/README.md +0 -43
  172. data/examples/widget_ratatui_logo/app.rb +0 -104
  173. data/examples/widget_ratatui_mascot/README.md +0 -43
  174. data/examples/widget_ratatui_mascot/app.rb +0 -95
  175. data/examples/widget_rect/README.md +0 -53
  176. data/examples/widget_rect/app.rb +0 -222
  177. data/examples/widget_render/README.md +0 -46
  178. data/examples/widget_render/app.rb +0 -186
  179. data/examples/widget_render/app.rbs +0 -41
  180. data/examples/widget_rich_text/README.md +0 -44
  181. data/examples/widget_rich_text/app.rb +0 -193
  182. data/examples/widget_scroll_text/README.md +0 -46
  183. data/examples/widget_scroll_text/app.rb +0 -109
  184. data/examples/widget_scrollbar/README.md +0 -46
  185. data/examples/widget_scrollbar/app.rb +0 -155
  186. data/examples/widget_sparkline/README.md +0 -51
  187. data/examples/widget_sparkline/app.rb +0 -277
  188. data/examples/widget_style_colors/README.md +0 -43
  189. data/examples/widget_style_colors/app.rb +0 -83
  190. data/examples/widget_table/README.md +0 -57
  191. data/examples/widget_table/app.rb +0 -285
  192. data/examples/widget_tabs/README.md +0 -50
  193. data/examples/widget_tabs/app.rb +0 -183
  194. data/examples/widget_text_width/README.md +0 -44
  195. data/examples/widget_text_width/app.rb +0 -117
  196. data/migrate_to_buffer.rb +0 -145
  197. data/mise.toml +0 -8
  198. data/tasks/autodoc/examples.rb +0 -87
  199. data/tasks/autodoc/member.rb +0 -58
  200. data/tasks/autodoc/name.rb +0 -21
  201. data/tasks/autodoc.rake +0 -21
  202. data/tasks/bump/bump_workflow.rb +0 -49
  203. data/tasks/bump/cargo_lockfile.rb +0 -21
  204. data/tasks/bump/changelog.rb +0 -104
  205. data/tasks/bump/header.rb +0 -32
  206. data/tasks/bump/history.rb +0 -32
  207. data/tasks/bump/links.rb +0 -69
  208. data/tasks/bump/manifest.rb +0 -33
  209. data/tasks/bump/patch_release.rb +0 -19
  210. data/tasks/bump/release_branch.rb +0 -17
  211. data/tasks/bump/release_from_trunk.rb +0 -49
  212. data/tasks/bump/repository.rb +0 -54
  213. data/tasks/bump/ruby_gem.rb +0 -29
  214. data/tasks/bump/sem_ver.rb +0 -44
  215. data/tasks/bump/unreleased_section.rb +0 -73
  216. data/tasks/bump.rake +0 -61
  217. data/tasks/doc/documentation.rb +0 -59
  218. data/tasks/doc/link/file_url.rb +0 -30
  219. data/tasks/doc/link/relative_path.rb +0 -61
  220. data/tasks/doc/link/web_url.rb +0 -55
  221. data/tasks/doc/link.rb +0 -52
  222. data/tasks/doc/link_audit.rb +0 -116
  223. data/tasks/doc/problem.rb +0 -40
  224. data/tasks/doc/source_file.rb +0 -93
  225. data/tasks/doc.rake +0 -905
  226. data/tasks/example_viewer.html.erb +0 -172
  227. data/tasks/extension.rake +0 -14
  228. data/tasks/license/headers_md.rb +0 -223
  229. data/tasks/license/headers_rb.rb +0 -210
  230. data/tasks/license/license_utils.rb +0 -130
  231. data/tasks/license/snippets_md.rb +0 -315
  232. data/tasks/license/snippets_rdoc.rb +0 -150
  233. data/tasks/license.rake +0 -91
  234. data/tasks/lint.rake +0 -170
  235. data/tasks/rbs_predicates/predicate_catalog.rb +0 -52
  236. data/tasks/rbs_predicates/predicate_tests.rb +0 -124
  237. data/tasks/rbs_predicates/rbs_signature.rb +0 -63
  238. data/tasks/rbs_predicates.rake +0 -31
  239. data/tasks/rdoc_config.rb +0 -29
  240. data/tasks/resources/build.yml.erb +0 -60
  241. data/tasks/resources/index.html.erb +0 -141
  242. data/tasks/resources/rubies.yml +0 -7
  243. data/tasks/sourcehut.rake +0 -122
  244. data/tasks/steep.rake +0 -11
  245. data/tasks/terminal_preview/app_screenshot.rb +0 -45
  246. data/tasks/terminal_preview/crash_report.rb +0 -54
  247. data/tasks/terminal_preview/example_app.rb +0 -27
  248. data/tasks/terminal_preview/launcher_script.rb +0 -48
  249. data/tasks/terminal_preview/preview_collection.rb +0 -60
  250. data/tasks/terminal_preview/preview_timing.rb +0 -24
  251. data/tasks/terminal_preview/safety_confirmation.rb +0 -58
  252. data/tasks/terminal_preview/saved_screenshot.rb +0 -56
  253. data/tasks/terminal_preview/system_appearance.rb +0 -13
  254. data/tasks/terminal_preview/terminal_window.rb +0 -138
  255. data/tasks/terminal_preview/window_id.rb +0 -16
  256. data/tasks/terminal_preview.rake +0 -30
  257. data/tasks/test.rake +0 -36
  258. data/tasks/website/index_page.rb +0 -30
  259. data/tasks/website/version.rb +0 -122
  260. data/tasks/website/version_menu.rb +0 -68
  261. data/tasks/website/versioned_documentation.rb +0 -83
  262. data/tasks/website/website.rb +0 -53
  263. data/tasks/website.rake +0 -28
data/migrate_to_buffer.rb DELETED
@@ -1,145 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- #
6
- # SPDX-License-Identifier: AGPL-3.0-or-later
7
- #++
8
-
9
- # !/usr/bin/env ruby
10
-
11
- # Migration script to refactor widget renderers from Frame to Buffer
12
-
13
- require "fileutils"
14
-
15
- WIDGETS_DIR = "/Users/kerrick/Developer/ratatui_ruby/ext/ratatui_ruby/src/widgets"
16
-
17
- # Files to update (excluding block.rs which is already done)
18
- WIDGET_FILES = %w[
19
- barchart.rs
20
- calendar.rs
21
- canvas.rs
22
- center.rs
23
- chart.rs
24
- clear.rs
25
- cursor.rs
26
- gauge.rs
27
- layout.rs
28
- line_gauge.rs
29
- list.rs
30
- overlay.rs
31
- paragraph.rs
32
- ratatui_logo.rs
33
- ratatui_mascot.rs
34
- scrollbar.rs
35
- sparkline.rs
36
- table.rs
37
- tabs.rs
38
- ].freeze
39
-
40
- def migrate_file(filepath)
41
- puts "Migrating #{File.basename(filepath)}..."
42
-
43
- content = File.read(filepath)
44
- original_content = content.dup
45
-
46
- # 1. Update function signature
47
- content.gsub!("pub fn render(frame: &mut Frame,", "pub fn render(buffer: &mut Buffer,")
48
- content.gsub!("pub fn render_ratatui_mascot(frame: &mut Frame,", "pub fn render_ratatui_mascot(buffer: &mut Buffer,")
49
-
50
- # 2. Update imports - Add Buffer, remove Frame
51
- # Handle various import patterns
52
- content.gsub!(/use ratatui::\{([^}]*),\s*Frame\s*\};/, 'use ratatui::{\1};')
53
- content.gsub!(/use ratatui::\{Frame,\s*([^}]*)\};/, 'use ratatui::{\1};')
54
- content.gsub!("use ratatui::Frame;", "")
55
-
56
- # Add Buffer import if not present
57
- unless content.match?(/use ratatui::(?:\{[^}]*)?buffer::Buffer/)
58
- # Find the ratatui use statement and add buffer::Buffer
59
- content.gsub!("use ratatui::{", "use ratatui::{buffer::Buffer, ")
60
- content.gsub!("use ratatui::layout::Rect;", "use ratatui::{buffer::Buffer, layout::Rect};")
61
- end
62
-
63
- # 3. Update widget.render calls
64
- # frame.render_widget(widget, area) → widget.render(area, buffer)
65
- content.gsub!(/frame\.render_widget\(([^,]+),\s*([^)]+)\)/, '\1.render(\2, buffer)')
66
-
67
- # 4. Update direct buffer access
68
- content.gsub!("frame.buffer_mut()", "buffer")
69
-
70
- # 5. Update recursive render_node calls
71
- content.gsub!("render_node(frame,", "render_node(buffer,")
72
-
73
- # 5.5. Update stateful widget rendering
74
- # frame.render_stateful_widget(widget, area, state) → StatefulWidget::render(widget, area, buffer, state)
75
- content.gsub!(/frame\.render_stateful_widget\(([^,]+),\s*([^,]+),\s*([^)]+)\)/, 'StatefulWidget::render(\1, \2, buffer, \3)')
76
-
77
- # Add StatefulWidget import if stateful widgets are used
78
- if content.match?(/StatefulWidget::render/) && !content.match?(/use ratatui::widgets::StatefulWidget/) && content.match?(/use ratatui::/)
79
- content.sub!("use ratatui::{", "use ratatui::{widgets::StatefulWidget, ")
80
- end
81
-
82
- # 6. Clean up any double-added Buffer imports and duplicate Widget imports
83
- content.gsub!(/buffer::Buffer,\s*buffer::Buffer,/, "buffer::Buffer,")
84
- content.gsub!(/widgets::Widget,\s*widgets::Widget/, "widgets::Widget")
85
- content.gsub!(/(use ratatui::\{[^}]*widgets::Widget[^}]*),\s*widgets::Widget/, '\1')
86
-
87
- # 7. Fix Widget trait usage - make sure Widget is imported where .render is called
88
- # Add Widget to imports if calling .render on widgets
89
- if content.match?(/\.render\(area,\s*buffer\)/) && !content.match?(/use ratatui::widgets::Widget/) && content.match?(/use ratatui::\{/) && !content.match?(/widgets::Widget/)
90
- content.sub!("use ratatui::{", "use ratatui::{widgets::Widget, ")
91
- end
92
-
93
- # 8. For files that don't have proper Buffer imports yet, add them
94
- if !content.match?(/use ratatui::\{[^}]*buffer::Buffer/) && content.match?(/use ratatui::/)
95
- # Try to add to first ratatui import
96
- content.sub!("use ratatui::", "use ratatui::{buffer::Buffer};\nuse ratatui::")
97
- end
98
-
99
- # 9. Special case: cursor.rs uses frame.set_cursor_position which doesn't exist on Buffer
100
- # Cursor widget needs special handling - it can't work with just Buffer
101
- if File.basename(filepath) == "cursor.rs"
102
- puts " ⚠ cursor.rs requires special handling - skipping set_cursor_position"
103
- # This widget can't be fully migrated as set_cursor_position is Frame-only
104
- # Will need manual fix or different approach
105
- end
106
- # Only write if content changed
107
- if content != original_content
108
- File.write(filepath, content)
109
- puts " ✓ Updated #{File.basename(filepath)}"
110
- true
111
- else
112
- puts " - No changes needed for #{File.basename(filepath)}"
113
- false
114
- end
115
- end
116
-
117
- def main
118
- puts "Starting widget renderer migration..."
119
- puts "=" * 60
120
-
121
- updated_count = 0
122
-
123
- WIDGET_FILES.each do |filename|
124
- filepath = File.join(WIDGETS_DIR, filename)
125
-
126
- unless File.exist?(filepath)
127
- puts " ⚠ File not found: #{filename}"
128
- next
129
- end
130
-
131
- # Create backup
132
- backup_path = "#{filepath}.premigration"
133
- FileUtils.cp(filepath, backup_path) unless File.exist?(backup_path)
134
-
135
- updated_count += 1 if migrate_file(filepath)
136
- end
137
-
138
- puts "=" * 60
139
- puts "Migration complete!"
140
- puts " Files updated: #{updated_count}/#{WIDGET_FILES.length}"
141
- puts "\nBackups saved with .premigration extension"
142
- puts "Run 'bundle exec rake compile' to verify the changes"
143
- end
144
-
145
- main if __FILE__ == $PROGRAM_NAME
data/mise.toml DELETED
@@ -1,8 +0,0 @@
1
- # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
2
- # SPDX-License-Identifier: AGPL-3.0-or-later
3
-
4
- [tools]
5
- ruby = "4.0.0"
6
- rust = "1.91.1"
7
- python = "3.12"
8
- pre-commit = "latest"
@@ -1,87 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- module Autodoc
9
- class Examples
10
- def self.sync
11
- new.sync
12
- end
13
-
14
- def sync
15
- Dir.glob("{README.md,doc/**/*.md,examples/*/README.md}").each do |readme_path|
16
- sync_readme(readme_path)
17
- end
18
- end
19
-
20
- private def sync_readme(readme_path)
21
- content = File.read(readme_path)
22
- dir = File.dirname(readme_path)
23
-
24
- new_content = content.gsub(/<!-- SYNC:START:([^ ]+) -->.*?<!-- SYNC:END -->/m) do
25
- marker_info = $1
26
- source_rel_path, segment_id = marker_info.split(":")
27
-
28
- # Support both repo-root-relative paths (no leading ./) and file-relative paths
29
- source_path = if source_rel_path.start_with?("./", "../")
30
- File.join(dir, source_rel_path)
31
- else
32
- source_rel_path # Already relative to repo root
33
- end
34
-
35
- unless File.exist?(source_path)
36
- warn "Warning: Source file not found: #{source_path}"
37
- next $&
38
- end
39
-
40
- source_content = File.read(source_path)
41
- extracted_content = if segment_id
42
- extract_segment(source_content, segment_id, source_path)
43
- else
44
- source_content
45
- end
46
-
47
- # Detect language from extension
48
- ext = File.extname(source_path).delete(".")
49
- lang = (ext == "rb") ? "ruby" : ext
50
-
51
- # Build replacement
52
- "<!-- SYNC:START:#{marker_info} -->\n```#{lang}\n#{extracted_content}```\n<!-- SYNC:END -->"
53
- end
54
-
55
- if new_content != content
56
- puts "Syncing #{readme_path}..."
57
- File.write(readme_path, new_content)
58
- end
59
- end
60
-
61
- def extract_segment(content, segment_id, source_path)
62
- start_marker = /#\s*\[SYNC:START:#{segment_id}\]/
63
- end_marker = /#\s*\[SYNC:END:#{segment_id}\]/
64
-
65
- lines = content.lines
66
- start_idx = lines.find_index { |l| l =~ start_marker }
67
- end_idx = lines.find_index { |l| l =~ end_marker }
68
-
69
- if start_idx && end_idx
70
- "#{unindent(lines[(start_idx + 1)...end_idx].join).strip}\n"
71
- else
72
- warn "Warning: Segment '#{segment_id}' not found in #{source_path}"
73
- content # Fallback to full content or error? Let's fallback to original for now.
74
- end
75
- end
76
-
77
- def unindent(text)
78
- lines = text.lines
79
- # Don't unindent if empty or just one line
80
- return text if lines.empty?
81
-
82
- # Find common leading whitespace
83
- indentation = lines.grep(/\S/).map { |l| l[/^\s*/].length }.min || 0
84
- lines.map { |l| (l.length > indentation) ? l[indentation..-1] : "#{l.strip}\n" }.join
85
- end
86
- end
87
- end
@@ -1,58 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- module Autodoc
9
- module Member
10
- class Delegate < Data.define(:name)
11
- def rbs
12
- " def #{name}: (*untyped args, **untyped kwargs) ?{ (*untyped) -> untyped } -> untyped"
13
- end
14
-
15
- def rdoc
16
- [
17
- " # :method: #{name}",
18
- " # :call-seq: #{name}(*args, **kwargs, &block)",
19
- " #",
20
- " # Delegates to RatatuiRuby.#{name}.",
21
- " #",
22
- ]
23
- end
24
- end
25
-
26
- class Factory < Data.define(:name, :const_name)
27
- def rbs
28
- " def #{name}: (*untyped args, **untyped kwargs) ?{ (*untyped) -> untyped } -> untyped"
29
- end
30
-
31
- def rdoc
32
- [
33
- " # :method: #{name}",
34
- " # :call-seq: #{name}(*args, **kwargs, &block)",
35
- " #",
36
- " # Factory for RatatuiRuby::#{const_name}.new.",
37
- " #",
38
- ]
39
- end
40
- end
41
-
42
- class Helper < Data.define(:name, :class_method, :const_name)
43
- def rbs
44
- " def #{name}: (*untyped args, **untyped kwargs) ?{ (*untyped) -> untyped } -> untyped"
45
- end
46
-
47
- def rdoc
48
- [
49
- " # :method: #{name}",
50
- " # :call-seq: #{name}(*args, **kwargs, &block)",
51
- " #",
52
- " # Helper for RatatuiRuby::#{const_name}.#{class_method}.",
53
- " #",
54
- ]
55
- end
56
- end
57
- end
58
- end
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- module Autodoc
9
- class Name < Data.define(:string)
10
- def snake
11
- string.to_s
12
- .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
13
- .gsub(/([a-z\d])([A-Z])/, '\1_\2')
14
- .downcase
15
- end
16
-
17
- def to_s
18
- string.to_s
19
- end
20
- end
21
- end
data/tasks/autodoc.rake DELETED
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- require_relative "autodoc/examples"
9
-
10
- namespace :autodoc do
11
- desc "Update all automatically generated documentation"
12
- task all: [:examples]
13
-
14
- desc "Sync code snippets in example READMEs with source files"
15
- task :examples do
16
- Autodoc::Examples.sync
17
- end
18
- end
19
-
20
- desc "Update all automatically generated documentation"
21
- task autodoc: "autodoc:all"
@@ -1,49 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- require_relative "repository"
9
- require_relative "changelog"
10
-
11
- # Base class for version bump workflows.
12
- # Subclasses implement the template methods: prepare, release_on_branch, finalize.
13
- class BumpWorkflow
14
- def initialize(gem:, repository: Repository.new)
15
- @gem = gem
16
- @repository = repository
17
- end
18
-
19
- def call(segment)
20
- @repository.assert_can_bump!(segment)
21
- @target = @gem.version.next(segment)
22
-
23
- prepare(segment)
24
- release_on_branch
25
- finalize
26
- end
27
-
28
- attr_reader :target
29
-
30
- private def release_on_branch
31
- changelog = Changelog.new
32
- @commit_message = changelog.commit_message(target)
33
- changelog.release(target)
34
- @gem.update_version(target)
35
- generate_ci_manifests
36
- @repository.commit_all(@commit_message)
37
- end
38
-
39
- private def generate_ci_manifests
40
- Rake::Task["sourcehut:build:manifest"].reenable
41
- Rake::Task["sourcehut:build"].reenable
42
- Rake::Task["sourcehut"].reenable
43
- Rake::Task["sourcehut"].invoke
44
- end
45
-
46
- # Template methods for subclasses
47
- private def prepare(segment) = nil
48
- private def finalize = nil
49
- end
@@ -1,21 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- # Lockfiles need to be refreshed by a tool after Manifests are changed.
9
- class CargoLockfile < Data.define(:path, :dir, :name)
10
- def exists?
11
- File.exist?(path)
12
- end
13
-
14
- def refresh
15
- return unless exists?
16
-
17
- Dir.chdir(dir) do
18
- system("cargo update -p #{name} --offline")
19
- end
20
- end
21
- end
@@ -1,104 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- require_relative "links"
9
- require_relative "unreleased_section"
10
- require_relative "history"
11
- require_relative "header"
12
-
13
- # Changelog manages the project's CHANGELOG.md file.
14
- class Changelog
15
- # Creates a new Changelog for the file at the given path.
16
- def initialize(path: "CHANGELOG.md")
17
- @path = path
18
- end
19
-
20
- # Releases a new version in the changelog.
21
- # This moves the unreleased changes to a new version heading and resets the unreleased section.
22
- def release(new_version)
23
- content = File.read(@path)
24
-
25
- header = Header.parse(content)
26
- unreleased = UnreleasedSection.parse(content)
27
- links = Links.from_markdown(content)
28
-
29
- raise "Could not parse CHANGELOG.md" unless header && unreleased && links
30
-
31
- history = History.parse(content, header.length, unreleased.to_s.length, links.to_s)
32
-
33
- links.release(new_version)
34
- history.add(unreleased.as_version(new_version))
35
-
36
- File.write(@path, "#{header}#{UnreleasedSection.fresh}\n\n#{history}\n#{links}")
37
- nil
38
- end
39
-
40
- # Removes entries from [Unreleased] that were released in the given version.
41
- # Used when creating a release branch from trunk.
42
- def prune_released_entries(released_entries)
43
- content = File.read(@path)
44
-
45
- header = Header.parse(content)
46
- unreleased = UnreleasedSection.parse(content)
47
- links = Links.from_markdown(content)
48
-
49
- raise "Could not parse CHANGELOG.md" unless header && unreleased && links
50
-
51
- history = History.parse(content, header.length, unreleased.to_s.length, links.to_s)
52
-
53
- pruned = unreleased.without_entries(released_entries)
54
-
55
- File.write(@path, "#{header}#{pruned}\n\n#{history}\n#{links}")
56
- nil
57
- end
58
-
59
- # Imports a release section from another branch's changelog.
60
- # Adds the version section to history and dedupes from [Unreleased].
61
- # Uses "first wins" — if entry already deduped, doesn't re-add it.
62
- def import_release(version, release_changelog_content)
63
- release_section = extract_version_section(release_changelog_content, version)
64
- return unless release_section
65
-
66
- content = File.read(@path)
67
-
68
- header = Header.parse(content)
69
- unreleased = UnreleasedSection.parse(content)
70
- links = Links.from_markdown(content)
71
-
72
- raise "Could not parse CHANGELOG.md" unless header && unreleased && links
73
-
74
- history = History.parse(content, header.length, unreleased.to_s.length, links.to_s)
75
-
76
- # Add the release section to history (inserted in version order)
77
- history.add(release_section)
78
- links.release(version)
79
-
80
- # Dedupe from [Unreleased] (first-wins: if already gone, no-op)
81
- release_entries = release_section.lines.select { |l| l.strip.start_with?("- ") }.map(&:strip)
82
- pruned = unreleased.without_entries(release_entries)
83
-
84
- File.write(@path, "#{header}#{pruned}\n\n#{history}\n#{links}")
85
- nil
86
- end
87
-
88
- def commit_message(version)
89
- content = File.read(@path)
90
- unreleased = UnreleasedSection.parse(content)
91
- return nil unless unreleased
92
-
93
- "chore: release v#{version}\n\n#{unreleased.commit_body}"
94
- end
95
-
96
- private def extract_version_section(changelog_content, version)
97
- # Match the version heading and capture until the next version heading or links section
98
- pattern = /^## \[#{Regexp.escape(version.to_s)}\][^\n]*\n(.*?)(?=^## \[|\n\[Unreleased\]:)/m
99
- match = changelog_content.match(pattern)
100
- return nil unless match
101
-
102
- "## [#{version}]#{match[0].split("\n", 2).first.split(']', 2).last}\n#{match[1]}"
103
- end
104
- end
data/tasks/bump/header.rb DELETED
@@ -1,32 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- # Header manages the header section of the changelog.
9
- class Header
10
- PATTERN = /^(.*?)(?=## \[Unreleased\])/m
11
-
12
- # Extracts the header section from the given content.
13
- def self.parse(content)
14
- match = content.match(PATTERN)
15
- new(match[1]) if match
16
- end
17
-
18
- # Creates a new Header from the given content.
19
- def initialize(content)
20
- @content = content.dup
21
- end
22
-
23
- # Returns the length of the header content.
24
- def length
25
- @content.length
26
- end
27
-
28
- # Returns the current state of the header as a string.
29
- def to_s
30
- @content
31
- end
32
- end
@@ -1,32 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- # History manages the versioned history of the changelog.
9
- class History
10
- # Extracts the history section from the given content, between unreleased and links.
11
- def self.parse(content, header_length, unreleased_length, links_text)
12
- start = header_length + unreleased_length
13
- text = "#{content[start...(content.index(links_text))].strip}\n"
14
- new(text)
15
- end
16
-
17
- # Creates a new History from the given content.
18
- def initialize(content)
19
- @content = content.dup
20
- end
21
-
22
- # Adds a new versioned section to the history.
23
- def add(section)
24
- @content = "#{"#{section}\n\n#{@content}".strip}\n"
25
- nil
26
- end
27
-
28
- # Returns the current state of the history as a string.
29
- def to_s
30
- @content
31
- end
32
- end
data/tasks/bump/links.rb DELETED
@@ -1,69 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- # Manages the version comparison links at the botton of the changelog.
9
- #
10
- # Release automation needs to update links. Manually calculating git diff URLs
11
- # for every release is tedious and error-prone. SourceHut does not have
12
- # standard comparison views, complicating matters further.
13
- #
14
- # This class manages the collection of links. It parses them from the markdown.
15
- # It generates the correct tree links for SourceHut. It properly shifts the
16
- # "Unreleased" pointer.
17
- #
18
- # Use it to update the changelog during a release.
19
- class Links
20
- PATTERN = /^(\[Unreleased\]: .*)$/m
21
- UNRELEASED_PATTERN = %r{^\[Unreleased\]: (.*?/refs/)HEAD$}
22
-
23
- # Creates a Links object from the full markdown content.
24
- #
25
- # [content] String. The full text of the changelog.
26
- def self.from_markdown(content)
27
- match = content.match(PATTERN)
28
- return unless match
29
-
30
- new(match[1].strip)
31
- end
32
-
33
- # Returns the raw text of the links.
34
- attr_reader :text
35
-
36
- # Creates a new Links object.
37
- #
38
- # [text] String. The raw text of the links section.
39
- def initialize(text)
40
- @text = text.dup
41
- end
42
-
43
- # Releases a new version.
44
- #
45
- # Updates the "Unreleased" link to point to the new head. Adds a new link for
46
- # the just-released version pointing to its specific tag.
47
- #
48
- # [version] String. The new version number (e.g., <tt>"0.5.0"</tt>).
49
- def release(version)
50
- return unless base_url
51
-
52
- new_unreleased = "[Unreleased]: #{base_url}HEAD" # .../HEAD
53
- new_version_link = "[#{version}]: #{base_url}v#{version}" # .../v1.0.0
54
-
55
- @text.sub!(UNRELEASED_PATTERN, "#{new_unreleased}\n#{new_version_link}")
56
- self
57
- end
58
-
59
- # Returns the string representation of the links.
60
- def to_s
61
- @text
62
- end
63
-
64
- # The base URL for the repository's references.
65
- private def base_url
66
- match = @text.match(UNRELEASED_PATTERN)
67
- match[1] if match
68
- end
69
- end
@@ -1,33 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- #--
4
- # SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
5
- # SPDX-License-Identifier: AGPL-3.0-or-later
6
- #++
7
-
8
- # Manifests hold a copy of the version number and should be changed manually.
9
- # Use Regexp lookarounds in `pattern` to match the version number.
10
- class Manifest < Data.define(:path, :pattern, :primary)
11
- def read
12
- File.read(path)
13
- end
14
-
15
- def initialize(path:, pattern:, primary: false)
16
- super
17
- end
18
-
19
- def version
20
- content = read
21
- match = content.match(pattern)
22
- raise "Version missing in manifest #{path}" unless match
23
-
24
- SemVer.parse(match[0])
25
- end
26
-
27
- def write(version)
28
- return unless File.exist?(path)
29
-
30
- new_content = read.gsub(pattern, version.to_s)
31
- File.write(path, new_content)
32
- end
33
- end