scriptorium 0.0.2 → 0.6.1

data/test/rubytext/rubytext_testing_guide.md

@@ -0,0 +1,277 @@
+# RubyText Testing Guide
+
+## Overview
+
+Testing curses-based applications like RubyText is challenging because they're inherently interactive and terminal-dependent. This guide outlines a comprehensive testing strategy that balances automation with practical reality.
+
+## Testing Challenges
+
+### **1. Terminal Dependencies**
+- Different terminals behave differently
+- Terminal capabilities vary (colors, Unicode, etc.)
+- Screen sizes and resolutions differ
+
+### **2. Interactive Nature**
+- User input is time-sensitive
+- Screen state changes dynamically
+- Hard to capture and verify visual output
+
+### **3. Platform Differences**
+- Unix/Linux vs macOS vs Windows
+- Different curses implementations
+- Terminal emulator variations
+
+## Testing Strategy
+
+### **1. Component Testing (Recommended)**
+
+Test individual components in isolation:
+
+```ruby
+# Test menu logic without curses
+def test_menu_logic
+  menu = RubyText::Menu.new(["Option 1", "Option 2"])
+  assert_equal 2, menu.options.length
+  assert_equal "Option 1", menu.options[0]
+end
+
+# Test screen buffer logic
+def test_screen_buffer
+  screen = RubyText::Screen.new(80, 24)
+  screen.puts("Hello")
+  assert_includes screen.buffer, "Hello"
+end
+```
+
+### **2. PTY-Based Integration Testing**
+
+Use PTY for realistic terminal interaction:
+
+```ruby
+def test_basic_interaction
+  PTY.spawn('ruby -e "require \"rubytext\"; RubyText.start { puts \"Hello\"; gets }"') do |read, write, pid|
+    begin
+      read.expect(/Hello/, 5)
+      write.puts "q"
+      Process.wait(pid)
+      assert_equal 0, $?.exitstatus
+    ensure
+      Process.kill('TERM', pid) rescue nil
+    end
+  end
+end
+```
+
+### **3. Regression Testing with Screenshots**
+
+Capture expected screen states:
+
+```ruby
+def test_screen_regression
+  # Capture current screen
+  current_screen = capture_screen do
+    run_rubytext_app_with_input(["help", "quit"])
+  end
+  
+  # Compare with expected
+  expected_screen = File.read("test/fixtures/expected_help_screen.txt")
+  assert_equal expected_screen, current_screen
+end
+```
+
+### **4. Automated Demo Testing**
+
+Automate your existing demo/slideshow:
+
+```ruby
+def test_demo_automation
+  PTY.spawn('ruby demo.rb --automated') do |read, write, pid|
+    begin
+      # Navigate through slides
+      read.expect(/Slide 1/, 5)
+      write.puts "n"  # next
+      read.expect(/Slide 2/, 5)
+      write.puts "q"  # quit
+      
+      Process.wait(pid)
+      assert_equal 0, $?.exitstatus
+    ensure
+      Process.kill('TERM', pid) rescue nil
+    end
+  end
+end
+```
+
+## Test Categories
+
+### **Core Functionality**
+- [ ] Menu creation and navigation
+- [ ] Screen rendering and layout
+- [ ] Input handling (keyboard, mouse)
+- [ ] Color and style support
+- [ ] Window management
+
+### **User Interface**
+- [ ] Menu interactions
+- [ ] Form input
+- [ ] Dialog boxes
+- [ ] Progress indicators
+- [ ] Error messages
+
+### **Performance**
+- [ ] Large content rendering
+- [ ] Screen refresh speed
+- [ ] Memory usage
+- [ ] Input responsiveness
+
+### **Error Handling**
+- [ ] Invalid input
+- [ ] Terminal errors
+- [ ] Resource limits
+- [ ] Graceful degradation
+
+### **Platform Compatibility**
+- [ ] Different terminals
+- [ ] Screen sizes
+- [ ] Color support
+- [ ] Unicode support
+
+## Implementation Examples
+
+### **1. Menu Testing**
+
+```ruby
+class MenuTest < Minitest::Test
+  def test_menu_creation
+    menu = RubyText::Menu.new(["Option 1", "Option 2"])
+    assert_equal 2, menu.options.length
+  end
+  
+  def test_menu_interaction
+    PTY.spawn('ruby -e "require \"rubytext\"; RubyText.start { menu = RubyText::Menu.new([\"A\", \"B\"]); puts menu.show; gets }"') do |read, write, pid|
+      begin
+        read.expect(/A/, 5)
+        write.puts "\r"  # Select first option
+        result = read.expect(/A/, 5)
+        assert result
+      ensure
+        Process.kill('TERM', pid) rescue nil
+      end
+    end
+  end
+end
+```
+
+### **2. Screen Testing**
+
+```ruby
+class ScreenTest < Minitest::Test
+  def test_screen_rendering
+    PTY.spawn('ruby -e "require \"rubytext\"; RubyText.start { puts \"Test\"; gets }"') do |read, write, pid|
+      begin
+        result = read.expect(/Test/, 5)
+        assert result, "Screen should display content"
+      ensure
+        Process.kill('TERM', pid) rescue nil
+      end
+    end
+  end
+end
+```
+
+### **3. Input Testing**
+
+```ruby
+class InputTest < Minitest::Test
+  def test_keyboard_input
+    PTY.spawn('ruby -e "require \"rubytext\"; RubyText.start { key = RubyText.getch; puts \"Key: #{key}\"; gets }"') do |read, write, pid|
+      begin
+        write.puts "a"
+        result = read.expect(/Key: a/, 5)
+        assert result, "Should detect key press"
+      ensure
+        Process.kill('TERM', pid) rescue nil
+      end
+    end
+  end
+end
+```
+
+## Testing Tools
+
+### **1. PTY (Pseudo-Terminal)**
+- Realistic terminal interaction
+- Captures input/output
+- Good for integration testing
+
+### **2. Screen Capture**
+- Capture screen states
+- Compare with expected output
+- Good for regression testing
+
+### **3. Mock Terminals**
+- Test logic without curses
+- Faster execution
+- Good for unit testing
+
+### **4. Automated Demos**
+- Test real user workflows
+- Verify end-to-end functionality
+- Good for acceptance testing
+
+## Best Practices
+
+### **1. Test Structure**
+- Separate unit tests from integration tests
+- Use descriptive test names
+- Group related tests together
+
+### **2. Error Handling**
+- Test error conditions
+- Verify graceful degradation
+- Check error messages
+
+### **3. Performance**
+- Test with realistic data sizes
+- Monitor memory usage
+- Check response times
+
+### **4. Platform Coverage**
+- Test on multiple platforms
+- Use CI/CD for automated testing
+- Document platform-specific issues
+
+## Manual Testing Checklist
+
+Since automated testing can't cover everything, maintain a manual testing checklist:
+
+### **Visual Verification**
+- [ ] Colors display correctly
+- [ ] Text alignment is proper
+- [ ] Screen layout is clean
+- [ ] Unicode characters render
+
+### **Interaction Testing**
+- [ ] Menu navigation works
+- [ ] Keyboard shortcuts function
+- [ ] Mouse input responds
+- [ ] Error messages are clear
+
+### **Performance Testing**
+- [ ] Large content renders quickly
+- [ ] Screen updates are smooth
+- [ ] Input is responsive
+- [ ] Memory usage is reasonable
+
+## Conclusion
+
+Testing RubyText requires a multi-faceted approach:
+
+1. **Unit test the core logic** (menus, screens, input handling)
+2. **Integration test with PTY** (real terminal interaction)
+3. **Regression test with screenshots** (visual verification)
+4. **Manual test the complex interactions** (user experience)
+
+The key is to **automate what you can** and **accept that some testing will always be manual**. Focus on testing the critical paths and user workflows, and use your existing demo/slideshow as a foundation for automated testing.
+
+Remember: **Perfect automated testing of curses applications is impossible, but good testing is definitely achievable!**

data/test/run_automated_tests.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+
+# Set up environment
+ENV['PATH'] = "#{ENV['HOME']}/.rbenv/shims:#{ENV['PATH']}"
+
+puts "\n" + "="*60
+puts "Running all automated tests..."
+puts "="*60
+
+# Run unit tests
+puts "\n--- Running unit tests ---"
+system("ruby test/all")
+
+# Run manual tests in automated mode
+puts "\n--- Running manual tests in automated mode ---"
+
+manual_tests = [
+  "test/manual/test1.rb",
+  "test/manual/test2.rb", 
+  "test/manual/test3.rb blog1",
+  "test/manual/test4.rb",
+  "test/manual/test5.rb",
+  "test/manual/test_banner_combinations.rb",
+  "test/manual/test_banner_features.rb",
+  "test/manual/test_complex_header.rb",
+  "test/manual/test_empty_header.rb",
+  "test/manual/test_banner_in_header.rb",
+  "test/manual/test_radial_custom.rb",
+  "test/manual/test_radial_large_radius.rb",
+  "test/manual/test_svg_debug.rb"
+]
+
+manual_tests.each do |test|
+  puts "\nRunning: #{test}"
+  result = system("ruby #{test} --automated")
+  if result
+    puts "✓ PASSED"
+  else
+    puts "✗ FAILED"
+  end
+end
+
+puts "\n" + "="*60
+puts "All automated tests completed!"
+puts "="*60 

