glamour 0.1.0-x86_64-linux-gnu

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d5bd266a6ea97448b7451821d0a0b5328489865472407b8adb94b2ab603ce273
+  data.tar.gz: b134b28a1f7aa00907aef1f03deb14044b3d135d4d92f95d5718b8bc2f646546
+SHA512:
+  metadata.gz: 0bb88d5a1a758275f56eb5ab14c279e6f31dc516fb8c067ce3b5974e7e933d44b95f622edda37a48ece8b94e089ee0895fad3dec4cec60cf7a482cd49b187bc6
+  data.tar.gz: 89de15c6bcb2a71adceae654b3875149765b34661f178e314bc042d479502723020fa19fc124efa39816d18fa48d1ce0ee7aa84f99cf23d34d96c47ea931f61e

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,306 @@
+<div align="center">
+  <h1>Glamour</h1>
+  <h4>Stylesheet-based Markdown Rendering for Ruby CLI Apps</h4>
+
+  <p>
+    <a href="https://rubygems.org/gems/glamour"><img alt="Gem Version" src="https://img.shields.io/gem/v/glamour"></a>
+    <a href="https://github.com/marcoroth/glamour-ruby/blob/main/LICENSE.txt"><img alt="License" src="https://img.shields.io/github/license/marcoroth/glamour-ruby"></a>
+  </p>
+
+  <p>Ruby bindings for <a href="https://github.com/charmbracelet/glamour">charmbracelet/glamour</a>.<br/>Render markdown documents with beautiful styling on ANSI-compatible terminals.</p>
+</div>
+
+## Installation
+
+**Add to your Gemfile:**
+
+```ruby
+gem "glamour"
+```
+
+**Or install directly:**
+
+```bash
+gem install glamour
+```
+
+## Usage
+
+### Basic Rendering
+
+**Render markdown with auto-detected style:**
+
+```ruby
+require "glamour"
+
+puts Glamour.render("# Hello World")
+```
+
+**Render with a specific style:**
+
+```ruby
+puts Glamour.render("# Hello", style: "dark")
+puts Glamour.render("# Hello", style: "light")
+puts Glamour.render("# Hello", style: "dracula")
+puts Glamour.render("# Hello", style: "notty")
+```
+
+**Render with word wrap:**
+
+```ruby
+puts Glamour.render(long_markdown, width: 80)
+```
+
+### Render Options
+
+| Option | Description |
+|--------|-------------|
+| `style` | `"auto"`, `"dark"`, `"light"`, `"notty"`, `"dracula"` |
+| `width` | Word wrap width |
+| `emoji` | Enable emoji rendering (`:wave:` → 👋) |
+| `preserve_newlines` | Preserve newlines in output |
+| `base_url` | Base URL for relative links |
+| `color_profile` | `:auto`, `:true_color`, `:ansi256`, `:ansi`, `:ascii` |
+
+**Example with all options:**
+
+```ruby
+Glamour.render(markdown,
+  style: "dark",
+  width: 80,
+  emoji: true,
+  preserve_newlines: true,
+  base_url: "https://example.com",
+  color_profile: :true_color
+)
+```
+
+### Custom Styles with Hash
+
+**Define a custom style:**
+
+```ruby
+custom_style = {
+  heading: { bold: true, color: "212" },
+  strong: { bold: true, color: "196" },
+  emph: { italic: true, color: "226" },
+  code: { color: "203", background_color: "236" }
+}
+```
+
+**Render with the custom style:**
+
+```ruby
+Glamour.render_with_style("# Hello **World**", custom_style)
+```
+
+**With width option:**
+
+```ruby
+Glamour.render_with_style("# Hello", custom_style, width: 60)
+```
+
+### Style DSL
+
+**Define reusable styles using a Ruby DSL:**
+
+```ruby
+class MyStyle < Glamour::Style
+  style :heading do
+    bold true
+    color "212"
+  end
+
+  style :h1 do
+    prefix "# "
+    color "99"
+    bold true
+  end
+
+  style :strong do
+    bold true
+    color "196"
+  end
+
+  style :emph do
+    italic true
+    color "226"
+  end
+
+  style :code do
+    color "203"
+    background_color "236"
+  end
+
+  style :document do
+    margin 2
+  end
+end
+```
+
+**Use the style class directly:**
+
+```ruby
+MyStyle.render("# Hello **World**")
+MyStyle.render("# Hello", width: 80)
+```
+
+**Or pass to Glamour.render:**
+
+```ruby
+Glamour.render("# Hello", style: MyStyle)
+```
+
+### Reusable Renderer
+
+**Create a renderer with preset options:**
+
+```ruby
+renderer = Glamour::Renderer.new(
+  style: "dark",
+  width: 80,
+  emoji: true
+)
+```
+
+**Render multiple documents:**
+
+```ruby
+puts renderer.render("# Hello :wave:")
+puts renderer.render("# Another document")
+```
+
+**With a Style class:**
+
+```ruby
+renderer = Glamour::Renderer.new(style: MyStyle, width: 60)
+puts renderer.render("# Styled output")
+```
+
+## Available Style Elements
+
+### Block Elements
+
+| Element | Description |
+|---------|-------------|
+| `document` | Root document wrapper |
+| `paragraph` | Text paragraphs |
+| `heading` | Base heading style (h1-h6 inherit from this) |
+| `h1` - `h6` | Individual heading levels |
+| `block_quote` | Block quotations |
+| `code_block` | Fenced code blocks |
+| `list` | List containers |
+| `item` | List items (bullets) |
+| `enumeration` | Numbered list items |
+| `table` | Markdown tables |
+| `hr` | Horizontal rules |
+
+### Inline Elements
+
+| Element | Description |
+|---------|-------------|
+| `text` | Base text styling |
+| `strong` | Bold text (`**bold**`) |
+| `emph` | Italic text (`*italic*`) |
+| `strikethrough` | Strikethrough text |
+| `code` | Inline code (`` `code` ``) |
+| `link` | Link elements |
+| `link_text` | Link text display |
+| `image` | Image references |
+
+## Style Properties
+
+**Text decoration:**
+
+```ruby
+bold true
+italic true
+underline true
+crossed_out true
+faint true
+inverse true
+overlined true
+```
+
+**Colors (ANSI 256 color codes):**
+
+```ruby
+color "212"
+background_color "236"
+```
+
+**Spacing:**
+
+```ruby
+margin 2
+indent 1
+indent_token "  "
+level_indent 2
+```
+
+**Prefix/suffix:**
+
+```ruby
+prefix "# "
+suffix ""
+block_prefix ""
+block_suffix "\n"
+```
+
+## Built-in Styles
+
+- `"auto"` - Auto-detect dark/light terminal
+- `"dark"` - Dark terminal theme
+- `"light"` - Light terminal theme
+- `"notty"` - No colors (for non-TTY output)
+- `"dracula"` - Dracula color scheme
+
+## Version Info
+
+```ruby
+puts Glamour.version
+```
+
+## Development
+
+**Requirements:**
+- Go 1.23+
+- Ruby 3.2+
+
+**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/styles
+./demo/style_dsl
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/glamour-ruby.
+
+## License
+
+The gem is available as open source under the terms of the MIT License.
+
+## Acknowledgments
+
+This gem wraps [charmbracelet/glamour](https://github.com/charmbracelet/glamour), part of the excellent [Charm](https://charm.sh) ecosystem.

data/ext/glamour/extconf.rb

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

data/ext/glamour/extension.c

@@ -0,0 +1,300 @@
+/* frozen_string_literal: true */
+
+#include <ruby.h>
+#include "libglamour.h"
+
+VALUE mGlamour;
+VALUE cRenderer;
+
+#define COLOR_PROFILE_AUTO 0
+#define COLOR_PROFILE_TRUE_COLOR 1
+#define COLOR_PROFILE_ANSI256 2
+#define COLOR_PROFILE_ANSI 3
+#define COLOR_PROFILE_ASCII 4
+
+/*
+ * Render markdown to terminal-styled output.
+ *
+ * @param markdown [String] The markdown content to render
+ * @param style [String] Style name: "auto", "dark", "light", "notty", "dracula"
+ * @param width [Integer] Optional word wrap width
+ * @param emoji [Boolean] Enable emoji rendering
+ * @param preserve_newlines [Boolean] Preserve newlines in output
+ * @param base_url [String] Base URL for relative links
+ * @param color_profile [Symbol] Color profile: :auto, :true_color, :ansi256, :ansi, :ascii
+ * @return [String] Rendered output with ANSI escape codes
+ */
+static VALUE glamour_render_rb(int argc, VALUE *argv, VALUE self) {
+  VALUE markdown, options;
+  rb_scan_args(argc, argv, "1:", &markdown, &options);
+
+  Check_Type(markdown, T_STRING);
+
+  const char *style = "auto";
+  const char *base_url = NULL;
+
+  int width = 0;
+  int emoji = 0;
+  int preserve_newlines = 0;
+  int color_profile = COLOR_PROFILE_AUTO;
+  int has_advanced_options = 0;
+
+  if (!NIL_P(options)) {
+    VALUE style_value = rb_hash_lookup(options, ID2SYM(rb_intern("style")));
+    VALUE width_value = rb_hash_lookup(options, ID2SYM(rb_intern("width")));
+    VALUE emoji_value = rb_hash_lookup(options, ID2SYM(rb_intern("emoji")));
+    VALUE color_value = rb_hash_lookup(options, ID2SYM(rb_intern("color_profile")));
+
+    VALUE base_url_value = rb_hash_lookup(options, ID2SYM(rb_intern("base_url")));
+    VALUE preserve_value = rb_hash_lookup(options, ID2SYM(rb_intern("preserve_newlines")));
+
+    if (!NIL_P(style_value)) {
+      Check_Type(style_value, T_STRING);
+      style = StringValueCStr(style_value);
+    }
+
+    if (!NIL_P(width_value)) {
+      width = NUM2INT(width_value);
+    }
+
+    if (RTEST(emoji_value)) {
+      emoji = 1;
+      has_advanced_options = 1;
+    }
+
+    if (RTEST(preserve_value)) {
+      preserve_newlines = 1;
+      has_advanced_options = 1;
+    }
+
+    if (!NIL_P(base_url_value)) {
+      Check_Type(base_url_value, T_STRING);
+      base_url = StringValueCStr(base_url_value);
+      has_advanced_options = 1;
+    }
+
+    if (!NIL_P(color_value)) {
+      has_advanced_options = 1;
+
+      if (color_value == ID2SYM(rb_intern("true_color"))) {
+        color_profile = COLOR_PROFILE_TRUE_COLOR;
+      } else if (color_value == ID2SYM(rb_intern("ansi256"))) {
+        color_profile = COLOR_PROFILE_ANSI256;
+      } else if (color_value == ID2SYM(rb_intern("ansi"))) {
+        color_profile = COLOR_PROFILE_ANSI;
+      } else if (color_value == ID2SYM(rb_intern("ascii"))) {
+        color_profile = COLOR_PROFILE_ASCII;
+      }
+    }
+  }
+
+  char *result;
+
+  if (has_advanced_options || width > 0) {
+    result = glamour_render_with_options(
+      (char *) StringValueCStr(markdown),
+      (char *) style,
+      width,
+      emoji,
+      preserve_newlines,
+      (char *) base_url,
+      color_profile
+    );
+  } else {
+    result = glamour_render(
+      (char *) StringValueCStr(markdown),
+      (char *) style
+    );
+  }
+
+  VALUE rb_result = rb_utf8_str_new_cstr(result);
+  glamour_free(result);
+
+  return rb_result;
+}
+
+/*
+ * Render markdown with a custom JSON style.
+ *
+ * @param markdown [String] The markdown content to render
+ * @param json_style [String] JSON style definition
+ * @param width [Integer] Optional word wrap width
+ * @return [String] Rendered output with ANSI escape codes
+ */
+static VALUE glamour_render_with_json_rb(int argc, VALUE *argv, VALUE self) {
+  VALUE markdown, json_style, options;
+  rb_scan_args(argc, argv, "2:", &markdown, &json_style, &options);
+
+  Check_Type(markdown, T_STRING);
+  Check_Type(json_style, T_STRING);
+
+  int width = 0;
+
+  if (!NIL_P(options)) {
+    VALUE width_value = rb_hash_lookup(options, ID2SYM(rb_intern("width")));
+
+    if (!NIL_P(width_value)) {
+      width = NUM2INT(width_value);
+    }
+  }
+
+  char *result = glamour_render_with_json_style(
+    (char *) StringValueCStr(markdown),
+    (char *) StringValueCStr(json_style),
+    width
+  );
+
+  VALUE rb_result = rb_utf8_str_new_cstr(result);
+  glamour_free(result);
+
+  return rb_result;
+}
+
+/*
+ * Get the upstream glamour version.
+ *
+ * @return [String] Upstream glamour version
+ */
+static VALUE glamour_upstream_version_rb(VALUE self) {
+  char *version = glamour_upstream_version();
+  VALUE rb_version = rb_utf8_str_new_cstr(version);
+  glamour_free(version);
+
+  return rb_version;
+}
+
+/*
+ * Get the glamour version info.
+ *
+ * @return [String] Version information string
+ */
+static VALUE glamour_version_rb(VALUE self) {
+  VALUE gem_version = rb_const_get(self, rb_intern("VERSION"));
+  VALUE upstream_version = glamour_upstream_version_rb(self);
+  VALUE format_string = rb_utf8_str_new_cstr("glamour v%s (upstream v%s) [Go native extension]");
+
+  return rb_funcall(rb_mKernel, rb_intern("sprintf"), 3, format_string, gem_version, upstream_version);
+}
+
+/* Renderer class methods */
+
+static VALUE renderer_alloc(VALUE klass) {
+  return Data_Wrap_Struct(klass, NULL, NULL, NULL);
+}
+
+static VALUE renderer_initialize(int argc, VALUE *argv, VALUE self) {
+  VALUE options;
+  rb_scan_args(argc, argv, "0:", &options);
+
+  rb_iv_set(self, "@style", rb_str_new_cstr("auto"));
+  rb_iv_set(self, "@width", INT2FIX(0));
+  rb_iv_set(self, "@emoji", Qfalse);
+  rb_iv_set(self, "@preserve_newlines", Qfalse);
+  rb_iv_set(self, "@base_url", Qnil);
+  rb_iv_set(self, "@color_profile", ID2SYM(rb_intern("auto")));
+  rb_iv_set(self, "@json_style", Qnil);
+
+  if (!NIL_P(options)) {
+    VALUE style = rb_hash_lookup(options, ID2SYM(rb_intern("style")));
+    if (!NIL_P(style)) rb_iv_set(self, "@style", style);
+
+    VALUE width = rb_hash_lookup(options, ID2SYM(rb_intern("width")));
+    if (!NIL_P(width)) rb_iv_set(self, "@width", width);
+
+    VALUE emoji = rb_hash_lookup(options, ID2SYM(rb_intern("emoji")));
+    if (RTEST(emoji)) rb_iv_set(self, "@emoji", Qtrue);
+
+    VALUE preserve = rb_hash_lookup(options, ID2SYM(rb_intern("preserve_newlines")));
+    if (RTEST(preserve)) rb_iv_set(self, "@preserve_newlines", Qtrue);
+
+    VALUE base_url = rb_hash_lookup(options, ID2SYM(rb_intern("base_url")));
+    if (!NIL_P(base_url)) rb_iv_set(self, "@base_url", base_url);
+
+    VALUE color = rb_hash_lookup(options, ID2SYM(rb_intern("color_profile")));
+    if (!NIL_P(color)) rb_iv_set(self, "@color_profile", color);
+
+    VALUE json = rb_hash_lookup(options, ID2SYM(rb_intern("json_style")));
+    if (!NIL_P(json)) rb_iv_set(self, "@json_style", json);
+  }
+
+  return self;
+}
+
+static VALUE renderer_render(VALUE self, VALUE markdown) {
+  Check_Type(markdown, T_STRING);
+
+  VALUE json_style = rb_iv_get(self, "@json_style");
+
+  if (!NIL_P(json_style)) {
+    int width = NUM2INT(rb_iv_get(self, "@width"));
+
+    char *result = glamour_render_with_json_style(
+      (char *)StringValueCStr(markdown),
+      (char *)StringValueCStr(json_style),
+      width
+    );
+
+    VALUE rb_result = rb_utf8_str_new_cstr(result);
+    glamour_free(result);
+    return rb_result;
+  }
+
+  VALUE style_value = rb_iv_get(self, "@style");
+  const char *style = NIL_P(style_value) ? "auto" : StringValueCStr(style_value);
+  int width = NUM2INT(rb_iv_get(self, "@width"));
+  int emoji = RTEST(rb_iv_get(self, "@emoji")) ? 1 : 0;
+  int preserve_newlines = RTEST(rb_iv_get(self, "@preserve_newlines")) ? 1 : 0;
+
+  VALUE base_url_value = rb_iv_get(self, "@base_url");
+  const char *base_url = NIL_P(base_url_value) ? NULL : StringValueCStr(base_url_value);
+
+  VALUE color_value = rb_iv_get(self, "@color_profile");
+  int color_profile = COLOR_PROFILE_AUTO;
+
+  if (color_value == ID2SYM(rb_intern("true_color"))) {
+    color_profile = COLOR_PROFILE_TRUE_COLOR;
+  } else if (color_value == ID2SYM(rb_intern("ansi256"))) {
+    color_profile = COLOR_PROFILE_ANSI256;
+  } else if (color_value == ID2SYM(rb_intern("ansi"))) {
+    color_profile = COLOR_PROFILE_ANSI;
+  } else if (color_value == ID2SYM(rb_intern("ascii"))) {
+    color_profile = COLOR_PROFILE_ASCII;
+  }
+
+  char *result = glamour_render_with_options(
+    (char *)StringValueCStr(markdown),
+    (char *)style,
+    width,
+    emoji,
+    preserve_newlines,
+    (char *)base_url,
+    color_profile
+  );
+
+  VALUE rb_result = rb_utf8_str_new_cstr(result);
+  glamour_free(result);
+
+  return rb_result;
+}
+
+__attribute__((__visibility__("default"))) void Init_glamour(void) {
+  mGlamour = rb_define_module("Glamour");
+
+  rb_define_singleton_method(mGlamour, "render", glamour_render_rb, -1);
+  rb_define_singleton_method(mGlamour, "render_with_json", glamour_render_with_json_rb, -1);
+  rb_define_singleton_method(mGlamour, "upstream_version", glamour_upstream_version_rb, 0);
+  rb_define_singleton_method(mGlamour, "version", glamour_version_rb, 0);
+
+  cRenderer = rb_define_class_under(mGlamour, "Renderer", rb_cObject);
+  rb_define_alloc_func(cRenderer, renderer_alloc);
+  rb_define_method(cRenderer, "initialize", renderer_initialize, -1);
+  rb_define_method(cRenderer, "render", renderer_render, 1);
+
+  rb_define_attr(cRenderer, "style", 1, 1);
+  rb_define_attr(cRenderer, "width", 1, 1);
+  rb_define_attr(cRenderer, "emoji", 1, 1);
+  rb_define_attr(cRenderer, "preserve_newlines", 1, 1);
+  rb_define_attr(cRenderer, "base_url", 1, 1);
+  rb_define_attr(cRenderer, "color_profile", 1, 1);
+  rb_define_attr(cRenderer, "json_style", 1, 1);
+}