bubbletea 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed92e1bbe622a400cd6fbcc2b69770c7d25744b25e45dc4292cdf2a930f065a4
-  data.tar.gz: c3f3b9f55209016227269d3f4496e4c8f8e6dadd8b349cdd5f07f4c8e2c06143
+  metadata.gz: acdee3b175481f16d4a4080472a633b4c80efa7c5042c75441f01827b58840dd
+  data.tar.gz: 1b8b37c756c887225add359144efac1810d162ce187ebcdbe0e07c2b90076648
 SHA512:
-  metadata.gz: e28087495d9b294ec2e45cdbc2a2784b7694f0f252db99be443a0cf9bdcd383b29990bd5d95ca1ba166415d9c1d58af9e4995f24d26534e4642b3c9173cd0bbc
-  data.tar.gz: 14f6c04b6a2075dfb8427d8cee3e1b498e2ce6865c5600cbe2db919ea94657847c787755743280c3c5aa0cf26b5b872053e0e5ad9a9ca5268f3eca0efd5690f9
+  metadata.gz: c93f2b40dd0fa39d0567ea57ea59c757d4cfbf378f59ceabe8f1ec621b869b4e3734749cfc0e2e812b7b8135e9aa2ad71c0dd21f0da1004ab21831edc81f3f34
+  data.tar.gz: 567a50b78e99970ed2f2b0678f78602c7fc8efa7c578d5918dfbe65c9bad5fa87021167d0ae210d5b7289d237926bbfac7e67f17054f583be93b20913ec10656

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Marco Roth
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -1,39 +1,264 @@
-# Bubbletea
+<div align="center">
+  <h1>Bubbletea for Ruby</h1>
+  <h4>A powerful TUI framework for Ruby.</h4>
 
