asciidoctor-mathematical 0.1.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c60e640244d19ad2679b5117d86aa6b71ea3068d
-  data.tar.gz: a872640167565771f597fdd7868db7103a626a82
+SHA256:
+  metadata.gz: e817ca8a177571fe61d368e26b09d8b35e1560b38ac8f971e14281f403b88344
+  data.tar.gz: 96d5d392cdf0ff18fd2d4bb3972247230f2c00b552b345ef42202f3327eede11
 SHA512:
-  metadata.gz: b13a97f6910f9936f965eddc9eec2764bff84d15f81f27dfa1dfa2c8abe7c67c15a47072bdc620d10bd10a14ab82e761df2acc78cbba2695cb922401fa45b081
-  data.tar.gz: 8a1e50165d18cb99a763b8ca769fe970c5b1fdd683350cedc2d2b7c08abc881983d436be412bc07829868d743fdd5995ebf1da660f33e7adba1ae6db48447254
+  metadata.gz: 0a50106271975fa4975ff5511f969106e088de7e0a94d4fd64b65eff1c29d97c1131bdad2547732a90ca30555dd28c5fc2b31a2e74fc86b460764ace24dde8a1
+  data.tar.gz: ec3da1e35a5d0ab1ef4ff6005b0aa81802e477400b87078564b0a9d32e85e92a6a1c288b02c048ef1a17ddd44e002e00030ff8ef4f7a304915200258068ea4e7

data/lib/asciidoctor-mathematical/extension.rb

@@ -1,143 +1,233 @@
 require 'pathname'
 require 'asciidoctor/extensions'
+require 'asciimath'
 
 autoload :Digest, 'digest'
 autoload :Mathematical, 'mathematical'
 
 class MathematicalTreeprocessor < Asciidoctor::Extensions::Treeprocessor
   LineFeed = %(\n)
-  StemInlineMacroRx = /\\?(?:stem|latexmath):([a-z,]*)\[(.*?[^\\])\]/m
+  StemInlineMacroRx = /\\?(?:stem|latexmath|asciimath):([a-z,]*)\[(.*?[^\\])\]/m
   LatexmathInlineMacroRx = /\\?latexmath:([a-z,]*)\[(.*?[^\\])\]/m
+  AsciiMathInlineMacroRx = /\\?asciimath:([a-z,]*)\[(.*?[^\\])\]/m
 
   def process document
-    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
     end
