texd 0.1.0 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8adfd41b8474299e99aabf34619decaf04acd780093e53edeef3df4d7373dbe8
-  data.tar.gz: 817ea60570bfecc734cfc7ea4500401f136076d0d7cebf8b5d1a8e95b900eed6
+  metadata.gz: 33d8cf48e8c880611c853f282bc3db47cf5d627022887dd311ff7a895a3f24e9
+  data.tar.gz: c77ab1247262c025cd814d58b22f32f21f241a33fb5d95b15d1d805409546534
 SHA512:
-  metadata.gz: 5945f91f78c4d4b7386b5ea109a7306f24573223f1e9e6c5b2a4ce85d766b5564c0c2feb87d682e539560765ed12c65d7f316604ae45b325a2dfcbe1cdc61f76
-  data.tar.gz: 351d90cadc208506ddc33446dfd182e1a544b2f9cce1fa243d6316515e87d557bcbb759e112bf8f5c6daf2586288e66b9a7fafa70bb516f4567a8651b659a3f9
+  metadata.gz: 398a048ca70ecdb2a65ec3466ea900ebd918f7aacc5d4335ea1099cacf9342729a5e232eaed8af9bed261d4ca1e6d6ceb1e19476acea5ccc5a310b1520157afc
+  data.tar.gz: 7dd01397f2fdc0975dc0e31d8dcc2fb8de21017af585615333ad34a62ffcbce1793e994f6f6ac25eefa70c79779b8edfa1f5fd3d831b581ce826613b477b05c1

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    texd (0.1.0)
+    texd (0.2.2)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 
@@ -81,7 +81,7 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
     digest (3.1.0)
@@ -183,7 +183,7 @@ GEM
       rspec-mocks (~> 3.10)
       rspec-support (~> 3.10)
     rspec-support (3.11.0)
-    rubocop (1.26.0)
+    rubocop (1.26.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/gemfiles/rails-6.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    texd (0.1.0)
+    texd (0.2.2)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 
@@ -70,7 +70,7 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
     erubi (1.10.0)

data/gemfiles/rails-6.1.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    texd (0.1.0)
+    texd (0.2.2)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 
@@ -74,7 +74,7 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
     erubi (1.10.0)

data/gemfiles/rails-7.0.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    texd (0.1.0)
+    texd (0.2.2)
       multipart-post (~> 2.0)
       rails (>= 6.0, < 8)
 
@@ -80,7 +80,7 @@ GEM
       activesupport (>= 3.0.0)
       railties (>= 3.0.0)
       thor (>= 0.14.6)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     crass (1.0.6)
     diff-lcs (1.5.0)
     digest (3.1.0)

data/lib/texd/document.rb

@@ -6,8 +6,8 @@ module Texd
     attr_reader :attachments
 
     # Shorthand for `new.compile`.
-    def self.compile(*args)
-      new.compile(*args)
+    def self.compile(template:, locals: {})
+      new.compile(template: template, locals: locals)
     end
 
     def initialize
@@ -18,14 +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)
-      helper_mod = ::Texd.helpers(attachments)
+    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
-      text.to_s.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.1.0"
+  VERSION = "0.2.2"
 end

data/lib/texd.rb

@@ -55,16 +55,26 @@ module Texd
     @client
   end
 
-  # Creates a helper module containing (a) the `texd_attach` helper,
-  # and (b) any other helper configured in Text.config.helpers.
+  # Creates a helper module containing:
   #
-  # This needs to be dynamic, because the attachment list is volatile.
+  # 1. the `texd_attach` and `texd_reference` helper,
+  # 2. locals passed in, transformed to helper methods, and
+  # 3. any other helper configured in Text.config.helpers.
   #
   # @api private
-  def helpers(attachments)
+  # @param [Texd::AttachmentList] attachments
+  # @param [Hash, nil] locals
+  # @return [Module] a new helper module
+  def helpers(attachments, locals) # rubocop:disable Metrics/AbcSize
+    locals ||= {}
+
     Module.new do
       include Texd::Helpers
 
+      Texd.config.helpers.each do |mod|
+        include mod
+      end
+
       define_method :texd_attach do |path, rename: true, with_extension: true|
         attachments.attach(path, rename).name(with_extension)
       end
@@ -75,8 +85,8 @@ module Texd
 
       alias_method :texd_references, :texd_reference
 
-      Texd.config.helpers.each do |mod|
-        include mod
+      locals.each do |name, value|
+        define_method(name) { value }
       end
     end
   end
@@ -84,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
@@ -104,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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: texd
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.2
 platform: ruby
 authors:
 - Dominik Menke
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-21 00:00:00.000000000 Z
+date: 2022-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -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.1.0/CHANGELOG.md
+  changelog_uri: https://github.com/digineo/texd-ruby/blob/v0.2.2/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: