gum 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a02c8427e4f3b3cecd799d40eafa9c0e7255fb89
-  data.tar.gz: 4d77a6c86e9e28e1d0fb8e7256482215c70eb73a
+SHA256:
+  metadata.gz: 88374c0fc709544b235e42532afa044db6c1942c94038e2cf7812d61993b179f
+  data.tar.gz: 3a5899c9aa058bd33ac932cb746ada5abfbb2d7db12b7d442964d52a1d10e8a0
 SHA512:
-  metadata.gz: 18154411713179aece9cc1d5174ef2a5973e66b586bcef7b3557f785ece3e32ab4ee0f58e93b21cc1f2e79375c29b727355f4c4074db7f7f5ab129dc572abeb9
-  data.tar.gz: 676e2721de554a6bdc9b5b71511e3a33f2973e941d535e7755f71798cc131e617dedf0a3c44aac480efbe6312f4192173f058c855e8d5d306ba759bfe067a9b7
+  metadata.gz: 0e83f09326ff0f52a4333c5da044bb36f698af6b7714bfbd9ccbb500bc66de3b087e80e5ec07eab6598d321417fbe8ebeac541345592ba8cbb66028fd8255388
+  data.tar.gz: dfa419bb6acf8cab4ba247485dbd0d67db96f709566917d8a577f01a462b0613090c0b0e900d3dd270169ec3f753ee794b99b5e30215c3b0da82f7f39975e02d

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Anton Sozontov
+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

data/README.md

@@ -1,41 +1,460 @@
-# Gum
+# Gum for Ruby
 
-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/gum`. To experiment with that code, run `bin/console` for an interactive prompt.
+<p>
+  <a href="https://github.com/marcoroth/gum-ruby" target="_blank"><img src="assets/logo.png" alt="Gum Image" width="450" /></a>
+</p>
 
-TODO: Delete this and the text above, and describe your gem
+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 this line to your application's Gemfile:
+**Add to your Gemfile:**
+
+```bash
+bundle add gum
+```
+
+**Or install directly:**
+
+```bash
+gem install gum
+```
+
+## Usage
 
 ```ruby
-gem 'gum'
+require "gum"
 ```
 
-And then execute:
+### Input
 
-    $ bundle
+**Prompt for single-line input:**
 
-Or install it yourself as:
+```ruby
+name = Gum.input(placeholder: "Enter your name")
+```
 
-    $ gem install gum
+**Password input (masked):**
 
-## Usage
+```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)
+```
 
-TODO: Write usage instructions here
+**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 spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+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.
 
-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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+### Building Platform Gems
 
-## Contributing
+```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
+```
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gum.
+## 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](http://opensource.org/licenses/MIT).
+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

@@ -1,39 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'gum/version'
+# frozen_string_literal: true
+
+require_relative "lib/gum/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'gum'
-  spec.version       = Gum::VERSION
-  spec.authors       = ['Anton Sozontov']
-  spec.email         = ['a.sozontov@gmail.com']
+  spec.name = "gum"
+  spec.version = Gum::VERSION
+  spec.authors = ["Marco Roth"]
+  spec.email = ["marco.roth@intergga.ch"]
 
-  spec.summary       = 'Search DSL on top of chewy gem'
-  spec.description   = %q{Gum provides simple DSL for searching in your Elasticsearch}
-  spec.homepage      = 'https://github.com/qwiqer/gum'
-  spec.license       = 'MIT'
+  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"
 
-  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
-  # to allow pushing to a single host or delete this section to allow pushing to any host.
-  if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "https://rubygems.org"
-  else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
-  end
+  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         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
-  end
-  spec.bindir        = 'exe'
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
+  spec.files = Dir[
+    "gum.gemspec",
+    "lib/**/*",
+    "sig/**/*",
+    "LICENSE.txt",
+    "README.md"
+  ]
 
-  spec.add_development_dependency 'bundler', '~> 1.13'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'pry-byebug', '~> 3.4'
-  spec.add_development_dependency 'simplecov', '~> 0'
-  spec.add_dependency 'activesupport', '>=3.2', '<5.1'
-  spec.add_dependency 'chewy', '~> 0.8.4'
+  spec.bindir = "exe"
+  spec.executables = ["gum"]
+  spec.require_paths = ["lib"]
 end