bubblezone 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 464eb72e138a345fabe04d3afd3b9df88cf45dc46d2acdef5549851e65599e78
-  data.tar.gz: 8fa05abaa960d03625b415ba0a64628c9794a637282f490ac5978c674cc1c74a
+  metadata.gz: 233090f01a0a7b63b5a2fe7cafa1cea8b714fe846ad6dac9ee852238b80692ee
+  data.tar.gz: 6e8084cbcb55dd14712c61e8d994a68fe7d9e538d71497dae7da2dc2389c5d17
 SHA512:
-  metadata.gz: df0548ca34f9c95b7e5fdd0618230d2ef58593fa06aa9edfe49a05a087b5736d42070f85162bf07c3620071e3dad46ba68c8ed556c7e4a41bf73a4cbeddeb377
-  data.tar.gz: f4658720eb81685489105e20308a36d8b548df273f720d9c9683fd7e6dce51f71081235355ec1a00cdf46ebd21dbe3916ac1ebfc13451266d1d5f6682d34233c
+  metadata.gz: 8df820e13416ce757560d86d7d6cf5ab14da8c6a698db44c6620ab2e07b423f90235586a8cd218a44badf26ad008f824d7475067b06cad8df489fdd4cb3869b4
+  data.tar.gz: 89f04858df8e4fe9a14d0594c2e68dc661c16fd00bf5a6242941c7d44d1faed8e7ac6b9f654b03d0088139d6157d59dc40f59ee15e00e7552beef451312da2de

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,370 @@
-# Bubblezone
+<div align="center">
+  <h1>Bubblezone for Ruby</h1>
+  <h4>Helper utility for <a href="https://github.com/marcoroth/bubbletea-ruby">Bubble Tea</a>, allowing easy mouse event tracking in terminal applications.</h4>
 
