RubyGems - typst - Versions diffs - 0.14.2.1 → 0.14.2.3 - Mend

typst 0.14.2.1 → 0.14.2.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (20) hide show

checksums.yaml +4 -4
data/README.md +104 -37
data/README.typ +110 -38
data/ext/typst/Cargo.toml +1 -1
data/ext/typst/src/compiler.rs +0 -1
data/ext/typst/src/download.rs +1 -1
data/ext/typst/src/lib.rs +41 -4
data/ext/typst/src/query.rs +1 -1
data/ext/typst/src/world.rs +0 -1
data/lib/base.rb +45 -72
data/lib/document.rb +15 -7
data/lib/formats/html_experimental.rb +3 -1
data/lib/formats/pdf.rb +4 -2
data/lib/formats/png.rb +4 -2
data/lib/formats/svg.rb +3 -1
data/lib/query.rb +6 -3
data/lib/typst.rb +68 -5
metadata +32 -6
data/lib/formats/html.rb +0 -35
data/lib/typst/typst.bundle +0 -0

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 77a2b80d3ddc7e3b8a2fd44c365b3a7c9464383894bb3a61e869d87085baa8a2
-  data.tar.gz: ce2e709afe2b9b76f73292ec13df74815ac0ff7dc7fc4636a58d73b7122ad391
+  metadata.gz: bdc56381647f2be411648ebbf5525576c5c6a259257cafd29de225dbd50da25c
+  data.tar.gz: 414023a808e3081a46e5e3ca64aa44920aedc41bbeca7c7004557e2a76b682f9
 SHA512:
-  metadata.gz: b0e845ea82c232ed88b4dd6c159b814aad54199ff85829a7edb18a42346abf887e138345efca9e1ab1a2ca8b379b161bda3448162cd128f811b342815a7f0b85
-  data.tar.gz: 73c99e328ea7aa5ba58d574b7b7770b86355f97787e2df6de4a4578913ae7d72082e11309309ae2ccd2f3882ceba26a482e60de8b25dc188a78e678ca41c99b7
+  metadata.gz: bf751aa8cfe5c0cb9f7433728f61ef1882af9fdea3b0aa031fa87e906a6be1880b1832a74597871911751fc912fb93f2f8946d4b8fd022c175828865d428938c
+  data.tar.gz: 62d507c32cdd32be9cf125350953a57971968e5aff1b43604d506e640901a327b940ab51c5becb6e4890ce1c8f656c4adb0a8bae19e1b3b217a6d82c8cddfb80

data/README.md CHANGED Viewed

@@ -16,56 +16,82 @@ require "typst"
 # Compile a typst file and write the output to a PDF file
 Typst("readme.typ").compile(:pdf).write("readme.pdf")
+```
-# Use a typst file `readme.typ`
+### Use a typst file `readme.typ`
+```ruby
 t = Typst("readme.typ")
+```
-# Use a typst string
+### Use a typst string
+```ruby
 t = Typst(body: %{hello world})
+```
-# Use a typst file in a zip file
+### Use a typst file in a zip file
+```ruby
 t = Typst(zip: "test/main.typ.zip")
+```
-# Compile to PDF
-f = t.compile(:pdf)
+### Compile to PDF
+```ruby
+doc = t.compile(:pdf)
+```
-# Compile to SVG
-f = t.compile(:svg)
+### Compile to PDF selecting the typst supported PdfStandard
+```ruby
+doc = t.compile(:pdf, pdf_standards: ["2.0"])
+```
-# Compile to PNG
-f = t.compile(:png)
+### Compile to SVG
+```ruby
+doc = t.compile(:svg)
+```
-# Compile to SVGs enveloped in HTML
-# Depracation warning: this feature will go away once Typst HTML moves out of experimental
-f = t.compile(:html, title: "Typst+Ruby")
+### Compile to PNG
+```ruby
+doc = t.compile(:png)
+```
-# Compile to HTML (using Typst expirmental HTML)
-f = t.compile(:html_experimental)
+### Compile to PNG and set PPI
+```ruby
+doc = t.compile(:png, ppi: 72)
+```
-# Access PDF or HTML output as a string
-# Note: For PDF and PNG this will give data, for SVG and HTML this will give markup
-Typst("readme.typ").compile(:pdf).document
-# => "%PDF-1.7\n%\x80\x80\x80\x80\n\n4 0 obj\n<<\n  /Type /Font\n  /Subtype ..."
-Typst("readme.typ").compile(:html).document
-# => "\n<!DOCTYPE html>\n<html>\n<head>\n<title>main</title>\n</head>\n<body>\n<svg class=\"typst-doc\" ...
+### Compile to HTML (using Typst expirmental HTML)
+```ruby
+doc = t.compile(:html_experimental)
+```
-# Or return content as an array of bytes
+### Or return content as an array of bytes
+```ruby
 pdf_bytes = Typst("readme.typ").compile(:pdf).bytes
 # => [37, 80, 68, 70, 45, 49, 46, 55, 10, 37, 128 ...]
