jekyll-antex 0.4.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8af04a4d3122b7e58926aed907120b7bef5e4d5cfb660be03c625f1e0ec48d4
-  data.tar.gz: 4066bd201baba8f6bdcf724f38ea8991eb011da58f1da13831d32547781ade9c
+  metadata.gz: 7d7e55a185748b2e917234281bb7f2242ddc40a4d36a81da3c82c63e394fa1f5
+  data.tar.gz: e5f4058b0c13c5a0397fb181a9c1fc6c266b9ea1957d3265a35dbbdb6592cee5
 SHA512:
-  metadata.gz: 86ebce737fc0c681b040f329d46aee48198d528a25e0bab5bbbecebc5da5215fb5f462bd385a5f211e97063b45639feaf76cfa0343ac19ec7fd28ccf0091c530
-  data.tar.gz: 381bc28893d16e442f07567eddee15b08bab1eed15387eb4b3793dbc8e35949a61dcaa0d79e98b1716db5268762d99c6e91304c806a81e914eeaaf111658eee3
+  metadata.gz: f7d87025ca79d0f2bd6aa8e2f0f66d8c7fb1f2d5683bc24f01c5fbace55b6bc069b07e15f93cb78fdd41b9abc8f4809f7b48d4f96f9f404c8eb23d7aa99882ee
+  data.tar.gz: babab2523a37de3b562008177980c36f37e7c8588c2de46888d9b428683e3c608e8fe012cefc3aba0891b9fc411dc79bac2f6dec4e50fdd9ae4b2de6e0888ad6

data/README.md

@@ -1,10 +1,18 @@
 # 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)
+[![CI tests status badge][build-shield]][build-url]
+[![Latest release badge][rubygems-shield]][rubygems-url]
+[![License badge][license-shield]][license-url]
+[![Maintainability badge][cc-maintainability-shield]][cc-maintainability-url]
+[![Test coverage badge][cc-coverage-shield]][cc-coverage-url]
 
-[![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)
+[build-shield]: https://img.shields.io/github/workflow/status/paolobrasolin/jekyll-antex/CI/main?label=tests&logo=github
+[build-url]: https://github.com/paolobrasolin/jekyll-antex/actions/workflows/main.yml "CI tests status"
+[rubygems-shield]: https://img.shields.io/gem/v/jekyll-antex?logo=ruby
+[rubygems-url]: https://rubygems.org/gems/jekyll-antex "Latest release"
+[license-shield]: https://img.shields.io/github/license/paolobrasolin/jekyll-antex
+[license-url]: https://github.com/paolobrasolin/jekyll-antex/blob/main/LICENSE "License"
+[cc-maintainability-shield]: https://img.shields.io/codeclimate/maintainability/paolobrasolin/jekyll-antex?logo=codeclimate
+[cc-maintainability-url]: https://codeclimate.com/github/paolobrasolin/jekyll-antex "Maintainability"
+[cc-coverage-shield]: https://img.shields.io/codeclimate/coverage/paolobrasolin/jekyll-antex?logo=codeclimate&label=test%20coverage
+[cc-coverage-url]: https://codeclimate.com/github/paolobrasolin/jekyll-antex/coverage "Test coverage"

data/lib/jekyll/antex/alias.rb

@@ -7,7 +7,6 @@ module Jekyll
     class InvalidRegexp < Error; end
 
     Alias = Struct.new(:priority, :regexp, :options, keyword_init: true) do
-
       def initialize(*args)
         super
         validate_regexp!
@@ -17,6 +16,7 @@ module Jekyll
 
       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

data/lib/jekyll/antex/block.rb

@@ -9,6 +9,10 @@ require 'jekyll/antex/options'
 
 module Jekyll
   module Antex
+    class << self
+      attr_accessor :jobs
+    end
+
     class Block < Liquid::Block
       def initialize(tag, markup, tokens)
         @markup = markup
@@ -18,54 +22,56 @@ module Jekyll
       def render(context)
         options = build_options registers: context.registers, markup: @markup
         job = ::Antex::Job.new snippet: super, options: options
-        job.run!
+        Jekyll::Antex.jobs.store(job.hash, job)
         add_static_file context.registers[:site], job
-        render_html job
+        self.class.render_html(job)
       end
 
-      private
-
-      def render_html(job)
-        img_tag = render_img_tag src: img_url(job),
-                                 set_box: job.set_box
+      def self.render_html(job)
+        img_tag = render_img_tag job
         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
+      def self.render_img_tag(job)
+        "<img data-antex='#{job.hash}' src='#{img_url(job)}' />"
       end
 
-      def add_static_file(site, job)
-        site.static_files << Jekyll::StaticFile.new(
-          site, *static_file_paths(job)
-        )
+      def self.render_style_attribute(job_set_box, precision: 3)
+        <<~IMG_TAG.gsub(/(\s\s+)/m, ' ').strip!
+          style='margin: #{job_set_box.mt.round(precision)}ex
+                         #{job_set_box.mr.round(precision)}ex
+                         #{job_set_box.mb.round(precision)}ex
+                         #{job_set_box.ml.round(precision)}ex;
+                 height: #{job_set_box.th.round(precision)}ex;
+                 width:  #{job_set_box.wd.round(precision)}ex;'
+        IMG_TAG
       end
 
-      def img_url(job)
+      def self.img_url(job)
         _, dest_dir, filename = static_file_paths job
         url_path_prefix = job.options['url_path_prefix'] || '/'
         File.join url_path_prefix, dest_dir, filename
       end
 
-      def static_file_paths(job)
-        work_dir_prefix = %r{^#{Regexp.escape job.dirs['work']}(?=\/|$)}
+      def self.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{^\/}, ''),
+          job.dirs['dest'].sub(work_dir_prefix, '').sub(%r{^/}, ''),
           File.basename(job.files['svg'])
         ]
       end
 