data/test/scriptorium-TEST-1754622690-146/config/bootstrap_css.txt

@@ -0,0 +1,5 @@
+href         https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css
+rel          stylesheet
+# integrity has a problem - compute instead?
+# integrity    sha384-KyZXEJ04F5o1v7V5b7ZMjGhGjxA8yQmBfvZwzI1r+0gEv+9KnQIMJxWwzD0u8nZ7
+# crossorigin  anonymous

data/test/scriptorium-TEST-1754622690-146/config/bootstrap_js.txt

@@ -0,0 +1,4 @@
+src          https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js
+# integrity has a problem - compute instead?
+# integrity    sha384-pzjw8f+ua7Kw1TIq0+v5+GZkR6P/6v03cI0myXcJU22Hc5p5BY5/X93HmaJXjm4C
+crossorigin  anonymous

data/test/scriptorium-TEST-1754622690-146/config/common.js

@@ -0,0 +1,57 @@
+  // Handle the back button (or JavaScript history.go(-1))
+  window.onpopstate = function(event) {
+    console.log('onpopstate event:', event); // Log the event object
+    if (event.state && event.state.slug) {
+      console.log('Navigating to slug:', event.state.slug); // Log the slug
+      load_main(event.state.slug);  // Load the post for the previous history state
+    }
+  };
+
+  // Initialize with the front page when navigating via the back button or similar
+  window.onload = function() {
+    // Check if the initial state exists, if not, set it
+    if (!history.state) {
+       // Don't try to load post_index.html if there are no posts
+       // The "No posts yet!" message is already in the main container
+       history.replaceState({ slug: "index.html" }, "", "index.html");
+    }
+};
+
+// Load the main content and other page containers (header, footer, left, right)
+function load_main(slug) {
+    // Get all container elements (header, footer, left, right, and main)
+    const contentDiv = document.getElementById("main");
+    const headerDiv = document.querySelector("header");
+    const footerDiv = document.querySelector("footer");
+    const leftDiv = document.querySelector(".left");
+    const rightDiv = document.querySelector(".right");
+    console.log('Loading main with slug:', slug); // Log the slug
+
+  fetch(slug)
+    .then(response => {
+        if (response.ok) {
+            console.log('Response is ok');
+            return response.text();
+        } else {
+            console.error('Failed to load:', response.status); // Log the failed response
+        }
+    })
+    .then(content => {
+        console.log('Loaded content into div'); // Log successful content insertion
+
+        // Now, reload the content into the respective containers:
+        // Main section
+        contentDiv.innerHTML = content;
+
+        // Re-insert header, footer, left, and right (if necessary)
+        // If you want the static layout to be kept, you can preserve these parts
+        // with additional logic or predefined structure (here it's assumed 
+        // that header/footer/left/right are already statically included).
+        
+        // You can also replace the other parts (left, right, header, footer) if needed.
+        history.pushState({slug: slug}, "", slug);  // Update browser history
+    })
+    .catch(error => {
+        console.log("Error loading content:", error); // Log any errors during fetch
+    });
+  }

