latexpdf 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a2db60b381091e8e650a7e7edd0146b025e0e5c3
+  data.tar.gz: addb19220017e210191cd34b01aea5324ce3c010
+SHA512:
+  metadata.gz: 5d20c41796aeb00532693b675d4079bc77bb7e6bcc8f84449ecbb2d4510e201d79ac8f2507c5189c52b23ccb18bee2abe2dee4d64bd4d313d09dfc7c8b8a0849
+  data.tar.gz: 83e7801782cbce78be9c51571bfcd20696e02ebc4d8cda3d8b19931190b41c018439233b8a73e3a7fcf4de24c725d8eba4e00894829e95bbda001a490d2276a8

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2009 Peter Jones
+Copyright (c) 2009 James Healy
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,34 @@
+= LaTeXPdf
+
+* Git: http://github.com/mjooms/latexpdf
+* Original author: Matthijs Ooms 
+* Copyright: 2016
+* License: MIT-LICENSE
+
+== Description
+
+Latexpdf is a renderer intended for rails which compiles Tex files with ERB to a PDF using xelatex by
+default so that it supports Unicode.
+
+== Synopsis
+
+TODO
+
+== Requirements
+
+* ruby 2.2
+
+== Install
+
+* gem install latexpdf
+
+== Development
+
+Developing rails-latex requires bundler
+
+* rake test
+
+== Contributions
+
+* Matthijs Ooms
+

data/Rakefile

@@ -0,0 +1,16 @@
+require 'rake/testtask'
+require 'rubygems/tasks'
+Gem::Tasks.new
+
+Rake::TestTask.new do |task|
+  task.libs << "test"
+  task.pattern = "test/**/*_test.rb"
+end
+
+task default: :test
+
+desc 'Generates a coverage report'
+task :coverage do
+  ENV['COVERAGE'] = 'true'
+  Rake::Task['test'].execute
+end

data/lib/action_view/template_handlers/tex.rb

@@ -0,0 +1,26 @@
+module ActionView
+  class Template
+    module Handlers
+      class Tex
+        def handles_encoding?; true; end
+
+        class_attribute :default_format
+        self.default_format = Mime::PDF
+
+        def erb_handler
+          @@erb_handler ||= ActionView::Template.registered_template_handler(:erb)
+        end
+
+        def self.call(template)
+          new.call(template)
+        end
+
+        def call(template)
+          compiled_source = erb_handler.call(template)
+
+          "Latexpdf::compile(begin;#{compiled_source};end)"
+        end
+      end
+    end
+  end
+end

data/lib/latexpdf/configuration.rb

@@ -0,0 +1,13 @@
+module Latexpdf 
+  class Configuration
+    attr_accessor :passes, :logger, :build_path
+
+    def initialize
+      @passes = 2
+      @build_path = File.expand_path("../../tmp/", __dir__)
+      @logger = Logger.new(STDERR).tap do |log|
+        log.progname = "Latexpdf"
+      end
+    end
+  end
+end

data/lib/latexpdf/errors/latexpdf_error.rb

@@ -0,0 +1,13 @@
+module Latexpdf 
+  class LatexpdfError < StandardError
+    attr_reader :message
+
+    def initialize(message=nil)
+      @message = message
+    end
+
+    def to_s
+      self.message
+    end
+  end
+end

data/lib/latexpdf/pdf_generator.rb

@@ -0,0 +1,105 @@
+##
+# Handles the creation of a PDF
+#
+# +generate+ will generate a PDF
+# +cleanup+ removes the build dir and all related files. Should be called after generation of PDF; also after a failure
+# +errors+ will contain latex log on failure
+module Latexpdf
+  class PdfGenerator
+    attr_reader :errors, :template, :pdf_file, :content
+
+    def initialize(tex)
+      @template = tex
+    end
+
+    def generate
+      write_tex
+      Latexpdf.configuration.passes.times do
+        run_tex
+      end
+      if pdf_exist?
+        @pdf_file = target_pdf_file
+        @content = File.read(pdf_file)
+      end
+    end
+
+    def cleanup
+      if File.directory?(build_path)
+        FileUtils.remove_entry_secure(build_path)
+      end
+      @build_path = nil
+    end
+
+    def pdf_exist?
+      File.exist?(target_pdf_file)
+    end
+
+    protected
+
+    def build_path
+      @build_path ||= make_build_path
+    end
+
+    private
+
+    def write_tex
+      File.open(target_tex_file, "w") do |f|
+        f.write template
+        f.close
+      end
+    end
+
+    def tex_command
+      "xelatex"
+    end
+
+    def run_tex
+      args = %w[-halt-on-error -shell-escape -interaction batchmode]
+      args = args + ["#{target_tex_file}"]
+
+      result = exec_in_build_path do
+        system tex_command, *args, [:out, :err] => "/dev/null"
+      end
+
+      raise LatexpdfError.new "Latex failed:\n#{tex_log}" unless result
+      raise LatexpdfError.new "Latex PDF not generated:\n#{tex_log}" unless pdf_exist?
+    end
+
+    def exec_in_build_path
+      orig_dir = Dir.pwd
+      begin
+        Dir.chdir build_path
+        yield
+      ensure
+        Dir.chdir orig_dir
+      end
+    end
+
+    def tex_log
+      @errors ||= File.read(tex_log_file)
+    end
+
+    def build_id
+      @build_id ||= SecureRandom.uuid
+    end
+
+    def make_build_path
+      build_dir = Pathname.new(Latexpdf.configuration.build_path)
+      new_build_path = build_dir.join(build_id)
+      FileUtils.mkdir_p(new_build_path)
+      new_build_path
+    end
+
+    def target_pdf_file
+      build_path.join("input.pdf")
+    end
+
+    def tex_log_file
+      build_path.join("input.log")
+    end
+
+    def target_tex_file
+      build_path.join("input.tex")
+    end
+  end
+end

data/lib/latexpdf/railtie.rb

@@ -0,0 +1,9 @@
+require "action_view/template_handlers/tex"
+
+module Latexpdf
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ActionView::Template.register_template_handler :tex, ActionView::Template::Handlers::Tex
+    end
+  end
+end

data/lib/latexpdf/version.rb

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

data/lib/latexpdf.rb

@@ -0,0 +1,45 @@
+
+require "rbconfig"
+require "logger"
+require "securerandom"
+
+# Version
+require "latexpdf/version"
+require "latexpdf/configuration"
+
+# Errors
+require "latexpdf/errors/latexpdf_error"
+
+# Generator
+require "latexpdf/pdf_generator"
+
+require "latexpdf/railtie" if defined?(Rails)
+
+module Latexpdf 
+  class << self
+    attr_writer   :configuration
+    attr_writer   :logger
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.logger
+    @logger ||= configuration.logger
+  end
+
+  def self.compile(tex)
+    generator = PdfGenerator.new(tex)
+    begin
+      generator.generate
+      generator.content
+    ensure
+      generator.cleanup
+    end
+  end
+end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

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

@@ -0,0 +1,7 @@
+class TexController < ApplicationController
+  layout false
+
+  def example
+    render "example.pdf.tex"
+  end
+end

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

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

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

@@ -0,0 +1,4 @@
+\documentclass{article}
+\begin{document}
+Test latex document <%= "YEAH!" %>
+\end{document}

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config/application.rb

@@ -0,0 +1,32 @@
+require File.expand_path('../boot', __FILE__)
+
+require "rails"
+# Pick the frameworks you want:
+require "active_model/railtie"
+require "active_job/railtie"
+# require "active_record/railtie"
+require "action_controller/railtie"
+require "action_mailer/railtie"
+require "action_view/railtie"
+require "sprockets/railtie"
+require "rails/test_unit/railtie"
+
+Bundler.require(*Rails.groups)
+require "latexpdf"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

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

@@ -0,0 +1,41 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  config.action_mailer.raise_delivery_errors = false
+
+  # 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.
+  config.assets.debug = true
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # Adds additional error checking when serving assets at runtime.
+  # Checks for improperly declared sprockets dependencies.
+  # Raises helpful error messages.
+  config.assets.raise_runtime_errors = true
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

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

@@ -0,0 +1,79 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both threaded web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like
+  # NGINX, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable serving static files from the `/public` folder by default since
+  # Apache or NGINX already handles this.
+  config.serve_static_files = ENV['RAILS_SERVE_STATIC_FILES'].present?
+
+  # Compress JavaScripts and CSS.
+  config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  config.assets.compile = false
+
+  # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+  # yet still be able to expire them through the digest params.
+  config.assets.digest = true
+
+  # `config.assets.precompile` and `config.assets.version` have moved to config/initializers/assets.rb
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Use the lowest log level to ensure availability of diagnostic information
+  # when problems arise.
+  config.log_level = :debug
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = 'http://assets.example.com'
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation cannot be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+
+  # Do not dump schema after migrations.
+  config.active_record.dump_schema_after_migration = false
+end