rouge-ddot 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6dd196cff29b3d1b7435c68febdf46fec71e7246ef1d1bfa40cc56793bf3094
-  data.tar.gz: 40e95e043ee75d8bd53ba25a3c411a63a616f9f1a8ca07edd9998bea11e0145f
+  metadata.gz: a99cbaae721a52151bcfff4eb8d656c88aade697eab78160a3841f8274c0041e
+  data.tar.gz: adda0083411ae5755d34944ca3a194947b95827f73af93b8c55094a7660df8cd
 SHA512:
-  metadata.gz: 5bc30e43a5ad1909266a3d4908fea9c94ee3bddab264ad4eea04a4f03ae083db3cc9288f9892f86e86c8fc700fc1e5dae5cc9c99a4d35a0234299cef43a91068
-  data.tar.gz: a27f2ea628b044ade571952af1638ae661a9b30b00cd674d38bd7169f27807dd2adaeed25114ea09c6179768c3e6b830d8bd8f27987db116d3c0a3967ac23d81
+  metadata.gz: 285d6debe396c45d56abd71d15998bb414c877d74d6d792a6d2cd3531957bd97187cfd2e3fcde1a84aab842a3cf94a15029a66d0b4f3cab17832b80b5a3d2f47
+  data.tar.gz: 422c3c2721efe2b5ecb062f23cd65e7bc518f3733f2aa2f1859f3f9ea3615680610caaf967440da55f18e8803f640294678909a54378f1b5f5642b0ba461e1ac

data/CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## 0.1.3
+
+No lexer changes — token output is identical to 0.1.2.
+
+### Added
+
+- **`require 'rouge-ddot'` now works.** The gem shipped only
+  `lib/rouge/lexers/ddot.rb`, so requiring it by gem *name* raised
+  `LoadError: cannot load such file -- rouge-ddot`. Since Rouge does not
+  auto-discover third-party lexers, and `Bundler.require` (Jekyll's
+  `:jekyll_plugins` group, Rails initializers, …) requires gems by name,
+  hosts could not load the lexer the conventional way: adding it to a
+  `:jekyll_plugins` group *crashed the build*. Every host therefore had to
+  know the internal path and write `require 'rouge/lexers/ddot'` into a plugin
+  file of its own. A `lib/rouge-ddot.rb` entry point now requires the lexer,
+  so this is enough to highlight `[source,ddot.it]` blocks in Jekyll:
+
+  ```ruby
+  # Gemfile
+  group :jekyll_plugins do
+    gem 'rouge-ddot', '~> 0.1.3'
+  end
+  ```
+
+  `require 'rouge/lexers/ddot'` keeps working unchanged.
+
 ## 0.1.2
 
 Brings the lexer in line with the ddot.it Parse and Highlight specifications.

data/README.md

