glamour 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d0ecf8fcc767052fa79a80770da871d02c62fd62bc505a56ec614ccc565e3c3
-  data.tar.gz: 7e1e2eb1053f154da64ede7c46ced5197b6c96f19399339b2377c285da449a11
+  metadata.gz: 3beabca10dea479df451bf2fa5b90cd7105b481f083ba2af84e2a5205d10e269
+  data.tar.gz: d5671fbf5384cdf925a6596baf3784d20e6e79236fb8d901e678cd488fcf5573
 SHA512:
-  metadata.gz: a1a913819e3ecf1203e991f8ad418d2df641ee44fca60cf92e64156f3a955e566ac703cac217e3afc0530c1f6785641dc7a3a57320c4b0b30d3ee6d07bfafd24
-  data.tar.gz: bfa13eee909f6953ff86752a0b27f7d4700bdca4ac4b8d9a490080c6a4915a5456c48e2a0e0023cff7901500838701e7e2bb29bf6e222833641f6128bd21f580
+  metadata.gz: e89304cd6bdd6ecffc8d389719ed4da14c41c919b8c5c1ac4eab5bcc217c1cc68f8fc3c14d26c58c9c57cbcb59c4f0096ef8a53ec9a15b5e7907d20fc67b48a5
+  data.tar.gz: 756f7149b87f9283f3f5cf984e26b4b7d682eff1b00f1715943df1f97a3ce382c689d7765631ab0163541a8ff49e32a566e8c364b2752ae140019f496b58f0d5

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,306 @@
-# Glamour
+<div align="center">
+  <h1>Glamour</h1>
+  <h4>Stylesheet-based Markdown Rendering for Ruby CLI Apps</h4>
 
-TODO: Delete this and the text below, and describe your gem
+  <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>
 
-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/glamour`. To experiment with that code, run `bin/console` for an interactive prompt.
+  <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
 
-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 "glamour"
 ```
 
-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 glamour
 ```
 
 ## Usage
 
-TODO: Write usage instructions here
+### 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
 
-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/styles
+./demo/style_dsl
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/glamour. 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/glamour/blob/main/CODE_OF_CONDUCT.md).
+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.
 
-## Code of Conduct
+## Acknowledgments
 
-Everyone interacting in the Glamour project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/glamour/blob/main/CODE_OF_CONDUCT.md).
+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}")