+```
+### Write the output to a file
+Note: for multi-page documents using formats other than PDF and HTML, pages write to multiple files, e.g. `readme_0.png`, `readme_1.png`
+```ruby
+doc.write("filename.pdf")
+```
-# Write the output to a file
-# Note: for multi-page documents using formats other than PDF, pages write to multiple files, e.g. `readme_0.png`, `readme_1.png`
-f.write("filename.pdf")
+### Return PDF, SVG, PNG or HTML content as an array of pages
+```ruby
+Typst("readme.typ").compile(:pdf).pages
+# => ["%PDF-1.7\n%\x80\x80\x80\x80\n\n1 0 obj\n<<\n  /Type /Pages\n  /Count 3\n  /Kids [160 0 R 162 ...
-# Return SVG, HTML or PNG content as an array of pages
 Typst("readme.typ").compile(:svg).pages
-# => ["<svg class=\"typst-doc\" viewBox=\"0 0 595.2764999999999 841.89105\" ..."
-Typst("readme.typ").compile(:html).pages
-# => ["<svg class=\"typst-doc\" viewBox=\"0 0 595.2764999999999 841.89105\" ..."
+# => ["<svg class=\"typst-doc\" viewBox=\"0 0 595.2764999999999 841.89105\" ...
 Typst("readme.typ").compile(:png).pages
 # => ["\x89PNG\r\n\x1A\n\x00\x00\x00\rIHDR\x00\x00\x04\xA7\x00\x00\x06\x94\b\ ...
