latexpdf 0.4.1 → 0.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2db60b381091e8e650a7e7edd0146b025e0e5c3
-  data.tar.gz: addb19220017e210191cd34b01aea5324ce3c010
+  metadata.gz: 617518c1f7ec6b02b3c2d789c717f14bd5d15bf9
+  data.tar.gz: d0fdc327ff7685d40d6236a984ce297531905891
 SHA512:
-  metadata.gz: 5d20c41796aeb00532693b675d4079bc77bb7e6bcc8f84449ecbb2d4510e201d79ac8f2507c5189c52b23ccb18bee2abe2dee4d64bd4d313d09dfc7c8b8a0849
-  data.tar.gz: 83e7801782cbce78be9c51571bfcd20696e02ebc4d8cda3d8b19931190b41c018439233b8a73e3a7fcf4de24c725d8eba4e00894829e95bbda001a490d2276a8
+  metadata.gz: 90db69ee7ea6e75cf90e12c0de5b31b91af9e0cfbbfb53d096fe4a7f4ca14e58e6daf231b582fc4bef7704cb4f028ada22206171fddf8f8778aea99ccc0dba5d
+  data.tar.gz: 27d1def3ad962959d8a1c36a3765572a2a9f9d17c154dee20b7220fd0dd6bfba497cdbdab64616e71ecd22b0ec46c50c55349a2666f6f8afba6315a4e1c761aa

data/lib/latexpdf/escaper.rb

@@ -0,0 +1,33 @@
+module Latexpdf
+  class Escaper
+    ESCAPE_RE=/([{}_$&%#])|([\\^~|<>])/
+    ESC_MAP = {
+        '\\' => 'backslash',
+        '^' => 'asciicircum',
+        '~' => 'asciitilde',
+        '|' => 'bar',
+        '<' => 'less',
+        '>' => 'greater',
+    }
+
+    def tex_safe(text)
+      text.gsub(ESCAPE_RE) { |m|
+        if $1
+          "\\#{m}"
+        else
+          "\\text#{ESC_MAP[m]}{}"
+        end
+      }.html_safe
+    end
+  end
+
+  def self.escape_latex(text)
+    latex_escaper.tex_safe(text)
+  end
+
+  private
+
+  def self.latex_escaper
+    @latex_escaper ||= Escaper.new
+  end
+end

data/lib/latexpdf/version.rb

@@ -1,3 +1,3 @@
 module Latexpdf 
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end

data/lib/latexpdf.rb

@@ -13,6 +13,9 @@ require "latexpdf/errors/latexpdf_error"
 # Generator
 require "latexpdf/pdf_generator"
 
+# Escaper
+require "latexpdf/escaper"
+
 require "latexpdf/railtie" if defined?(Rails)
 
 module Latexpdf 

data/test/dummy/app/controllers/tex_controller.rb

@@ -4,4 +4,8 @@ class TexController < ApplicationController
   def example
     render "example.pdf.tex"
   end
+
+  def example2
+    render "example2.pdf.tex"
+  end
 end

data/test/dummy/app/helpers/application_helper.rb

@@ -1,2 +1,5 @@
 module ApplicationHelper
+  def tex_safe(text)
+    Latexpdf.escape_latex(text)
+  end
 end

data/test/dummy/app/views/tex/example2.pdf.tex

@@ -0,0 +1,6 @@
+\documentclass{article}
+\begin{document}
+These are all ten latex characters with special meaning:
+
+<%= tex_safe '& % $ # _ { } ~ ^ \ ' %>
+\end{document}

data/test/dummy/config/environments/development.rb

@@ -19,9 +19,6 @@ Rails.application.configure do
   # Print deprecation notices to the Rails logger.
   config.active_support.deprecation = :log
 
-  # Raise an error on page load if there are pending migrations.
-  config.active_record.migration_error = :page_load
-
   # Debug mode disables concatenation and preprocessing of assets.
   # This option may cause significant delays in view rendering with a large
   # number of complex assets.

data/test/dummy/log/development.log

@@ -0,0 +1,54 @@
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:21:02 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1397.9ms)
+Completed 200 OK in 1408ms (Views: 1408.0ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:24:01 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1451.5ms)
+Completed 200 OK in 1454ms (Views: 1453.4ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:24:02 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1495.4ms)
+Completed 200 OK in 1498ms (Views: 1497.5ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:24:47 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1300.8ms)
+Completed 200 OK in 1303ms (Views: 1302.3ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:24:49 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1474.8ms)
+Completed 200 OK in 1478ms (Views: 1477.2ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:25:01 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1272.2ms)
+Completed 200 OK in 1274ms (Views: 1273.6ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:25:02 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1470.4ms)
+Completed 200 OK in 1472ms (Views: 1471.9ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:27:26 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1483.5ms)
+Completed 200 OK in 1495ms (Views: 1494.2ms)
+
+
+Started GET "/tex/example2.pdf" for ::1 at 2016-05-24 11:27:28 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1586.0ms)
+Completed 200 OK in 1589ms (Views: 1588.4ms)