+      private
+
+      def add_static_file(site, job)
+        site.static_files << Jekyll::StaticFile.new(
+          site, *self.class.static_file_paths(job)
+        )
+      end
+
       def build_options(registers:, markup:)
         Jekyll::Antex::Options.build Jekyll::Antex::Options::DEFAULTS,
                                      registers[:site].config['antex'] || {},
@@ -75,5 +81,3 @@ module Jekyll
     end
   end
 end
-
-Liquid::Template.register_tag('antex', Jekyll::Antex::Block)

data/lib/jekyll/antex/dealiaser.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'jekyll/antex/alias'
+require 'jekyll/antex/guard'
+require 'jekyll/antex/stasher'
+require 'jekyll/antex/options'
+
+module Jekyll
+  module Antex
+    module Dealiaser
+      def self.run(resource)
+        options = build_options(resource)
+        guarder = build_guarder(options)
+        aliaser = build_aliaser(options)
+        content = aliaser.lift(guarder.lift(resource.content))
+        aliaser.bake(&method(:dealias_tag))
+        guarder.drop(aliaser.drop(content))
+      end
+
+      def self.build_options(resource)
+        Jekyll::Antex::Options.build(
+          Jekyll::Antex::Options::DEFAULTS,
+          resource.site.config['antex'] || {},
+          resource.data['antex'] || {}
+        )
+      end
+
+      def self.build_guarder(options)
+        Jekyll::Antex::Stasher.new(
+          options['guards'].values.reject { |value| value == false }.map(&Guard.method(:new))
+        )
+      end
+
+      def self.build_aliaser(options)
+        Jekyll::Antex::Stasher.new(
+          options['aliases'].values.reject { |value| value == false }.map(&Alias.method(:new))
+        )
+      end
+
+      def self.dealias_tag(match, matcher)
+        markup = YAML.safe_load match[:markup] if match.names.include?('markup')
+        markup = YAML.dump Options.build(matcher.options || {}, markup || {})
+        code = match['code']
+        "{% antex #{markup} %}#{code}{% endantex %}"
+      end
+    end
+  end
+end

data/lib/jekyll/antex/options.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
-require 'jekyll/utils'
+require 'jekyll'
 
 module Jekyll
   module Antex

data/lib/jekyll/antex/version.rb

@@ -2,6 +2,6 @@
 
 module Jekyll
   module Antex
-    VERSION = '0.4.0'
+    VERSION = '0.6.1'
   end
 end

data/lib/jekyll/antex.rb

@@ -3,10 +3,57 @@
 require 'antex'
 
 require 'jekyll/antex/version'
-require 'jekyll/antex/error'
-require 'jekyll/antex/options'
-require 'jekyll/antex/guard'
-require 'jekyll/antex/stasher'
-require 'jekyll/antex/alias'
-require 'jekyll/antex/generator'
+require 'jekyll/antex/dealiaser'
 require 'jekyll/antex/block'