-TODO: Delete this and the text below, and describe your gem
+  <p>
+    <a href="https://rubygems.org/gems/bubblezone"><img alt="Gem Version" src="https://img.shields.io/gem/v/bubblezone"></a>
+    <a href="https://github.com/marcoroth/bubblezone-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/bubblezone-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/bubblezone`. To experiment with that code, run `bin/console` for an interactive prompt.
+  <p>Ruby bindings for <a href="https://github.com/lrstanley/bubblezone">lrstanley/bubblezone</a>.<br/>Track clickable regions in terminal UIs. Built for use with <a href="https://github.com/marcoroth/bubbletea-ruby">Bubble Tea</a> and <a href="https://github.com/marcoroth/lipgloss-ruby">Lipgloss</a>.</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 "bubblezone"
 ```
 
-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 bubblezone
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Zone Marking
+
+**Initialize the global zone manager:**
+
+```ruby
+require "bubblezone"
+
+Bubblezone.new_global
+```
+
+**Mark a region with an ID:**
+
+```ruby
+button = Bubblezone.mark("my_button", "Click Me")
+```
+
+**Build your layout and scan to register zones:**
+
+```ruby
+layout = "Header\n#{button}\nFooter"
+output = Bubblezone.scan(layout)
+puts output
+```
+
+**Output:**
+
+```
+Header
+Click Me
+Footer
+```
+
+### Getting Zone Information
+
+**Get zone info by ID:**
+
+```ruby
+zone = Bubblezone.get("my_button")
+```
+
+**Check zone bounds:**
+
+```ruby
+if zone
+  puts "Zone bounds: (#{zone.start_x}, #{zone.start_y}) to (#{zone.end_x}, #{zone.end_y})"
+end
+```
+
+### Checking Mouse Coordinates
+
+**Get coordinates from mouse event:**
+
+```ruby
+x, y = message.x, message.y
+```
+
+**Check if coordinates are within a zone:**
+
+```ruby
+zone = Bubblezone.get("my_button")
+if zone&.in_bounds?(x, y)
+  puts "Button clicked!"
+end
+```
+
+### Iterating Over Zones
+
+**Iterate over all zones containing the coordinates:**
+
+```ruby
+Bubblezone.each_in_bounds(x, y) do |id, zone|
+  puts "Hit zone: #{id}"
+end
+```
+
+**Check if any zone contains the coordinates:**
+
+```ruby
+if Bubblezone.any_in_bounds?(x, y)
+  puts "Something was clicked"
+end
+```
+
+**Get the first matching zone:**
+
+```ruby
+result = Bubblezone.find_in_bounds(x, y)
+if result
+  id, zone = result
+  puts "First hit: #{id}"
+end
+```
+
+### Zone Prefixes
+
+**Prevent ID conflicts between components:**
+
+```ruby
+class MyComponent
+  def initialize
+    @prefix = Bubblezone.new_prefix
+  end
+
+  def view
+    items = ["Apple", "Banana", "Cherry"]
+    items.map.with_index do |item, i|
+      Bubblezone.mark("#{@prefix}#{i}", item)
+    end.join("\n")
+  end
+end
+```
+
+### Manager Instances
+
+**Create a dedicated manager:**
+
+```ruby
+manager = Bubblezone::Manager.new
+```
+
+**Use the same API as the global manager:**
+
+```ruby
+marked = manager.mark("zone_id", "Content")
+output = manager.scan(marked)
+zone = manager.get("zone_id")
+```
+
+**Iterate zones:**
+
+```ruby
+manager.each_in_bounds(x, y) { |id, zone| ... }
+```
+
+**Clean up when done:**
+
+```ruby
+manager.close
+```
+
+### Integration with Bubbletea
+
+**Handle mouse clicks in a Bubbletea model:**
+
+```ruby
+require "bubbletea"
+require "bubblezone"
+
+Bubblezone.new_global
+
+class ClickableApp
+  include Bubbletea::Model
+
+  ITEMS = ["Option A", "Option B", "Option C"]
+
+  def initialize
+    @selected = nil
+    @prefix = Bubblezone.new_prefix
+  end
+
+  def init
+    [self, nil]
+  end
+
+  def update(message)
+    case message
+    when Bubbletea::MouseMessage
+      if message.release? && (message.left? || message.button == 0)
+        result = Bubblezone.find_in_bounds(message.x, message.y)
+        if result
+          id, _zone = result
+          @selected = id.sub(@prefix, "").to_i
+        end
+      end
+      [self, nil]
+    when Bubbletea::KeyMessage
+      return [self, Bubbletea.quit] if message.to_s == "q"
+      [self, nil]
+    else
+      [self, nil]
+    end
+  end
+
+  def view
+    lines = ITEMS.map.with_index do |item, i|
+      marker = i == @selected ? "[x]" : "[ ]"
+      content = "#{marker} #{item}"
+      Bubblezone.mark("#{@prefix}#{i}", content)
+    end
+
+    Bubblezone.scan(lines.join("\n"))
+  end
+end
+
+Bubbletea.run(ClickableApp.new, alt_screen: true, mouse_cell_motion: true)
+```
+
+### Integration with Lipgloss
+
+**Style your content first:**
+
+```ruby
+require "lipgloss"
+require "bubblezone"
+
+Bubblezone.new_global
+
+button_style = Lipgloss::Style.new
+  .background("#7D56F4")
+  .foreground("#FFFFFF")
+  .padding(0, 3)
+```
+
+**Mark the fully styled content:**
+
+```ruby
+styled_button = button_style.render("Click Me")
+clickable_button = Bubblezone.mark("btn", styled_button)
+```
+
+**Scan to register zones:**
+
+```ruby
+output = Bubblezone.scan(clickable_button)
+```
+
+## API Reference
+
+### Module Methods (Global Manager)
+
+| Method | Description |
+|--------|-------------|
+| `Bubblezone.new_global` | Initialize the global zone manager |
+| `Bubblezone.close` | Close the global manager |
+| `Bubblezone.enabled?` | Check if zone tracking is enabled |
+| `Bubblezone.enabled = bool` | Enable/disable zone tracking |
+| `Bubblezone.new_prefix` | Generate a unique zone ID prefix |
+| `Bubblezone.mark(id, text)` | Wrap text with zone markers |
+| `Bubblezone.scan(text)` | Parse zones and strip markers |
+| `Bubblezone.get(id)` | Get ZoneInfo for an ID (or nil) |
+| `Bubblezone.clear(id)` | Remove a stored zone |
+| `Bubblezone.clear_all` | Remove all stored zones |
+| `Bubblezone.zone_ids` | Get array of all tracked zone IDs |
+
+### Iteration Methods
+
+| Method | Description |
+|--------|-------------|
+| `Bubblezone.each_in_bounds(x, y) { \|id, zone\| }` | Yield each zone containing coordinates |
+| `Bubblezone.any_in_bounds?(x, y)` | Check if any zone contains coordinates |
+| `Bubblezone.find_in_bounds(x, y)` | Get first `[id, zone]` pair, or nil |
+
+### Manager Class
+
+| Method | Description |
+|--------|-------------|
+| `Manager.new` | Create a new zone manager |
+| `#close` | Close the manager |
+| `#enabled?` / `#enabled=` | Get/set enabled state |
+| `#new_prefix` | Generate unique prefix |
+| `#mark(id, text)` | Mark text with zone |
+| `#scan(text)` | Parse and strip markers |
+| `#get(id)` | Get zone info |
+| `#clear(id)` | Clear specific zone |
+| `#clear_all` | Clear all zones |
+| `#zone_ids` | Get all zone IDs |
+| `#each_in_bounds(x, y)` | Iterate matching zones |
+| `#any_in_bounds?(x, y)` | Check for any match |
+| `#find_in_bounds(x, y)` | Get first match |
+
+### ZoneInfo Class
+
+| Method | Description |
+|--------|-------------|
+| `#start_x`, `#start_y` | Zone start coordinates |
+| `#end_x`, `#end_y` | Zone end coordinates |
+| `#in_bounds?(x, y)` | Check if coordinates are within zone |
+| `#zero?` | Check if zone has no position data |
+| `#pos(x, y)` | Get relative position within zone |
+
+## Important Notes
+
+### Zone Processing is Asynchronous
+
+The Go bubblezone library processes zones asynchronously. After calling `scan`, there may be a brief delay before zones are available via `get`. In interactive applications with Bubbletea, this is typically not an issue as mouse events occur after rendering.
+
+### Coordinate Systems
+
+When using `alt_screen: true` with Bubbletea, mouse coordinates are relative to (0, 0) at the top-left of the screen, matching zone coordinates exactly. Without alt screen, you may need to account for terminal scroll position.
+
+### Order of Operations
+
+1. Style your content with Lipgloss
+2. Mark the styled content with `Bubblezone.mark`
+3. Build your complete layout
+4. Call `Bubblezone.scan` on the final output
+5. Handle mouse events using `get` or `find_in_bounds`
 
 ## 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+
 
