nanoc-latexmk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 31432aeef559015397ad00d6f276e265896c3b80
+  data.tar.gz: 8f1ac7dc2a96aed15ef0a528dd6b9b65c9ebc9d0
+SHA512:
+  metadata.gz: '049a200efb3b01b6b5256956f3360b95a6eaf822a62c5323cabd18a6939eaf3e0360eb67d902a36ecc92598675bff4b3b1f55707777a849850868d006b20228c'
+  data.tar.gz: 62057f6a30b0a4cfa78c3f6e724bf0506b294e24d3cbac508f3fb9118303ba9b22249dec6713934f7479bfe636ccf4e4460fb8224fb442a4c6f91a84e36624fc

data/.gitignore

@@ -0,0 +1,57 @@
+# Created by https://www.gitignore.io/api/ruby
+
+.byebug_history
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# End of https://www.gitignore.io/api/ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.4.2

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## Release 0.1.0
+
+- First release
+

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'coveralls'
+  gem 'rspec'
+  gem 'byebug'
+end
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,52 @@
+PATH
+  remote: .
+  specs:
+    nanoc-latexmk (0.pre.1.pre.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (9.1.0)
+    coveralls (0.8.21)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.14.1)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.4)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    json (2.1.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.0)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.0)
+    simplecov (0.14.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    term-ansicolor (1.6.0)
+      tins (~> 1.0)
+    thor (0.19.4)
+    tins (1.16.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  coveralls
+  nanoc-latexmk!
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/README.md

@@ -0,0 +1,63 @@
+# Nanoc-latexmk
+
+[Nanoc](https://nanoc.ws/) filter to compile `.tex` files to pdf using the `latexmk` command. Supports both `pdflatex` and `xelatex`.
+
+## System requirements
+
+You need everything to build your LaTeX file manually, so `latexmk`, `pdflatex` and `xelatex` need to be installed on your system.
+
+## Installation
+
+To use this filter, add nanoc-latexmk to your `Gemfile`.
+```
+gem 'nanoc-latexmk'
+```
+Then require this project in your `Rules`:
+```
+require 'nanoc/latexmk'
+```
+
+## Usage
+
+First, be sure to add `tex` to the `text_extensions` in your `nanoc.yaml`.
+
+With a basic file in `content/file.tex`:
+
+```
+---
+title: Hello
+---
+\section{World}
+```
+And a layout in `layouts/default.tex.erb`
+```
+\documentclass{article}
+\title{<%= item[:title] %>}
+\begin{document}
+\maketitle
+<%= yield %>
+\end{document}
+```
+You can add this to your `Rules`
+```
+compile '/**/*.tex', rep: :pdf do
+  layout '/default.tex.erb'
+  filter :latexmk
+  write ext: 'pdf'
+end
+```
+
+Results in:
+![Hello World PDF](https://user-images.githubusercontent.com/3226995/34323260-3995578a-e841-11e7-9aeb-b1e2ae6e84a6.png)
+
+## Licence
+
+See the [UNLICENSE](https://github.com/rien/nanoc-latexmk/blob/master/LICENSE) for details.
+
+## Author
+Rien Maertens [maertensrien@gmail.com](mailto:maertensrien@gmail.com)
+
+## Changelog
+
+See the [CHANGELOG](https://github.com/rien/nanoc-latexmk/blob/master/CHANGELOG.md) for details.
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+require 'rubygems'
+require 'rspec/core/rake_task'
+require 'rake'
+
+Bundler::GemHelper.install_tasks
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.pattern = './spec/**/*_spec.rb'
+end
+
+task default: :spec

data/lib/nanoc/latexmk.rb

@@ -0,0 +1,9 @@
+require 'nanoc'
+
+module Nanoc
+  module Latexmk
+  end
+end
+
+require_relative 'latexmk/filters'
+require_relative 'latexmk/version'

data/lib/nanoc/latexmk/filters.rb

@@ -0,0 +1,4 @@
+module Nanoc::Latexmk::Filters
+end
+
+require_relative 'filters/latexmk'

data/lib/nanoc/latexmk/filters/latexmk.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'tmpdir'
+
+module Nanoc::Latexmk::Filters
+  class LatexmkFilter < Nanoc::Filter
+    identifier :latexmk
+
+    type :text => :binary
+
+    TMPFILE_NAME = 'nanoc-latexmk.tex'
+
+    ENGINES = {
+      pdflatex: { cmd: %w[pdflatex], param: '-pdf' },
+      xelatex:  { cmd: %w[xelatex], param: '-xelatex' }
+    }.freeze
+
+    LATEX_PARAMS = %w[-interaction=nonstopmode -halt-on-error].freeze
+
+    DEFAULT_PARAMS = {
+      engine: :pdflatex,
+      command_params: LATEX_PARAMS,
+      shell_escape: false
+    }.freeze
+
+    def run(content, params = {})
+      params = DEFAULT_PARAMS.merge(params)
+
+      raise 'Unknown Engine' unless ENGINES.key? params[:engine].to_sym
+      engine = ENGINES[params[:engine].to_sym]
+
+      latex_command = engine[:cmd]
+
+      latex_command += params[:command_params]
+
+      latex_command << if params[:shell_escape]
+                         '-shell-escape'
+                       else
+                         '-no-shell-escape'
+                       end
+
+      Dir.mktmpdir do |dir|
+        File.open(File.join(dir, TMPFILE_NAME), 'w') do |f|
+          f.write(content)
+          f.flush
+
+          latexmk_command = ['latexmk',
+                             engine[:param],
+                             "-latex=\"#{latex_command.join(' ')}\"",
+                             "-output-directory=#{dir}",
+                             f.path]
+
+          raise 'Build Error' unless system(*latexmk_command)
+          system('mv', f.path.sub('.tex', '.pdf'), output_filename)
+
+        end
+      end
+    end
+  end
+end

data/lib/nanoc/latexmk/version.rb

@@ -0,0 +1,14 @@
+module Nanoc
+  module Latexmk
+    module Version
+      MAJOR = 0
+      MINOR = 1
+      PATCH = 0
+      BUILD = nil
+
+      STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.')
+    end
+
+    VERSION = Version::STRING
+  end
+end

data/nanoc-latexmk.gemspec

@@ -0,0 +1,14 @@
+require File.expand_path('../lib/nanoc/latexmk/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name          = 'nanoc-latexmk'
+  s.version       = Nanoc::Latexmk::VERSION
+  s.platform      = Gem::Platform::RUBY
+  s.authors       = ['Rien Maertens']
+  s.email         = ['maertensrien@gmail.com']
+  s.homepage      = 'https://github.com/rien/nanoc-latexmk'
+  s.summary       = 'Latexmk filter for nanoc.'
+  s.description   = 'Nanoc filter to convert latex files to pdf using latexmk'
+  s.files         = `git ls-files`.split("\n")
+  s.require_path  = 'lib'
+end

data/spec/filters/latexmk_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'byebug'
+
+describe Nanoc::Latexmk::Filters::LatexmkFilter do
+  before(:each) do
+    @filter = described_class.new
+    @input = <<~HEREDOC
+      \\documentclass[12pt]{article}
+      \\begin{document}
+      Hello world!
+      \\end{document}
+    HEREDOC
+    @pdf_magic_bytes = '%PDF'
+  end
+
+  describe '.run' do
+    it 'compile to pdf' do
+      expect(@filter.run(@input)).to be_truthy
+
+      result = File.read @filter.output_filename
+      expect(result.slice(0, @pdf_magic_bytes.length)).to eql(@pdf_magic_bytes)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'rspec/core'
+require 'nanoc/latexmk'
+require 'nanoc'
+
+unless defined?(SPEC_ROOT)
+  SPEC_ROOT = File.expand_path('../', __FILE__)
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-latexmk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rien Maertens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-23 00:00:00.000000000 Z
+dependencies: []
+description: Nanoc filter to convert latex files to pdf using latexmk
+email:
+- maertensrien@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/nanoc/latexmk.rb
+- lib/nanoc/latexmk/filters.rb
+- lib/nanoc/latexmk/filters/latexmk.rb
+- lib/nanoc/latexmk/version.rb
+- nanoc-latexmk.gemspec
+- spec/filters/latexmk_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/rien/nanoc-latexmk
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Latexmk filter for nanoc.
+test_files: []