ratatui_ruby 0.4.0 → 0.5.0

data/tasks/website/versioned_documentation.rb

@@ -12,38 +12,70 @@ class VersionedDocumentation
 
   def publish_to(path, project_name:, globs:, assets: [])
     puts "Building documentation for #{@version.name}..."
-    
+
     absolute_path = File.absolute_path(path)
     gemfile_path = File.absolute_path("Gemfile")
     custom_css_path = File.absolute_path("doc/custom.css")
+    rakefile_path = File.absolute_path("Rakefile")
+    tasks_dir_path = File.absolute_path("tasks")
+
+    @version.checkout(globs:) do |source_path|
+      # Copy current Rakefile and tasks into the temp directory
+      # This ensures all versions use the latest example generation logic
+      FileUtils.cp(rakefile_path, File.join(source_path, "Rakefile"))
+      FileUtils.cp_r(tasks_dir_path, File.join(source_path, "tasks"))
 
-    @version.checkout(globs: globs) do |source_path|
       Dir.chdir(source_path) do
         title = "#{project_name} #{@version.name}"
         title = "#{project_name} (main)" if @version.edge?
-        
-        # We need to expand globs relative to the source path
-        files = globs.flat_map { |glob| Dir[glob] }.uniq
-        
-        system(
-          { "BUNDLE_GEMFILE" => gemfile_path },
-          "bundle exec rdoc -o #{absolute_path} --main #{RDocConfig::MAIN} --title '#{title}' --template-stylesheets \"#{custom_css_path}\" #{files.join(' ')}"
+
+        # Use rake rerdoc to ensure copy_examples runs
+        # Set environment variables to override rdoc settings
+        success = system(
+          {
+            "BUNDLE_GEMFILE" => gemfile_path,
+            "RDOC_OUTPUT" => absolute_path,
+            "RDOC_TITLE" => title,
+            "RDOC_CUSTOM_CSS" => custom_css_path,
+          },
+          "bundle exec rake rerdoc"
         )
 
+        # Fall back to direct rdoc call if rake fails for any reason
+        unless success
+          puts "  Rake task failed, falling back to direct rdoc call..."
+          files = globs.flat_map { |glob| Dir[glob] }.uniq
+          system(
+            { "BUNDLE_GEMFILE" => gemfile_path },
+            "bundle exec rdoc -o #{absolute_path} --main #{RDocConfig::MAIN} --title '#{title}' --template-stylesheets \"#{custom_css_path}\" #{files.join(' ')}"
+          )
+        end
+
+        # Copy generated documentation to target path if it was generated elsewhere
+        # This handles cases where RDOC_OUTPUT wasn't respected (evaluated at load time)
+        temp_output_paths = ["tmp/rdoc", "doc"]
+        temp_output_paths.each do |temp_path|
+          # Check if this looks like generated rdoc (has index.html)
+          if Dir.exist?(temp_path) && !Dir.empty?(temp_path) && File.exist?(File.join(temp_path, "index.html"))
+            puts "  Copying generated docs from #{temp_path} to #{absolute_path}..."
+            FileUtils.mkdir_p(absolute_path)
+            FileUtils.cp_r Dir["#{temp_path}/*"], absolute_path
+            break
+          end
+        end
+
         copy_assets_to(absolute_path, assets)
       end
     end
   end
 
-  private
-
-  def copy_assets_to(path, assets)
+  private def copy_assets_to(path, assets)
     assets.each do |asset_dir|
-       if Dir.exist?(asset_dir)
-         destination = File.join(path, asset_dir)
-         FileUtils.mkdir_p(destination)
-         FileUtils.cp_r Dir["#{asset_dir}/*"], destination
-       end
+      if Dir.exist?(asset_dir)
+        destination = File.join(path, asset_dir)
+        FileUtils.mkdir_p(destination)
+        FileUtils.cp_r Dir["#{asset_dir}/*"], destination
+      end
     end
   end
 end

data/tasks/website/website.rb

@@ -19,11 +19,11 @@ class Website
 
   def build
     clean
-    
+
     versions.each do |version|
       VersionedDocumentation.new(version).publish_to(
-        join(version.slug), 
-        project_name: @project_name, 
+        join(version.slug),
+        project_name: @project_name,
         globs: @globs,
         assets: @assets
       )
@@ -31,7 +31,7 @@ class Website
 
     IndexPage.new(versions).publish_to(join("index.html"), project_name: @project_name)
 
-    VersionMenu.new(root: @destination, versions: versions).run
+    VersionMenu.new(root: @destination, versions:).run
 
     puts "Website built in #{@destination}/"
   end
@@ -40,13 +40,11 @@ class Website
     @versions ||= Version.all
   end
 
-  private
-
-  def join(path)
+  private def join(path)
     File.join(@destination, path)
   end
 
-  def clean
+  private def clean
     FileUtils.rm_rf(@destination)
     FileUtils.mkdir_p(@destination)
   end

data/tasks/website.rake

@@ -12,14 +12,14 @@ namespace :website do
   desc "Build documentation for main (current dir) and all git tags"
   task :build do
     require_relative "website/website"
-    
+
     spec = Gem::Specification.load(Dir["*.gemspec"].first)
-    globs = RDocConfig::RDOC_FILES + ["*.gemspec", "doc/images/**/*"]
-    
+    globs = RDocConfig::RDOC_FILES + ["*.gemspec", "doc/images/**/*", "examples/**/*"]
+
     Website.new(
       at: "www",
       project_name: spec.name,
-      globs: globs,
+      globs:,
       assets: ["doc/images"] # directories to copy
     ).build
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratatui_ruby
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Kerrick Long
@@ -84,7 +84,6 @@ files:
 - CHANGELOG.md
 - LICENSE
 - LICENSES/AGPL-3.0-or-later.txt
-- LICENSES/BSD-2-Clause.txt
 - LICENSES/CC-BY-SA-4.0.txt
 - LICENSES/CC0-1.0.txt
 - LICENSES/MIT.txt
@@ -93,143 +92,121 @@ files:
 - Rakefile
 - doc/application_architecture.md
 - doc/application_testing.md
-- doc/contributors/better_dx.md
 - doc/contributors/design.md
 - doc/contributors/design/ruby_frontend.md
 - doc/contributors/design/rust_backend.md
 - doc/contributors/developing_examples.md
 - doc/contributors/documentation_style.md
 - doc/contributors/dwim_dx.md
-- doc/contributors/example_analysis.md
 - doc/contributors/index.md
 - doc/custom.css
 - doc/event_handling.md
-- doc/images/all_events.png
-- doc/images/analytics.png
-- doc/images/block_padding.png
-- doc/images/block_titles.png
-- doc/images/box_demo.png
-- doc/images/calendar_demo.png
-- doc/images/cell_demo.png
-- doc/images/chart_demo.png
-- doc/images/custom_widget.png
-- doc/images/flex_layout.png
-- doc/images/gauge_demo.png
-- doc/images/hit_test.png
-- doc/images/line_gauge_demo.png
-- doc/images/list_demo.png
-- doc/images/list_styles.png
-- doc/images/login_form.png
-- doc/images/map_demo.png
-- doc/images/mouse_events.png
-- doc/images/popup_demo.png
-- doc/images/quickstart_dsl.png
-- doc/images/quickstart_lifecycle.png
-- doc/images/ratatui_logo_demo.png
-- doc/images/readme_usage.png
-- doc/images/rich_text.png
-- doc/images/scroll_text.png
-- doc/images/scrollbar_demo.png
-- doc/images/sparkline_demo.png
-- doc/images/table_flex.png
-- doc/images/table_select.png
+- doc/images/app_all_events.png
+- doc/images/app_analytics.png
+- doc/images/app_color_picker.png
+- doc/images/app_custom_widget.png
+- doc/images/app_login_form.png
+- doc/images/app_map_demo.png
+- doc/images/app_mouse_events.png
+- doc/images/app_table_select.png
+- doc/images/verify_quickstart_dsl.png
+- doc/images/verify_quickstart_layout.png
+- doc/images/verify_quickstart_lifecycle.png
+- doc/images/verify_readme_usage.png
+- doc/images/widget_barchart_demo.png
+- doc/images/widget_block_padding.png
+- doc/images/widget_block_titles.png
+- doc/images/widget_box_demo.png
+- doc/images/widget_calendar_demo.png
+- doc/images/widget_cell_demo.png
+- doc/images/widget_chart_demo.png
+- doc/images/widget_gauge_demo.png
+- doc/images/widget_layout_split.png
+- doc/images/widget_line_gauge_demo.png
+- doc/images/widget_list_demo.png
+- doc/images/widget_list_styles.png
+- doc/images/widget_popup_demo.png
+- doc/images/widget_ratatui_logo_demo.png
+- doc/images/widget_ratatui_mascot_demo.png
+- doc/images/widget_rect.png
+- doc/images/widget_render.png
+- doc/images/widget_rich_text.png
+- doc/images/widget_scroll_text.png
+- doc/images/widget_scrollbar_demo.png
+- doc/images/widget_sparkline_demo.png
 - doc/images/widget_style_colors.png
+- doc/images/widget_table_flex.png
+- doc/images/widget_tabs_demo.png
 - doc/index.md
 - doc/interactive_design.md
 - doc/quickstart.md
-- examples/all_events/app.rb
-- examples/all_events/app.rbs
-- examples/all_events/test_app.rb
-- examples/analytics/app.rb
-- examples/analytics/app.rbs
-- examples/analytics/test_app.rb
-- examples/block_padding/app.rb
-- examples/block_padding/app.rbs
-- examples/block_padding/test_app.rb
-- examples/block_titles/app.rb
-- examples/block_titles/app.rbs
-- examples/block_titles/test_app.rb
-- examples/box_demo/app.rb
-- examples/box_demo/app.rbs
-- examples/box_demo/test_app.rb
-- examples/calendar_demo/app.rb
-- examples/calendar_demo/app.rbs
-- examples/calendar_demo/test_app.rb
-- examples/cell_demo/app.rb
-- examples/cell_demo/app.rbs
-- examples/cell_demo/test_app.rb
-- examples/chart_demo/app.rb
-- examples/chart_demo/app.rbs
-- examples/chart_demo/test_app.rb
-- examples/custom_widget/app.rb
-- examples/custom_widget/app.rbs
-- examples/custom_widget/test_app.rb
-- examples/flex_layout/app.rb
-- examples/flex_layout/app.rbs
-- examples/flex_layout/test_app.rb
-- examples/gauge_demo/app.rb
-- examples/gauge_demo/app.rbs
-- examples/gauge_demo/test_app.rb
-- examples/hit_test/app.rb
-- examples/hit_test/app.rbs
-- examples/hit_test/test_app.rb
-- examples/line_gauge_demo/app.rb
-- examples/line_gauge_demo/app.rbs
-- examples/line_gauge_demo/test_app.rb
-- examples/list_demo/app.rb
-- examples/list_demo/app.rbs
-- examples/list_demo/test_app.rb
-- examples/list_styles/app.rb
-- examples/list_styles/app.rbs
-- examples/list_styles/test_app.rb
-- examples/login_form/app.rb
-- examples/login_form/app.rbs
-- examples/login_form/test_app.rb
-- examples/map_demo/app.rb
-- examples/map_demo/app.rbs
-- examples/map_demo/test_app.rb
-- examples/mouse_events/app.rb
-- examples/mouse_events/app.rbs
-- examples/mouse_events/test_app.rb
-- examples/popup_demo/app.rb
-- examples/popup_demo/app.rbs
-- examples/popup_demo/test_app.rb
-- examples/quickstart_dsl/app.rb
-- examples/quickstart_dsl/app.rbs
-- examples/quickstart_dsl/test_app.rb
-- examples/quickstart_lifecycle/app.rb
-- examples/quickstart_lifecycle/app.rbs
-- examples/quickstart_lifecycle/test_app.rb
-- examples/ratatui_logo_demo/app.rb
-- examples/ratatui_logo_demo/app.rbs
-- examples/ratatui_logo_demo/test_app.rb
-- examples/ratatui_mascot_demo/app.rb
-- examples/ratatui_mascot_demo/app.rbs
-- examples/ratatui_mascot_demo/test_app.rb
-- examples/readme_usage/app.rb
-- examples/readme_usage/app.rbs
-- examples/readme_usage/test_app.rb
-- examples/rich_text/app.rb
-- examples/rich_text/app.rbs
-- examples/rich_text/test_app.rb
-- examples/scroll_text/app.rb
-- examples/scroll_text/app.rbs
-- examples/scroll_text/test_app.rb
-- examples/scrollbar_demo/app.rb
-- examples/scrollbar_demo/app.rbs
-- examples/scrollbar_demo/test_app.rb
-- examples/sparkline_demo/app.rb
-- examples/sparkline_demo/app.rbs
-- examples/sparkline_demo/test_app.rb
-- examples/table_flex/app.rb
-- examples/table_flex/app.rbs
-- examples/table_flex/test_app.rb
-- examples/table_select/app.rb
-- examples/table_select/app.rbs
-- examples/table_select/test_app.rb
+- examples/app_all_events/README.md
+- examples/app_all_events/app.rb
+- examples/app_all_events/model/event_color_cycle.rb
+- examples/app_all_events/model/event_entry.rb
+- examples/app_all_events/model/events.rb
+- examples/app_all_events/model/highlight.rb
+- examples/app_all_events/model/timestamp.rb
+- examples/app_all_events/test/snapshots/after_focus_lost.txt
+- examples/app_all_events/test/snapshots/after_focus_regained.txt
+- examples/app_all_events/test/snapshots/after_horizontal_resize.txt
+- examples/app_all_events/test/snapshots/after_key_a.txt
+- examples/app_all_events/test/snapshots/after_key_ctrl_x.txt
+- examples/app_all_events/test/snapshots/after_mouse_click.txt
+- examples/app_all_events/test/snapshots/after_mouse_drag.txt
+- examples/app_all_events/test/snapshots/after_multiple_events.txt
+- examples/app_all_events/test/snapshots/after_paste.txt
+- examples/app_all_events/test/snapshots/after_resize.txt
+- examples/app_all_events/test/snapshots/after_right_click.txt
+- examples/app_all_events/test/snapshots/after_vertical_resize.txt
+- examples/app_all_events/test/snapshots/initial_state.txt
+- examples/app_all_events/view.rb
+- examples/app_all_events/view/app_view.rb
+- examples/app_all_events/view/controls_view.rb
+- examples/app_all_events/view/counts_view.rb
+- examples/app_all_events/view/live_view.rb
+- examples/app_all_events/view/log_view.rb
+- examples/app_all_events/view_state.rb
+- examples/app_color_picker/README.md
+- examples/app_color_picker/app.rb
+- examples/app_color_picker/clipboard.rb
+- examples/app_color_picker/color.rb
+- examples/app_color_picker/copy_dialog.rb
+- examples/app_color_picker/harmony.rb
+- examples/app_color_picker/input.rb
+- examples/app_color_picker/palette.rb
+- examples/app_color_picker/scene.rb
+- examples/app_login_form/app.rb
+- examples/app_map_demo/app.rb
+- examples/app_table_select/app.rb
+- examples/verify_quickstart_dsl/app.rb
+- examples/verify_quickstart_layout/app.rb
+- examples/verify_quickstart_lifecycle/app.rb
+- examples/verify_readme_usage/app.rb
+- examples/widget_barchart_demo/app.rb
+- examples/widget_block_padding/app.rb
+- examples/widget_block_titles/app.rb
+- examples/widget_box_demo/app.rb
+- examples/widget_calendar_demo/app.rb
+- examples/widget_cell_demo/app.rb
+- examples/widget_chart_demo/app.rb
+- examples/widget_gauge_demo/app.rb
+- examples/widget_layout_split/app.rb
+- examples/widget_line_gauge_demo/app.rb
+- examples/widget_list_demo/app.rb
+- examples/widget_list_styles/app.rb
+- examples/widget_popup_demo/app.rb
+- examples/widget_ratatui_logo_demo/app.rb
+- examples/widget_ratatui_mascot_demo/app.rb
+- examples/widget_rect/app.rb
+- examples/widget_render/app.rb
+- examples/widget_rich_text/app.rb
+- examples/widget_scroll_text/app.rb
+- examples/widget_scrollbar_demo/app.rb
+- examples/widget_sparkline_demo/app.rb
 - examples/widget_style_colors/app.rb
-- examples/widget_style_colors/app.rbs
-- examples/widget_style_colors/test_app.rb
+- examples/widget_table_flex/app.rb
+- examples/widget_tabs_demo/app.rb
 - ext/ratatui_ruby/.cargo/config.toml
 - ext/ratatui_ruby/.gitignore
 - ext/ratatui_ruby/Cargo.lock
@@ -237,6 +214,7 @@ files:
 - ext/ratatui_ruby/clippy.toml
 - ext/ratatui_ruby/extconf.rb
 - ext/ratatui_ruby/src/events.rs
+- ext/ratatui_ruby/src/frame.rs
 - ext/ratatui_ruby/src/lib.rs
 - ext/ratatui_ruby/src/rendering.rs
 - ext/ratatui_ruby/src/style.rs
@@ -270,8 +248,10 @@ files:
 - lib/ratatui_ruby/event/focus_lost.rb
 - lib/ratatui_ruby/event/key.rb
 - lib/ratatui_ruby/event/mouse.rb
+- lib/ratatui_ruby/event/none.rb
 - lib/ratatui_ruby/event/paste.rb
 - lib/ratatui_ruby/event/resize.rb
+- lib/ratatui_ruby/frame.rb
 - lib/ratatui_ruby/schema/bar_chart.rb
 - lib/ratatui_ruby/schema/bar_chart/bar.rb
 - lib/ratatui_ruby/schema/bar_chart/bar_group.rb
@@ -301,10 +281,52 @@ files:
 - lib/ratatui_ruby/schema/tabs.rb
 - lib/ratatui_ruby/schema/text.rb
 - lib/ratatui_ruby/session.rb
+- lib/ratatui_ruby/session/autodoc.rb
 - lib/ratatui_ruby/test_helper.rb
 - lib/ratatui_ruby/version.rb
 - mise.toml
+- sig/examples/app_all_events/app.rbs
+- sig/examples/app_all_events/model/event_entry.rbs
+- sig/examples/app_all_events/model/events.rbs
+- sig/examples/app_all_events/model/timestamp.rbs
+- sig/examples/app_all_events/view.rbs
+- sig/examples/app_all_events/view/app_view.rbs
+- sig/examples/app_all_events/view/controls_view.rbs
+- sig/examples/app_all_events/view/counts_view.rbs
+- sig/examples/app_all_events/view/live_view.rbs
+- sig/examples/app_all_events/view/log_view.rbs
+- sig/examples/app_all_events/view_state.rbs
+- sig/examples/app_color_picker/app.rbs
+- sig/examples/app_login_form/app.rbs
+- sig/examples/app_map_demo/app.rbs
+- sig/examples/app_table_select/app.rbs
+- sig/examples/verify_quickstart_dsl/app.rbs
+- sig/examples/verify_quickstart_lifecycle/app.rbs
+- sig/examples/verify_readme_usage/app.rbs
+- sig/examples/widget_block_padding/app.rbs
+- sig/examples/widget_block_titles/app.rbs
+- sig/examples/widget_box_demo/app.rbs
+- sig/examples/widget_calendar_demo/app.rbs
+- sig/examples/widget_cell_demo/app.rbs
+- sig/examples/widget_chart_demo/app.rbs
+- sig/examples/widget_gauge_demo/app.rbs
+- sig/examples/widget_layout_split/app.rbs
+- sig/examples/widget_line_gauge_demo/app.rbs
+- sig/examples/widget_list_demo/app.rbs
+- sig/examples/widget_list_styles/app.rbs
+- sig/examples/widget_popup_demo/app.rbs
+- sig/examples/widget_ratatui_logo_demo/app.rbs
+- sig/examples/widget_ratatui_mascot_demo/app.rbs
+- sig/examples/widget_rect/app.rbs
+- sig/examples/widget_render/app.rbs
+- sig/examples/widget_rich_text/app.rbs
+- sig/examples/widget_scroll_text/app.rbs
+- sig/examples/widget_scrollbar_demo/app.rbs
+- sig/examples/widget_sparkline_demo/app.rbs
+- sig/examples/widget_style_colors/app.rbs
+- sig/examples/widget_table_flex/app.rbs
 - sig/ratatui_ruby/event.rbs
+- sig/ratatui_ruby/frame.rbs
 - sig/ratatui_ruby/ratatui_ruby.rbs
 - sig/ratatui_ruby/schema/bar_chart.rbs
 - sig/ratatui_ruby/schema/bar_chart/bar.rbs
@@ -332,8 +354,16 @@ files:
 - sig/ratatui_ruby/schema/table.rbs
 - sig/ratatui_ruby/schema/tabs.rbs
 - sig/ratatui_ruby/schema/text.rbs
+- sig/ratatui_ruby/session.rbs
 - sig/ratatui_ruby/test_helper.rbs
 - sig/ratatui_ruby/version.rbs
+- tasks/autodoc.rake
+- tasks/autodoc/inventory.rb
+- tasks/autodoc/member.rb
+- tasks/autodoc/name.rb
+- tasks/autodoc/notice.rb
+- tasks/autodoc/rbs.rb
+- tasks/autodoc/rdoc.rb
 - tasks/bump.rake
 - tasks/bump/cargo_lockfile.rb
 - tasks/bump/changelog.rb
@@ -345,6 +375,7 @@ files:
 - tasks/bump/sem_ver.rb
 - tasks/bump/unreleased_section.rb
 - tasks/doc.rake
+- tasks/example_viewer.html.erb
 - tasks/extension.rake
 - tasks/lint.rake
 - tasks/rdoc_config.rb

data/LICENSES/BSD-2-Clause.txt

@@ -1,9 +0,0 @@
-Copyright <YEAR> <COPYRIGHT HOLDER>
-
-Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
-
-1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
-
-2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.