gum 0.3.0-arm64-linux

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04da5a10876b453c8c3e8cc911d083d547ab25f3187d646ecc1cd823ef0087f8
+  data.tar.gz: 1dcfedba5197b25c353a796d2123c65f8a882cf54bc2714b0cad7801b3886383
+SHA512:
+  metadata.gz: c29db2d3e3aa86eba9dedbb1fd9fa1f5135985d86c0c1c84cb81f172f617d03ebb9d464fe087b23af62b0ea53086375f6e561c6e8ad6ac4e7a058987334f26f6
+  data.tar.gz: 42c13e04922d19ea5dfdeceafa84fbee8debf2c01a98b0fb5aae96a981400026fc795916399ba4acf6d986360fac552ae4367fc829b9f64ca257b96a384b7695

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

@@ -0,0 +1,460 @@
+# Gum for Ruby
+
+<p>
+  <a href="https://github.com/marcoroth/gum-ruby" target="_blank"><img src="assets/logo.png" alt="Gum Image" width="450" /></a>
+</p>
+
+Ruby wrapper for [Charm's Gum](https://github.com/charmbracelet/gum). A tool for glamorous scripts.
+
+This gem bundles the `gum` binary and provides an idiomatic Ruby API for all gum commands.
+
+## Installation
+
+**Add to your Gemfile:**
+
+```bash
+bundle add gum
+```
+
+**Or install directly:**
+
+```bash
+gem install gum
+```
+
+## Usage
+
+```ruby
+require "gum"
+```
+
+### Input
+
+**Prompt for single-line input:**
+
+```ruby
+name = Gum.input(placeholder: "Enter your name")
+```
+
+**Password input (masked):**
+
+```ruby
+password = Gum.input(password: true)
+```
+
+**With default value and custom prompt:**
+
+```ruby
+email = Gum.input(value: "user@", prompt: "> ", placeholder: "email")
+```
+
+**With character limit:**
+
+```ruby
+code = Gum.input(placeholder: "Enter code", char_limit: 6)
+```
+
+### Write
+
+**Prompt for multi-line text input (Ctrl+D to submit):**
+
+```ruby
+description = Gum.write(placeholder: "Enter description...")
+```
+
+**With dimensions:**
+
+```ruby
+notes = Gum.write(width: 80, height: 10, header: "Notes")
+```
+
+**With line numbers:**
+
+```ruby
+content = Gum.write(show_line_numbers: true)
+```
+
+### Choose
+
+**Single selection (array):**
+
+```ruby
+color = Gum.choose(["red", "green", "blue"])
+```
+
+**Single selection (splat):**
+
+```ruby
+color = Gum.choose("red", "green", "blue")
+```
+
+**Multiple selection with limit:**
+
+```ruby
+colors = Gum.choose(["red", "green", "blue"], limit: 2)
+```
+
+**Unlimited selection:**
+
+```ruby
+colors = Gum.choose(["red", "green", "blue"], no_limit: true)
+```
+
+**With header and custom height:**
+
+```ruby
+choice = Gum.choose(options, header: "Pick one:", height: 10)
+```
+
+**Pre-selected items:**
+
+```ruby
+choice = Gum.choose(["a", "b", "c"], selected: ["b"])
+```
+
+### Filter
+
+**Single selection (array):**
+
+```ruby
+file = Gum.filter(Dir.glob("**/*.rb"))
+```
+
+**Single selection (splat):**
+
+```ruby
+file = Gum.filter("file1.rb", "file2.rb", "file3.rb")
+```
+
+**Multiple selection:**
+
+```ruby
+files = Gum.filter(Dir.glob("*"), limit: 5)
+```
+
+**Unlimited selection:**
+
+```ruby
+files = Gum.filter(items, no_limit: true)
+```
+
+**With placeholder and height:**
+
+```ruby
+selection = Gum.filter(items, placeholder: "Search...", height: 20)
+```
+
+**Disable fuzzy matching for exact search:**
+
+```ruby
+result = Gum.filter(items, fuzzy: false)
+```
+
+### Confirm
+
+**Ask for yes/no confirmation:**
+
+```ruby
+if Gum.confirm("Delete file?")
+  File.delete(path)
+end
+```
+
+**With default value:**
+
+```ruby
+proceed = Gum.confirm("Continue?", default: true)
+```
+
+**Custom button labels:**
+
+```ruby
+Gum.confirm("Save changes?", affirmative: "Save", negative: "Discard")
+```
+
+### File
+
+**Start from current directory:**
+
+```ruby
+path = Gum.file
+```
+
+**Start from specific directory:**
+
+```ruby
+path = Gum.file("~/Documents")
+```
+
+**Show hidden files:**
+
+```ruby
+path = Gum.file(all: true)
+```
+
+**Only show directories:**
+
+```ruby
+dir = Gum.file(directory_only: true)
+```
+
+### Pager
+
+**Scroll through content:**
+
+```ruby
+Gum.pager(File.read("README.md"))
+```
+
+**With line numbers:**
+
+```ruby
+Gum.pager(content, show_line_numbers: true)
+```
+
+**Soft wrap long lines:**
+
+```ruby
+Gum.pager(content, soft_wrap: true)
+```
+
+### Spin
+
+**With shell command:**
+
+```ruby
+Gum.spin("Installing...", command: "npm install")
+```
+
+**With Ruby block:**
+
+```ruby
+result = Gum.spin("Processing...") do
+  expensive_computation
+end
+```
+
+**Custom spinner type:**
+
+```ruby
+Gum.spin("Loading...", spinner: :dot, command: "sleep 5")
+```
+
+Available spinner types: `:line`, `:dot`, `:minidot`, `:jump`, `:pulse`, `:points`, `:globe`, `:moon`, `:monkey`, `:meter`, `:hamburger`
+
+### Style
+
+**Basic styling:**
+
+```ruby
+styled = Gum.style("Hello", foreground: "212", bold: true)
+```
+
+**With border:**
+
+```ruby
+box = Gum.style("Content", border: :double, padding: "1 2")
+```
+
+**Multiple lines with alignment:**
+
+```ruby
+styled = Gum.style("Line 1", "Line 2", align: :center, width: 50)
+```
+
+**Full styling example:**
+
+```ruby
+styled = Gum.style(
+  "Bubble Gum",
+  foreground: "212",
+  border: :double,
+  border_foreground: "212",
+  align: :center,
+  width: 50,
+  margin: "1 2",
+  padding: "2 4"
+)
+```
+
+Available border types: `:none`, `:hidden`, `:rounded`, `:double`, `:thick`, `:normal`
+
+### Join
+
+Join text blocks horizontally or vertically:
+
+```ruby
+box1 = Gum.style("A", border: :rounded, padding: "1 3")
+box2 = Gum.style("B", border: :rounded, padding: "1 3")
+```
+
+**Horizontal join (default):**
+
+```ruby
+combined = Gum.join(box1, box2)
+```
+
+**Vertical join:**
+
+```ruby
+stacked = Gum.join(box1, box2, vertical: true)
+```
+
+**With alignment:**
+
+```ruby
+aligned = Gum.join(box1, box2, vertical: true, align: :center)
+```
+
+### Format
+
+**Markdown:**
+
+```ruby
+Gum.format("# Hello\n- Item 1\n- Item 2", type: :markdown)
+```
+
+**Template (see Termenv docs for helpers):**
+
+```ruby
+Gum.format('{{ Bold "Hello" }} {{ Color "99" "0" " World " }}', type: :template)
+```
+
+**Emoji:**
+
+```ruby
+Gum.format("I :heart: Ruby :gem:", type: :emoji)
+# => "I ❤️ Ruby 💎"
+```
+
+**Shorthand methods:**
+
+```ruby
+Gum::Format.markdown("# Hello")
+Gum::Format.emoji("I :heart: Ruby")
+```
+
+### Table
+
+**From array of arrays:**
+
+```ruby
+data = [["Alice", "30"], ["Bob", "25"]]
+selection = Gum.table(data, columns: %w[Name Age])
+```
+
+**Just print (no selection):**
+
+```ruby
+Gum.table(data, columns: %w[Name Age], print: true)
+```
+
+**From CSV string:**
+
+```ruby
+Gum.table(File.read("data.csv"))
+```
+
+**With custom border:**
+
+```ruby
+Gum.table(data, columns: %w[Name Age], border: :rounded)
+```
+
+### Log
+
+**Basic logging:**
+
+```ruby
+Gum.log("Application started", level: :info)
+```
+
+**Structured logging with key-value pairs:**
+
+```ruby
+Gum.log("User created", level: :info, user_id: 123, email: "user@example.com")
+```
+
+**With timestamp:**
+
+```ruby
+Gum.log("Error occurred", level: :error, time: :rfc822)
+```
+
+**Shorthand methods:**
+
+```ruby
+Gum::Log.debug("Debug message")
+Gum::Log.info("Info message")
+Gum::Log.warn("Warning message")
+Gum::Log.error("Error message", code: 500)
+```
+
+Available log levels: `:debug`, `:info`, `:warn`, `:error`, `:fatal`
+
+## Styling Options
+
+Most commands support styling options as hashes. Common style properties include:
+
+```ruby
+{
+  foreground: "212",        # ANSI color code, hex (#ff0000), or name
+  background: "0",
+  bold: true,
+  italic: true,
+  underline: true,
+  strikethrough: true,
+  faint: true,
+}
+```
+
+**Example with input styling:**
+
+```ruby
+Gum.input(
+  placeholder: "Enter name",
+  cursor: { foreground: "#FF0" },
+  prompt_style: { foreground: "#0FF" }
+)
+```
+
+## Environment Variables
+
+- `GUM_INSTALL_DIR` - Override the path to the gum binary
+
+## Raw Command Execution
+
+For commands not covered by the Ruby API, you can execute gum directly:
+
+```ruby
+Gum.execute("choose", "a", "b", "c", "--limit", "2")
+```
+
+## 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.
+
+### Building Platform Gems
+
+```bash
+rake gem:ruby           # Build pure Ruby gem (no binary)
+rake gem:arm64-darwin   # Build macOS ARM64 gem
+rake gem:x86_64-darwin  # Build macOS Intel gem
+rake gem:arm64-linux    # Build Linux ARM64 gem
+rake gem:x86_64-linux   # Build Linux x86_64 gem
+rake package            # Build all platform gems
+rake download           # Download all binaries
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/gum-ruby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Acknowledgements
+
+- [Charm](https://charm.sh/) for creating the amazing [gum](https://github.com/charmbracelet/gum) tool
+- Inspired by [`litestream-ruby`](https://github.com/fractaledmind/litestream-ruby) for the native binary packaging approach

data/exe/gum

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Because rubygems shims assume a gem's executables are Ruby scripts,
+# we need this wrapper to find and exec the native gum binary.
+
+$LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
+
+require "gum"
+
+exec(Gum.executable, *ARGV)

data/gum.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/gum/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gum"
+  spec.version = Gum::VERSION
+  spec.authors = ["Marco Roth"]
+  spec.email = ["marco.roth@intergga.ch"]
+
+  spec.summary = "Ruby wrapper for Charm's gum CLI tool."
+  spec.description = "Integrate Charm's gum with the RubyGems infrastructure."
+  spec.homepage = "https://github.com/marcoroth/gum-ruby"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 3.2.0"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => "https://github.com/marcoroth/gum-ruby",
+    "changelog_uri" => "https://github.com/marcoroth/gum-ruby/releases",
+    "rubygems_mfa_required" => "true",
+  }
+
+  spec.files = Dir[
+    "gum.gemspec",
+    "lib/**/*",
+    "sig/**/*",
+    "LICENSE.txt",
+    "README.md"
+  ]
+
+  spec.bindir = "exe"
+  spec.executables = ["gum"]
+  spec.require_paths = ["lib"]
+end

data/lib/gum/command.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+# typed: true
+# rbs_inline: enabled
+
+require "English"
+require "open3"
+
+module Gum
+  module Command
+    def self.run(*, input: nil, interactive: true)
+      if input && interactive
+        run_interactive_with_input(*, input: input)
+      elsif input
+        run_non_interactive(*, input: input)
+      else
+        run_interactive(*)
+      end
+    end
+
+    def self.run_non_interactive(*args, input:)
+      stdout, stderr, status = Open3.capture3(Gum.executable, *args.map(&:to_s), stdin_data: input)
+
+      unless status.success?
+        return nil if status.exitstatus == 130 # User cancelled (Ctrl+C)
+
+        raise Error, "gum #{args.first} failed: #{stderr}" unless stderr.empty?
+      end
+
+      stdout.chomp
+    end
+
+    def self.run_interactive(*args)
+      tty = File.open("/dev/tty", "r+")
+
+      stdout, wait_thread = Open3.pipeline_r(
+        [Gum.executable, *args.map(&:to_s)],
+        in: tty,
+        err: tty
+      )
+
+      output = stdout.read.chomp
+      stdout.close
+      tty.close
+
+      status = wait_thread.last.value
+      return nil if status.exitstatus == 130 # User cancelled
+      return nil unless status.success?
+
+      output
+    rescue Errno::ENOENT, Errno::ENXIO, Errno::EIO
+      stdout, stderr, status = Open3.capture3(Gum.executable, *args.map(&:to_s))
+
+      unless status.success?
+        return nil if status.exitstatus == 130
+        raise Error, "gum #{args.first} failed: #{stderr}" unless stderr.empty?
+      end
+
+      stdout.chomp
+    end
+
+    def self.run_interactive_with_input(*args, input:)
+      tty = File.open("/dev/tty", "r+")
+      stdin_read, stdin_write = IO.pipe
+      stdout_read, stdout_write = IO.pipe
+
+      pid = Process.spawn(
+        Gum.executable, *args.map(&:to_s),
+        in: stdin_read,
+        out: stdout_write,
+        err: tty
+      )
+
+      stdin_read.close
+      stdout_write.close
+
+      stdin_write.write(input)
+      stdin_write.close
+
+      output = stdout_read.read.chomp
+      stdout_read.close
+
+      _, status = Process.wait2(pid)
+      tty.close
+
+      return nil if status.exitstatus == 130 # User cancelled
+      return nil unless status.success?
+
+      output
+    rescue Errno::ENOENT, Errno::ENXIO, Errno::EIO
+      run_non_interactive(*args, input: input)
+    end
+
+    def self.run_display_only(*args, input:)
+      IO.popen([Gum.executable, *args.map(&:to_s)], "w") do |io|
+        io.write(input)
+      end
+
+      $CHILD_STATUS.success? || nil
+    rescue Errno::ENOENT
+      raise Error, "gum executable not found"
+    end
+
+    def self.run_with_status(*args, input: nil)
+      if input
+        _stdout, _stderr, status = Open3.capture3(Gum.executable, *args.map(&:to_s), stdin_data: input)
+        status.success?
+      else
+        system(Gum.executable, *args.map(&:to_s))
+      end
+    end
+
+    def self.build_args(command, *positional, **options)
+      args = [command]
+      args.concat(positional.flatten.compact)
+
+      options.each do |key, value|
+        next if value.nil?
+
+        flag = key.to_s.tr("_", "-")
+
+        case value
+        when true
+          args << "--#{flag}"
+        when false
+          args << "--no-#{flag}" if flag_supports_negation?(command, flag)
+        when Array
+          value.each { |v| args << "--#{flag}=#{v}" }
+        when Hash
+          value.each { |k, v| args << "--#{flag}.#{k}=#{v}" }
+        else
+          args << "--#{flag}=#{value}"
+        end
+      end
+
+      args
+    end
+
+    def self.add_style_args(args, flag, style_hash)
+      return unless style_hash
+
+      style_hash.each do |key, value|
+        args << "--#{flag}.#{key}" << value.to_s
+      end
+    end
+
+    def self.flag_supports_negation?(command, flag)
+      negatable = {
+        "filter" => ["fuzzy", "sort", "strict", "reverse", "indicator"],
+        "choose" => ["limit"],
+        "input" => ["echo-mode"],
+        "file" => ["all", "file", "directory"],
+        "pager" => ["soft-wrap"],
+        "table" => ["border", "print"],
+      }
+
+      negatable.fetch(command, []).include?(flag)
+    end
+  end
+end