-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).
+**Install dependencies:**
+
+```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:**
+
+```bash
+./demo/clickable_alt
+./demo/clickable_list
+./demo/clickable_simple
+./demo/full_layout
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/bubblezone. 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/bubblezone/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/bubblezone-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
 
-## Code of Conduct
+## Acknowledgments
 
-Everyone interacting in the Bubblezone project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/bubblezone/blob/main/CODE_OF_CONDUCT.md).
+This gem wraps [lrstanley/bubblezone](https://github.com/lrstanley/bubblezone), which provides zone tracking for terminal UIs and builds on the excellent [Charm](https://charm.sh) ecosystem, including [lipgloss](https://github.com/marcoroth/lipgloss-ruby) and [bubbletea](https://github.com/marcoroth/bubbletea-ruby).

data/bubblezone.gemspec

@@ -33,5 +33,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.extensions = ["ext/bubblezone/extconf.rb"]
+
   spec.add_dependency "rake-compiler", "~> 1.2"
 end

data/ext/bubblezone/extconf.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+extension_name = "bubblezone"
+
+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, "libbubblezone.a"))
+  abort <<~ERROR
+    Could not find libbubblezone.a for platform #{platform}
+
+    Please build the Go archive first:
+      cd go && go build -buildmode=c-archive -o build/#{platform}/libbubblezone.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}/libbubblezone.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",
+  "manager.c",
+  "zone_info.c",
+]
+
+create_makefile("#{extension_name}/#{extension_name}")

data/ext/bubblezone/extension.c