-TODO: Delete this and the text below, and describe your gem
+  <p>
+    <a href="https://rubygems.org/gems/bubbletea"><img alt="Gem Version" src="https://img.shields.io/gem/v/bubbletea"></a>
+    <a href="https://github.com/marcoroth/bubbletea-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/bubbletea-ruby"></a>
+  </p>
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bubbletea`. To experiment with that code, run `bin/console` for an interactive prompt.
+  <p>Ruby bindings for <a href="https://github.com/charmbracelet/bubbletea">charmbracelet/bubbletea</a>.<br/>Build beautiful, interactive terminal applications using the Elm Architecture in Ruby.</p>
+</div>
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+**Add to your Gemfile:**
 
-Install the gem and add to the application's Gemfile by executing:
-
-```bash
-bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```ruby
+gem "bubbletea"
 ```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+**Or install directly:**
 
 ```bash
-gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+gem install bubbletea
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### The Elm Architecture
+
+Bubbletea implements the Elm Architecture pattern with three core methods:
+
+| Method | Description |
+|--------|-------------|
+| `init` | Returns `[model, command]` - initial state and optional startup command |
+| `update(message)` | Returns `[model, command]` - handles messages and updates state |
+| `view` | Returns `String` - renders the current state to the terminal |
+
+### Basic Example
+
+**A simple counter:**
+
+```ruby
+require "bubbletea"
+
+class Counter
+  include Bubbletea::Model
+
+  def initialize
+    @count = 0
+  end
+
+  def init
+    [self, nil]
+  end
+
+  def update(message)
+    case message
+    when Bubbletea::KeyMessage
+      case message.to_s
+      when "q", "ctrl+c"
+        [self, Bubbletea.quit]
+      when "up", "k"
+        @count += 1
+        [self, nil]
+      when "down", "j"
+        @count -= 1
+        [self, nil]
+      else
+        [self, nil]
+      end
+    else
+      [self, nil]
+    end
+  end
+
+  def view
+    "Count: #{@count}\n\nPress up/down to change, q to quit"
+  end
+end
+
+Bubbletea.run(Counter.new)
+```
+
+### Messages
+
+Messages are events that trigger updates to your model:
+
+| Message | Description |
+|---------|-------------|
+| `KeyMessage` | Keyboard input with key type, runes, and modifiers |
+| `MouseMessage` | Mouse events with position, button, and action |
+| `WindowSizeMessage` | Terminal resize events with width and height |
+| `FocusMessage` | Terminal gained focus |
+| `BlurMessage` | Terminal lost focus |
+
+**Handling key messages:**
+
+```ruby
+def update(message)
+  case message
+  when Bubbletea::KeyMessage
+    case message.to_s
+    when "q", "ctrl+c", "esc"
+      [self, Bubbletea.quit]
+    when "up", "k"
+      # handle up
+    when "down", "j"
+      # handle down
+    when "enter"
+      # handle enter
+    end
+  end
+end
+```
+
+**Key message helpers:**
+
+```ruby
+message.enter?     # true if Enter key
+message.backspace? # true if Backspace
+message.tab?       # true if Tab
+message.esc?       # true if Escape
+message.space?     # true if Space
+message.ctrl?      # true if Ctrl modifier
+message.up?        # true if Up arrow
+message.down?      # true if Down arrow
+message.left?      # true if Left arrow
+message.right?     # true if Right arrow
+```
+
+### Commands
+
+Commands trigger side effects and return messages:
+
+| Command | Description |
+|---------|-------------|
+| `Bubbletea.quit` | Exit the program |
+| `Bubbletea.tick(duration) { message }` | Schedule a message after delay |
+| `Bubbletea.batch(cmd1, cmd2, ...)` | Run multiple commands together |
+| `Bubbletea.sequence(cmd1, cmd2, ...)` | Run commands in sequence |
+| `Bubbletea.send_message(message)` | Send a message immediately |
+| `Bubbletea.enter_alt_screen` | Switch to alternate screen buffer |
+| `Bubbletea.exit_alt_screen` | Return to normal screen buffer |
+| `Bubbletea.set_window_title(title)` | Set terminal window title |
+
+**Using tick for animations:**
+
+```ruby
+class TickMessage < Bubbletea::Message; end
+
+def init
+  [self, schedule_tick]
+end
+
+def update(message)
+  case message
+  when TickMessage
+    @frame = (@frame + 1) % FRAMES.length
+    [self, schedule_tick]
+  end
+end
+
+def schedule_tick
+  Bubbletea.tick(0.1) { TickMessage.new }
+end
+```
+
+### Run Options
+
+| Option | Description |
+|--------|-------------|
+| `alt_screen` | Use alternate screen buffer (fullscreen mode) |
+| `mouse_cell_motion` | Enable mouse click tracking |
+| `mouse_all_motion` | Enable all mouse movement tracking |
+| `bracketed_paste` | Enable bracketed paste mode |
+| `report_focus` | Report terminal focus/blur events |
+| `fps` | Target frames per second (default: 60) |
+
+**Run with options:**
+
+```ruby
+Bubbletea.run(MyModel.new,
+  alt_screen: true,
+  mouse_all_motion: true,
+  report_focus: true
+)
+```
+
+### Styling with Lipgloss
+
+Bubbletea works great with [Lipgloss](https://github.com/marcoroth/lipgloss-ruby) for styling:
+
+```ruby
+require "bubbletea"
+require "lipgloss"
+
+class StyledApp
+  include Bubbletea::Model
+
+  def initialize
+    @title_style = Lipgloss::Style.new
+      .bold(true)
+      .foreground("212")
+
+    @help_style = Lipgloss::Style.new
+      .foreground("241")
+  end
+
+  def view
+    lines = []
+    lines << @title_style.render("My App")
+    lines << ""
+    lines << @help_style.render("Press q to quit")
+    lines.join("\n")
+  end
+end
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+**Requirements:**
+- Go 1.23+
+- Ruby 3.2+
+
+**Install dependencies:**
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```bash
+bundle install
+```
+
+**Build the Go library and compile the extension:**
+
+```bash
+bundle exec rake compile
+```
+
+**Run tests:**
+
+```bash
+bundle exec rake test
+```
+
+**Run demos:**
+
+The `demo/` directory contains many working examples:
+
+```bash
+demo/counter
+demo/spinner
+demo/test_runner
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/bubbletea. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/bubbletea/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/bubbletea-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
 
-## Code of Conduct
+## Acknowledgments
 
-Everyone interacting in the Bubbletea project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/bubbletea/blob/main/CODE_OF_CONDUCT.md).
+This gem wraps [charmbracelet/bubbletea](https://github.com/charmbracelet/bubbletea), part of the excellent [Charm](https://charm.sh) ecosystem.

data/bubbletea.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/bubbletea/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "bubbletea"
+  spec.version = Bubbletea::VERSION
+  spec.authors = ["Marco Roth"]
+  spec.email = ["marco.roth@intergga.ch"]
+
+  spec.summary = "Ruby wrapper for Charm's bubbletea. A powerful TUI framework."
+  spec.description = "Build beautiful, interactive terminal applications using the Elm Architecture in Ruby."
+  spec.homepage = "https://github.com/marcoroth/bubbletea-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/releases"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  spec.files = Dir[
+    "bubbletea.gemspec",
+    "LICENSE.txt",
+    "README.md",
+    "CHANGELOG.md",
+    "lib/**/*.rb",
+    "ext/**/*.{c,h,rb}",
+    "go/**/*.{go,mod,sum}",
+    "go/build/**/*"
+  ]
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.extensions = ["ext/bubbletea/extconf.rb"]
+
+  spec.add_dependency "lipgloss", "~> 0.1"
+end

data/ext/bubbletea/extconf.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+extension_name = "bubbletea"
+
+def detect_platform
+  cpu = RbConfig::CONFIG["host_cpu"]
+  os = RbConfig::CONFIG["host_os"]
+
+  arch = case cpu
+         when /aarch64|arm64/ then "arm64"
+         when /x86_64|amd64/ then "amd64"
+         when /arm/ then "arm"
+         when /i[3-6]86/ then "386"
+         else cpu
+         end
+
+  goos = case os
+         when /darwin/ then "darwin"
+         when /mswin|mingw/ then "windows"
+         else "linux"
+         end
+
+  "#{goos}_#{arch}"
+end
+
+platform = detect_platform
+go_lib_dir = File.expand_path("../../go/build/#{platform}", __dir__)
+
+puts "Looking for Go library in: #{go_lib_dir}"
+
+unless File.exist?(File.join(go_lib_dir, "libbubbletea.a"))
+  abort <<~ERROR
+    Could not find libbubbletea.a for platform #{platform}
+
+    Please build the Go archive first:
+      cd go && go build -buildmode=c-archive -o build/#{platform}/libbubbletea.a .
+
+    Or run:
+      bundle exec rake go:build
+  ERROR
+end
+
+$LDFLAGS << " -L#{go_lib_dir}"
+$INCFLAGS << " -I#{go_lib_dir}"
+
+$LOCAL_LIBS << " #{go_lib_dir}/libbubbletea.a"
+
+case RbConfig::CONFIG["host_os"]
+when /darwin/
+  $LDFLAGS << " -framework CoreFoundation -framework Security -framework SystemConfiguration"
+  $LDFLAGS << " -lresolv"
+when /linux/
+  $LDFLAGS << " -lpthread -lm -ldl"
+  $LDFLAGS << " -lresolv" if find_library("resolv", "res_query")
+end
+
+$srcs = [
+  "extension.c",
+  "program.c",
+]
+
+create_makefile("#{extension_name}/#{extension_name}")

data/ext/bubbletea/extension.c

@@ -0,0 +1,59 @@
+#include "extension.h"
+
+VALUE mBubbletea;
+VALUE cProgram;
+
+static VALUE bubbletea_upstream_version_rb(VALUE self) {
+  char *version = tea_upstream_version();
+  VALUE rb_version = rb_utf8_str_new_cstr(version);
+
+  tea_free(version);
+
+  return rb_version;
+}
+
+static VALUE bubbletea_version_rb(VALUE self) {
+  VALUE gem_version = rb_const_get(self, rb_intern("VERSION"));
+  VALUE upstream_version = bubbletea_upstream_version_rb(self);
+  VALUE format_string = rb_utf8_str_new_cstr("bubbletea v%s (upstream charmbracelet/x/ansi %s) [Go native extension]");
+
+  return rb_funcall(rb_mKernel, rb_intern("sprintf"), 3, format_string, gem_version, upstream_version);
+}
+
+static VALUE bubbletea_is_tty_rb(VALUE self) {
+  return tea_terminal_is_tty() ? Qtrue : Qfalse;
+}
+
+static VALUE bubbletea_clear_screen_rb(VALUE self) {
+  tea_terminal_clear_screen();
+  return Qnil;
+}
+
+static VALUE bubbletea_set_window_title_rb(VALUE self, VALUE title) {
+  Check_Type(title, T_STRING);
+  tea_terminal_set_window_title(StringValueCStr(title));
+  return Qnil;
+}
+
+static VALUE bubbletea_get_key_name_rb(VALUE self, VALUE key_type) {
+  Check_Type(key_type, T_FIXNUM);
+  char *name = tea_get_key_name(FIX2INT(key_type));
+  VALUE rb_name = rb_utf8_str_new_cstr(name);
+  free(name);
+  return rb_name;
+}
+
+__attribute__((__visibility__("default"))) void Init_bubbletea(void) {
+  rb_require("json");
+
+  mBubbletea = rb_define_module("Bubbletea");
+
+  Init_bubbletea_program();
+
+  rb_define_singleton_method(mBubbletea, "upstream_version", bubbletea_upstream_version_rb, 0);
+  rb_define_singleton_method(mBubbletea, "version", bubbletea_version_rb, 0);
+  rb_define_singleton_method(mBubbletea, "tty?", bubbletea_is_tty_rb, 0);
+  rb_define_singleton_method(mBubbletea, "clear_screen", bubbletea_clear_screen_rb, 0);
+  rb_define_singleton_method(mBubbletea, "_set_window_title", bubbletea_set_window_title_rb, 1);
+  rb_define_singleton_method(mBubbletea, "get_key_name", bubbletea_get_key_name_rb, 1);
+}

data/ext/bubbletea/extension.h

@@ -0,0 +1,22 @@
+#ifndef BUBBLETEA_EXTENSION_H
+#define BUBBLETEA_EXTENSION_H
+
+#include <ruby.h>
+#include "libbubbletea.h"
+
+extern VALUE mBubbletea;
+extern VALUE cProgram;
+
+extern const rb_data_type_t program_type;
+
+typedef struct {
+  unsigned long long handle;
+} bubbletea_program_t;
+
+#define GET_PROGRAM(self, program) \
+  bubbletea_program_t *program; \
+  TypedData_Get_Struct(self, bubbletea_program_t, &program_type, program)
+
+void Init_bubbletea_program(void);
+
+#endif