data/test/dummy/log/test.log

@@ -456,3 +456,108 @@ Started GET "/tex/example.pdf" for 127.0.0.1 at 2016-05-23 17:40:08 +0200
 Processing by TexController#example as PDF
   Rendered tex/example.pdf.tex (1144.2ms)
 Completed 200 OK in 1154ms (Views: 1153.8ms)
+-----------------------------------------------------------
+RenderingTest: test_Generate_PDF_on_the_fly_in_a_controller
+-----------------------------------------------------------
+Started GET "/tex/example.pdf" for 127.0.0.1 at 2016-05-24 10:22:59 +0200
+Processing by TexController#example as PDF
+  Rendered tex/example.pdf.tex (2845.9ms)
+Completed 200 OK in 2856ms (Views: 2855.3ms)
+-----------------------------------------------------------
+RenderingTest: test_Generate_PDF_on_the_fly_in_a_controller
+-----------------------------------------------------------
+Started GET "/tex/example.pdf" for 127.0.0.1 at 2016-05-24 11:01:22 +0200
+Processing by TexController#example as PDF
+  Rendered tex/example.pdf.tex (1315.1ms)
+Completed 200 OK in 1326ms (Views: 1325.5ms)
+-----------------------------------------------------------
+RenderingTest: test_Generate_PDF_on_the_fly_in_a_controller
+-----------------------------------------------------------
+Started GET "/tex/example.pdf" for 127.0.0.1 at 2016-05-24 11:08:45 +0200
+Processing by TexController#example as PDF
+  Rendered tex/example.pdf.tex (1221.9ms)
+Completed 200 OK in 1229ms (Views: 1229.0ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:13:39 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (356.3ms)
+Completed 500 Internal Server Error in 364ms
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:13:58 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (15.7ms)
+Completed 500 Internal Server Error in 23ms
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:14:21 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1306.3ms)
+Completed 200 OK in 1314ms (Views: 1314.1ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:27:59 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1307.1ms)
+Completed 200 OK in 1314ms (Views: 1313.8ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:30:41 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1358.4ms)
+Completed 200 OK in 1367ms (Views: 1366.3ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:31:00 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1300.7ms)
+Completed 200 OK in 1308ms (Views: 1307.7ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:31:20 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1287.9ms)
+Completed 200 OK in 1295ms (Views: 1294.4ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:31:46 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1301.4ms)
+Completed 200 OK in 1309ms (Views: 1309.2ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:31:54 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1303.6ms)
+Completed 200 OK in 1311ms (Views: 1310.3ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:31:59 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (1326.0ms)
+Completed 200 OK in 1333ms (Views: 1332.7ms)
+-----------------------------------------------------------
+RenderingTest: test_Generate_PDF_on_the_fly_in_a_controller
+-----------------------------------------------------------
+Started GET "/tex/example.pdf" for 127.0.0.1 at 2016-05-24 11:43:02 +0200
+Processing by TexController#example as PDF
+  Rendered tex/example.pdf.tex (3393.3ms)
+Completed 200 OK in 3402ms (Views: 3402.0ms)
+---------------------------------------------------------
+RenderingTest: test_Generate_PDF_using_escaped_characters
+---------------------------------------------------------
+Started GET "/tex/example2.pdf" for 127.0.0.1 at 2016-05-24 11:43:05 +0200
+Processing by TexController#example2 as PDF
+  Rendered tex/example2.pdf.tex (3438.5ms)
+Completed 200 OK in 3441ms (Views: 3440.4ms)

data/test/integration/rendering_test.rb

@@ -8,4 +8,14 @@ class RenderingTest < ActionDispatch::IntegrationTest
     assert_equal 1, reader.pages.count
     assert_match (/Test latex document/), reader.pages.first.text
   end
+
+  test "Generate PDF using escaped characters" do
+    get "/tex/example2.pdf"
+    assert_match (/application\/pdf/), response.headers["Content-Type"]
+    reader = PDF::Reader.new(StringIO.new(response.body))
+    assert_equal 1, reader.pages.count
+    assert_match (/& % \$ #/), reader.pages.first.text
+    assert_match (/\~ \^/), reader.pages.first.text
+    # PDF reader does not parse the others correctly unfortunately
+  end
 end

data/test/latexpdf/escaper_test.rb

@@ -0,0 +1,45 @@
+require "test_helper"
+
+module Latexpdf
+  class EscaperTest < MiniTest::Test
+    def test_escape_ampersand
+      assert_equal "\\&", Latexpdf.escape_latex("&")
+    end
+
+    def test_escape_dollar
+      assert_equal "\\$", Latexpdf.escape_latex("$")
+    end
+
+    def test_escape_pound
+      assert_equal "\\#", Latexpdf.escape_latex("#")
+    end
+
+    def test_escape_underscore
+      assert_equal "\\_", Latexpdf.escape_latex("_")
+    end
+
+    def test_escape_lcurly
+      assert_equal "\\{", Latexpdf.escape_latex("{")
+    end
+
+    def test_escape_rcurly
+      assert_equal "\\}", Latexpdf.escape_latex("}")
+    end
+
+    def test_escape_tilde
+      assert_equal "\\textasciitilde{}", Latexpdf.escape_latex("~")
+    end
+
+    def test_escape_ciicircum
+      assert_equal "\\textasciicircum{}", Latexpdf.escape_latex("^")
+    end
+
+    def test_escape_backslash
+      assert_equal "\\textbackslash{}", Latexpdf.escape_latex("\\")
+    end
+
+    def test_escape_percent_sign
+      assert_equal "\\%", Latexpdf.escape_latex("%")
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: latexpdf
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.2
 platform: ruby
 authors:
 - Matthijs Ooms
@@ -125,6 +125,7 @@ files:
 - lib/latexpdf.rb
 - lib/latexpdf/configuration.rb
 - lib/latexpdf/errors/latexpdf_error.rb
+- lib/latexpdf/escaper.rb
 - lib/latexpdf/pdf_generator.rb
 - lib/latexpdf/railtie.rb
 - lib/latexpdf/version.rb
@@ -137,6 +138,7 @@ files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/tex/example.pdf.tex
+- test/dummy/app/views/tex/example2.pdf.tex
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
@@ -160,6 +162,7 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
+- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
@@ -183,6 +186,7 @@ files:
 - test/dummy/tmp/cache/assets/sprockets/v3.0/sp/sp2aS0gBrj1ZVPgX0e8j11TaSSz3qpMGjtFv6soZ0KM.cache
 - test/integration/rendering_test.rb
 - test/latexpdf/configuration_test.rb
+- test/latexpdf/escaper_test.rb
 - test/latexpdf/latexpdf_error_test.rb
 - test/latexpdf/latexpdf_test.rb
 - test/latexpdf/logger_test.rb
@@ -223,6 +227,7 @@ test_files:
 - test/dummy/app/helpers/application_helper.rb
 - test/dummy/app/views/layouts/application.html.erb
 - test/dummy/app/views/tex/example.pdf.tex
+- test/dummy/app/views/tex/example2.pdf.tex
 - test/dummy/bin/bundle
 - test/dummy/bin/rails
 - test/dummy/bin/rake
@@ -246,6 +251,7 @@ test_files:
 - test/dummy/config/routes.rb
 - test/dummy/config/secrets.yml
 - test/dummy/config.ru
+- test/dummy/log/development.log
 - test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
@@ -271,6 +277,7 @@ test_files:
 - test/dummy/tmp/cache/assets/sprockets/v3.0/Yr/YrZ0OIHu42cExs1kqngMA6ShVDKhfGmhyW-E9haNo5Y.cache
 - test/integration/rendering_test.rb
 - test/latexpdf/configuration_test.rb
+- test/latexpdf/escaper_test.rb
 - test/latexpdf/latexpdf_error_test.rb
 - test/latexpdf/latexpdf_test.rb
 - test/latexpdf/logger_test.rb