lipgloss 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 26fcd053ad0cf7fd8973dd14bd9858ac8ed7b098234b5c90743c78f0fbd6e877
-  data.tar.gz: 863a84b8de824a134508ee4629c62b6dcc5f4ed5f52fcc428004962fbaf75838
+  metadata.gz: 9901ec6ebe58427fd807f2b904bc0462afa0c98778ebf7e07bb4e2ab9119a1d3
+  data.tar.gz: db8ccca392715e11e439378696308b8fa7f6aa50a5883b68593aeab54a6076ff
 SHA512:
-  metadata.gz: fb22bdaf2071ceb6c12bc58752d2526a850f38227359fd1ecfd641cf795a05a9f7e63ff86df6ffbbddcbe982e947d6912c8a2d3e9088c3bc1655a76e95613039
-  data.tar.gz: '09e3ebe59c04153b0e4788040b5a48a3d73be80bd6837d1ecfbac7a1b63b19ee7af0899b04a99c9ed31a0fa23a6a86e8083b1cd34fb4491e8e31f35e2776885e'
+  metadata.gz: 2f1b4cf84ccca46aadebd0b8c34439460c228f9e221f0282e5f7af7e802dc72e8bfd009b99ee7c577e37942395c400e21edde4f20a8a45a9b537f0089994625f
+  data.tar.gz: 667e9132355d975ffb0db3db29d13eb92680135cf19eea208e51f881041d4cb9d6871c62d642b11b42260496ac9a391342212691f1113e60cedde1b75156ede4

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,461 @@
-# Lipgloss
+<div align="center">
+  <h1>Lipgloss for Ruby</h1>
+  <h4>CSS-like Terminal Styling for Ruby CLI Apps</h4>
 
