asciidoctor-mathematical 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7314ce3eb4a07303f58434c05e7b40d00b532ecb
-  data.tar.gz: 769f69516c2d5a113ad67cbbd8720098f860c00f
+  metadata.gz: c60e640244d19ad2679b5117d86aa6b71ea3068d
+  data.tar.gz: a872640167565771f597fdd7868db7103a626a82
 SHA512:
-  metadata.gz: baa9e15e5cdaeda7b3048470cd813c7647825ca35adb8816d9691b64743b357fc7e8b36017febefc147aa45ad3c0efb48751c1fb2c5964b7c5651891321c144b
-  data.tar.gz: fbb01d534e647733b86b756f45d6598013c28560635a7d9aaa1cc26f46ced269687476d6053a618f63d9eb7a8494a07f18ee6ae1d08741801de07aee3c22389e
+  metadata.gz: b13a97f6910f9936f965eddc9eec2764bff84d15f81f27dfa1dfa2c8abe7c67c15a47072bdc620d10bd10a14ab82e761df2acc78cbba2695cb922401fa45b081
+  data.tar.gz: 8a1e50165d18cb99a763b8ca769fe970c5b1fdd683350cedc2d2b7c08abc881983d436be412bc07829868d743fdd5995ebf1da660f33e7adba1ae6db48447254

data/lib/asciidoctor-mathematical.rb

@@ -1,6 +1,5 @@
-RUBY_ENGINE == 'opal' ? (require 'asciidoctor-mathematical/extension') : (require_relative 'asciidoctor-mathematical/extension')
+require_relative 'asciidoctor-mathematical/extension'
 
-Extensions.register do
-  preprocessor MathematicalPreprocessor
+Asciidoctor::Extensions.register do
   treeprocessor MathematicalTreeprocessor
 end

data/lib/asciidoctor-mathematical/extension.rb

@@ -1,43 +1,35 @@
-require 'asciidoctor'
+require 'pathname'
 require 'asciidoctor/extensions'
-require 'mathematical'
 
 autoload :Digest, 'digest'
+autoload :Mathematical, 'mathematical'
 
-include ::Asciidoctor
+class MathematicalTreeprocessor < Asciidoctor::Extensions::Treeprocessor
+  LineFeed = %(\n)
+  StemInlineMacroRx = /\\?(?:stem|latexmath):([a-z,]*)\[(.*?[^\\])\]/m
+  LatexmathInlineMacroRx = /\\?latexmath:([a-z,]*)\[(.*?[^\\])\]/m
 
-class MathematicalTreeprocessor < Extensions::Treeprocessor
   def process document
-    if (stem_blocks = document.find_by context: :stem)
+    to_html = document.basebackend? 'html'
+    format = ((document.attr 'mathematical-format') || 'png').to_sym
+    if format != :png and format != :svg
+      warn %(Unknown format '#{format}', retreat to 'png')
       format = :png
