texd 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 676222ee01af1a31facb86ee1a4416f4f5b3307e0c8e7de9b6ee7357b5e8a838
-  data.tar.gz: 153a30b56379209ba62ec860de87ae3fc6dd322b6828df73557bef90cb526bc9
+  metadata.gz: c54956eeb977294ed946d8f961d16c15e41eff3eca556d31787174c07852de97
+  data.tar.gz: cd603c3d2e9af5b04c43a8c0f9e542fddd18b815a5a01c3d8483f3729b8dd9f1
 SHA512:
-  metadata.gz: 210eab22723d4f043cad09601022fa577769a3235bbbac5984c538594d83015559b2f1d92d8f537cd230e301fc97425c75aca12a310d210f60ff85a05b3e0df8
-  data.tar.gz: 82c1ebfedabb268f92871ad707aa0b1d611440bb641a134a449e112eac76d24476e3ddcf25c788b6620b364650085e09a2e5ffad0a8fcc4592b04e953d2583c5
+  metadata.gz: 979a9503f9e4c38817d0c54b42c0ae288592819a65d0db1bd9ccf0dcaad81005d27842f35b49fc9b7869bfbb8563817e5e447413a865499d93993b95e0749081
+  data.tar.gz: a9d55ce2394c5bf940360ef4f11c7524c50149a0989da9a4c62ee186ecf6fddfcdba695a753ae9f20db20d55720179acecb4e9f5d6f08cc4dab4ec1f8850a81d

data/Gemfile.lock

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

data/gemfiles/rails-6.0.lock

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

data/gemfiles/rails-6.1.lock

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

data/gemfiles/rails-7.0.lock

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

data/lib/texd/document.rb

@@ -18,16 +18,16 @@ module Texd
     # Compile converts templates into TeX sources and collects file
     # references (created with `texd_attach` and `texd_reference` helpers).
     #
-    # @param args are forwarded to ApplicationController#render (which in turn
-    #   forwards to ActionView::Renderer#render).
+    # @param [String] template name of template file in ActionView's lookup
+    #   context.
+    # @param [Hash, nil] locals will be made available as getter methods in
+    #   the template.
     # @return [Compilation]
-    def compile(*args)
-      locals     = args.last.delete(:locals) if args.last.is_a?(Hash)
+    def compile(template:, locals: {})
       helper_mod = ::Texd.helpers(attachments, locals)
-
       tex_source = Class.new(ApplicationController) {
         helper helper_mod
-      }.render(*args)
+      }.render(template: template, format: :tex)
 
       main = attachments.main_input(tex_source)
       Compilation.new(main.name, attachments)

data/lib/texd/helpers.rb

@@ -28,8 +28,9 @@ module Texd
 
     # Escapes the given text, making it safe for use in TeX documents.
     def escape(text, line_break = "\\\\\\", typographic: true)
-      text = +text.to_s # text might be nil or a frozen string
-      text.tap do |str|
+      return "" if text.blank?
+
+      text.to_s.dup.tap do |str|
         str.gsub!(ESCAPE_RE) do |m|
           if Regexp.last_match(1)
             "\\#{m}"

data/lib/texd/version.rb

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

data/lib/texd.rb

@@ -94,8 +94,8 @@ module Texd
   # Render compiles a template, uploads the files to the texd instance,
   # and returns the PDF.
   #
-  # The arguments are directly forwarded to ApplicationController#render
-  # (which in turn delegates to ActionView::Renderer#render).
+  # The arguments are directly forwarded to Texd::Document (and end up in
+  # ActionView::Renderer#render).
   #
   # @example Render app/views/document/document.tex.erb
   #   begin
@@ -114,12 +114,16 @@ module Texd
   #     # something went wrong before we even got to sent data to the server
   #   end
   #
+  # @param [String] template name of template file in ActionView's lookup
+  #   context.
+  # @param [Hash, nil] locals will be made available as getter methods in
+  #   the template.
   # @raise [Texd::Client::ResponseError] on input and queue errors. Also on
   #   compilation errors, if Texd.config.error_format is set to JSON.
   # @raise [Texd::Error] on other Texd related errors.
   # @return [String] the PDF object
-  def render(*args)
-    doc = Document.compile(*args)
+  def render(template:, locals: {})
+    doc = Document.compile(template: template, locals: locals)
 
     client.render doc.to_upload_ios,
       input: doc.main_input_name

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: texd
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dominik Menke
@@ -140,7 +140,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.2.0/CHANGELOG.md
+  changelog_uri: https://github.com/digineo/texd-ruby/blob/v0.2.1/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: