jekyll-antex 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '06739363162b9ec5b67dd702ec1f408a01071ddf5b96799f2dbc399d70be4ddc'
-  data.tar.gz: 46564b16ae23c2e33e8cc4f9eea73db81a217de09674b17cd70db0e38068e8d2
+  metadata.gz: b8af04a4d3122b7e58926aed907120b7bef5e4d5cfb660be03c625f1e0ec48d4
+  data.tar.gz: 4066bd201baba8f6bdcf724f38ea8991eb011da58f1da13831d32547781ade9c
 SHA512:
-  metadata.gz: 3e4558ba74f46c1b95e5888ec24c6a400ceb28349f6657fb2a8515ece96c00e67c27d98785e076261d2aca31093b75dbc446b436ac3e81bdbdea326161a6a965
-  data.tar.gz: 178445b2a72d6955c0d5690006e31989c7d14f4b1cd26f0ae1827725516f69e17d27db8ac489dcc7e68a51a8cd4f2c77cc63d95e185bd10bd2fb31613adbed16
+  metadata.gz: 86ebce737fc0c681b040f329d46aee48198d528a25e0bab5bbbecebc5da5215fb5f462bd385a5f211e97063b45639feaf76cfa0343ac19ec7fd28ccf0091c530
+  data.tar.gz: 381bc28893d16e442f07567eddee15b08bab1eed15387eb4b3793dbc8e35949a61dcaa0d79e98b1716db5268762d99c6e91304c806a81e914eeaaf111658eee3

data/lib/jekyll/antex.rb

@@ -4,11 +4,9 @@ require 'antex'
 
 require 'jekyll/antex/version'
 require 'jekyll/antex/error'
-require 'jekyll/antex/utils'
 require 'jekyll/antex/options'
 require 'jekyll/antex/guard'
-require 'jekyll/antex/guardian'
+require 'jekyll/antex/stasher'
 require 'jekyll/antex/alias'
-require 'jekyll/antex/dealiaser'
 require 'jekyll/antex/generator'
 require 'jekyll/antex/block'

data/lib/jekyll/antex/alias.rb

@@ -1,31 +1,24 @@
 # frozen_string_literal: true
 
 require 'jekyll/antex/error'
-require 'jekyll/antex/utils'
 
 module Jekyll
   module Antex
-    class Alias
-      class InvalidRegexp < Error; end
+    class InvalidRegexp < Error; end
 
-      attr_reader :priority, :regexp, :options
+    Alias = Struct.new(:priority, :regexp, :options, keyword_init: true) do
 
-      def initialize(priority:, regexp:, options: {},
-                     multiline: false, extended: true)
-        @priority = priority.to_i
-        @regexp = Utils.build_regexp source: regexp,
-                                     extended: extended,
-                                     multiline: multiline
+      def initialize(*args)
+        super
         validate_regexp!
-        @options = options.to_h
       end
 
       private
 
       def validate_regexp!
-        return if @regexp.names.include? 'code'
+        return if regexp.names.include? 'code'
         raise InvalidRegexp, <<~MESSAGE
-          The regexp #{@regexp.inspect} is missing the required named matching group "code".
+          The regexp #{regexp.inspect} is missing the required named matching group "code".
         MESSAGE
       end
     end

data/lib/jekyll/antex/defaults.yml

@@ -76,45 +76,40 @@ commands:
 guards:
   comment:
     priority: 1000
-    multiline: true
-    regexp: >
-      <!---
+    regexp: !ruby/regexp |
+      /<!---
       .*?
-      --->
+      --->/mx
   verbatim:
     priority: 100
-    multiline: true
-    regexp: >
-      ```
+    regexp: !ruby/regexp |
+      /```
       .*?
-      ```
+      ```/mx
 aliases:
   # 'internal' must have the highest priority;
   # it is the liquid tag all other aliases are rendered to.
   internal:
     priority: 1000
-    multiline: true
-    regexp: >
-      {%\s*antex\s*(?<markup>.*?)%}
+    regexp: !ruby/regexp |
+      /{%\s*antex\s*(?<markup>.*?)%}
       (?<code>.*?)
-      {%\s*endantex\s*%}
+      {%\s*endantex\s*%}/mx
   # 'default' is the standard generic purpose alias.
   # Since it can contain tikz pictures,
   # it must have higher priority than 'tikzpicture' alias.
   default:
     priority: 100
-    multiline: true
-    regexp: >
-      {%\s*tex\s*(?<markup>.*?)%}
+    regexp: !ruby/regexp |
+      /{%\s*tex\s*(?<markup>.*?)%}
       (?<code>.*?)
-      {%\s*endtex\s*%}
+      {%\s*endtex\s*%}/mx
   tikzpicture:
     priority: 90
-    multiline: true
-    regexp: >
-      {%\s*tikz\s*(?<markup>.*?)%}
+    regexp: !ruby/regexp |
+      /{%\s*tikz\s*(?<markup>.*?)%}
       (?<code>.*?)
-      {%\s*endtikz\s*%}
+      {%\s*endtikz\s*%}/mx
     options:
       prepend: '\\begin{tikzpicture}'
       append: '\\end{tikzpicture}'
@@ -123,19 +118,18 @@ aliases:
   # since the respective deliniters are double and single dollars.
   display_math:
     priority: 20
-    multiline: true
-    regexp: >
-      \$\$
+    regexp: !ruby/regexp |
+      /\$\$
       (?<code>.*?)
-      \$\$
+      \$\$/mx
     options:
       prepend: '$\\displaystyle'
       append: $
       classes: [antex, display]
   inline_math:
     priority: 10
-    regexp: >
-      \$(?<code>.*?)\$
+    regexp: !ruby/regexp |
+      /\$(?<code>.*?)\$/x
     options:
       prepend: $
       append: $
@@ -144,7 +138,7 @@ aliases:
   # to avoid interference with others aliases.
   inline_macro:
     priority: 0
-    regexp: >
-      (?<code>\\[A-z]+)
+    regexp: !ruby/regexp |
+      /(?<code>\\[A-z]+)/x
     options:
       classes: [antex, inline]

data/lib/jekyll/antex/generator.rb

@@ -4,10 +4,12 @@ require 'jekyll'
 require 'jekyll/utils'
 
 require 'jekyll/antex/alias'
-require 'jekyll/antex/dealiaser'
-
 require 'jekyll/antex/guard'
-require 'jekyll/antex/guardian'
+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
@@ -27,11 +29,13 @@ module Jekyll
 
       def dealias_resource_content!(site:, resource:)
         options = build_options site: site, resource: resource
-        guardian = build_guardian options['guards']
-        dealiaser = build_dealiaser options['aliases']
-        resource.content = guardian.apply resource.content
-        resource.content = dealiaser.parse resource.content
-        resource.content = guardian.remove resource.content
+        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:)
@@ -40,18 +44,6 @@ module Jekyll
                                      resource.data['antex'] || {}
       end
 
-      def build_guardian(guards_options_hash)
-        guardian = Jekyll::Antex::Guardian.new
-        guardian.add_guards build_guards(guards_options_hash)
-        guardian
-      end
-
-      def build_dealiaser(aliases_options_hash)
-        dealiaser = Jekyll::Antex::Dealiaser.new
-        dealiaser.add_aliases build_aliases(aliases_options_hash)
-        dealiaser
-      end
-
       def build_guards(options_hash)
         options_hash.values.map do |args|
           Guard.new Jekyll::Utils.symbolize_hash_keys(args)
@@ -63,6 +55,13 @@ module Jekyll
           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

data/lib/jekyll/antex/guard.rb

@@ -1,19 +1,7 @@
 # frozen_string_literal: true
 
-require 'jekyll/antex/utils'
-
 module Jekyll
   module Antex