data/test/scriptorium-TEST-1754622690-146/config/currentview.txt

@@ -0,0 +1 @@
+sample

data/test/scriptorium-TEST-1754622690-146/config/global-head.txt

@@ -0,0 +1,9 @@
+# This global file supplies the default values for all views.
+# title is omitted - filled in at generation 
+charset    UTF-8
+desc       A blog powered by Scriptorium. This is default text intended to be changed by the user.
+viewport   width=device-width  initial-scale=1.0
+robots     index  follow
+javascript # See common.js 
+bootstrap  # See bootstrap.txt
+social     # See social.txt for configuration

data/test/scriptorium-TEST-1754622690-146/config/last_post_num.txt

@@ -0,0 +1 @@
+1

data/test/scriptorium-TEST-1754622690-146/config/os_helpers.rb

@@ -0,0 +1,4 @@
+# Generated at repo creation for macOS
+def open_file(file_path)
+  system("open", file_path)
+end

data/test/scriptorium-TEST-1754622690-146/config/widgets.txt

@@ -0,0 +1,3 @@
+links
+pages
+featuredposts

data/test/scriptorium-TEST-1754622690-146/posts/0001/meta.txt

@@ -0,0 +1,8 @@
+post.id 0001
+post.created 2025-08-07-22-11-30
+post.published no
+post.deployed no
+post.title Test Post
+post.blurb ADD BLURB HERE
+post.views sample
+post.tags  

data/test/scriptorium-TEST-1754622690-146/posts/0001/source.lt3

@@ -0,0 +1,6 @@
+.title Test Post
+.blurb ADD BLURB HERE
+.views sample
+.tags  
+
+Test body

data/test/scriptorium-TEST-1754622690-146/themes/standard/README.txt

@@ -0,0 +1 @@
+Empty file generated at 2025-08-07 22:11:30 -0500

data/test/scriptorium-TEST-1754622690-146/themes/standard/config.txt

@@ -0,0 +1 @@
+Empty file generated at 2025-08-07 22:11:30 -0500

data/test/scriptorium-TEST-1754622690-146/themes/standard/initial/post.lt3

@@ -0,0 +1,12 @@
+. Initial file created by StandardFiles#post_template(num)
+
+.id %{num}
+.created %{created}
+
+.title %{title}
+.blurb %{blurb}
+
+.views %{views}  
+.tags  %{tags}   
+
+BEGIN HERE...

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/config/footer.txt

@@ -0,0 +1,2 @@
+# <!-- Section: footer -->
+# Contents of footer

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/config/header.txt

@@ -0,0 +1,4 @@
+# <!-- Section: header -->
+# Contents of header
+# (may include banner, title, navbar, ...)
+title

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/config/left.txt

@@ -0,0 +1,3 @@
+# <!-- Section: left -->
+# Contents of left sidebar
+# (may be widgets or whatever)

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/config/main.txt

@@ -0,0 +1,5 @@
+# <!-- Section: main -->
+# Contents of center pane
+# This may be empty, as it is "usually" populated
+# by Javascript (list of recent posts, content from
+# a widget, or whatever)

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/config/right.txt

@@ -0,0 +1,3 @@
+# <!-- Section: right -->
+# Contents of right sidebar
+# (may be widgets or whatever)

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/gen/text.css

@@ -0,0 +1 @@
+Empty file generated at 2025-08-07 22:11:30 -0500

data/test/scriptorium-TEST-1754622690-146/themes/standard/layout/layout.txt

@@ -0,0 +1,5 @@
+header      # Top (banner? title? navbar? etc.)
+left   15%  # Left sidebar, 15% width
+main        # Main (center) container - posts/etc.
+right  15%  # Right sidebar, 15% width
+footer      # Footer (copyright? mail? social media? etc.)