-    image_ext = %(.#{format})
     ppi = ((document.attr 'mathematical-ppi') || '300.0').to_f
     ppi = format == :png ? ppi : 72.0
+    inline = document.attr 'mathematical-inline'
+    if inline and format == :png
+      warn 'Can\'t use mathematical-inline together with mathematical-format=png'
+    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, image_target_dir = image_output_and_target_dir document
-
-    unless (stem_blocks = document.find_by context: :stem).nil_or_empty?
+    unless inline
+      image_output_dir, image_target_dir = image_output_and_target_dir document
       ::Asciidoctor::Helpers.mkdir_p image_output_dir unless ::File.directory? image_output_dir
+    end
 
+    unless (stem_blocks = document.find_by context: :stem).nil_or_empty?
       stem_blocks.each do |stem|
-        equation_type = stem.style.to_sym
-        next unless equation_type == :latexmath
-        equation_data = %($$#{stem.content}$$)
+        handle_stem_block stem, mathematical, image_output_dir, image_target_dir, format, inline
+      end
+    end
 
-        # FIXME auto-generate id if one is not provided
-        unless (stem_id = stem.id)
-          stem_id = %(stem-#{::Digest::MD5.hexdigest stem.content})
+    unless (prose_blocks = document.find_by {|b|
+      (b.content_model == :simple && (b.subs.include? :macros)) || b.context == :list_item
+    }).nil_or_empty?
+      prose_blocks.each do |prose|
+        handle_prose_block prose, mathematical, image_output_dir, image_target_dir, format, inline
+      end
+    end
+
+    # handle table cells of the "asciidoc" type, as suggested by mojavelinux
+    # at asciidoctor/asciidoctor-mathematical#20.
+    unless (table_blocks = document.find_by context: :table).nil_or_empty?
+      table_blocks.each do |table|
+        (table.rows[:body] + table.rows[:foot]).each do |row|
+          row.each do |cell|
+            if cell.style == :asciidoc
+              process cell.inner_document
+            elsif cell.style != :literal
+              handle_nonasciidoc_table_cell cell, mathematical, image_output_dir, image_target_dir, format, inline
+            end
+          end
         end
+      end
+    end
 
-        alt_text = stem.attr 'alt', equation_data
+    unless (sect_blocks = document.find_by content: :section).nil_or_empty?
+      sect_blocks.each do |sect|
+        handle_section_title sect, mathematical, image_output_dir, image_target_dir, format, inline
+      end
+    end
 
-        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 == '.'
+    nil
+  end
 
-        # TODO check for error
-        result = mathematical.parse equation_data
-        ::IO.write image_file, result[:data]
+  def handle_stem_block(stem, mathematical, image_output_dir, image_target_dir, format, inline)
+    equation_type = stem.style.to_sym
 
-        attrs = { 'target' => image_target, 'alt' => alt_text, 'align' => 'center' }
-        if format == :png
-          attrs['width'] = %(#{result[:width]})
-          attrs['height'] = %(#{result[:height]})
-        end
-        parent = stem.parent
-        stem_image = create_image_block parent, attrs
-        stem_image.id = stem.id if stem.id
-        if (title = stem.attributes['title'])
-          stem_image.title = title
-        end
-        parent.blocks[parent.blocks.index stem] = stem_image
+    case equation_type
+    when :latexmath
+      content = stem.content
+    when :asciimath
+      content = AsciiMath.parse(stem.content).to_latex
+    else
+      return
+    end
+
+    img_target, img_width, img_height = make_equ_image content, stem.id, false, mathematical, image_output_dir, image_target_dir, format, inline
+
+    parent = stem.parent
+    if inline
+      stem_image = create_pass_block parent, %{<div class="stemblock"> #{img_target} </div>}, {}
+      parent.blocks[parent.blocks.index stem] = stem_image
+    else
+      alt_text = stem.attr 'alt', (equation_type == :latexmath ? %($$#{content}$$) : %(`#{content}`))
+      attrs = {'target' => img_target, 'alt' => alt_text, 'align' => 'center'}
+      # NOTE: The following setups the *intended width and height in pixel* for png images, which can be different that that of the generated image when PPIs larger than 72.0 is used.
+      if format == :png
+        attrs['width'] = %(#{img_width})
+        attrs['height'] = %(#{img_height})
+      end
+      parent = stem.parent
+      stem_image = create_image_block parent, attrs
+      stem_image.id = stem.id if stem.id
+      if (title = stem.attributes['title'])
+        stem_image.title = title
       end
+      parent.blocks[parent.blocks.index stem] = stem_image
     end
+  end
 
-    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
+  def handle_prose_block(prose, mathematical, image_output_dir, image_target_dir, format, inline)
+    text = prose.context == :list_item ? (prose.instance_variable_get :@text) : (prose.lines * LineFeed)
+    text, source_modified = handle_inline_stem prose, text, mathematical, image_output_dir, image_target_dir, format, inline
+    if source_modified
+      if prose.context == :list_item
+        prose.instance_variable_set :@text, text
+      else
+        prose.lines = text.split LineFeed
+      end
+    end
+  end
 
-          if (eq_data = m[2].rstrip).empty?
-            next
-          else
-            source_modified = true
-          end
+  def handle_nonasciidoc_table_cell(cell, mathematical, image_output_dir, image_target_dir, format, inline)
+    text = cell.instance_variable_get :@text
+    text, source_modified = handle_inline_stem cell, text, mathematical, image_output_dir, image_target_dir, format, inline
+    if source_modified
+      cell.instance_variable_set :@text, text
+    end
+  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?
+  def handle_section_title(sect, mathematical, image_output_dir, image_target_dir, format, inline)
+    text = sect.instance_variable_get :@title
+    text, source_modified = handle_inline_stem sect, text, mathematical, image_output_dir, image_target_dir, format, inline
+    if source_modified
+      sect.instance_variable_set :@title, text
+      sect.remove_instance_variable :@subbed_title
+    end
+  end
 
-          eq_id = %(stem-#{::Digest::MD5.hexdigest eq_data})
-          eq_input = %($#{eq_data}$)
+  def handle_inline_stem(node, text, mathematical, image_output_dir, image_target_dir, format, inline)
+    document = node.document
+    to_html = document.basebackend? 'html'
 
-          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 == '.'
+    case document.attr 'stem'
+    when 'latexmath'
+      support_stem_prefix = true
+      stem_rx = LatexmathInlineMacroRx
+    when 'asciimath'
+      support_stem_prefix = true
+      stem_rx = AsciiMathInlineMacroRx
+    else
+      support_stem_prefix = false
+      stem_rx = StemInlineMacroRx
+    end
 
-          eq_result = mathematical.parse eq_input
+    source_modified = false
 
-          ::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:'))
+    # TODO skip passthroughs in the source (e.g., +stem:[x^2]+)
+    if text != nil && text.include? ':'
+      text = text.gsub(stem_rx) {
+        if (m = $~)[0].start_with? '\\'
+          next m[0][1..-1]
+        end
 
-        if source_modified
-          if block.context == :list_item
-            block.instance_variable_set :@text, source
-          else
-            block.lines = source.split LineFeed
-          end
+        if (eq_data = m[2].rstrip).empty?
+          next
+        else
+          source_modified = true
         end
-      end
+
+        if text.include? 'asciimath:'
+          eq_data = AsciiMath.parse(eq_data).to_latex
+        else if (support_stem_prefix && (text.include? 'stem:')) || (text.include? 'latexmath:')
+          eq_data.gsub! '\]', ']'
+          subs = m[1].nil_or_empty? ? (to_html ? [:specialcharacters] : []) : (node.resolve_pass_subs m[1])
+          eq_data = node.apply_subs eq_data, subs unless subs.empty?
+        else
+          source_modified = false
+          return text
+        end
+          
+        img_target, img_width, img_height = make_equ_image eq_data, nil, true, mathematical, image_output_dir, image_target_dir, format, inline
+        if inline
+          %(pass:[<span class="steminline"> #{img_target} </span>])
+        else
+          %(image:#{img_target}[width=#{img_width},height=#{img_height}])
+        end
+      }
     end
 
-    nil
+    [text, source_modified]
   end
 
-  def image_output_and_target_dir(parent)
-    document = parent.document
+  def make_equ_image(equ_data, equ_id, equ_inline, mathematical, image_output_dir, image_target_dir, format, inline)
+    input = equ_inline ? %($#{equ_data}$) : %($$#{equ_data}$$)
+
+    # TODO: Handle exceptions.
+    result = mathematical.parse input
+    if inline
+      result[:data]
+    else
+      unless equ_id
+        equ_id = %(stem-#{::Digest::MD5.hexdigest input})
+      end
+      image_ext = %(.#{format})
+      img_target = %(#{equ_id}#{image_ext})
+      img_file = ::File.join image_output_dir, img_target
+
+      ::IO.write img_file, result[:data]
+
+      img_target = ::File.join image_target_dir, img_target unless image_target_dir == '.'
+      [img_target, result[:width], result[:height]]
+    end
+  end
 
-    output_dir = parent.attr('imagesoutdir')
+  def image_output_and_target_dir(doc)
+    output_dir = doc.attr('imagesoutdir')
     if output_dir
-      base_dir = nil
-      if parent.attr('imagesdir').nil_or_empty?
+      if doc.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
+        abs_imagesdir = ::Pathname.new doc.normalize_system_path(doc.attr('imagesdir'))
+        abs_outdir = ::Pathname.new doc.normalize_system_path(output_dir)
+        target_dir = abs_outdir.relative_path_from(abs_imagesdir).to_s
       end
     else
-      base_dir = parent.attr('outdir') || (document.respond_to?(:options) && document.options[:to_dir])
-      output_dir = parent.attr('imagesdir')
+      output_dir = doc.attr('imagesdir')
       # since we store images directly to imagesdir, target dir shall be NULL and asciidoctor converters will prefix imagesdir.
       target_dir = "."
     end
 
-    output_dir = parent.normalize_system_path(output_dir, base_dir)
+    output_dir = doc.normalize_system_path(output_dir, doc.attr('docdir'))
     return [output_dir, target_dir]
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-mathematical
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Tobias Stumm
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-21 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-enum
@@ -52,20 +52,54 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: asciimath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 12.3.0
 description: An Asciidoctor extension to converts latexmath equations to SVG or PNGs
 email: tstumm@users.noreply.github.com
 executables: []
@@ -93,8 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Asciidoctor STEM processor based on Mathematical