-    class Guard
-      attr_reader :priority, :regexp
-
-      def initialize(priority:, regexp:,
-                     multiline: false, extended: true)
-        @priority = priority.to_i
-        @regexp = Utils.build_regexp source: regexp,
-                                     extended: extended,
-                                     multiline: multiline
-      end
-    end
+    Guard = Struct.new(:priority, :regexp, keyword_init: true)
   end
 end

data/lib/jekyll/antex/options.rb

@@ -1,11 +1,7 @@
 # frozen_string_literal: true
 
 require 'yaml'
-
-require 'liquid/drop'
-require 'jekyll/drops/drop'
 require 'jekyll/utils'
-# NOTE: not sure why/how utils require drops, though
 
 module Jekyll
   module Antex

data/lib/jekyll/antex/stasher.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+
+module Jekyll
+  module Antex
+    class Stasher
+      attr_reader :matchers
+
+      def initialize(matchers)
+        @stash = []
+        @matchers = matchers
+        @matchers.sort_by!(&:priority)
+        @matchers.reverse!
+      end
+
+      def lift(input)
+        input.dup.tap do |output|
+          @matchers.each do |matcher|
+            output.gsub!(matcher.regexp) do
+              store(Regexp.last_match, matcher)
+            end
+          end
+        end
+      end
+
+      def bake
+        @stash.map! do |uuid, match, matcher|
+          replacement = yield match, matcher
+          [uuid, match, matcher, replacement]
+        end
+      end
+
+      def drop(input)
+        input.dup.tap do |output|
+          @stash.each do |uuid, match, _, replacement|
+            output.gsub!(uuid) { replacement || match.to_s }
+          end
+        end
+      end
+
+      private
+
+      def store(match, matcher)
+        SecureRandom.uuid.tap do |uuid|
+          @stash.push([uuid, match, matcher, nil])
+        end
+      end
+    end
+  end
+end

data/lib/jekyll/antex/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-antex
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Paolo Brasolin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-04 00:00:00.000000000 Z
+date: 2018-09-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: antex
   requirement: !ruby/object:Gem::Requirement
@@ -44,84 +44,98 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9.1'
+        version: '10'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.14'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.7'
+        version: '4'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.15'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.6'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.52'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.52'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -148,14 +162,12 @@ files:
 - 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/guardian.rb
 - lib/jekyll/antex/options.rb
-- lib/jekyll/antex/utils.rb
+- lib/jekyll/antex/stasher.rb
 - lib/jekyll/antex/version.rb
 homepage: https://github.com/paolobrasolin/antex
 licenses:
@@ -169,7 +181,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/jekyll/antex/dealiaser.rb

@@ -1,63 +0,0 @@
-# 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/guardian.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require 'securerandom'
-
-module Jekyll
-  module Antex
-    class Guardian
-      attr_reader :guards
-
-      def initialize(tag: 'antex')
-        @guards = []
-        @stash = {}
-        @tag = tag
-      end
-
-      def add_guards(guards)
-        @guards.concat(guards).sort_by!(&:priority).reverse!
-      end
-
-      def apply(content)
-        @content = content.dup
-        @stash = {}
-        stash_guards
-        @content
-      end
-
-      def remove(content)
-        @content = content.dup
-        unstash_guards
-        @content
-      end
-
-      private
-
-      def stash_guards
-        @guards.each do |guard|
-          @content.gsub!(guard.regexp) do
-            uuid = SecureRandom.uuid
-            @stash.store uuid, Regexp.last_match.to_s
-            uuid
-          end
-        end
-      end
-
-      def unstash_guards
-        @stash.each do |uuid, guard_match|
-          @content.gsub!(uuid) { guard_match }
-        end
-      end
-    end
-  end
-end

data/lib/jekyll/antex/utils.rb

@@ -1,14 +0,0 @@
-# frozen_string_literal: true
-
-module Jekyll
-  module Antex
-    module Utils
-      def self.build_regexp(source:, extended:, multiline:)
-        options = 0
-        options |= Regexp::EXTENDED if extended
-        options |= Regexp::MULTILINE if multiline
-        Regexp.new source, options
-      end
-    end
-  end
-end