texd 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde0921bb4b213505d16db41af06475dfb4915c0b1283e4e0ef74c956715bab5
-  data.tar.gz: 6bc1878f34088d9ad32a8ac9a9c81819f20293153ed11148b2da8d190e9a4afc
+  metadata.gz: e81fb33476966032e12c55d7078c824f82e249ad5191bb499a6f0047e6748603
+  data.tar.gz: 41860606ab46c0006a33b740120c8441a8a29d2b48b577ef133a4acff8a5bd8a
 SHA512:
-  metadata.gz: 3c6d63be3ffe9e11e9c0b98bc3466f07427014057291c8df551aa1ed49c3b5f4cf9e9e0583c96254fd7288193199598db6aabc17f92545e2de38f36004cbf6e0
-  data.tar.gz: 919b674fd137f097d241170a54ae2746b150a76edd52aa373974234336d6884f3bd8e2820834d58a11f6f0131f6d63fc07b43f76faf971a182604a044cde7f10
+  metadata.gz: 352f6eca45f3e55b0e0df036d59f21f4d77dd7567a6c92853ae5766b6a6b3e2d751a9d9a68f4f353c95435caf6cdfed843f0774a4fd64d3fc0ba0ec33a90405d
+  data.tar.gz: 71f761e43adf6268567cd49285a8fe542887e4654499dc297fe7d26feb6882803474702704f6493ece465a339e8ba2283cfd4e0e114f6ed153b7e2c98f2c99b5

data/CHANGELOG.md

@@ -1,10 +1,10 @@
 ## Unreleased
 
-[Compare changes](https://github.com/digineo/texd-ruby/compare/v0.4.0...master)
+[Compare changes](https://github.com/digineo/texd-ruby/compare/v0.4.1...master)
 
-## v0.4.0
+## v0.4.1 - 2022-06-16
 
-[Compare changes](https://github.com/digineo/texd-ruby/compare/v0.3.2...v0.4.0)
+[Compare changes](https://github.com/digineo/texd-ruby/compare/v0.3.2...v0.4.1)
 
 **Changes**
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    texd (0.4.0)
+    texd (0.4.1)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 

data/README.md

@@ -21,7 +21,7 @@ Install the gem and add to the application's Gemfile by executing:
 
 ## Configuration
 
-Befor you can use texd, you need to tell it where your instance is located.
+Before you can use texd, you need to tell it where your instance is located.
 
 By default, this gem reads the `TEXD_ENDPOINT` environment variable and falls
 back to `http://localhost:2201/render`, should it be empty.
@@ -38,15 +38,18 @@ end
 
 ```rb
 Texd.configure do |config|
-  config.endpoint      = ENV.fetch("TEXD_ENDPOINT", "http://localhost:2201/")
-  config.open_timeout  = ENV.fetch("TEXD_OPEN_TIMEOUT", 60)
-  config.read_timeout  = ENV.fetch("TEXD_READ_TIMEOUT", 180)
-  config.write_timeout = ENV.fetch("TEXD_WRITE_TIMEOUT", 60)
-  config.error_format  = ENV.fetch("TEXD_ERRORS", "full")
-  config.tex_engine    = ENV["TEXD_ENGINE"]
-  config.tex_image     = ENV["TEXD_IMAGE"]
-  config.helpers       = []
-  config.lookup_paths  = [] # Rails.root.join("app/tex") is always inserted as first entry
+  config.endpoint       = ENV.fetch("TEXD_ENDPOINT", "http://localhost:2201/")
+  config.open_timeout   = ENV.fetch("TEXD_OPEN_TIMEOUT", 60)
+  config.read_timeout   = ENV.fetch("TEXD_READ_TIMEOUT", 180)
+  config.write_timeout  = ENV.fetch("TEXD_WRITE_TIMEOUT", 60)
+  config.error_format   = ENV.fetch("TEXD_ERRORS", "full")
+  config.error_handler  = ENV.fetch("TEXD_ERROR_HANDLER", "raise")
+  config.tex_engine     = ENV["TEXD_ENGINE"]
+  config.tex_image      = ENV["TEXD_IMAGE"]
+  config.helpers        = []
+  config.lookup_paths   = []
+  config.lookup_paths   = [] # Rails.root.join("app/tex") is always prepended
+  config.ref_cache_size = 128
 end
 ```
 
@@ -174,6 +177,31 @@ All errors inherit from `Texd::Client::RenderError` and should have
 a `details` attribute (a Hash) containing the actual error returned
 from the server.
 
+## Global error reporting
+
+texd can be configured with external error reporting, like Sentry.
+
+This example sends the LaTeX compilation log and compiled main input `.tex`
+file to Sentry:
+
+```ruby
+Texd.configure do |config|
+  config.error_handler = ->(err, doc) {
+    Sentry.set_context "texd", {
+      details: err.details, # if config.error_format == "json"
+      logs:    err.logs,    # otherwise
+    }.compact
+    Sentry.capture_exception(err)
+
+    raise err # re-raise, so that your code can decide further actions
+  }
+end
+```
+
+`config.error_handler` must respond to `call`, and receives the error (an instance
+of `Texd::Client::CompilationError`) and the document context (an instance of
+`Texd::Document::Compilation`).
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run

data/gemfiles/rails-6.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    texd (0.4.0)
+    texd (0.4.1)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 

data/gemfiles/rails-6.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    texd (0.4.0)
+    texd (0.4.1)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 

data/gemfiles/rails-7.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    texd (0.4.0)
+    texd (0.4.1)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 

data/lib/texd/config.rb

@@ -82,7 +82,7 @@ module Texd
     #
     # Supported values are described in ERROR_FORMATS.
     #
-    # The default is "full" and can be overriden by the `TEXD_WRITE_TIMEOUT`
+    # The default is "full" and can be overriden by the `TEXD_ERRORS`
     # environment variable.
     attr_reader :error_format
 

data/lib/texd/document.rb

@@ -40,6 +40,12 @@ module Texd
       def to_upload_ios(missing_refs: Set.new)
         attachments.to_upload_ios(missing_refs)
       end
+
+      # Convenience accessor for the main input file.
+      # @returns [String] main input file contents
+      def main_input_contents
+        attachments.items.fetch(main_input_name).contents
+      end
     end
   end
 end

data/lib/texd/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Texd
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: texd
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Dominik Menke
@@ -141,7 +141,7 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/digineo/texd-ruby
   source_code_uri: https://github.com/digineo/texd-ruby
-  changelog_uri: https://github.com/digineo/texd-ruby/blob/v0.4.0/CHANGELOG.md
+  changelog_uri: https://github.com/digineo/texd-ruby/blob/v0.4.1/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: