asciidoctor-mathematical 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1c9eceb9149c84c9d4de3fcd30ec5db93a90ca95
-  data.tar.gz: 4374551bae0d9848f18cf32dfef01c23dca8cb1a
+SHA256:
+  metadata.gz: 437008600aa4b5218559e2572897d96af79213dfccadf5182d21d66211eb457d
+  data.tar.gz: 1d3c1222d9a7668176d1b3e3470f26d11d5b50b3e6c2682c44a8c66a5de250d6
 SHA512:
-  metadata.gz: 543213a341d317439b96f453ef3ef0233f1d4b4e49f3998d58601bc1e35f02f10e2a7557ce643686de95f352ecfed27f38bcc891c02a1dfe23ebe4de5c11123c
-  data.tar.gz: 5994fba652c78d3f5a7358f266e5aabfd467e0c402ada7864833ab22cc7353d2311950695189f07f210cb8f2ee8a73fe00c55a4ba2250c79071d6039979b479f
+  metadata.gz: e75cc6ce59b6ae680333e7ea97e3cc45b46f735fde6d6f3ca0eb0bb9489e8f74fe78c48872e3fc4f56aacc0c8d73e2b8325042b8e40389163b66ee125f975ccb
+  data.tar.gz: 433c46fe8a04eef3792c522a660b8fc733b036a514ade4f8a52e12152fb4f54d4b75e6749d1a9e59c3489ddaab7df6ff2998509929187dd1426931ff87b69279

data/lib/asciidoctor-mathematical/extension.rb

@@ -10,107 +10,173 @@ class MathematicalTreeprocessor < Asciidoctor::Extensions::Treeprocessor
   LatexmathInlineMacroRx = /\\?latexmath:([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
+
+    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
 
-        # FIXME auto-generate id if one is not provided
-        unless (stem_id = stem.id)
-          stem_id = %(stem-#{::Digest::MD5.hexdigest stem.content})
+    # 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
+    return unless equation_type == :latexmath
 
-        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
+    img_target, img_width, img_height = make_equ_image stem.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', %($$#{stem.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
+
+  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_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_inline_stem(node, text, mathematical, image_output_dir, image_target_dir, format, inline)
+    document = node.document
+    to_html = document.basebackend? 'html'
+    support_stem_prefix = document.attr? 'stem', 'latexmath'
+    stem_rx = support_stem_prefix ? StemInlineMacroRx : LatexmathInlineMacroRx
+
+    source_modified = false
+    # TODO skip passthroughs in the source (e.g., +stem:[x^2]+)
+    text.gsub!(stem_rx) {
+      if (m = $~)[0].start_with? '\\'
+        next m[0][1..-1]
+      end
 
-          eq_id = %(stem-#{::Digest::MD5.hexdigest eq_data})
-          eq_input = %($#{eq_data}$)
+      if (eq_data = m[2].rstrip).empty?
+        next
+      else
+        source_modified = true
+      end
 
-          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_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?
+      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
+    } if (text != nil) && (text.include? ':') && ((support_stem_prefix && (text.include? 'stem:')) || (text.include? 'latexmath:'))
 
-          eq_result = mathematical.parse eq_input
+    [text, source_modified]
+  end
 
-          ::IO.write img_file, eq_result[:data]
-          %(image:#{img_target}[width=#{eq_result[:width]},height=#{eq_result[:height]}])
-        } if (source != nil) && (source.include? ':') && ((support_stem_prefix && (source.include? 'stem:')) || (source.include? 'latexmath:'))
+  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}$$)
 
-        if source_modified
-          if block.context == :list_item
-            block.instance_variable_set :@text, source
-          else
-            block.lines = source.split LineFeed
-          end
-        end
+    # TODO: Handle exceptions.
+    result = mathematical.parse input
+    if inline
+      result[:data]
+    else
+      unless equ_id
+        equ_id = %(stem-#{::Digest::MD5.hexdigest input})
       end
-    end
+      image_ext = %(.#{format})
+      img_target = %(#{equ_id}#{image_ext})
+      img_file = ::File.join image_output_dir, img_target
 
-    nil
+      ::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
 
   def image_output_and_target_dir(parent)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: asciidoctor-mathematical
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Tobias Stumm
@@ -50,22 +50,36 @@ dependencies:
   name: asciidoctor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.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: '1.5'
-    - - ">="
+        version: '2.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: 1.5.0
+        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 +107,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.0.3
 signing_key: 
 specification_version: 4
 summary: Asciidoctor STEM processor based on Mathematical