-      if document.attributes['mathematical-format']
-        format_str = document.attributes['mathematical-format']
-        if format_str == 'png'
-          format = :png
-        elsif format_str == 'svg'
-          format = :svg
-        end
-      end
-      image_postfix = ".#{format}"
-      scale = 1.0
-      if format == :png
-        scale = 72.0/300.0
-      end
-      ppi = 72.0
-      if format == :png
-        ppi = 300.0
-      end
-      # The no-args constructor defaults to SVG and standard delimiters ($..$ for inline, $$..$$ for block)
-      mathematical = ::Mathematical.new({ :format => format, :ppi => ppi })
-      image_output_dir = resolve_image_output_dir document
-      image_target_dir = document.attr 'imagesoutdir', (document.attr 'imagesdir')
-      image_target_dir = '.' if image_target_dir.nil_or_empty?
-      ::FileUtils.mkdir_p image_output_dir unless ::File.directory? image_output_dir
+    end
+    image_ext = %(.#{format})
+    ppi = ((document.attr 'mathematical-ppi') || '300.0').to_f
+    ppi = format == :png ? ppi : 72.0
+    # The no-args constructor defaults to SVG and standard delimiters ($..$ for inline, $$..$$ for block)
+    mathematical = ::Mathematical.new format: format, ppi: ppi
+    image_output_dir, image_target_dir = image_output_and_target_dir document
+
+    unless (stem_blocks = document.find_by context: :stem).nil_or_empty?
+      ::Asciidoctor::Helpers.mkdir_p image_output_dir unless ::File.directory? image_output_dir
 
       stem_blocks.each do |stem|
-        equation_data = %($$#{stem.content}$$)
         equation_type = stem.style.to_sym
         next unless equation_type == :latexmath
+        equation_data = %($$#{stem.content}$$)
 
         # FIXME auto-generate id if one is not provided
         unless (stem_id = stem.id)
@@ -46,7 +38,7 @@ class MathematicalTreeprocessor < Extensions::Treeprocessor
 
         alt_text = stem.attr 'alt', equation_data
 
-        image_target = %(#{stem_id}#{image_postfix})
+        image_target = %(#{stem_id}#{image_ext})
         image_file = ::File.join image_output_dir, image_target
         image_target = ::File.join image_target_dir, image_target unless image_target_dir == '.'
 
@@ -56,8 +48,8 @@ class MathematicalTreeprocessor < Extensions::Treeprocessor
 
         attrs = { 'target' => image_target, 'alt' => alt_text, 'align' => 'center' }
         if format == :png
-          attrs['width'] = "#{result[:width]}pt"
-          attrs['height'] = "#{result[:height]}pt"
+          attrs['width'] = %(#{result[:width]})
+          attrs['height'] = %(#{result[:height]})
         end
         parent = stem.parent
         stem_image = create_image_block parent, attrs
@@ -68,94 +60,85 @@ class MathematicalTreeprocessor < Extensions::Treeprocessor
         parent.blocks[parent.blocks.index stem] = stem_image
       end
     end
-    nil
-  end
-
-  def resolve_image_output_dir doc
-    if (images_dir = doc.attr 'imagesoutdir')
-      base_dir = nil
-    else
-      base_dir = (doc.attr 'outdir') || ((doc.respond_to? :options) && doc.options[:to_dir])
-      images_dir = doc.attr 'imagesdir'
-    end
-
-    doc.normalize_system_path images_dir, base_dir
-  end
-end
-
-class MathematicalPreprocessor < Extensions::Preprocessor
-  LATEXMATH_PTN = /latexmath:\[([^\]]+)\]/
 
-  SPECIAL_CHARS = {
-    '&' => '&amp;',
-    '<' => '&lt;',
-    '>' => '&gt;'
-  }
-
-  SPECIAL_CHARS_PATTERN = /[#{SPECIAL_CHARS.keys.join}]/
-
-  # FIXME: I don't understand why I can not simply use sub_specialchars from
-  # Asciidoctor. It just crashes with 'unknown method name'. So I copy the
-  # code here.
-  def sub_specialchars text
-    text.gsub(SPECIAL_CHARS_PATTERN, SPECIAL_CHARS)
-  end
-
-  def process document, reader
-    # Setup image format information
-    format = :png
-    if document.attributes['mathematical-format']
-      format_str = document.attributes['mathematical-format']
-      if format_str == 'png'
-        format = :png
-      elsif format_str == 'svg'
-        format = :svg
+    unless (prose_blocks = document.find_by {|b|
+          (b.content_model == :simple && (b.subs.include? :macros)) || b.context == :list_item
+        }).nil_or_empty?
+      support_stem_prefix = document.attr? 'stem', 'latexmath'
+      ::Asciidoctor::Helpers.mkdir_p image_output_dir unless ::File.directory? image_output_dir
+      stem_rx = support_stem_prefix ? StemInlineMacroRx : LatexmathInlineMacroRx
+
+      prose_blocks.each do |block|
+        source_modified = false
+        source = block.context == :list_item ? (block.instance_variable_get :@text) : (block.lines * LineFeed)
+        # TODO skip passthroughs in the source (e.g., +stem:[x^2]+)
+        source.gsub!(stem_rx) {
+          if (m = $~)[0].start_with? '\\'
+            next m[0][1..-1]
+          end
+
+          if (eq_data = m[2].rstrip).empty?
+            next
+          else
+            source_modified = true
+          end
+
+          eq_data.gsub! '\]', ']'
+          subs = m[1].nil_or_empty? ? (to_html ? [:specialcharacters] : []) : (block.resolve_pass_subs m[1])
+          eq_data = block.apply_subs eq_data, subs unless subs.empty?
+
+          eq_id = %(stem-#{::Digest::MD5.hexdigest eq_data})
+          eq_input = %($#{eq_data}$)
+
+          img_target = %(#{eq_id}#{image_ext})
+          img_file = ::File.join image_output_dir, img_target
+          img_target = ::File.join image_target_dir, img_target unless image_target_dir == '.'
+
+          eq_result = mathematical.parse eq_input
+
+          ::IO.write img_file, eq_result[:data]
+          %(image:#{img_target}[width=#{eq_result[:width]},height=#{eq_result[:height]}])
+        } if (source.include? ':') && ((support_stem_prefix && (source.include? 'stem:')) || (source.include? 'latexmath:'))
+
+        if source_modified
+          if block.context == :list_item
+            block.instance_variable_set :@text, source
+          else
+            block.lines = source.split LineFeed
+          end
+        end
       end
     end
-    image_postfix = ".#{format}"
-    scale = 1.0
-    if format == :png
-      scale = 72.0/300.0
-    end
-    ppi = 72.0
-    if format == :png
-      ppi = 300.0
-    end
 
-    # Since at preprocessing stage, we have no document attribute avaliable,
-    # so fix the image output dir to be simple.
-    image_output_dir = './images'
-    image_target_dir = './images'
-    ::FileUtils.mkdir_p image_output_dir unless ::File.directory? image_output_dir
-
-    mathematical = ::Mathematical.new({ :format => format, :ppi => ppi })
-
-    lines = reader.readlines
-    lines.each do |line|
-      md = LATEXMATH_PTN.match line
-      while md
-        stem_content = md[1]
-        # NOTE: It seems that we need to escape '<>&' to make mathematical
-        # work. This is weired but verified. So we escape them here.
-        stem_content = sub_specialchars stem_content
-        equation_data = %($#{stem_content}$)
-        stem_id = %(stem-#{::Digest::MD5.hexdigest stem_content})
-
-        image_target = %(#{stem_id}#{image_postfix})
-        image_file = ::File.join image_output_dir, image_target
-        image_target = ::File.join image_target_dir, image_target unless image_target_dir == '.'
+    nil
+  end
 
-        # TODO check for error
-        result = mathematical.parse equation_data
-        ::IO.write image_file, result[:data]
+  def image_output_and_target_dir(parent)
+    document = parent.document
 
-        subst = %(image:#{image_target}[width=#{result[:width]}pt])
-        line.gsub! md[0], subst
-        md = LATEXMATH_PTN.match md.post_match
+    output_dir = parent.attr('imagesoutdir')
+    if output_dir
+      base_dir = nil
+      if parent.attr('imagesdir').nil_or_empty?
+        target_dir = output_dir
+      else
+        # When imagesdir attribute is set, every relative path is prefixed with it. So the real target dir shall then be relative to the imagesdir, instead of being relative to document root.
+        doc_outdir = parent.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
+        abs_imagesdir = parent.normalize_system_path(parent.attr('imagesdir'), doc_outdir)
+        abs_outdir = parent.normalize_system_path(output_dir, base_dir)
+        p1 = ::Pathname.new abs_outdir
+        p2 = ::Pathname.new abs_imagesdir
+        target_dir = p1.relative_path_from(p2).to_s
       end
+    else
+      base_dir = parent.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
+      output_dir = parent.attr('imagesdir')
+      # since we store images directly to imagesdir, target dir shall be NULL and asciidoctor converters will prefix imagesdir.
+      target_dir = "."
     end
 
-    reader.unshift_lines lines
-    reader
+    output_dir = parent.normalize_system_path(output_dir, base_dir)
+    return [output_dir, target_dir]
   end
+
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-mathematical
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Tobias Stumm
 - Zhang Yang
+- Dan Allen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-22 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -65,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.5.0
-description: Converts latexmath equations in Asciidoctor to SVG
+description: An Asciidoctor extension to converts latexmath equations to SVG or PNGs
 email: tstumm@users.noreply.github.com
 executables: []
 extensions: []
@@ -93,8 +94,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Wrapper for Mathematical
+summary: Asciidoctor STEM processor based on Mathematical
 test_files: []