@@ -6,35 +6,53 @@ graph notation (https://ddot.it).
 ## Usage
 
 ```ruby
-require 'rouge'
-require 'rouge/lexers/ddot'
+require 'rouge-ddot'
 
 Rouge::Lexers::Ddot.new.lex("Project Eagle ..started in.. 2024") do |tok, val|
   puts [tok.qualname, val].inspect
 end
 ```
 
+Rouge does not auto-discover third-party lexers, so the gem has to be required
+before a `ddot.it` block can be highlighted. Requiring it by name is enough
+(since 0.1.3); `require 'rouge/lexers/ddot'` also works.
+
+In **Jekyll**, put it in the `:jekyll_plugins` group and Bundler requires it at
+startup — no `_plugins/` file needed:
+
+```ruby
+# Gemfile
+group :jekyll_plugins do
+  gem 'rouge-ddot', '~> 0.1.3'
+end
+```
+
 In Asciidoctor with `:source-highlighter: rouge` set, `[source,ddot]` blocks
-are dispatched here automatically — no extra wiring per document.
+are dispatched here automatically — no extra wiring per document. The lexer
+registers under the tag `ddot`, with the aliases `ddotit` and `ddot.it`.
 
 ## Token mapping
 
 The lexer emits standard Rouge tokens; they map to the canonical ddot.it
 token vocabulary in [`../../ddot.it/test-data/tokens.md`](../../ddot.it/test-data/tokens.md):
 
-| Rouge                       | Canonical       |
-|-----------------------------|-----------------|
-| `Name::Class`               | `subject`       |
-| `Name::Function`            | `relation`      |
-| `Literal::String::Symbol`   | `object`        |
-| `Operator`                  | `operator`      |
-| `Keyword::Pseudo`           | `command`       |
-| `Comment::Preproc`          | `meta-delim`    |
-| `Comment::Hashbang`         | `meta-operator` |
-| `Comment::Doc`              | `meta-relation` |
-| `Comment::Special`          | `meta-object`   |
-| `Comment::Multiline`        | `meta-text`     |
-| `Comment::Single`           | `disabled`      |
+| Rouge                       | Canonical        |
+|-----------------------------|------------------|
+| `Name::Class`               | `subject`        |
+| `Name::Function`            | `relation`       |
+| `Literal::String::Symbol`   | `object`         |
+| `Operator`                  | `doubledot`      |
+| `Keyword::Pseudo`           | `command`        |
+| `Name::Attribute`           | `command-param`  |
+| `Name::Label`               | `block-end`      |
+| `Comment::Preproc`          | `meta-delim`     |
+| `Punctuation`               | `meta-separator` |
+| `Comment::Hashbang`         | `meta-doubledot` |
+| `Comment::Doc`              | `meta-relation`  |
+| `Comment::Special`          | `meta-object`    |
+| `Comment::Multiline`        | `meta-text`      |
+| `Comment::Single`           | `excluded`       |
+| `Literal::String::Backtick` | `verbatim`       |
 
 ## Conformance
 
@@ -57,9 +75,11 @@ lockstep.
 ```
 rouge/
 ├── lib/
+│   ├── rouge-ddot.rb            # entry point: require 'rouge-ddot'
 │   └── rouge/
 │       └── lexers/
 │           └── ddot.rb          # the lexer
+├── CHANGELOG.md
 ├── README.md
 └── rouge-ddot.gemspec
 ```

data/lib/rouge-ddot.rb

@@ -0,0 +1,13 @@
+# Entry point for `require 'rouge-ddot'` — the path Bundler takes when the gem
+# is listed in a Jekyll `:jekyll_plugins` group, or under any other
+# `Bundler.require`, which requires a gem by its *name*.
+#
+# Rouge does not auto-discover third-party lexers: a lexer is registered only
+# when its file is loaded. Up to 0.1.2 the gem shipped `lib/rouge/lexers/ddot.rb`
+# alone, so `require 'rouge-ddot'` raised LoadError and every host had to know
+# the internal path and write `require 'rouge/lexers/ddot'` into a plugin file
+# of its own. This file makes the conventional require work.
+#
+# `require_relative` rather than `require` so loading does not depend on this
+# gem's lib directory being on `$LOAD_PATH`. The lexer requires 'rouge' itself.
+require_relative 'rouge/lexers/ddot'

data/rouge-ddot.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name        = 'rouge-ddot'
-  s.version     = '0.1.2'
+  s.version     = '0.1.3'
   s.summary     = 'Rouge lexer for ddot.it'
   s.description = 'Syntax highlighter for the ddot.it knowledge graph notation. ' \
                   'Plugs into Rouge so any tool that uses Rouge for source ' \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rouge-ddot
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Calpano
@@ -35,6 +35,7 @@ extra_rdoc_files: []
 files:
 - CHANGELOG.md
 - README.md
+- lib/rouge-ddot.rb
 - lib/rouge/lexers/ddot.rb
 - rouge-ddot.gemspec
 homepage: https://ddot.it