@@ -0,0 +1,107 @@
+#include "extension.h"
+
+VALUE mBubblezone;
+VALUE cManager;
+VALUE cZoneInfo;
+
+static VALUE bubblezone_new_global_rb(VALUE self) {
+  bubblezone_new_global();
+  return Qnil;
+}
+
+static VALUE bubblezone_global_close_rb(VALUE self) {
+  bubblezone_global_close();
+  return Qnil;
+}
+
+static VALUE bubblezone_global_set_enabled_rb(VALUE self, VALUE enabled) {
+  bubblezone_global_set_enabled(RTEST(enabled) ? 1 : 0);
+  return enabled;
+}
+
+static VALUE bubblezone_global_enabled_rb(VALUE self) {
+  return bubblezone_global_enabled() ? Qtrue : Qfalse;
+}
+
+static VALUE bubblezone_global_new_prefix_rb(VALUE self) {
+  char *prefix = bubblezone_global_new_prefix();
+  VALUE rb_prefix = rb_utf8_str_new_cstr(prefix);
+  bubblezone_free(prefix);
+
+  return rb_prefix;
+}
+
+static VALUE bubblezone_global_mark_rb(VALUE self, VALUE zone_id, VALUE text) {
+  Check_Type(zone_id, T_STRING);
+  Check_Type(text, T_STRING);
+
+  char *result = bubblezone_global_mark(StringValueCStr(zone_id), StringValueCStr(text));
+  VALUE rb_result = rb_utf8_str_new_cstr(result);
+  bubblezone_free(result);
+
+  return rb_result;
+}
+
+static VALUE bubblezone_global_clear_rb(VALUE self, VALUE zone_id) {
+  Check_Type(zone_id, T_STRING);
+  bubblezone_global_clear(StringValueCStr(zone_id));
+  return Qnil;
+}
+
+static VALUE bubblezone_global_get_rb(VALUE self, VALUE zone_id) {
+  Check_Type(zone_id, T_STRING);
+
+  unsigned long long handle = bubblezone_global_get(StringValueCStr(zone_id));
+
+  if (handle == 0) {
+    return Qnil;
+  }
+
+  return zone_info_wrap(cZoneInfo, handle);
+}
+
+static VALUE bubblezone_global_scan_rb(VALUE self, VALUE text) {
+  Check_Type(text, T_STRING);
+
+  char *result = bubblezone_global_scan(StringValueCStr(text));
+  VALUE rb_result = rb_utf8_str_new_cstr(result);
+  bubblezone_free(result);
+
+  return rb_result;
+}
+
+static VALUE bubblezone_upstream_version_rb(VALUE self) {
+  char *version = bubblezone_upstream_version();
+  VALUE rb_version = rb_utf8_str_new_cstr(version);
+  bubblezone_free(version);
+
+  return rb_version;
+}
+
+static VALUE bubblezone_version_rb(VALUE self) {
+  VALUE gem_version = rb_const_get(self, rb_intern("VERSION"));
+  VALUE upstream_version = bubblezone_upstream_version_rb(self);
+  VALUE format_string = rb_utf8_str_new_cstr("bubblezone v%s (upstream %s) [Go native extension]");
+
+  return rb_funcall(rb_mKernel, rb_intern("sprintf"), 3, format_string, gem_version, upstream_version);
+}
+
+__attribute__((__visibility__("default"))) void Init_bubblezone(void) {
+  mBubblezone = rb_define_module("Bubblezone");
+
+  Init_bubblezone_manager();
+  Init_bubblezone_zone_info();
+
+  rb_define_singleton_method(mBubblezone, "new_global", bubblezone_new_global_rb, 0);
+  rb_define_singleton_method(mBubblezone, "close", bubblezone_global_close_rb, 0);
+  rb_define_singleton_method(mBubblezone, "enabled=", bubblezone_global_set_enabled_rb, 1);
+  rb_define_singleton_method(mBubblezone, "enabled?", bubblezone_global_enabled_rb, 0);
+  rb_define_singleton_method(mBubblezone, "new_prefix", bubblezone_global_new_prefix_rb, 0);
+  rb_define_singleton_method(mBubblezone, "mark", bubblezone_global_mark_rb, 2);
+  rb_define_singleton_method(mBubblezone, "clear", bubblezone_global_clear_rb, 1);
+  rb_define_singleton_method(mBubblezone, "get", bubblezone_global_get_rb, 1);
+  rb_define_singleton_method(mBubblezone, "scan", bubblezone_global_scan_rb, 1);
+
+  rb_define_singleton_method(mBubblezone, "upstream_version", bubblezone_upstream_version_rb, 0);
+  rb_define_singleton_method(mBubblezone, "version", bubblezone_version_rb, 0);
+}

data/ext/bubblezone/extension.h

@@ -0,0 +1,36 @@
+#ifndef BUBBLEZONE_EXTENSION_H
+#define BUBBLEZONE_EXTENSION_H
+
+#include <ruby.h>
+#include "libbubblezone.h"
+
+extern VALUE mBubblezone;
+extern VALUE cManager;
+extern VALUE cZoneInfo;
+
+typedef struct {
+  unsigned long long handle;
+} bubblezone_manager_t;
+
+typedef struct {
+  unsigned long long handle;
+} bubblezone_zone_info_t;
+
+#define GET_MANAGER(self, manager) \
+  bubblezone_manager_t *manager; \
+  TypedData_Get_Struct(self, bubblezone_manager_t, &manager_type, manager)
+
+#define GET_ZONE_INFO(self, zone_info) \
+  bubblezone_zone_info_t *zone_info; \
+  TypedData_Get_Struct(self, bubblezone_zone_info_t, &zone_info_type, zone_info)
+
+extern const rb_data_type_t manager_type;
+extern const rb_data_type_t zone_info_type;
+
+VALUE manager_wrap(VALUE klass, unsigned long long handle);
+VALUE zone_info_wrap(VALUE klass, unsigned long long handle);
+
+void Init_bubblezone_manager(void);
+void Init_bubblezone_zone_info(void);
+
+#endif