ratatui_ruby 0.8.0 → 0.9.0

data/lib/ratatui_ruby/event/key.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 require_relative "key/character"
@@ -27,21 +27,45 @@ module RatatuiRuby
     # === Examples
     #
     # Using predicates:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   if event.key? && event.ctrl? && event.code == "c"
     #     exit
     #   end
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # Using symbol comparison:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   if event == :ctrl_c
     #     exit
     #   end
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # Using pattern matching:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2026 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   case event
     #   in type: :key, code: "c", modifiers: ["ctrl"]
     #     exit
     #   end
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # === Terminal Compatibility
     #
     # Some key combinations never reach your application. Terminal emulators intercept them for
@@ -90,9 +114,17 @@ module RatatuiRuby
 
       # Returns true for Key events.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.key?    # => true
       #   event.mouse?  # => false
       #   event.resize? # => false
+      #--
+      # SPDX-SnippetEnd
+      #++
       def key?
         true
       end
@@ -104,8 +136,16 @@ module RatatuiRuby
       # [modifiers]
       #   List of modifiers (Array<String>).
       # [kind]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   The key category (Symbol). One of: <tt>:standard</tt>, <tt>:function</tt>,
       #   <tt>:media</tt>, <tt>:modifier</tt>, <tt>:system</tt>. Defaults to <tt>:standard</tt>.
+      #--
+      # SPDX-SnippetEnd
+      #++
       def initialize(code:, modifiers: [], kind: :standard)
         @code = code.freeze
         @modifiers = modifiers.map(&:freeze).sort.freeze
@@ -141,8 +181,16 @@ module RatatuiRuby
       # [Standard]
       #   <tt>:enter</tt>, <tt>:backspace</tt>, <tt>:tab</tt>, <tt>:back_tab</tt>, <tt>:esc</tt>, <tt>:null</tt>
       # [Navigation]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   <tt>:up</tt>, <tt>:down</tt>, <tt>:left</tt>, <tt>:right</tt>, <tt>:home</tt>, <tt>:end</tt>,
       #   <tt>:page_up</tt>, <tt>:page_down</tt>, <tt>:insert</tt>, <tt>:delete</tt>
+      #--
+      # SPDX-SnippetEnd
+      #++
       # [Function Keys]
       #   <tt>:f1</tt> through <tt>:f12</tt> (and beyond, e.g. <tt>:f24</tt>)
       # [Lock Keys]
@@ -150,17 +198,41 @@ module RatatuiRuby
       # [System Keys]
       #   <tt>:print_screen</tt>, <tt>:pause</tt>, <tt>:menu</tt>, <tt>:keypad_begin</tt>
       # [Media Keys]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   <tt>:play</tt>, <tt>:media_pause</tt>, <tt>:play_pause</tt>, <tt>:reverse</tt>, <tt>:stop</tt>,
       #   <tt>:fast_forward</tt>, <tt>:rewind</tt>, <tt>:track_next</tt>, <tt>:track_previous</tt>,
       #   <tt>:record</tt>, <tt>:lower_volume</tt>, <tt>:raise_volume</tt>, <tt>:mute_volume</tt>
+      #--
+      # SPDX-SnippetEnd
+      #++
       # [Modifier Keys]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   <tt>:left_shift</tt>, <tt>:left_control</tt>, <tt>:left_alt</tt>, <tt>:left_super</tt>,
       #   <tt>:left_hyper</tt>, <tt>:left_meta</tt>, <tt>:right_shift</tt>, <tt>:right_control</tt>,
       #   <tt>:right_alt</tt>, <tt>:right_super</tt>, <tt>:right_hyper</tt>, <tt>:right_meta</tt>,
       #   <tt>:iso_level3_shift</tt>, <tt>:iso_level5_shift</tt>
+      #--
+      # SPDX-SnippetEnd
+      #++
       # [Characters]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   <tt>:a</tt>, <tt>:b</tt>, <tt>:1</tt>, <tt>:space</tt>, etc.
       #
+      #--
+      # SPDX-SnippetEnd
+      #++
       # === Modifier Examples
       #
       # * <tt>:ctrl_c</tt>
@@ -183,8 +255,16 @@ module RatatuiRuby
       # [Special Keys]
       #   Returns an empty string (e.g., <tt>"enter"</tt>, <tt>"up"</tt>, <tt>"f1"</tt> all return <tt>""</tt>).
       # [Modifiers]
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   Returns the character if printable, ignoring modifiers unless they alter the character code itself.
       #   Note that <tt>ctrl+c</tt> typically returns <tt>"c"</tt> as the code, so +to_s+ will return <tt>"c"</tt>.
+      #--
+      # SPDX-SnippetEnd
+      #++
       def to_s
         if text?
           @code
@@ -202,11 +282,19 @@ module RatatuiRuby
       #
       # Allows convenient checking for specific keys or key combinations:
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.ctrl_c?     # => true if Ctrl+C
       #   event.enter?      # => true if Enter
       #   event.shift_up?   # => true if Shift+Up
       #   event.q?          # => true if "q"
       #
+      #--
+      # SPDX-SnippetEnd
+      #++
       # The method name is converted to a symbol and compared against the event.
       # This works for any key code or modifier+key combination.
       #
@@ -214,18 +302,34 @@ module RatatuiRuby
       #
       # For convenience, generic predicates match both system and media variants:
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.pause?      # => true for BOTH system "pause" AND "media_pause"
       #   event.play?       # => true for "media_play"
       #   event.stop?       # => true for "media_stop"
       #
+      #--
+      # SPDX-SnippetEnd
+      #++
       # This "Do What I Mean" behavior reduces boilerplate when you just want to
       # respond to a conceptual action (e.g., "pause the playback") regardless of
       # whether the user pressed a keyboard key or a media button.
       #
       # For strict matching, use the full predicate or compare the code directly:
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.media_pause?  # => true ONLY for media pause
       #   event.code == "pause"  # => true ONLY for system pause
+      #--
+      # SPDX-SnippetEnd
+      #++
       def method_missing(name, *args, &block)
         if name.to_s.end_with?("?")
           key_name = name.to_s[0...-1]
@@ -259,12 +363,20 @@ module RatatuiRuby
 
       # Deconstructs the event for pattern matching.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2026 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   case event
       #   in type: :key, code: "c", modifiers: ["ctrl"]
       #     puts "Ctrl+C pressed"
       #   in type: :key, kind: :media
       #     puts "Media key pressed"
       #   end
+      #--
+      # SPDX-SnippetEnd
+      #++
       def deconstruct_keys(keys)
         { type: :key, code: @code, modifiers: @modifiers, kind: @kind }
       end

data/lib/ratatui_ruby/event/mouse.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -20,9 +20,17 @@ module RatatuiRuby
     #
     # === Example
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   if event.mouse? && event.down? && event.button == "left"
     #     puts "Left click at #{event.x}, #{event.y}"
     #   end
+    #--
+    # SPDX-SnippetEnd
+    #++
     class Mouse < Event
       # The kind of event (<tt>"down"</tt>, <tt>"up"</tt>, <tt>"drag"</tt>, <tt>"moved"</tt>, <tt>"scroll_up"</tt>, <tt>"scroll_down"</tt>).
       #
@@ -38,8 +46,16 @@ module RatatuiRuby
       attr_reader :y
       # The button pressed (<tt>"left"</tt>, <tt>"right"</tt>, <tt>"middle"</tt>, <tt>"none"</tt>).
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   puts event.button # => "left"
       #
+      #--
+      # SPDX-SnippetEnd
+      #++
       # Can be <tt>nil</tt>, which is treated as <tt>"none"</tt>.
       attr_reader :button
       # List of active modifiers.
@@ -49,9 +65,17 @@ module RatatuiRuby
 
       # Returns true for Mouse events.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.mouse?  # => true
       #   event.key?    # => false
       #   event.resize? # => false
+      #--
+      # SPDX-SnippetEnd
+      #++
       def mouse?
         true
       end
@@ -98,19 +122,35 @@ module RatatuiRuby
 
       # Returns true if scroll wheel moved down.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   if event.scroll_down?
       #     scroll_offset += 1
       #   end
+      #--
+      # SPDX-SnippetEnd
+      #++
       def scroll_down?
         @kind == "scroll_down"
       end
 
       # Deconstructs the event for pattern matching.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   case event
       #   in type: :mouse, kind: "down", x:, y:
       #     puts "Click at #{x}, #{y}"
       #   end
+      #--
+      # SPDX-SnippetEnd
+      #++
       def deconstruct_keys(keys)
         { type: :mouse, kind: @kind, x: @x, y: @y, button: @button, modifiers: @modifiers }
       end

data/lib/ratatui_ruby/event/none.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -23,10 +23,18 @@ module RatatuiRuby
     #
     # === Predicate Example
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   event = RatatuiRuby.poll_event
     #   break if event.ctrl_c?
     #   redraw if event.none?
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # === Pattern Matching Example
     #
     #   redraw if RatatuiRuby.poll_event in type: :none

data/lib/ratatui_ruby/event/paste.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -20,15 +20,31 @@ module RatatuiRuby
     # === Examples
     #
     # Using predicates:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   if event.paste?
     #     puts "Pasted: #{event.content}"
     #   end
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # Using pattern matching:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   case event
     #   in type: :paste, content:
     #     puts "Pasted: #{content}"
     #   end
+    #--
+    # SPDX-SnippetEnd
+    #++
     class Paste < Event
       # The pasted content.
       #
@@ -37,9 +53,17 @@ module RatatuiRuby
 
       # Returns true for Paste events.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.paste?  # => true
       #   event.key?    # => false
       #   event.resize? # => false
+      #--
+      # SPDX-SnippetEnd
+      #++
       def paste?
         true
       end
@@ -54,10 +78,18 @@ module RatatuiRuby
 
       # Deconstructs the event for pattern matching.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   case event
       #   in type: :paste, content:
       #     puts "User pasted: #{content}"
       #   end
+      #--
+      # SPDX-SnippetEnd
+      #++
       def deconstruct_keys(keys)
         { type: :paste, content: @content }
       end

data/lib/ratatui_ruby/event/resize.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -21,15 +21,31 @@ module RatatuiRuby
     # === Examples
     #
     # Using predicates:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   if event.resize?
     #     puts "Resized to #{event.width}x#{event.height}"
     #   end
     #
+    #--
+    # SPDX-SnippetEnd
+    #++
     # Using pattern matching:
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   case event
     #   in type: :resize, width:, height:
     #     puts "Resized to #{width}x#{height}"
     #   end
+    #--
+    # SPDX-SnippetEnd
+    #++
     class Resize < Event
       # New terminal width in columns.
       #
@@ -43,9 +59,17 @@ module RatatuiRuby
 
       # Returns true for Resize events.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   event.resize? # => true
       #   event.key?    # => false
       #   event.mouse?  # => false
+      #--
+      # SPDX-SnippetEnd
+      #++
       def resize?
         true
       end
@@ -63,10 +87,18 @@ module RatatuiRuby
 
       # Deconstructs the event for pattern matching.
       #
+      #--
+      # SPDX-SnippetBegin
+      # SPDX-FileCopyrightText: 2025 Kerrick Long
+      # SPDX-License-Identifier: MIT-0
+      #++
       #   case event
       #   in type: :resize, width:, height:
       #     puts "Resized to #{width}x#{height}"
       #   end
+      #--
+      # SPDX-SnippetEnd
+      #++
       def deconstruct_keys(keys)
         { type: :resize, width: @width, height: @height }
       end

data/lib/ratatui_ruby/event.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 #--
-# SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
-# SPDX-License-Identifier: AGPL-3.0-or-later
+# SPDX-FileCopyrightText: 2026 Kerrick Long <me@kerricklong.com>
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 module RatatuiRuby
@@ -26,6 +26,11 @@ module RatatuiRuby
   # Use <tt>case...in</tt> to dispatch on every possible event type. This ensures
   # you handle every case without needing an +else+ clause:
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2025 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   case RatatuiRuby.poll_event
   #   in { type: :key, code: "q" }
   #     break
@@ -47,10 +52,18 @@ module RatatuiRuby
   #     # Idle
   #   end
   #
+  #--
+  # SPDX-SnippetEnd
+  #++
   # == Predicates
   #
   # Check event types with predicates without pattern matching:
   #
+  #--
+  # SPDX-SnippetBegin
+  # SPDX-FileCopyrightText: 2025 Kerrick Long
+  # SPDX-License-Identifier: MIT-0
+  #++
   #   event = RatatuiRuby.poll_event
   #   if event.key?
   #     puts "Key pressed"
@@ -59,6 +72,9 @@ module RatatuiRuby
   #   elsif event.mouse?
   #     puts "Mouse event"
   #   end
+  #--
+  # SPDX-SnippetEnd
+  #++
   class Event
     # Returns true if this is a None event.
     def none?
@@ -114,10 +130,18 @@ module RatatuiRuby
     #
     # Keys argument is unused but required by the protocol.
     #
+    #--
+    # SPDX-SnippetBegin
+    # SPDX-FileCopyrightText: 2025 Kerrick Long
+    # SPDX-License-Identifier: MIT-0
+    #++
     #   case event
     #   in type: :key, code:
     #     puts "Key: #{code}"
     #   end
+    #--
+    # SPDX-SnippetEnd
+    #++
     def deconstruct_keys(keys)
       {}
     end