-TODO: Delete this and the text below, and describe your gem
+  <p>
+    <a href="https://rubygems.org/gems/lipgloss"><img alt="Gem Version" src="https://img.shields.io/gem/v/lipgloss"></a>
+    <a href="https://github.com/marcoroth/lipgloss-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/lipgloss-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/lipgloss`. To experiment with that code, run `bin/console` for an interactive prompt.
+  <p>Ruby bindings for <a href="https://github.com/charmbracelet/lipgloss">charmbracelet/lipgloss</a>.<br/>Style definitions for nice terminal layouts with a fluent, CSS-like API.</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 "lipgloss"
 ```
 
-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 lipgloss
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Basic Styling
+
+**Create and render styled text:**
+
+```ruby
+require "lipgloss"
+
+style = Lipgloss::Style.new
+  .bold(true)
+  .foreground("#FAFAFA")
+  .background("#7D56F4")
+  .padding(1, 2)
+
+puts style.render("Hello, Lipgloss!")
+```
+
+**Reusable styles:**
+
+```ruby
+heading = Lipgloss::Style.new
+  .bold(true)
+  .foreground("#FF6B6B")
+  .margin_bottom(1)
+
+body = Lipgloss::Style.new
+  .width(40)
+  .align(Lipgloss::CENTER)
+
+puts heading.render("Welcome")
+puts body.render("Styled terminal output")
+```
+
+### Borders
+
+**Add borders to your content:**
+
+```ruby
+box = Lipgloss::Style.new
+  .border(:rounded)
+  .border_foreground("#874BFD")
+  .padding(1, 2)
+
+puts box.render("Boxed content")
+```
+
+**Available border styles:**
+
+| Style      | Description                       |
+|------------|-----------------------------------|
+| `:normal`  | Standard box drawing characters   |
+| `:rounded` | Rounded corners                   |
+| `:thick`   | Thick lines                       |
+| `:double`  | Double lines                      |
+| `:hidden`  | Hidden (spacing only)             |
+| `:block`   | Block characters                  |
+| `:ascii`   | ASCII characters (`+`, `-`, `\|`) |
+
+**Custom borders:**
+
+```ruby
+style = Lipgloss::Style.new
+  .border_custom(
+    top: "~", bottom: "~",
+    left: "|", right: "|",
+    top_left: "+", top_right: "+",
+    bottom_left: "+", bottom_right: "+"
+  )
+
+puts style.render("Custom border!")
+```
+
+**Per-side border colors:**
+
+```ruby
+style = Lipgloss::Style.new
+  .border(:rounded)
+  .border_top_foreground("#FF0000")
+  .border_right_foreground("#00FF00")
+  .border_bottom_foreground("#0000FF")
+  .border_left_foreground("#FFFF00")
+
+puts style.render("Rainbow border!")
+```
+
+### Layout
+
+**Join content horizontally:**
+
+```ruby
+left = box.render("Left")
+right = box.render("Right")
+
+puts Lipgloss.join_horizontal(Lipgloss::TOP, [left, right])
+```
+
+**Join content vertically:**
+
+```ruby
+puts Lipgloss.join_vertical(Lipgloss::CENTER, [left, right])
+```
+
+**Place content in whitespace:**
+
+```ruby
+puts Lipgloss.place(40, 10, Lipgloss::CENTER, Lipgloss::CENTER, "Centered")
+```
+
+### Colors
+
+**Simple hex colors:**
+
+```ruby
+style = Lipgloss::Style.new
+  .foreground("#FF0000")
+  .background("#0000FF")
+```
+
+**Adaptive colors (auto-detect light/dark terminal):**
+
+```ruby
+style = Lipgloss::Style.new
+  .foreground(Lipgloss::AdaptiveColor.new(light: "#000", dark: "#FFF"))
+```
+
+**Complete colors with fallbacks:**
+
+```ruby
+color = Lipgloss::CompleteColor.new(
+  true_color: "#FF6B6B",  # 24-bit color
+  ansi256: "196",          # 256-color fallback
+  ansi: "9"                # 16-color fallback
+)
+
+style = Lipgloss::Style.new.foreground(color)
+```
+
+**Complete adaptive colors:**
+
+```ruby
+light = Lipgloss::CompleteColor.new(true_color: "#000", ansi256: "0", ansi: "0")
+dark = Lipgloss::CompleteColor.new(true_color: "#FFF", ansi256: "15", ansi: "15")
+color = Lipgloss::CompleteAdaptiveColor.new(light: light, dark: dark)
+
+style = Lipgloss::Style.new.foreground(color)
+```
+
+### Style Inheritance
+
+**Inherit styles from a parent:**
+
+```ruby
+base = Lipgloss::Style.new
+  .foreground("#FF0000")
+  .bold(true)
+
+child = Lipgloss::Style.new
+  .padding(1)
+  .inherit(base)  # Inherits foreground and bold
+
+puts child.render("Inherited style!")
+```
+
+**Unset specific properties:**
+
+```ruby
+style = Lipgloss::Style.new
+  .bold(true)
+  .foreground("#FF0000")
+  .unset_bold        # Remove bold
+  .unset_foreground  # Remove foreground color
+```
+
+### SetString
+
+**Set default text for a style:**
+
+```ruby
+style = Lipgloss::Style.new
+  .bold(true)
+  .foreground("#7D56F4")
+  .set_string("Hello!")
+
+puts style.to_s  # Renders "Hello!" with the style
+```
+
+### Tables
+
+**Create styled tables:**
+
+```ruby
+table = Lipgloss::Table.new
+  .headers(["Language", "Greeting"])
+  .rows([
+    ["English", "Hello"],
+    ["Spanish", "Hola"],
+    ["Japanese", "こんにちは"]
+  ])
+  .border(:rounded)
+
+puts table.render
+```
+
+**Style cells with StyleFunc:**
+
+```ruby
+header_style = Lipgloss::Style.new.bold(true).background("#5A56E0")
+even_style = Lipgloss::Style.new.background("#3C3C3C")
+odd_style = Lipgloss::Style.new.background("#4A4A4A")
+
+table = Lipgloss::Table.new
+  .headers(["Name", "Role"])
+  .rows([["Alice", "Engineer"], ["Bob", "Designer"]])
+  .border(:rounded)
+  .style_func(rows: 2, columns: 2) do |row, column|
+    if row == Lipgloss::Table::HEADER_ROW
+      header_style
+    elsif row.even?
+      even_style
+    else
+      odd_style
+    end
+  end
+
+puts table.render
+```
+
+### Lists
+
+**Create styled lists:**
+
+```ruby
+list = Lipgloss::List.new
+  .items(["First item", "Second item", "Third item"])
+  .enumerator(:bullet)
+
+puts list.render
+```
+
+**Available enumerators:**
+
+| Enumerator  | Output             |
+|-------------|--------------------|
+| `:bullet`   | `•`                |
+| `:dash`     | `-`                |
+| `:asterisk` | `*`                |
+| `:arabic`   | `1.`, `2.`, `3.`   |
+| `:alphabet` | `A.`, `B.`, `C.`   |
+| `:roman`    | `I.`, `II.`, `III.` |
+
+**Styled list items:**
+
+```ruby
+list = Lipgloss::List.new
+  .items(["Red", "Green", "Blue"])
+  .enumerator(:bullet)
+  .enumerator_style(Lipgloss::Style.new.foreground("#FF0000"))
+  .item_style(Lipgloss::Style.new.bold(true))
+
+puts list.render
+```
+
+### Trees
+
+**Create tree structures:**
+
+```ruby
+tree = Lipgloss::Tree.new
+  .root("Project")
+  .child("src")
+  .child("lib")
+  .child("test")
+
+puts tree.render
+```
+
+**Nested trees:**
+
+```ruby
+src = Lipgloss::Tree.new.root("src").child("main.rb").child("helper.rb")
+test = Lipgloss::Tree.new.root("test").child("test_main.rb")
+
+tree = Lipgloss::Tree.new
+  .root("Project")
+  .child(src)
+  .child(test)
+
+puts tree.render
+```
+
+## Style Methods
+
+### Text Formatting
+
+| Method                | Description                   |
+|-----------------------|-------------------------------|
+| `bold(bool)`          | Bold text                     |
+| `italic(bool)`        | Italic text                   |
+| `underline(bool)`     | Underlined text               |
+| `strikethrough(bool)` | Strikethrough text            |
+| `reverse(bool)`       | Reverse foreground/background |
+| `blink(bool)`         | Blinking text                 |
+| `faint(bool)`         | Dimmed text                   |
+
+### Colors
+
+| Method                     | Description             |
+|----------------------------|-------------------------|
+| `foreground(color)`        | Text color              |
+| `background(color)`        | Background color        |
+| `margin_background(color)` | Margin background color |
+
+### Dimensions
+
+| Method           | Description    |
+|------------------|----------------|
+| `width(int)`     | Set width      |
+| `height(int)`    | Set height     |
+| `max_width(int)` | Maximum width  |
+| `max_height(int)`| Maximum height |
+
+### Spacing
+
+| Method                                         | Description           |
+|------------------------------------------------|-----------------------|
+| `padding(top, right, bottom, left)`            | Padding (CSS shorthand) |
+| `padding_top(int)`, `padding_right(int)`, etc. | Individual padding    |
+| `margin(top, right, bottom, left)`             | Margin (CSS shorthand) |
+| `margin_top(int)`, `margin_right(int)`, etc.   | Individual margin     |
+
+### Borders
+
+| Method                                         | Description                 |
+|------------------------------------------------|-----------------------------|
+| `border(type, *sides)`                         | Set border type and sides   |
+| `border_style(type)`                           | Set border type only        |
+| `border_foreground(color)`                     | Border color (all sides)    |
+| `border_background(color)`                     | Border background (all sides) |
+| `border_top_foreground(color)`, etc.           | Per-side border colors      |
+| `border_top_background(color)`, etc.           | Per-side border backgrounds |
+| `border_top(bool)`, `border_right(bool)`, etc. | Enable/disable sides        |
+| `border_custom(**opts)`                        | Custom border characters    |
+
+### Alignment
+
+| Method                        | Description          |
+|-------------------------------|----------------------|
+| `align(horizontal, vertical)` | Set alignment        |
+| `align_horizontal(position)`  | Horizontal alignment |
+| `align_vertical(position)`    | Vertical alignment   |
+
+**Position constants:** `Lipgloss::TOP`, `Lipgloss::BOTTOM`, `Lipgloss::LEFT`, `Lipgloss::RIGHT`, `Lipgloss::CENTER`
+
+### Other
+
+| Method             | Description                               |
+|--------------------|-------------------------------------------|
+| `inline(bool)`     | Render inline (no margins/padding/borders) |
+| `tab_width(int)`   | Tab character width (-1 to disable)       |
+| `set_string(text)` | Set default text                          |
+| `inherit(style)`   | Inherit from another style                |
+| `to_s`             | Render with default text                  |
+
+### Unset Methods
+
+| Method                                 | Description          |
+|----------------------------------------|----------------------|
+| `unset_bold`, `unset_italic`, etc.     | Clear text formatting |
+| `unset_foreground`, `unset_background` | Clear colors         |
+| `unset_width`, `unset_height`          | Clear dimensions     |
+| `unset_padding_top`, etc.              | Clear padding        |
+| `unset_margin_top`, etc.               | Clear margin         |
+| `unset_border_style`                   | Clear border         |
+| `unset_inline`                         | Clear inline         |
+
+## Module Methods
+
+| Method                                                                          | Description              |
+|---------------------------------------------------------------------------------|--------------------------|
+| `Lipgloss.join_horizontal(position, strings)`                                   | Join strings horizontally |
+| `Lipgloss.join_vertical(position, strings)`                                     | Join strings vertically  |
+| `Lipgloss.width(string)`                                                        | Get rendered width       |
+| `Lipgloss.height(string)`                                                       | Get rendered height      |
+| `Lipgloss.size(string)`                                                         | Get `[width, height]`    |
+| `Lipgloss.place(width, height, horizontal_position, vertical_position, string)` | Place in whitespace      |
+| `Lipgloss.place_horizontal(width, position, string)`                            | Place horizontally       |
+| `Lipgloss.place_vertical(height, position, string)`                             | Place vertically         |
+| `Lipgloss.has_dark_background?`                                                 | Check terminal background |
 
 ## 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/basic
+./demo/colors
+./demo/table
+./demo/list
+./demo/tree
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/lipgloss. 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/lipgloss/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/lipgloss-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
 
-## Code of Conduct
+## Acknowledgments
 
-Everyone interacting in the Lipgloss project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/lipgloss/blob/main/CODE_OF_CONDUCT.md).
+This gem wraps [charmbracelet/lipgloss](https://github.com/charmbracelet/lipgloss), part of the excellent [Charm](https://charm.sh) ecosystem.

data/ext/lipgloss/extconf.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require "mkmf"
+
+extension_name = "lipgloss"
+
+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, "liblipgloss.a"))
+  abort <<~ERROR
+    Could not find liblipgloss.a for platform #{platform}
+
+    Please build the Go archive first:
+      cd go && go build -buildmode=c-archive -o build/#{platform}/liblipgloss.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}/liblipgloss.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", "style.c", "style_spacing.c", "style_border.c", "style_unset.c", "table.c", "list.c", "tree.c"]
+
+create_makefile("#{extension_name}/#{extension_name}")