jekyll-antex 0.6.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0b87279a7608dbb4ca9eed439311e206cdb9fb66c978d6a0418275be1cf470fb
-  data.tar.gz: ab8381af64763d4b9cb0eec82cc5ba46ce4a619a77a6fedbf07665b404eb3f6d
+  metadata.gz: 38cc80b080df5998a00550b7046fa6518e8842d4b225abe15ff21c39ced1290b
+  data.tar.gz: 064c607a0b8d825356b22fb6f6837526fd536ca64b13bfa0dc9cb054e9f945bb
 SHA512:
-  metadata.gz: 29151511d7b8c79afaa5b23f16e666c30912f000d6d2608f4fb6461e99913ed818165f1b53140edccf85e48bf7fd48243768104ade14d9b152714330880c5fab
-  data.tar.gz: 3a6cf462426c1cca9171b87b288fce058ba7d27d26316398a255e251e6dab4d176e3161866424e7dc17194fec85b46865a632c943af310d3c913647787b96ad6
+  metadata.gz: '082e533cae85f3ec1ac9f8db5a1d80cf0f1574b876e6e37cf5e874a1ab7787e1aa606af2979e170818743391d4e06e8c05486947d0426b70970da43c48463dc1'
+  data.tar.gz: '08e6bdd8202cf293cfe4b93cdcdfc8103464559196b1362d1b76f9f5e5f073194effa619085f9913ca366bad1eff24573dd5b9be4ea43c20aaa54fc44eaaca48'

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

@@ -16,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

@@ -14,6 +14,8 @@ module Jekyll
     end
 
     class Block < Liquid::Block
+      HASH_ATTR_NAME = 'data-antex-job-hash'
+
       def initialize(tag, markup, tokens)
         @markup = markup
         super
@@ -27,33 +29,64 @@ module Jekyll
         self.class.render_html(job)
       end
 
-      private
-
       def self.render_html(job)
-        img_tag = render_img_tag job
+        placeholder_tag = render_placeholder_tag job
         classes = job.options['classes'].join(' ')
-        "<span class='#{classes}'>#{img_tag}</span>"
+        "<span class='#{classes}'>#{placeholder_tag}</span>"
       end
 
-      def self.render_img_tag(job)
-        "<img data-antex='#{job.hash}' src='#{img_url(job)}' />"
+      def self.replace_placeholders(content)
+        doc = Nokogiri::HTML.parse(content)
+        placeholders = doc.xpath("//object[@#{HASH_ATTR_NAME}]")
+        placeholders.each(&method(:replace_placeholder))
+        doc.to_s
       end
 
-      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
+      def self.replace_placeholder(placeholder)
+        job = Jekyll::Antex.jobs[placeholder[HASH_ATTR_NAME]]
+        if job.options['inlining']
+          replace_placeholder_with_svg(placeholder)
+        else
+          replace_placeholder_with_img(placeholder)
+        end
       end
 
-      def add_static_file(site, job)
-        site.static_files << Jekyll::StaticFile.new(
-          site, *self.class.static_file_paths(job)
-        )
+      def self.replace_placeholder_with_img(placeholder)
+        job = Jekyll::Antex.jobs[placeholder[HASH_ATTR_NAME]]
+        style = render_style_attribute_value(job.set_box)
+        img = Nokogiri::XML::Node.new('img', placeholder.document)
+        src = Jekyll::Antex::Block.img_url(job)
+        img.set_attribute('src', src)
+        img.set_attribute('style', style)
+        placeholder.add_next_sibling(img)
+        placeholder.remove()
+      end
+
+      def self.replace_placeholder_with_svg(placeholder)
+        job = Jekyll::Antex.jobs[placeholder[HASH_ATTR_NAME]]
+        style = render_style_attribute_value(job.set_box)
+        path = File.read(job.files['svg'])
+        svg = Nokogiri::XML(path).at_css('svg')
+        svg.remove_attribute('width')
+        svg.remove_attribute('height')
+        svg.set_attribute('style', style)
+        placeholder.add_next_sibling(svg)
+        placeholder.remove()
+      end
+
+      def self.render_placeholder_tag(job)
+        "<object #{HASH_ATTR_NAME}='#{job.hash}'></object>"
+      end
+
+      def self.render_style_attribute_value(job_set_box, precision: 3)
+        <<~IMG_TAG.gsub(/(\s\s+)/m, ' ').strip!
+          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 self.img_url(job)
@@ -63,15 +96,24 @@ module Jekyll
       end
 
       def self.static_file_paths(job)
-        work_dir_prefix = %r{^#{Regexp.escape job.dirs['work']}(?=\/|$)}
+        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)
+        return if job.options['inlining']
+        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'] || {},

data/lib/jekyll/antex/dealiaser.rb

@@ -27,13 +27,13 @@ module Jekyll
 
       def self.build_guarder(options)
         Jekyll::Antex::Stasher.new(
-          options['guards'].values.reject { |value| false == value }.map(&Guard.method(: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| false == value }.map(&Alias.method(:new))
+          options['aliases'].values.reject { |value| value == false }.map(&Alias.method(:new))
         )
       end
 

data/lib/jekyll/antex/defaults.yml

@@ -142,3 +142,4 @@ aliases:
       /(?<code>\\[A-z]+)/x
     options:
       classes: [antex, inline]
+inlining: false

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.6.0'
+    VERSION = '0.8.0'
   end
 end

data/lib/jekyll/antex.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'antex'
+require 'nokogiri'
 
 require 'jekyll/antex/version'
 require 'jekyll/antex/dealiaser'
@@ -8,23 +9,33 @@ require 'jekyll/antex/block'
 
 module Jekyll
   module Antex
+    def self.gather_resources(site)
+      pages = site.pages
+      documents = site.collections.values.flat_map(&:docs)
+      [*pages, *documents].filter(&method(:allowed_resource?))
+    end
+
+    def self.allowed_resource?(resource)
+      # TODO: perhaps this should be configurable
+      File.fnmatch('*.{html,md}', resource.relative_path, File::FNM_EXTGLOB)
+    end
+
     def self.run_jobs
-      jobs_count = Jekyll::Antex.jobs.count
-      Jekyll.logger.writer << "Compiling TeX: ".rjust(20)
-      Jekyll::Antex.jobs.values.each_with_index do |job, i|
-        progress = "job " + i.next.to_s.rjust(jobs_count.to_s.length) + " of #{jobs_count} "
-        Jekyll.logger.writer << progress
-        job.run!
-        Jekyll.logger.writer << "\b" * progress.length
+      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"
+      jekyll_logger_writer << "#{jobs_count} jobs completed.\n"
     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
+    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
   end
 end
@@ -32,20 +43,20 @@ 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::Hooks.register :site, :pre_render do |site|
   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|
+  Jekyll::Antex.gather_resources(site).each do |resource|
   resource.content = Jekyll::Antex::Dealiaser.run(resource)
+  end
 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|
-    resource.output = Jekyll::Antex.inject_style_attributes(resource.output)
+  Jekyll::Antex.gather_resources(site).each do |resource|
+    # NOTE: skip unrendered resources e.g. when using --incremental
+    next if resource.output.nil?
+    resource.output = Jekyll::Antex::Block.replace_placeholders(resource.output)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-antex
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Paolo Brasolin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: antex
@@ -16,140 +16,174 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: 0.1.3
 - !ruby/object:Gem::Dependency
   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: '3.8'
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.8'
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !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,7 +191,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- LICENSE.txt
 - README.md
 - lib/jekyll/antex.rb
 - lib/jekyll/antex/alias.rb
@@ -181,15 +214,14 @@ 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
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Universal TeX integration for Jekyll

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.