ratatui_ruby 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa64c94e2dded3a4de71ebdff888860a1528f42a4b9a1ed0200361d3a811e715
-  data.tar.gz: aa98fe686ef20f10e310b3a0bc87b60412279d85d1d60befa31c60c3eef5bf01
+  metadata.gz: 765a191883719b12dc911fd0279af0812275ab4abeec564667fee00d413f9dd0
+  data.tar.gz: bd58e3e32d9e90f3e3b6c51941900b0f787f056c75051441bf8a663c906c2563
 SHA512:
-  metadata.gz: fab99ab43c386a115027ea204ec578c7d20c1b4bd7ddfeee43d384825f536ed49162ca8957e1c46b994809cbd20137d16857f39c792330148a5b1eb3d69957a3
-  data.tar.gz: c6b42590b5f920d19062e99fef14a92dfffe2a5482a9b3295fc5b73df095336a99c33b782e1ae14fd17027593253f545957919cf8603936842e121e166dd54b7
+  metadata.gz: 0a556ffb8388ef0d36e5f0223f25c4e7a97327ac7ebcad2555c0fb605ab5320df795a98ea1646ba1656cbb31d02cc42a246aaa6276894b476140ef36272842d6
+  data.tar.gz: 2c0072dc2a5b68ea732ff652617ba583df19f23c3256b6bd4e68abbd7a7b8bbe10096bc2249212236a306d3cfdd9f5862281b90c86968c9df3f4d0dc2dd42958

data/ext/ratatui_ruby/Cargo.lock

@@ -1059,12 +1059,13 @@ dependencies = [
 
 [[package]]
 name = "ratatui_ruby"
-version = "1.2.1"
+version = "1.2.2"
 dependencies = [
  "bumpalo",
  "lazy_static",
  "magnus",
  "ratatui",
+ "rb-sys",
  "time",
  "unicode-width 0.1.14",
 ]

data/ext/ratatui_ruby/Cargo.toml

@@ -3,7 +3,7 @@
 
 [package]
 name = "ratatui_ruby"
-version = "1.2.1"
+version = "1.2.2"
 edition = "2021"
 
 [lib]
@@ -11,6 +11,7 @@ crate-type = ["cdylib", "staticlib"]
 
 [dependencies]
 magnus = "0.8.2"
+rb-sys = "*"
 ratatui = { version = "0.30", features = ["widget-calendar", "layout-cache", "unstable-rendered-line-info", "palette"] }
 unicode-width = "0.1"
 

data/ext/ratatui_ruby/src/events.rs

@@ -2,7 +2,9 @@
 // SPDX-License-Identifier: AGPL-3.0-or-later
 
 use magnus::{Error, IntoValue, TryConvert, Value};
+use rb_sys::rb_thread_call_without_gvl;
 use std::cell::RefCell;
+use std::os::raw::c_void;
 
 /// Wrapper enum for test events - includes crossterm events and our Sync event.
 #[derive(Debug, Clone)]
@@ -314,6 +316,92 @@ pub fn clear_events() {
     EVENT_QUEUE.with(|q| q.borrow_mut().clear());
 }
 
+/// Result of polling crossterm from outside the GVL.
+///
+/// The blocking I/O (poll + read) happens without the Ruby GVL held,
+/// so other Ruby threads can run concurrently. This enum carries the
+/// result back across the GVL boundary for Ruby object construction.
+#[derive(Debug)]
+enum PollResult {
+    /// A crossterm event was read successfully.
+    Event(ratatui::crossterm::event::Event),
+    /// The timeout expired with no event available.
+    NoEvent,
+    /// An I/O error occurred during poll or read.
+    Error(String),
+}
+
+/// Data passed to the GVL-free polling callback.
+///
+/// The `timeout` field controls the poll behavior:
+/// - `Some(duration)`: poll with a timeout, return `NoEvent` if it expires.
+/// - `None`: block indefinitely until an event arrives.
+struct PollData {
+    timeout: Option<std::time::Duration>,
+    result: PollResult,
+}
+
+/// Polls crossterm for events without the Ruby GVL held.
+///
+/// This is the work function passed to `rb_thread_call_without_gvl`.
+/// It performs blocking I/O that would otherwise starve Ruby threads.
+extern "C" fn poll_without_gvl(data: *mut c_void) -> *mut c_void {
+    // SAFETY: `data` is a valid pointer to `PollData`, passed by
+    // `poll_crossterm_without_gvl` via `rb_thread_call_without_gvl`. The
+    // pointer remains valid for the duration of this callback because the
+    // caller owns the `PollData` on the stack and waits for us to return.
+    let data = unsafe { &mut *data.cast::<PollData>() };
+
+    data.result = match data.timeout {
+        Some(duration) => match ratatui::crossterm::event::poll(duration) {
+            Ok(true) => match ratatui::crossterm::event::read() {
+                Ok(event) => PollResult::Event(event),
+                Err(e) => PollResult::Error(e.to_string()),
+            },
+            Ok(false) => PollResult::NoEvent,
+            Err(e) => PollResult::Error(e.to_string()),
+        },
+        None => match ratatui::crossterm::event::read() {
+            Ok(event) => PollResult::Event(event),
+            Err(e) => PollResult::Error(e.to_string()),
+        },
+    };
+
+    std::ptr::null_mut()
+}
+
+/// Polls crossterm with the GVL released, then converts the result
+/// to a Ruby value after reacquiring the GVL.
+fn poll_crossterm_without_gvl(
+    ruby: &magnus::Ruby,
+    timeout: Option<std::time::Duration>,
+) -> Result<Value, Error> {
+    let mut data = PollData {
+        timeout,
+        result: PollResult::NoEvent,
+    };
+
+    // SAFETY: `data` is a valid stack-local `PollData` whose lifetime
+    // spans this entire call. `poll_without_gvl` only reads/writes
+    // through the pointer while `rb_thread_call_without_gvl` blocks,
+    // and we don't access `data` again until that function returns.
+    unsafe {
+        rb_thread_call_without_gvl(
+            Some(poll_without_gvl),
+            (&raw mut data).cast::<c_void>(),
+            None,
+            std::ptr::null_mut(),
+        );
+    }
+
+    // GVL is now re-held — safe to create Ruby objects.
+    match data.result {
+        PollResult::Event(event) => handle_crossterm_event(event),
+        PollResult::NoEvent => Ok(ruby.qnil().into_value_with(ruby)),
+        PollResult::Error(msg) => Err(Error::new(ruby.exception_runtime_error(), msg)),
+    }
+}
+
 pub fn poll_event(ruby: &magnus::Ruby, timeout_val: Option<f64>) -> Result<Value, Error> {
     let event = EVENT_QUEUE.with(|q| {
         let mut queue = q.borrow_mut();
@@ -334,24 +422,8 @@ pub fn poll_event(ruby: &magnus::Ruby, timeout_val: Option<f64>) -> Result<Value
         return Ok(ruby.qnil().into_value_with(ruby));
     }
 
-    if let Some(secs) = timeout_val {
-        // Timed poll: wait up to the specified duration
-        let duration = std::time::Duration::from_secs_f64(secs);
-        if ratatui::crossterm::event::poll(duration)
-            .map_err(|e| Error::new(ruby.exception_runtime_error(), e.to_string()))?
-        {
-            let event = ratatui::crossterm::event::read()
-                .map_err(|e| Error::new(ruby.exception_runtime_error(), e.to_string()))?;
-            handle_crossterm_event(event)
-        } else {
-            Ok(ruby.qnil().into_value_with(ruby))
-        }
-    } else {
-        // Blocking: wait indefinitely for an event
-        let event = ratatui::crossterm::event::read()
-            .map_err(|e| Error::new(ruby.exception_runtime_error(), e.to_string()))?;
-        handle_crossterm_event(event)
-    }
+    let timeout = timeout_val.map(std::time::Duration::from_secs_f64);
+    poll_crossterm_without_gvl(ruby, timeout)
 }
 
 fn handle_test_event(event: TestEvent) -> Result<Value, Error> {
@@ -559,3 +631,70 @@ fn handle_focus_event(event_type: &str) -> Result<Value, Error> {
     hash.aset(ruby.to_symbol("type"), ruby.to_symbol(event_type))?;
     Ok(hash.into_value_with(&ruby))
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn poll_data_defaults_to_no_event() {
+        let data = PollData {
+            timeout: Some(std::time::Duration::from_millis(0)),
+            result: PollResult::NoEvent,
+        };
+        assert!(matches!(data.result, PollResult::NoEvent));
+    }
+
+    #[test]
+    fn poll_data_accepts_none_timeout_for_indefinite_blocking() {
+        let data = PollData {
+            timeout: None,
+            result: PollResult::NoEvent,
+        };
+        assert!(data.timeout.is_none());
+    }
+
+    #[test]
+    fn poll_result_error_preserves_message() {
+        let result = PollResult::Error("connection reset".to_string());
+        match result {
+            PollResult::Error(msg) => assert_eq!(msg, "connection reset"),
+            _ => panic!("Expected PollResult::Error"),
+        }
+    }
+
+    #[test]
+    fn poll_result_event_wraps_crossterm_event() {
+        let key_event =
+            ratatui::crossterm::event::Event::Key(ratatui::crossterm::event::KeyEvent::new(
+                ratatui::crossterm::event::KeyCode::Char('q'),
+                ratatui::crossterm::event::KeyModifiers::empty(),
+            ));
+        let result = PollResult::Event(key_event.clone());
+        match result {
+            PollResult::Event(e) => assert_eq!(format!("{e:?}"), format!("{key_event:?}")),
+            _ => panic!("Expected PollResult::Event"),
+        }
+    }
+
+    #[test]
+    fn poll_without_gvl_returns_no_event_on_zero_timeout() {
+        // With a zero-duration timeout, poll returns immediately with no event.
+        // In headless environments (CI), crossterm may return an Error because
+        // there is no terminal to read from — that's also a valid outcome.
+        let mut data = PollData {
+            timeout: Some(std::time::Duration::from_millis(0)),
+            result: PollResult::Error("sentinel — should be overwritten".to_string()),
+        };
+
+        poll_without_gvl(&mut data as *mut PollData as *mut c_void);
+
+        // The callback must have overwritten the sentinel value.
+        match &data.result {
+            PollResult::Error(msg) if msg == "sentinel — should be overwritten" => {
+                panic!("poll_without_gvl did not write to data.result")
+            }
+            _ => {} // NoEvent, Event, or a *different* Error are all fine.
+        }
+    }
+}

data/lib/ratatui_ruby/version.rb

@@ -8,5 +8,5 @@
 module RatatuiRuby
   # The version of the ratatui_ruby gem.
   # See https://semver.org/spec/v2.0.0.html
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ratatui_ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Kerrick Long