+
+module Jekyll
+  module Antex
+    def self.run_jobs
+      jekyll_antex_jobs = Jekyll::Antex.jobs
+      jobs_count = jekyll_antex_jobs.count
+      jekyll_logger_writer = Jekyll.logger.writer
+      jekyll_logger_writer << 'Compiling TeX: '.rjust(20)
+      jekyll_antex_jobs.values.each_with_index do |job, index|
+        run_job(job, index, jobs_count, jekyll_logger_writer)
+      end
+      jekyll_logger_writer << "#{jobs_count} jobs completed.\n"
+    end
+
+    def self.run_job(job, index, jobs_count, jekyll_logger_writer)
+      progress = "job #{index.next.to_s.rjust(jobs_count.to_s.length)} of #{jobs_count} "
+      jekyll_logger_writer << progress
+      job.run!
+      jekyll_logger_writer << ("\b" * progress.length)
+    end
+
+    def self.inject_style_attributes(output)
+      output.gsub(/data-antex="(?<hash>.*?)"/) do
+        job = Jekyll::Antex.jobs[Regexp.last_match[:hash]]
+        Jekyll::Antex::Block.render_style_attribute(job.set_box)
+      end
+    end
+  end
+end
+
+# NOTE: I'm conflicted, but regexp flags in yaml must be easy to use.
+SafeYAML::OPTIONS[:whitelisted_tags].push('!ruby/regexp')
+
+Jekyll::Hooks.register :site, :pre_render do
+  Jekyll::Antex.jobs = {}
+end
+
+# NOTE: we're not registering :posts since they are included in :documents.
+Jekyll::Hooks.register [:documents, :pages], :pre_render do |resource|
+  resource.content = Jekyll::Antex::Dealiaser.run(resource)
+end
+
+Liquid::Template.register_tag('antex', Jekyll::Antex::Block)
+
+Jekyll::Hooks.register :site, :post_render do |site|
+  Jekyll::Antex.run_jobs
+  [*site.pages, *site.documents].each do |resource|
+    # NOTE: skip unrendered resources e.g. when using --incremental
+    next if resource.output.nil?
+    resource.output = Jekyll::Antex.inject_style_attributes(resource.output)
+  end
+end

metadata

@@ -1,155 +1,175 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-antex
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Paolo Brasolin
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-09-11 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: jekyll
+  name: antex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
-  name: antex
+  name: jekyll
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: kramdown-parser-gfm
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 11.1.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10'
+        version: 11.1.3
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.18.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
+        version: 2.18.0
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.7.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 4.7.3
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 6.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: 6.0.6
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 1.22.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.52'
+        version: 1.22.3
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.21.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: 0.21.2
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.26
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.26
 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
@@ -157,14 +177,13 @@ 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/guard.rb
 - lib/jekyll/antex/options.rb
 - lib/jekyll/antex/stasher.rb
@@ -173,7 +192,7 @@ homepage: https://github.com/paolobrasolin/antex
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -181,16 +200,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Universal TeX integration for Jekyll
 test_files: []

data/LICENSE.txt

@@ -1,21 +0,0 @@
-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/lib/jekyll/antex/generator.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require 'jekyll'
-require 'jekyll/utils'
-
-require 'jekyll/antex/alias'
-require 'jekyll/antex/guard'
-require 'jekyll/antex/stasher'
-require 'jekyll/antex/options'
-
-# NOTE: I'm pretty conflicted about this.
-SafeYAML::OPTIONS[:whitelisted_tags].push('!ruby/regexp')
-
-module Jekyll
-  module Antex
-    class Generator < Jekyll::Generator
-      def generate(site)
-        site.pages.each do |page|
-          dealias_resource_content! site: site, resource: page
-        end
-
-        # NOTE: jekyll deprecated direct access to site.posts.each
-        site.posts.docs.each do |post|
-          dealias_resource_content! site: site, resource: post
-        end
-      end
-
-      private
-
-      def dealias_resource_content!(site:, resource:)
-        options = build_options site: site, resource: resource
-        guardian = Jekyll::Antex::Stasher.new(build_guards(options['guards']))
-        dealiaser = Jekyll::Antex::Stasher.new(build_aliases(options['aliases']))
-        resource.content = guardian.lift(resource.content)
-        resource.content = dealiaser.lift(resource.content)
-        dealiaser.bake(&self.class.method(:dealias_tag))
-        resource.content = dealiaser.drop(resource.content)
-        resource.content = guardian.drop(resource.content)
-      end
-
-      def build_options(site:, resource:)
-        Jekyll::Antex::Options.build Jekyll::Antex::Options::DEFAULTS,
-                                     site.config['antex'] || {},
-                                     resource.data['antex'] || {}
-      end
-
-      def build_guards(options_hash)
-        options_hash.values.map do |args|
-          Guard.new Jekyll::Utils.symbolize_hash_keys(args)
-        end
-      end
-
-      def build_aliases(options_hash)
-        options_hash.values.map do |args|
-          Alias.new Jekyll::Utils.symbolize_hash_keys(args)
-        end
-      end
-
-      def self.dealias_tag(match, matcher)
-        markup = YAML.safe_load match[:markup] if match.names.include?('markup')
-        markup = YAML.dump Options.build(matcher.options || {}, markup || {})
-        code = match['code']
-        "{% antex #{markup} %}#{code}{% endantex %}"
-      end
-    end
-  end
-end