data/test/scriptorium-TEST-1754622690-146/themes/standard/templates/index.lt3

@@ -0,0 +1 @@
+Empty file generated at 2025-08-07 22:11:30 -0500

data/test/scriptorium-TEST-1754622690-146/themes/standard/templates/index_entry.lt3

@@ -0,0 +1,14 @@
+<div class="index-entry" style="display: flex; justify-content: space-between; align-items: flex-start; margin-bottom: 20px;">
+  <!-- Left Side: Date (right aligned) -->
+  <div style="text-align: right; font-size: 0.7em; flex-basis: 10%%; padding-top: 3px;">
+    <div>%{post.pubdate.month} %{post.pubdate.day}</div>
+    <div>%{post.pubdate.year}</div>
+  </div>
+  <!-- Right Side: Title and Blurb (left aligned) -->
+  <div style="font-size: 1.2em; margin-left: 10px; flex-grow: 1; padding-top: 0;">
+    <div><a href="javascript:void(0)" 
+            style="text-decoration: none;"
+            onclick="load_main('posts/%{post.slug}')">%{post.title}</a></div>
+    <div style="font-size: 0.9em;">%{post.blurb}</div>
+  </div>
+</div>

data/test/scriptorium-TEST-1754622690-146/themes/standard/templates/post.lt3

@@ -0,0 +1,13 @@
+<!-- theme: standard -->
+
+<div align='right'><a style="text-decoration: none" href="javascript:history.go(-1)">
+  <img src="assets/back-icon.png" width=24 height=24 alt="Go back"></img></a>
+</div>
+<div style="display: flex; justify-content: space-between; align-items: baseline;">
+  <span style="text-align: left; font-size: 1.5em;">%{post.title}</span>
+  <span style="text-align: right; font-size: 0.9em;">%{reddit_button}%{post.pubdate}</span>
+</div>
+<hr>
+%{post.body}
+<hr>
+<div style="text-align: right; font-size: 0.8em;">%{post.tags}</div>

data/test/scriptorium-TEST-1754622690-146/themes/standard/templates/widget.lt3

@@ -0,0 +1 @@
+Empty file generated at 2025-08-07 22:11:30 -0500

data/test/scriptorium-TEST-1754622690-146/views/sample/config/bootstrap_css.txt

@@ -0,0 +1,5 @@
+href         https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/css/bootstrap.min.css
+rel          stylesheet
+# integrity has a problem - compute instead?
+# integrity    sha384-KyZXEJ04F5o1v7V5b7ZMjGhGjxA8yQmBfvZwzI1r+0gEv+9KnQIMJxWwzD0u8nZ7
+# crossorigin  anonymous

data/test/scriptorium-TEST-1754622690-146/views/sample/config/bootstrap_js.txt

@@ -0,0 +1,4 @@
+src          https://cdn.jsdelivr.net/npm/bootstrap@5.3.3/dist/js/bootstrap.bundle.min.js
+# integrity has a problem - compute instead?
+# integrity    sha384-pzjw8f+ua7Kw1TIq0+v5+GZkR6P/6v03cI0myXcJU22Hc5p5BY5/X93HmaJXjm4C
+crossorigin  anonymous

data/test/scriptorium-TEST-1754622690-146/views/sample/config/common.js

@@ -0,0 +1,57 @@
+  // Handle the back button (or JavaScript history.go(-1))
+  window.onpopstate = function(event) {
+    console.log('onpopstate event:', event); // Log the event object
+    if (event.state && event.state.slug) {
+      console.log('Navigating to slug:', event.state.slug); // Log the slug
+      load_main(event.state.slug);  // Load the post for the previous history state
+    }
+  };
+
+  // Initialize with the front page when navigating via the back button or similar
+  window.onload = function() {
+    // Check if the initial state exists, if not, set it
+    if (!history.state) {
+       // Don't try to load post_index.html if there are no posts
+       // The "No posts yet!" message is already in the main container
+       history.replaceState({ slug: "index.html" }, "", "index.html");
+    }
+};
+
+// Load the main content and other page containers (header, footer, left, right)
+function load_main(slug) {
+    // Get all container elements (header, footer, left, right, and main)
+    const contentDiv = document.getElementById("main");
+    const headerDiv = document.querySelector("header");
+    const footerDiv = document.querySelector("footer");
+    const leftDiv = document.querySelector(".left");
+    const rightDiv = document.querySelector(".right");
+    console.log('Loading main with slug:', slug); // Log the slug
+
+  fetch(slug)
+    .then(response => {
+        if (response.ok) {
+            console.log('Response is ok');
+            return response.text();
+        } else {
+            console.error('Failed to load:', response.status); // Log the failed response
+        }
+    })
+    .then(content => {
+        console.log('Loaded content into div'); // Log successful content insertion
+
+        // Now, reload the content into the respective containers:
+        // Main section
+        contentDiv.innerHTML = content;
+
+        // Re-insert header, footer, left, and right (if necessary)
+        // If you want the static layout to be kept, you can preserve these parts
+        // with additional logic or predefined structure (here it's assumed 
+        // that header/footer/left/right are already statically included).
+        
+        // You can also replace the other parts (left, right, header, footer) if needed.
+        history.pushState({slug: slug}, "", slug);  // Update browser history
+    })
+    .catch(error => {
+        console.log("Error loading content:", error); // Log any errors during fetch
+    });
+  }

data/test/scriptorium-TEST-1754622690-146/views/sample/config/deploy.txt

@@ -0,0 +1,5 @@
+user      root
+server    example.com
+docroot   /var/www/html
+path      sample
+proto     https

data/test/scriptorium-TEST-1754622690-146/views/sample/config/footer.txt

@@ -0,0 +1,2 @@
+# <!-- Section: footer -->
+# Contents of footer

data/test/scriptorium-TEST-1754622690-146/views/sample/config/global-head.txt

@@ -0,0 +1,9 @@
+# This view-specific file supplies the default values for this view.
+# title is omitted - filled in at generation 
+charset    UTF-8
+desc       A blog powered by Scriptorium. This is default text intended to be changed by the user.
+viewport   width=device-width  initial-scale=1.0
+robots     index  follow
+javascript # See common.js 
+bootstrap  # See bootstrap.txt
+social     # See social.txt for configuration

data/test/scriptorium-TEST-1754622690-146/views/sample/config/header.txt

@@ -0,0 +1,4 @@
+# <!-- Section: header -->
+# Contents of header
+# (may include banner, title, navbar, ...)
+title

data/test/scriptorium-TEST-1754622690-146/views/sample/config/layout.txt

@@ -0,0 +1,5 @@
+header      # Top (banner? title? navbar? etc.)
+left   15%  # Left sidebar, 15% width
+main        # Main (center) container - posts/etc.
+right  15%  # Right sidebar, 15% width
+footer      # Footer (copyright? mail? social media? etc.)

data/test/scriptorium-TEST-1754622690-146/views/sample/config/left.txt

@@ -0,0 +1,3 @@
+# <!-- Section: left -->
+# Contents of left sidebar
+# (may be widgets or whatever)

data/test/scriptorium-TEST-1754622690-146/views/sample/config/main.txt

@@ -0,0 +1,5 @@
+# <!-- Section: main -->
+# Contents of center pane
+# This may be empty, as it is "usually" populated
+# by Javascript (list of recent posts, content from
+# a widget, or whatever)

data/test/scriptorium-TEST-1754622690-146/views/sample/config/reddit.txt

@@ -0,0 +1,10 @@
+# Reddit sharing button configuration
+# Set to true to show Reddit share button on posts
+button true
+
+# Optional: specify a subreddit for direct posting
+# Leave empty or omit to let users choose subreddit
+subreddit
+
+# Optional: custom hover text (defaults to "Share on Reddit" or "Share on [subreddit]")
+hover_text

data/test/scriptorium-TEST-1754622690-146/views/sample/config/right.txt

@@ -0,0 +1,3 @@
+# <!-- Section: right -->
+# Contents of right sidebar
+# (may be widgets or whatever)