texd 0.3.2 → 0.4.2

data/gemfiles/rails-7.0.lock

@@ -1,74 +1,74 @@
 PATH
   remote: ..
   specs:
-    texd (0.3.2)
+    texd (0.4.2)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actioncable (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actioncable (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
       nio4r (~> 2.0)
       websocket-driver (>= 0.6.1)
-    actionmailbox (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionmailbox (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
       mail (>= 2.7.1)
       net-imap
       net-pop
       net-smtp
-    actionmailer (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      actionview (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionmailer (7.0.3)
+      actionpack (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activesupport (= 7.0.3)
       mail (~> 2.5, >= 2.5.4)
       net-imap
       net-pop
       net-smtp
       rails-dom-testing (~> 2.0)
-    actionpack (7.0.2.3)
-      actionview (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionpack (7.0.3)
+      actionview (= 7.0.3)
+      activesupport (= 7.0.3)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actiontext (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actiontext (7.0.3)
+      actionpack (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
       globalid (>= 0.6.0)
       nokogiri (>= 1.8.5)
-    actionview (7.0.2.3)
-      activesupport (= 7.0.2.3)
+    actionview (7.0.3)
+      activesupport (= 7.0.3)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activejob (7.0.2.3)
-      activesupport (= 7.0.2.3)
+    activejob (7.0.3)
+      activesupport (= 7.0.3)
       globalid (>= 0.3.6)
-    activemodel (7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activerecord (7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
-    activestorage (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    activemodel (7.0.3)
+      activesupport (= 7.0.3)
+    activerecord (7.0.3)
+      activemodel (= 7.0.3)
+      activesupport (= 7.0.3)
+    activestorage (7.0.3)
+      actionpack (= 7.0.3)
+      activejob (= 7.0.3)
+      activerecord (= 7.0.3)
+      activesupport (= 7.0.3)
       marcel (~> 1.0)
       mini_mime (>= 1.1.0)
-    activesupport (7.0.2.3)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -76,7 +76,7 @@ GEM
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    combustion (1.3.5)
+    combustion (1.3.7)
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
@@ -89,8 +89,7 @@ GEM
       activesupport (>= 5.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    io-wait (0.2.1)
-    loofah (2.15.0)
+    loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -98,8 +97,9 @@ GEM
     marcel (1.0.2)
     method_source (1.0.0)
     mini_mime (1.1.2)
-    minitest (5.15.0)
-    multipart-post (2.1.1)
+    mini_portile2 (2.8.0)
+    minitest (5.16.1)
+    multipart-post (2.2.3)
     net-imap (0.2.3)
       digest
       net-protocol
@@ -108,15 +108,17 @@ GEM
       digest
       net-protocol
       timeout
-    net-protocol (0.1.2)
-      io-wait
+    net-protocol (0.1.3)
       timeout
     net-smtp (0.3.1)
       digest
       net-protocol
       timeout
     nio4r (2.5.8)
-    nokogiri (1.13.3-x86_64-linux)
+    nokogiri (1.13.6)
+      mini_portile2 (~> 2.8.0)
+      racc (~> 1.4)
+    nokogiri (1.13.6-x86_64-linux)
       racc (~> 1.4)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -125,31 +127,31 @@ GEM
       byebug (~> 11.0)
       pry (~> 0.13.0)
     racc (1.6.0)
-    rack (2.2.3)
-    rack-test (1.1.0)
-      rack (>= 1.0, < 3)
-    rails (7.0.2.3)
-      actioncable (= 7.0.2.3)
-      actionmailbox (= 7.0.2.3)
-      actionmailer (= 7.0.2.3)
-      actionpack (= 7.0.2.3)
-      actiontext (= 7.0.2.3)
-      actionview (= 7.0.2.3)
-      activejob (= 7.0.2.3)
-      activemodel (= 7.0.2.3)
-      activerecord (= 7.0.2.3)
-      activestorage (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    rack (2.2.3.1)
+    rack-test (2.0.1)
+      rack (>= 1.3)
+    rails (7.0.3)
+      actioncable (= 7.0.3)
+      actionmailbox (= 7.0.3)
+      actionmailer (= 7.0.3)
+      actionpack (= 7.0.3)
+      actiontext (= 7.0.3)
+      actionview (= 7.0.3)
+      activejob (= 7.0.3)
+      activemodel (= 7.0.3)
+      activerecord (= 7.0.3)
+      activestorage (= 7.0.3)
+      activesupport (= 7.0.3)
       bundler (>= 1.15.0)
-      railties (= 7.0.2.3)
+      railties (= 7.0.3)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.4.2)
+    rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (7.0.2.3)
-      actionpack (= 7.0.2.3)
-      activesupport (= 7.0.2.3)
+    railties (7.0.3)
+      actionpack (= 7.0.3)
+      activesupport (= 7.0.3)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -164,10 +166,10 @@ GEM
     rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-rails (5.1.1)
+    rspec-rails (5.1.2)
       actionpack (>= 5.2)
       activesupport (>= 5.2)
       railties (>= 5.2)
@@ -176,17 +178,18 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    strscan (3.0.1)
+    strscan (3.0.3)
     thor (1.2.1)
-    timeout (0.2.0)
+    timeout (0.3.0)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
     websocket-driver (0.7.5)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.5.4)
+    zeitwerk (2.6.0)
 
 PLATFORMS
+  ruby
   x86_64-linux
 
 DEPENDENCIES

data/lib/texd/attachment.rb

@@ -132,7 +132,7 @@ module Texd
 
     Dynamic = Struct.new(:name, :contents) do
       def to_upload_io(**)
-        UploadIO.new(StringIO.new(contents), nil, name).tap { |io|
+        Multipart::Post::UploadIO.new(StringIO.new(contents), nil, name).tap { |io|
           io.instance_variable_set :@original_filename, name
         }
       end
@@ -177,7 +177,7 @@ module Texd
     class File < Base
       # @api private
       def to_upload_io(**)
-        UploadIO.new(absolute_path.open("rb"), nil, name).tap { |io|
+        Multipart::Post::UploadIO.new(absolute_path.open("rb"), nil, name).tap { |io|
           io.instance_variable_set :@original_filename, name
         }
       end
@@ -197,7 +197,7 @@ module Texd
         f  = full ? absolute_path.open("rb") : StringIO.new(checksum)
         ct = full ? STORE_REF                : USE_REF
 
-        UploadIO.new(f, ct, name).tap { |io|
+        Multipart::Post::UploadIO.new(f, ct, name).tap { |io|
           io.instance_variable_set :@original_filename, name
         }
       end

data/lib/texd/client.rb

@@ -3,6 +3,7 @@
 require "net/http"
 require "net/http/post/multipart"
 require "json"
+require "pp"
 
 module Texd
   class Client
@@ -39,6 +40,20 @@ module Texd
         @logs = logs
         super(message, details: details)
       end
+
+      def write_to(io)
+        io << "Compilation failed: #{message}\n"
+        if details
+          io.print "Details: "
+          PP.pp(details, io)
+        end
+
+        if logs
+          io << "Logs:\n" << logs
+        else
+          io << "Logs: not available"
+        end
+      end
     end
 
     # Raised when the texd server encountered one or more unknown file

data/lib/texd/config.rb

@@ -27,8 +27,9 @@ module Texd
       read_timeout:   ENV.fetch("TEXD_READ_TIMEOUT", 180),
       write_timeout:  ENV.fetch("TEXD_WRITE_TIMEOUT", 60),
       error_format:   ENV.fetch("TEXD_ERRORS", "full"),
-      tex_engine:     ENV["TEXD_ENGINE"],
-      tex_image:      ENV["TEXD_IMAGE"],
+      error_handler:  ENV.fetch("TEXD_ERROR_HANDLER", "raise"),
+      tex_engine:     ENV.fetch("TEXD_ENGINE", nil),
+      tex_image:      ENV.fetch("TEXD_IMAGE", nil),
       helpers:        Set.new,
       lookup_paths:   [], # Rails.root.join("app/tex") is inserted in railtie.rb
       ref_cache_size: 128,
@@ -40,6 +41,13 @@ module Texd
     # Supported error formats.
     ERROR_FORMATS = %w[json full condensed].freeze
 
+    # Default error handlers. One might provide a custom proc, if desired.
+    ERROR_HANDLERS = {
+      "raise"  => proc { |err, _doc| raise err },
+      "stderr" => proc { |err, _doc| err.write_to($stderr) },
+      "ignore" => proc { |_err, _doc| },
+    }.freeze
+
     # Supported TeX engines.
     TEX_ENGINES = %w[xelatex lualatex pdflatex].freeze
 
@@ -74,10 +82,26 @@ 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
 
+    # This setting defines how to handle Texd::Client::CompilationError errors.
+    #
+    # Supported values are:
+    #
+    # - "raise", which will not process the error,
+    # - "stderr", which will print the error to stderr,
+    # - "ignore", which will silently discard,
+    # - a Proc instance, which will delegate the error handling to it.
+    #
+    # The setter will lookup "raise", "stderr", and "ignore" from ERROR_HANDLERS,
+    # so this attribute will always be of kind Proc.
+    #
+    # The default value is "raise" and can be overridden by the `TEXD_ERROR_HANDLER`
+    # environment variable.
+    attr_reader :error_handler
+
     # This is the selected TeX engine. Supported values are described in
     # TEX_ENGINES.
     #
@@ -122,8 +146,8 @@ module Texd
     end
 
     def to_h
-      DEFAULT_CONFIGURATION.keys.each_with_object({}) do |key, hash|
-        hash[key] = public_send(key)
+      DEFAULT_CONFIGURATION.keys.index_with do |key|
+        public_send(key)
       end
     end
 
@@ -163,12 +187,30 @@ module Texd
       val   = val.to_s
 
       unless ERROR_FORMATS.include?(val)
-        raise InvalidConfig.new(nil, got: val, expected: ERROR_FORMATS)
+        raise InvalidConfig.new(nil,
+          option:   :error_format,
+          got:      val,
+          expected: ERROR_FORMATS)
       end
 
       @error_format = val
     end
 
+    def error_handler=(val)
+      val ||= "raise"
+      val   = ERROR_HANDLERS.fetch(val.to_s, nil) unless val.respond_to?(:call)
+
+      if val
+        @error_handler = val
+        return
+      end
+
+      raise InvalidConfig.new(nil,
+        option:   :error_handler,
+        got:      val,
+        expected: ERROR_HANDLERS.keys + ["a Proc instance"])
+    end
+
     def tex_engine=(val)
       unless val.nil?
         val = val.to_s

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.3.2"
+  VERSION = "0.4.2"
 end

data/lib/texd.rb

@@ -105,7 +105,6 @@ module Texd
   #     # Compilation failed and we might have a log in err.logs (only
   #     # Texd.config.error_format is "full" or "condensed").
   #     # Otherwise some details might be available in err.details.
-  #     # have a log in err.details
   #   rescue Texd::Client::InputError => err
   #     # something failed during input file processing. For details see
   #     # err.details
@@ -135,5 +134,8 @@ module Texd
     # retry once with resolved references
     client.render doc.to_upload_ios(missing_refs: err.references),
       input: doc.main_input_name
+  rescue Client::CompilationError => err
+    config.error_handler.call(err, doc)
+    nil
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texd
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.2
 platform: ruby
 authors:
 - Dominik Menke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-28 00:00:00.000000000 Z
+date: 2022-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -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.3.2/CHANGELOG.md
+  changelog_uri: https://github.com/digineo/texd-ruby/blob/v0.4.2/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: