jekyll-antex 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: acb00f8957a33f86919174a4e9ddf0371b285e50
+  data.tar.gz: 45f2fb9e89254c85dbe0f593c18ae6bc03f13060
+SHA512:
+  metadata.gz: 29d722d3b106e2c7ec4c8cfd15c8ee0faa66d6c89e6d5cc6d1dca38acc8ad58fb500995c668af6d875896b7431174f736ca4fded6149a970f11d8cc41f0325cb
+  data.tar.gz: 7f38caaac8717756d3cf18c714fb91a5ba17b25c68848bd42d7e1ff79cb54ba161424719bcd0a26b8ce89398c451a60f623048aab79a0d36a45fce768d49d06f

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Paolo Brasolin
+
+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.md

@@ -0,0 +1,10 @@
+# jekyll-antex
+
+[![Build Status](https://travis-ci.org/paolobrasolin/jekyll-antex.svg?branch=master)](https://travis-ci.org/paolobrasolin/jekyll-antex)
+[![Gem Version](https://badge.fury.io/rb/jekyll-antex.svg)](https://badge.fury.io/rb/jekyll-antex)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+[![Code Climate](https://codeclimate.com/github/paolobrasolin/jekyll-antex/badges/gpa.svg)](https://codeclimate.com/github/paolobrasolin/jekyll-antex)
+[![Test Coverage](https://codeclimate.com/github/paolobrasolin/jekyll-antex/badges/coverage.svg)](https://codeclimate.com/github/paolobrasolin/jekyll-antex/coverage)
+[![Inline docs](http://inch-ci.org/github/paolobrasolin/jekyll-antex.svg?branch=master)](http://inch-ci.org/github/paolobrasolin/jekyll-antex)
+[![Issue Count](https://codeclimate.com/github/paolobrasolin/jekyll-antex/badges/issue_count.svg)](https://codeclimate.com/github/paolobrasolin/jekyll-antex)

data/lib/jekyll/antex/alias.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'jekyll/antex/error'
+
+module Jekyll
+  module Antex
+    class Alias
+      class InvalidRegexp < Error; end
+
+      attr_reader :priority, :regexp, :options
+
+      def initialize(priority:, regexp:, options: {})
+        @priority = priority.to_i
+        @regexp = Regexp.new regexp
+        validate_regexp!
+        @options = options.to_h
+      end
+
+      private
+
+      def validate_regexp!
+        return if @regexp.names.include? 'code'
+        raise InvalidRegexp, <<~MESSAGE
+          The regexp #{@regexp.inspect} is missing the required named matching group "code".
+        MESSAGE
+      end
+    end
+  end
+end

data/lib/jekyll/antex/block.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'liquid'
+require 'antex'
+require 'yaml'
+
+require 'jekyll/antex/options'
+
+module Jekyll
+  module Antex
+    class Block < Liquid::Block
+      def initialize(tag, markup, tokens)
+        @markup = markup
+        super
+      end
+
+      def render(context)
+        options = build_options registers: context.registers, markup: @markup
+        job = ::Antex::Job.new snippet: super, options: options
+        job.run!
+        add_static_file context.registers[:site], job
+        render_html job
+      end
+
+      private
+
+      def render_html(job)
+        _, dir, name = static_file_paths job
+        img_tag = render_img_tag src: File.join(dir, name),
+                                 set_box: job.set_box
+        classes = job.options['classes'].join(' ')
+        "<span class='#{classes}'>#{img_tag}</span>"
+      end
+
+      def render_img_tag(src:, set_box:, precision: 3)
+        <<~IMG_TAG.gsub(/(\s\s+)/m, ' ').strip!
+          <img style='margin: #{set_box.mt.round(precision)}ex
+                              #{set_box.mr.round(precision)}ex
+                              #{set_box.mb.round(precision)}ex
+                              #{set_box.ml.round(precision)}ex;
+                      height: #{set_box.th.round(precision)}ex;
+                      width:  #{set_box.wd.round(precision)}ex;'
+              src='#{src}' />
+        IMG_TAG
+      end
+
+      def add_static_file(site, job)
+        site.static_files << Jekyll::StaticFile.new(
+          site, *static_file_paths(job)
+        )
+      end
+
+      def static_file_paths(job)
+        work_dir_prefix = %r{^#{Regexp.escape job.dirs['work']}(?=\/|$)}
+        # base, dir, name
+        [
+          job.dirs['work'],
+          job.dirs['dest'].sub(work_dir_prefix, '').sub(%r{^\/}, ''),
+          File.basename(job.files['svg'])
+        ]
+      end
+
+      def build_options(registers:, markup:)
+        Jekyll::Antex::Options.build Jekyll::Antex::Options::DEFAULTS,
+                                     registers[:site].config['antex'] || {},
+                                     registers[:page]['antex'] || {},
+                                     YAML.safe_load(markup) || {}
+      end
+    end
+  end
+end
+
+Liquid::Template.register_tag('antex', Jekyll::Antex::Block)

data/lib/jekyll/antex/dealiaser.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+require 'jekyll/antex/options'
+
+module Jekyll
+  module Antex
+    class Dealiaser
+      attr_reader :aliases
+
+      def initialize(tag: 'antex')
+        @aliases = []
+        @stash = {}
+        @tag = tag
+      end
+
+      def add_aliases(aliases)
+        @aliases.concat(aliases).sort_by!(&:priority).reverse!
+      end
+
+      def parse(content)
+        @content = content.dup
+        @stash = {}
+        stash_aliases
+        render_stashed_aliases_as_tags
+        unstash_tags
+        @content
+      end
+
+      private
+
+      def stash_aliases
+        @aliases.each do |aliaz|
+          @content.gsub!(aliaz.regexp) do
+            uuid = SecureRandom.uuid
+            @stash.store uuid, match: Regexp.last_match, options: aliaz.options
+            uuid
+          end
+        end
+      end
+
+      def render_stashed_aliases_as_tags
+        @stash.each do |key, value|
+          @stash[key] = render_matched_alias_as_tag(**value)
+        end
+      end
+
+      def unstash_tags
+        @stash.each do |uuid, rendered_tag|
+          @content.gsub! uuid, rendered_tag
+        end
+      end
+
+      def render_matched_alias_as_tag(match:, options:)
+        markup = YAML.safe_load match[:markup] if match.names.include?('markup')
+        markup = YAML.dump Options.build(options || {}, markup || {})
+        code = match['code']
+        "{% #{@tag} #{markup} %}#{code}{% end#{@tag} %}"
+      end
+    end
+  end
+end

data/lib/jekyll/antex/defaults.yml

@@ -0,0 +1,120 @@
+preamble: |
+  \usepackage{mathtools, amssymb}
+  \usepackage{tikz}
+template: |
+  \documentclass{article}
+  \pagestyle{empty}
+  {{ preamble }}
+  \newsavebox\snippet
+  \begin{lrbox}{\snippet}{{ prepend }}{{ snippet }}{{ append }}\end{lrbox}
+  \newwrite\file
+  \immediate\openout\file=\jobname.yml
+  \immediate\write\file{em: \the\dimexpr1em}
+  \immediate\write\file{ex: \the\dimexpr1ex}
+  \immediate\write\file{ht: \the\ht\snippet}
+  \immediate\write\file{dp: \the\dp\snippet}
+  \immediate\write\file{wd: \the\wd\snippet}
+  \closeout\file
+  \begin{document}\usebox{\snippet}\end{document}
+classes: [antex]
+pipeline:
+  - latexmk
+  - dvisvgm_tfm
+  - dvisvgm_fit
+  - cp_to_dest
+dirs:
+  work: .antex-cache
+  dest: .antex-cache/antex
+files:
+  tex: "{{ dir.work }}/{{ hash }}.tex"
+  dvi: "{{ dir.work }}/{{ hash }}.dvi"
+  yml: "{{ dir.work }}/{{ hash }}.yml"
+  tfm: "{{ dir.work }}/{{ hash }}.tfm.svg"
+  fit: "{{ dir.work }}/{{ hash }}.fit.svg"
+  svg: "{{ dir.dest }}/{{ hash }}.svg"
+commands:
+  latexmk:
+    command:
+      - "latexmk"
+      - "-output-directory={{ dir.work }}"
+      - "{{ file.tex }}"
+    sources:
+      - "{{ file.tex }}"
+    targets:
+      - "{{ file.dvi }}"
+      - "{{ file.yml }}"
+  dvisvgm_tfm:
+    command:
+      - "dvisvgm"
+      - "--no-fonts"
+      - "{{ file.dvi }}"
+      - "--output={{ file.tfm }}"
+    sources:
+      - "{{ file.dvi }}"
+    targets:
+      - "{{ file.tfm }}"
+  dvisvgm_fit:
+    command:
+      - "dvisvgm"
+      - "--no-fonts"
+      - "--exact"
+      - "{{ file.dvi }}"
+      - "--output={{ file.fit }}"
+    sources:
+      - "{{ file.dvi }}"
+    targets:
+      - "{{ file.fit }}"
+  cp_to_dest:
+    command:
+      - "cp"
+      - "{{ file.fit }}"
+      - "{{ file.svg }}"
+    sources:
+      - "{{ file.fit }}"
+    targets:
+      - "{{ file.svg }}"
+aliases:
+  # 'internal' must have the highest priority;
+  # it is the liquid tag all other aliases are rendered to.
+  internal:
+    priority: 1000
+    regexp: !ruby/regexp
+      /{%\s*antex\s*(?<markup>.*?)%}(?<code>.*?){%\s*endantex\s*%}/m
+  # 'default' is the standard generic purpose alias.
+  # Since it can contain tikz pictures,
+  # it must have higher priority than 'tikzpicture' alias.
+  default:
+    priority: 100
+    regexp: !ruby/regexp
+      /{%\s*tex\s*(?<markup>.*?)%}(?<code>.*?){%\s*endtex\s*%}/m
+  tikzpicture:
+    priority: 90
+    regexp: !ruby/regexp
+      /{%\s*tikz\s*(?<markup>.*?)%}(?<code>.*?){%\s*endtikz\s*%}/m
+    options:
+      prepend: '\\begin{tikzpicture}'
+      append: '\\end{tikzpicture}'
+      classes: [antex, tikz]
+  # 'display_math' must have a higher priority than 'inline_math'
+  # since the respective deliniters are double and single dollars.
+  display_math:
+    priority: 20
+    regexp: !ruby/regexp /\$\$(?<code>.*?)\$\$/m
+    options:
+      prepend: '$\\displaystyle'
+      append: $
+      classes: [antex, display]
+  inline_math:
+    priority: 10
+    regexp: !ruby/regexp /\$(?<code>.*?)\$/
+    options:
+      prepend: $
+      append: $
+      classes: [antex, inline]
+  # 'inline_macro' must have the lowest priority
+  # to avoid interference with others aliases.
+  inline_macro:
+    priority: 0
+    regexp: !ruby/regexp /(?<code>\\[A-z]+)/
+    options:
+      classes: [antex, inline]

data/lib/jekyll/antex/error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Antex
+    class Error < StandardError; end
+  end
+end

data/lib/jekyll/antex/generator.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'jekyll'
+require 'jekyll/utils'
+
+require 'jekyll/antex/alias'
+require 'jekyll/antex/dealiaser'
+
+module Jekyll
+  module Antex
+    class Generator < Jekyll::Generator
+      def generate(site)
+        site.pages.each do |page|
+          dealiaser = build_dealiaser site: site, resource: page
+          page.content = dealiaser.parse page.content
+        end
+
+        # site.documents.each do |document|
+        #   TODO
+        # end
+
+        # site.posts.docs.each do |post|
+        #   TODO
+        # end
+      end
+
+      private
+
+      def build_dealiaser(site:, resource:)
+        options = build_options(site: site, resource: resource)
+        dealiaser = Jekyll::Antex::Dealiaser.new
+        dealiaser.add_aliases build_aliases(options['aliases'])
+        dealiaser
+      end
+
+      def build_options(site:, resource:)
+        Jekyll::Antex::Options.build Jekyll::Antex::Options::DEFAULTS,
+                                     site.config['antex'] || {},
+                                     resource.data['antex'] || {}
+      end
+
+      def build_aliases(options_hash)
+        options_hash.values.map do |args|
+          Alias.new Jekyll::Utils.symbolize_hash_keys(args)
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/antex/options.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'yaml'
+require 'jekyll/utils'
+
+module Jekyll
+  module Antex
+    module Options
+      DEFAULTS =
+        YAML.load_file(File.join(File.dirname(__FILE__), 'defaults.yml')).freeze
+
+      def self.build(*hashes)
+        hashes.reduce({}) do |result, hash|
+          Jekyll::Utils.deep_merge_hashes result, hash
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/antex/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Antex
+    VERSION = '0.1.0'
+  end
+end

data/lib/jekyll/antex.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'antex'
+
+require 'jekyll/antex/version'
+require 'jekyll/antex/error'
+require 'jekyll/antex/options'
+require 'jekyll/antex/alias'
+require 'jekyll/antex/dealiaser'
+require 'jekyll/antex/generator'
+require 'jekyll/antex/block'

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-antex
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paolo Brasolin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: antex
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.50'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 'Jekyll-anTeX implements universal TeX support in Jekyll to embed and
+  render arbitrary code using any engine and dialect. '
+email: paolo.brasolin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/jekyll/antex.rb
+- lib/jekyll/antex/alias.rb
+- lib/jekyll/antex/block.rb
+- lib/jekyll/antex/dealiaser.rb
+- lib/jekyll/antex/defaults.yml
+- lib/jekyll/antex/error.rb
+- lib/jekyll/antex/generator.rb
+- lib/jekyll/antex/options.rb
+- lib/jekyll/antex/version.rb
+homepage: https://github.com/paolobrasolin/antex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+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: Universal TeX integration for Jekyll
+test_files: []