-# Pass values into typst using sys_inputs
+Typst("readme.typ").compile(:html_experimental).pages
+# => ["<!DOCTYPE html>\n<html>\n  <head>\n    <meta charset=\"utf-8\">\n    <meta name=\"viewport\" ...
+```
+### Pass values into typst using sys_inputs
+```ruby
 sys_inputs_example = %{
 #let persons = json(bytes(sys.inputs.persons))
@@ -76,15 +102,18 @@ sys_inputs_example = %{
 people = [{"name" => "John", "age" => 35}, {"name" => "Xoliswa", "age" => 45}]
 data = { "persons" => people.to_json }
 Typst(body: sys_inputs_example, sys_inputs: data).compile(:pdf).write("sys_inputs_example.pdf")
+```
-# Apply inputs to typst to product multiple PDFs
+### Apply inputs to typst to product multiple PDFs
+```ruby
 t = Typst(body: sys_inputs_example)
 people.each do |person|
   t.with_inputs({ "persons" => [person].to_json }).compile(:pdf).write("#{person['name']}.pdf")
 end
+```
-# A more complex example of compiling from string
+### A more complex example of compiling from string using other dependency typst template, svg and font resources all in memory
+```ruby
 main = %{
 #import "template.typ": *
@@ -106,27 +135,65 @@ icon = File.read("icon.svg")
 font_bytes = File.read("Example.ttf")
 Typst(body: main, dependencies: { "template.typ" => template, "icon.svg" => icon }, fonts: { "Example.ttf" => font_bytes }).compile(:pdf)
+```
-# From a zip with a named main typst file
+### From a zip with a named main typst file
+```ruby
 Typst(zip: "test/main.typ.zip", main_file: "hello.typ").compile(:pdf)
+```
+### Use a package from the [Typst Universe](https://typst.app/universe)
+Your package_example.typ file...
+```typst
+#import "@preview/wordometer:0.1.5": word-count, total-words
+#show: word-count
+In this document, there are #total-words words all up.
+#word-count(total => [
+  The number of words in this block is #total.words
+  and there are #total.characters letters.
+])
+```
+...compiles just like anything else
+```ruby
+Typst("package_example.typ").compile(:pdf).write("package_example.pdf")
+```
-Typst::Query.new("heading", "readme.typ").result
+### Query a typst document
+```ruby
+Typst("readme.typ").query("heading").result
 # =>
 # [{"func" => "heading",
 #   "level" => 1,
 #   "depth" => 1,
 # ...
-Typst::Query.new("heading", "readme.typ", format: "json").result(raw: true)
+Typst("readme.typ").query("heading", format: "json").result(raw: true)
 # => "[\n  {\n    \"func\": \"heading\",\n    \"level\": 1,\n    \"depth\": ..."
-Typst::Query.new("heading", "readme.typ", format: "yaml").result(raw: true)
+Typst("readme.typ").query("heading", format: "yaml").result(raw: true)
 # => "- func: heading\n  level: 1\n  depth: 1\n  offset: 0\n  numbering: ..."
+# Query results as JSON string
+Typst("test/test.typ").query("heading").to_s
+# => "[\n  {\n    \"func\": \"heading\",\n    \"level\": 1,\n    \"depth\": 1,\n    \"offset\": 0,\n ...
+# Query results as YAML string
+Typst("test/test.typ").query("heading", format: "yaml").to_s
+# => "- func: heading\n  level: 1\n  depth: 1\n  offset: 0\n  numbering: null\n  supplement:\n    ...
+```
+### clear the compilation cache
+```ruby
+# Evict all entries whose age is larger than or equal to `max_age`
+max_age = 10
+Typst::clear_cache(max_age)
 ```
 ## Contributors & Acknowledgements
-typst-rb is based on [typst-py](https://github.com/messense/typst-py) by [messense](https://github.com/messense)
+typst-rb is based on [typst-py](https://github.com/messense/typst-py) by [messense](https://github.com/messense)\
+clear_cache was contributed by [NRicciVestmark](https://github.com/NRicciVestmark)
 ## License

data/README.typ CHANGED Viewed

@@ -1,6 +1,11 @@
+#set document(title: [typst.rb README])
 #show link: underline
 #show link: set text(blue)
+#show raw.where(block: true): block.with(
+  fill: luma(240),
+  inset: 10pt,
+  radius: 4pt,
+)
 = typst-rb
@@ -19,56 +24,82 @@ require "typst"
 # Compile a typst file and write the output to a PDF file
 Typst("readme.typ").compile(:pdf).write("readme.pdf")
+```
-# Use a typst file `readme.typ`
+=== Use a typst file `readme.typ`
+```ruby
 t = Typst("readme.typ")
+```
-# Use a typst string
+=== Use a typst string
+```ruby
 t = Typst(body: %{hello world})
+```
-# Use a typst file in a zip file
+=== Use a typst file in a zip file
+```ruby
 t = Typst(zip: "test/main.typ.zip")
+```
-# Compile to PDF
-f = t.compile(:pdf)
+=== Compile to PDF
+```ruby
+doc = t.compile(:pdf)
+```
-# Compile to SVG
-f = t.compile(:svg)
+=== Compile to PDF selecting the typst supported PdfStandard
+```ruby
+doc = t.compile(:pdf, pdf_standards: ["2.0"])
+```
-# Compile to PNG
-f = t.compile(:png)
+=== Compile to SVG
+```ruby
+doc = t.compile(:svg)
+```
-# Compile to SVGs enveloped in HTML
-# Depracation warning: this feature will go away once Typst HTML moves out of experimental
-f = t.compile(:html, title: "Typst+Ruby")
+=== Compile to PNG
+```ruby
+doc = t.compile(:png)
+```
-# Compile to HTML (using Typst expirmental HTML)
-f = t.compile(:html_experimental)
+=== Compile to PNG and set PPI
+```ruby
+doc = t.compile(:png, ppi: 72)
+```
-# Access PDF or HTML output as a string
-# Note: For PDF and PNG this will give data, for SVG and HTML this will give markup
-Typst("readme.typ").compile(:pdf).document
-# => "%PDF-1.7\n%\x80\x80\x80\x80\n\n4 0 obj\n<<\n  /Type /Font\n  /Subtype ..."
-Typst("readme.typ").compile(:html).document
-# => "\n<!DOCTYPE html>\n<html>\n<head>\n<title>main</title>\n</head>\n<body>\n<svg class=\"typst-doc\" ...
+=== Compile to HTML (using Typst expirmental HTML)
+```ruby
+doc = t.compile(:html_experimental)
+```
-# Or return content as an array of bytes
+=== Or return content as an array of bytes
+```ruby
 pdf_bytes = Typst("readme.typ").compile(:pdf).bytes
 # => [37, 80, 68, 70, 45, 49, 46, 55, 10, 37, 128 ...]
+```
-# Write the output to a file
-# Note: for multi-page documents using formats other than PDF, pages write to multiple files, e.g. `readme_0.png`, `readme_1.png`
-f.write("filename.pdf")
+=== Write the output to a file
+Note: for multi-page documents using formats other than PDF and HTML, pages write to multiple files, e.g. `readme_0.png`, `readme_1.png`
+```ruby
+doc.write("filename.pdf")
+```
+=== Return PDF, SVG, PNG or HTML content as an array of pages
+```ruby
+Typst("readme.typ").compile(:pdf).pages
+# => ["%PDF-1.7\n%\x80\x80\x80\x80\n\n1 0 obj\n<<\n  /Type /Pages\n  /Count 3\n  /Kids [160 0 R 162 ...
-# Return SVG, HTML or PNG content as an array of pages
 Typst("readme.typ").compile(:svg).pages
-# => ["<svg class=\"typst-doc\" viewBox=\"0 0 595.2764999999999 841.89105\" ..."
-Typst("readme.typ").compile(:html).pages
-# => ["<svg class=\"typst-doc\" viewBox=\"0 0 595.2764999999999 841.89105\" ..."
+# => ["<svg class=\"typst-doc\" viewBox=\"0 0 595.2764999999999 841.89105\" ...
 Typst("readme.typ").compile(:png).pages
 # => ["\x89PNG\r\n\x1A\n\x00\x00\x00\rIHDR\x00\x00\x04\xA7\x00\x00\x06\x94\b\ ...
-# Pass values into typst using sys_inputs
+Typst("readme.typ").compile(:html_experimental).pages
+# => ["<!DOCTYPE html>\n<html>\n  <head>\n    <meta charset=\"utf-8\">\n    <meta name=\"viewport\" ...
+```
+=== Pass values into typst using sys_inputs
+```ruby
 sys_inputs_example = %{
 #let persons = json(bytes(sys.inputs.persons))
@@ -79,15 +110,18 @@ sys_inputs_example = %{
 people = [{"name" => "John", "age" => 35}, {"name" => "Xoliswa", "age" => 45}]
 data = { "persons" => people.to_json }
 Typst(body: sys_inputs_example, sys_inputs: data).compile(:pdf).write("sys_inputs_example.pdf")
+```
-# Apply inputs to typst to product multiple PDFs
+=== Apply inputs to typst to product multiple PDFs
+```ruby
 t = Typst(body: sys_inputs_example)
 people.each do |person|
   t.with_inputs({ "persons" => [person].to_json }).compile(:pdf).write("#{person['name']}.pdf")
 end
+```
-# A more complex example of compiling from string
+=== A more complex example of compiling from string using other dependency typst template, svg and font resources all in memory
+```ruby
 main = %{
 #import "template.typ": *
@@ -109,27 +143,65 @@ icon = File.read("icon.svg")
 font_bytes = File.read("Example.ttf")
 Typst(body: main, dependencies: { "template.typ" => template, "icon.svg" => icon }, fonts: { "Example.ttf" => font_bytes }).compile(:pdf)
+```
-# From a zip with a named main typst file
+=== From a zip with a named main typst file
+```ruby
 Typst(zip: "test/main.typ.zip", main_file: "hello.typ").compile(:pdf)
+```
+=== Use a package from the #link("https://typst.app/universe")[Typst Universe]
+Your package_example.typ file...
+```typst
+#import "@preview/wordometer:0.1.5": word-count, total-words
+#show: word-count
+In this document, there are #total-words words all up.
+#word-count(total => [
+  The number of words in this block is #total.words
+  and there are #total.characters letters.
+])
+```
+...compiles just like anything else
+```ruby
+Typst("package_example.typ").compile(:pdf).write("package_example.pdf")
+```
-Typst::Query.new("heading", "readme.typ").result
+=== Query a typst document
+```ruby
+Typst("readme.typ").query("heading").result
 # =>
 # [{"func" => "heading",
 #   "level" => 1,
 #   "depth" => 1,
 # ...
-Typst::Query.new("heading", "readme.typ", format: "json").result(raw: true)
+Typst("readme.typ").query("heading", format: "json").result(raw: true)
 # => "[\n  {\n    \"func\": \"heading\",\n    \"level\": 1,\n    \"depth\": ..."
-Typst::Query.new("heading", "readme.typ", format: "yaml").result(raw: true)
+Typst("readme.typ").query("heading", format: "yaml").result(raw: true)
 # => "- func: heading\n  level: 1\n  depth: 1\n  offset: 0\n  numbering: ..."
+# Query results as JSON string
+Typst("test/test.typ").query("heading").to_s
+# => "[\n  {\n    \"func\": \"heading\",\n    \"level\": 1,\n    \"depth\": 1,\n    \"offset\": 0,\n ...
+# Query results as YAML string
+Typst("test/test.typ").query("heading", format: "yaml").to_s
+# => "- func: heading\n  level: 1\n  depth: 1\n  offset: 0\n  numbering: null\n  supplement:\n    ...
+```
+=== clear the compilation cache
+```ruby
+# Evict all entries whose age is larger than or equal to `max_age`
+max_age = 10
+Typst::clear_cache(max_age)
 ```
 == Contributors & Acknowledgements
-typst-rb is based on #link("https://github.com/messense/typst-py")[typst-py] by #link("https://github.com/messense")[messense]
+typst-rb is based on #link("https://github.com/messense/typst-py")[typst-py] by #link("https://github.com/messense")[messense]\
+clear_cache was contributed by #link("https://github.com/NRicciVestmark")[NRicciVestmark]
 == License

data/ext/typst/Cargo.toml CHANGED Viewed

@@ -49,4 +49,4 @@ walkdir = "2.4.0"
 # enable rb-sys feature to test against Ruby head. This is only needed if you
 # want to work with the unreleased, in-development, next version of Ruby
-rb-sys = { version = "0.9.123", default-features = false, features = ["stable-api-compiled-fallback"] }
+rb-sys = { version = "0.9.124", default-features = false, features = ["stable-api-compiled-fallback"] }

data/ext/typst/src/compiler.rs CHANGED Viewed

@@ -6,7 +6,6 @@ use typst::diag::{Severity, SourceDiagnostic, StrResult, Warned};
 use typst::foundations::Datetime;
 use typst_html::HtmlDocument;
 use typst::layout::PagedDocument;
-//use typst::syntax::{FileId, Source, Span};
 use typst::syntax::{FileId, Lines, Span};
 use typst::{World, WorldExt};

data/ext/typst/src/download.rs CHANGED Viewed

@@ -14,6 +14,6 @@ impl<T: Display> Progress for SlientDownload<T> {
 /// Returns a new downloader.
 pub fn downloader() -> Downloader {
-    let user_agent = concat!("typst-py/", env!("CARGO_PKG_VERSION"));
+    let user_agent = concat!("typst-rb/", env!("CARGO_PKG_VERSION"));
     Downloader::new(user_agent)
 }

data/ext/typst/src/lib.rs CHANGED Viewed

@@ -6,6 +6,7 @@ use std::collections::HashMap;
 use query::{query as typst_query, QueryCommand, SerializationFormat};
 use typst::foundations::{Dict, Value};
 use typst_library::Feature;
+use typst_pdf::PdfStandard;
 use world::SystemWorld;
 mod compiler;
@@ -144,6 +145,7 @@ fn to_png(
     resource_path: PathBuf,
     ignore_system_fonts: bool,
     sys_inputs: HashMap<String, String>,
+    ppi: Option<f32>,
 ) -> Result<Vec<Vec<u8>>, Error> {
     let input = input.canonicalize()
         .map_err(|err| magnus::Error::new(ruby.exception_arg_error(), err.to_string()))?;
@@ -185,7 +187,7 @@ fn to_png(
         .map_err(|msg| magnus::Error::new(ruby.exception_arg_error(), msg.to_string()))?;
     let bytes = world
-        .compile(Some("png"), None, &Vec::new())
+        .compile(Some("png"), ppi, &Vec::new())
         .map_err(|msg| magnus::Error::new(ruby.exception_arg_error(), msg.to_string()))?;
     Ok(bytes)
@@ -199,6 +201,7 @@ fn to_pdf(
     resource_path: PathBuf,
     ignore_system_fonts: bool,
     sys_inputs: HashMap<String, String>,
+    pdf_standards: Vec<String>,
 ) -> Result<Vec<Vec<u8>>, Error> {
     let input = input.canonicalize()
         .map_err(|err| magnus::Error::new(ruby.exception_arg_error(), err.to_string()))?;
@@ -239,8 +242,37 @@ fn to_pdf(
         .build()
         .map_err(|msg| magnus::Error::new(ruby.exception_arg_error(), msg.to_string()))?;
+    let pdf_standards_lookup: HashMap::<&str, PdfStandard> = HashMap::from([
+        ("1.4", PdfStandard::V_1_4),
+        ("1.5", PdfStandard::V_1_5),
+        ("1.6", PdfStandard::V_1_6),
+        ("1.7", PdfStandard::V_1_7),
+        ("2.0", PdfStandard::V_2_0),
+        ("a-1a", PdfStandard::A_1a),
+        ("a-1b", PdfStandard::A_1b),
+        ("a-2a", PdfStandard::A_2a),
+        ("a-2b", PdfStandard::A_2b),
+        ("a-2u", PdfStandard::A_2u),
+        ("a-3a", PdfStandard::A_3a),
+        ("a-3b", PdfStandard::A_3b),
+        ("a-3u", PdfStandard::A_3u),
+        ("a-4", PdfStandard::A_4),
+        ("a-4e", PdfStandard::A_4e),
+        ("a-4f", PdfStandard::A_4f),
+        ("ua-1", PdfStandard::Ua_1),
+    ]);
+    let mut pdf_standards_vec = Vec::<PdfStandard>::new();
+    for pdf_standard in pdf_standards.iter() {
+        let result = pdf_standards_lookup.get(pdf_standard.as_str());
+        match result {
+            Some(value) => pdf_standards_vec.push(*value),
+            _ => return Err(magnus::Error::new(ruby.exception_arg_error(), "Unknown PdfStandard")),
+        }
+    }
     let pdf_bytes = world
-        .compile(Some("pdf"), None, &Vec::new())
+        .compile(Some("pdf"), None, &pdf_standards_vec)
         .map_err(|msg| magnus::Error::new(ruby.exception_arg_error(), msg.to_string()))?;
     Ok(pdf_bytes)
@@ -320,15 +352,20 @@ fn query(
     }
 }
+fn clear_cache(_ruby: &Ruby, max_age: usize) {
+    comemo::evict(max_age);
+}
 #[magnus::init]
 fn init(ruby: &Ruby) -> Result<(), Error> {
     env_logger::init();
     let module = ruby.define_module("Typst")?;
-    module.define_singleton_method("_to_pdf", function!(to_pdf, 6))?;
+    module.define_singleton_method("_to_pdf", function!(to_pdf, 7))?;
     module.define_singleton_method("_to_svg", function!(to_svg, 6))?;
-    module.define_singleton_method("_to_png", function!(to_png, 6))?;
+    module.define_singleton_method("_to_png", function!(to_png, 7))?;
     module.define_singleton_method("_to_html", function!(to_html, 6))?;
     module.define_singleton_method("_query", function!(query, 10))?;
+    module.define_singleton_method("_clear_cache", function!(clear_cache, 1))?;
     Ok(())
 }

data/ext/typst/src/query.rs CHANGED Viewed

@@ -8,7 +8,7 @@ use typst::layout::PagedDocument;
 use typst::syntax::Span;
 use typst::syntax::SyntaxMode;
 use typst::World;
-use typst_eval::eval_string; //{eval_string, EvalMode};
+use typst_eval::eval_string;
 use crate::world::SystemWorld;

data/ext/typst/src/world.rs CHANGED Viewed

@@ -3,7 +3,6 @@ use std::path::{Path, PathBuf};
 use std::sync::{Mutex, OnceLock};
 use chrono::{DateTime, Datelike, Local};
-//use rustc_hash::FxHashMap;
 use ecow::eco_format;
 use typst::diag::{FileError, FileResult, StrResult};
 use typst::foundations::{Bytes, Datetime, Dict};

data/lib/base.rb CHANGED Viewed

@@ -34,74 +34,44 @@ module Typst
       options[:dependencies] ||= {}
       options[:fonts] ||= {}
       options[:sys_inputs] ||= {}
+      options[:resource_path] ||= File.dirname(__FILE__)
+      options[:ignore_system_fonts] ||= false
       self.options = options
     end
     def typst_args
-      [options[:file], options[:root], options[:font_paths], File.dirname(__FILE__), false, options[:sys_inputs].map{ |k,v| [k.to_s,v.to_s] }.to_h]
+      [options[:file], options[:root], options[:font_paths], options[:resource_path], options[:ignore_system_fonts], options[:sys_inputs].map{ |k,v| [k.to_s,v.to_s] }.to_h]
     end
-    def self.from_s(main_source, **options)
-      dependencies = options[:dependencies] ||= {}
-      fonts = options[:fonts] ||= {}
-      Dir.mktmpdir do |tmp_dir|
-        tmp_main_file = Pathname.new(tmp_dir).join("main.typ")
-        File.write(tmp_main_file, main_source)
-        dependencies.each do |dep_name, dep_source|
-          tmp_dep_file = Pathname.new(tmp_dir).join(dep_name)
-          File.write(tmp_dep_file, dep_source)
-        end
-        relative_font_path = Pathname.new(tmp_dir).join("fonts")
-        fonts.each do |font_name, font_bytes|
-          Pathname.new(relative_font_path).mkpath
-          tmp_font_file = relative_font_path.join(font_name)
-          File.write(tmp_font_file, font_bytes)
-        end
+    def typst_pdf_args
+      options[:pdf_standards] ||= []
+      [*typst_args, options[:pdf_standards]]
+    end
-        options[:file] = tmp_main_file
-        options[:root] = tmp_dir
-        options[:font_paths] = [relative_font_path]
+    def typst_png_args
+      [*typst_args, options[:ppi]]
+    end
-        if options[:format]
-          Typst::formats[options[:format]].new(**options)
+    def self.from_s(main_source, **options)
+      Typst::build_world_from_s(main_source, **options) do |opts|
+        from_options = options.merge(opts)
+        if from_options[:format]
+          Typst::formats[from_options[:format]].new(**from_options)
         else
-          new(**options)
+          new(**from_options)
         end
       end
     end
-    def self.from_zip(zip_file_path, main_file = nil, **options)
-      options[:dependencies] ||= {}
-      options[:fonts] ||= {}
-      Zip::File.open(zip_file_path) do |zipfile|
-        file_names = zipfile.dir.glob("*").collect{ |f| f.name }
-        case
-          when file_names.include?(main_file) then tmp_main_file = main_file
-          when file_names.include?("main.typ") then tmp_main_file = "main.typ"
-          when file_names.size == 1 then tmp_main_file = file_names.first
-          else raise "no main file found"
-        end
-        main_source = zipfile.file.read(tmp_main_file)
-        file_names.delete(tmp_main_file)
-        file_names.delete("fonts/")
-        file_names.each do |dep_name|
-          options[:dependencies][dep_name] = zipfile.file.read(dep_name)
-        end
-        font_file_names = zipfile.dir.glob("fonts/*").collect{ |f| f.name }
-        font_file_names.each do |font_name|
-          options[:fonts][Pathname.new(font_name).basename.to_s] = zipfile.file.read(font_name)
+    def self.from_zip(zip_file_path, main_file = "main.typ", **options)
+      Typst::build_world_from_zip(zip_file_path, main_file, **options) do |opts|
+        from_options = options.merge(opts)
+        if from_options[:format]
+          Typst::formats[from_options[:format]].new(**from_options)
+        else
+          new(**from_options)
         end
-        options[:main_file] = tmp_main_file
-        from_s(main_source, **options)
       end
     end
@@ -138,32 +108,35 @@ module Typst
       if options.has_key?(:file)
         Typst::formats[format].new(**options).compiled
       elsif options.has_key?(:body)
-        Typst::formats[format].from_s(options[:body], **options).compiled
+        Typst::build_world_from_s(self.options[:body], **options) do |opts|
+          Typst::formats[format].new(**options.merge(opts)).compiled
+        end
       elsif options.has_key?(:zip)
-        Typst::formats[format].from_zip(options[:zip], options[:main_file], **options).compiled
+        main_file = options[:main_file]
+        Typst::build_world_from_zip(options[:zip], main_file, **options) do |opts|
+          Typst::formats[format].new(**options.merge(opts)).compiled
+        end
       else
         raise "No input given"
       end
     end
-    def write(output)
-      STDERR.puts "DEPRECATION WARNING: this method will go away in a future version"
-      compiled.write(output)
-    end
-    def document
-      STDERR.puts "DEPRECATION WARNING: this method will go away in a future version"
-      compiled.document
-    end
+    def query(selector, field: nil, one: false, format: "json")
+      query_options = { field: field, one: one, format: format }
-    def bytes
-      STDERR.puts "DEPRECATION WARNING: this method will go away in a future version"
-      compiled.bytes
-    end
-    def pages
-      STDERR.puts "DEPRECATION WARNING: this method will go away in a future version"
-      compiled.pages
+      if self.options.has_key?(:file)
+        Typst::Query.new(selector, self.options[:file], **query_options.merge(self.options.slice(:root, :font_paths, :resource_path, :ignore_system_fonts, :sys_inputs)))
+      elsif self.options.has_key?(:body)
+        Typst::build_world_from_s(self.options[:body], **self.options) do |opts|
+          Typst::Query.new(selector, opts[:file], **query_options.merge(opts.slice(:root, :font_paths, :resource_path, :ignore_system_fonts, :sys_inputs)))
+        end
+      elsif self.options.has_key?(:zip)
+        Typst::build_world_from_zip(self.options[:zip], **self.options) do |opts|
+          Typst::Query.new(selector, opts[:file], **query_options.merge(opts.slice(:root, :font_paths, :resource_path, :ignore_system_fonts, :sys_inputs)))
+        end
+      else
+        raise "No input given"
+      end
     end
   end
 end

data/lib/document.rb CHANGED Viewed

@@ -6,15 +6,23 @@ module Typst
       @bytes = bytes
     end
-    def write(out)
+    def write_some(filename)
       if pages.size == 1
-        File.write(out, pages.first, mode: "wb")
+        write_one(filename)
       else
-        pages.each_with_index do |page, i|
-          fn = File.basename(out, ".*") + "_{{n}}" + File.extname(out) unless out.include?("{{n}}")
-          fn = fn.gsub("{{n}}", (i+1).to_s)
-          File.write(fn, page, mode: "wb")
-        end
+        write_paged(filename)
+      end
+    end
+    def write_one(filename)
+      File.write(filename, pages.first, mode: "wb")
+    end
+    def write_paged(base_filename)
+      pages.each_with_index do |page, i|
+        paged_filename = File.basename(base_filename, ".*") + "_{{n}}" + File.extname(base_filename) unless base_filename.include?("{{n}}")
+        paged_filename = paged_filename.gsub("{{n}}", (i+1).to_s)
+        File.write(paged_filename, page, mode: "wb")
       end
     end

data/lib/formats/html_experimental.rb CHANGED Viewed

@@ -5,7 +5,9 @@ module Typst
       @compiled = HtmlExperimentalDocument.new(Typst::_to_html(*self.typst_args))
     end
   end
-  class HtmlExperimentalDocument < Document; end
+  class HtmlExperimentalDocument < Document
+    alias_method :write, :write_one
+  end
   register_format(html_experimental: HtmlExperimental)
 end

data/lib/formats/pdf.rb CHANGED Viewed

@@ -2,10 +2,12 @@ module Typst
   class Pdf < Base
     def initialize(*options)
       super(*options)
-      @compiled = PdfDocument.new(Typst::_to_pdf(*self.typst_args))
+      @compiled = PdfDocument.new(Typst::_to_pdf(*self.typst_pdf_args))
     end
   end
-  class PdfDocument < Document; end
+  class PdfDocument < Document
+    alias_method :write, :write_one
+  end
   register_format(pdf: Pdf)
 end

data/lib/formats/png.rb CHANGED Viewed

@@ -2,10 +2,12 @@ module Typst
   class Png < Base
     def initialize(*options)
       super(*options)
-      @compiled = PngDocument.new(Typst::_to_png(*self.typst_args))
+      @compiled = PngDocument.new(Typst::_to_png(*self.typst_png_args))
     end
   end
-  class PngDocument < Document; end
+  class PngDocument < Document
+    alias_method :write, :write_some
+  end
   register_format(png: Png)
 end

data/lib/formats/svg.rb CHANGED Viewed

@@ -5,7 +5,9 @@ module Typst
       @compiled = SvgDocument.new(Typst::_to_svg(*self.typst_args))
     end
   end
-  class SvgDocument < Document; end
+  class SvgDocument < Document
+    alias_method :write, :write_some
+  end
   register_format(svg: Svg)
 end

data/lib/query.rb CHANGED Viewed

@@ -2,10 +2,9 @@ module Typst
   class Query < Base
     attr_accessor :format
-    def initialize(selector, input, field: nil, one: false, format: "json", root: ".", font_paths: [], sys_inputs: {})
-      super(input, root: root, font_paths: font_paths, sys_inputs: sys_inputs)
+    def initialize(selector, input, field: nil, one: false, format: "json", root: ".", font_paths: [], resource_path: ".", ignore_system_fonts: false, sys_inputs: {})
       self.format = format
-      @result = Typst::_query(selector, field, one, format, input, root, font_paths, File.dirname(__FILE__), false, sys_inputs)
+      @result = Typst::_query(selector, field, one, format, input, root, font_paths, resource_path, ignore_system_fonts, sys_inputs)
     end
     def result(raw: false)
@@ -15,5 +14,9 @@ module Typst
         else @result
       end
     end
+    def to_s
+      @result
+    end
   end
 end

data/lib/typst.rb CHANGED Viewed

@@ -8,23 +8,87 @@ module Typst
   def self.register_format(**format)
     @@formats.merge!(format)
   end
   def self.formats
     @@formats
   end
-end
+  def self.clear_cache(max_age = 0)
+    Typst::_clear_cache(max_age)
+  end
+  def self.build_world_from_s(main_source, **options, &blk)
+    dependencies = options[:dependencies] ||= {}
+    fonts = options[:fonts] ||= {}
+    Dir.mktmpdir do |tmp_dir|
+      tmp_main_file = Pathname.new(tmp_dir).join("main.typ")
+      File.write(tmp_main_file, main_source)
+      dependencies.each do |dep_name, dep_source|
+        tmp_dep_file = Pathname.new(tmp_dir).join(dep_name)
+        File.binwrite(tmp_dep_file, dep_source)
+      end
+      relative_font_path = Pathname.new(tmp_dir).join("fonts")
+      relative_font_path.mkpath
+      fonts.each do |font_name, font_bytes|
+        tmp_font_file = relative_font_path.join(font_name)
+        File.binwrite(tmp_font_file, font_bytes)
+      end
+      options[:file] = tmp_main_file
+      options[:root] = tmp_dir
+      options[:font_paths] = [relative_font_path]
+      blk.call(options)
+    end
+  end
+  def self.build_world_from_zip(zip_file_path, main_file = "main.typ", **options, &blk)
+    options[:dependencies] ||= {}
+    options[:fonts] ||= {}
+    Zip::File.open(zip_file_path) do |zipfile|
+      file_names = zipfile.dir.glob("*").collect{ |f| f.name }
+      case
+        when file_names.include?(main_file) then tmp_main_file = main_file
+        when file_names.include?("main.typ") then tmp_main_file = "main.typ"
+        when file_names.size == 1 then tmp_main_file = file_names.first
+        else raise "no main file found"
+      end
+      main_source = zipfile.file.read(tmp_main_file)
+      file_names.delete(tmp_main_file)
+      file_names.delete("fonts/")
+      file_names.each do |dep_name|
+        options[:dependencies][dep_name] = zipfile.file.read(dep_name)
+      end
+      font_file_names = zipfile.dir.glob("fonts/*").collect{ |f| f.name }
+      font_file_names.each do |font_name|
+        options[:fonts][Pathname.new(font_name).basename.to_s] = zipfile.file.read(font_name)
+      end
+      options[:main_file] = tmp_main_file
+      build_world_from_s(main_source, **options, &blk)
+    end
+  end
+end
-require "cgi"
+require "cgi/escape"
 require "pathname"
 require "tmpdir"
 require "zip/filesystem"
+require "json"
+require "yaml"
 begin
   # native precompiled gems package shared libraries in <gem_dir>/lib/typst/<ruby_version>
   RUBY_VERSION =~ /(\d+\.\d+)/
   require_relative "typst/#{Regexp.last_match(1)}/typst"
-rescue LoadError => e
+rescue LoadError
   require_relative "typst/typst"
 end
@@ -34,5 +98,4 @@ require_relative "document"
 require_relative "formats/pdf"
 require_relative "formats/svg"
 require_relative "formats/png"
-require_relative "formats/html"
 require_relative "formats/html_experimental"

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typst
 version: !ruby/object:Gem::Version
-  version: 0.14.2.1
+  version: 0.14.2.3
 platform: ruby
 authors:
 - Flinn
@@ -18,7 +18,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.123
+        version: 0.9.124
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,7 +28,7 @@ dependencies:
         version: '0.9'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.123
+        version: 0.9.124
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pngcheck
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 email: flinn@actsasflinn.com
 executables: []
 extensions:
@@ -106,14 +134,12 @@ files:
 - lib/fonts/NewCM10-Regular.otf
 - lib/fonts/NewCMMath-Book.otf
 - lib/fonts/NewCMMath-Regular.otf
-- lib/formats/html.rb
 - lib/formats/html_experimental.rb
 - lib/formats/pdf.rb
 - lib/formats/png.rb
 - lib/formats/svg.rb
 - lib/query.rb
 - lib/typst.rb
-- lib/typst/typst.bundle
 homepage: https://github.com/actsasflinn/typst-rb
 licenses:
 - Apache-2.0
@@ -132,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 4.0.4
 specification_version: 4
 summary: Ruby binding to typst, a new markup-based typesetting system that is powerful
   and easy to learn.

data/lib/formats/html.rb DELETED Viewed

@@ -1,35 +0,0 @@
-module Typst
-  class Html < Base
-    def initialize(*options)
-      super(*options)
-      title = CGI::escapeHTML(@options[:title] || File.basename(@options[:file], ".*"))
-      @compiled = HtmlDocument.new(Typst::_to_svg(*self.typst_args), title)
-    end
-  end
-  class HtmlDocument < Document
-    attr_accessor :title
-    def initialize(bytes, title)
-      super(bytes)
-      self.title = title
-    end
-    def markup
-      %{
-  <!DOCTYPE html>
-  <html>
-  <head>
-  <title>#{title}</title>
-  </head>
-  <body>
-  #{pages.join("<br />")}
-  </body>
-  </html>
-      }
-    end
-    alias_method :document, :markup
-  end
-  register_format(html: Html)
-end

data/lib/typst/typst.bundle DELETED Viewed

Binary file