rabbit 3.0.1 → 3.0.2

data/lib/rabbit/image/base.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2020  Sutou Kouhei <kou@cozmixng.org>
+# Copyright (C) 2004-2022  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -14,6 +14,9 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
+require "forwardable"
+require "digest/sha2"
+
 require "gdk_pixbuf2"
 
 require "rabbit/image-data-loader"
@@ -21,19 +24,40 @@ require "rabbit/properties"
 
 module Rabbit
   module ImageManipulable
-
     class Base
       extend ModuleLoader
 
+      class << self
+        def delegate
+          extend Forwardable
+
+          def_delegators(:@delegated_loader,
+                         :draw,
+                         :ensure_resize,
+                         :height,
+                         :internal_pixbuf,
+                         :keep_ratio,
+                         :keep_ratio=,
+                         :keep_ratio?,
+                         :original_height,
+                         :original_width,
+                         :pixbuf,
+                         :resize,
+                         :update_size,
+                         :width)
+        end
+      end
+
       attr_reader :filename
       attr_reader :properties
       attr_reader :original_width
       attr_reader :original_height
       attr_reader :animation
 
-      def initialize(filename, props)
+      def initialize(filename, props, canvas: nil)
         @filename = filename
         @properties = Properties.new(props)
+        @canvas = canvas
         initialize_keep_ratio
         @animation = nil
         @animation_iterator = nil
@@ -200,6 +224,46 @@ module Rabbit
           }
         end
       end
+
+      # TODO: Move to more suitable location
+      def cache_processed_data(canvas, input, extension)
+        tmp_dir_name = canvas&.tmp_dir_name
+        return yield unless tmp_dir_name
+        hash = compute_hash(input)
+        cached_path = File.join(tmp_dir_name, "#{hash}.#{extension}")
+        unless File.exist?(cached_path)
+          processed_path = yield
+          FileUtils.cp(processed_path, cached_path)
+        end
+        cached_path
+      end
+
+      def compute_hash(input)
+        digest = Digest::SHA2.new
+        add_data = lambda do |data|
+          case data
+          when Array
+            data.each do |element|
+              add_data.call(element)
+            end
+          when Hash
+            data.each do |key, value|
+              add_data.call(key)
+              add_data.call(value)
+            end
+          when String
+            digest << data
+          when IO
+            loop do
+              chunk = data.read(4096)
+              break if chunk.nil?
+              digest << chunk
+            end
+          end
+        end
+        add_data.call(input)
+        digest.hexdigest
+      end
     end
   end
 end

data/lib/rabbit/image/dia.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2020  Sutou Kouhei <kou@cozmixng.org>
+# Copyright (C) 2004-2022  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -14,8 +14,6 @@
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
-require "forwardable"
-
 require "rabbit/image/base"
 
 module Rabbit
@@ -26,7 +24,6 @@ module Rabbit
 
       DIA_COMMANDS = %w(dia)
 
-      extend Forwardable
       include SystemRunner
 
       class << self
@@ -48,26 +45,21 @@ module Rabbit
         end
       end
 
-      def_delegators(:@svg_loader, :keep_ratio, :keep_ratio?, :keep_ratio=)
-      def_delegators(:@svg_loader, :pixbuf, :internal_pixbuf)
-      def_delegators(:@svg_loader, :width, :height)
-      def_delegators(:@svg_loader, :original_width, :original_height)
-      def_delegators(:@svg_loader, :resize, :ensure_resize)
-      def_delegators(:@svg_loader, :update_size)
+      delegate
 
-      def initialize(filename, props)
-        init_svg_loader(filename, props)
+      def initialize(filename, props, canvas: nil)
+        init_delegated_loader(filename, props, canvas)
         super
       end
 
       private
-      def init_svg_loader(filename, props)
-        @svg_file = Tempfile.new(["rabbit-loader-dia", ".svg"])
+      def init_delegated_loader(filename, props, canvas)
+        @svg_file = Tempfile.new(["rabbit-image-loader-dia", ".svg"])
         args = ["--export=#{@svg_file.path}"]
         args << "--filter=svg"
         args << filename
         if DIA_COMMANDS.any? {|dia| run(dia, *args)}
-          @svg_loader = SVG.new(@svg_file.path, props)
+          @delegated_loader = SVG.new(@svg_file.path, props)
         else
           raise DiaCanNotHandleError.new("dia #{args.join(' ')}",
                                          DIA_COMMANDS)

data/lib/rabbit/image/mermaid.rb

@@ -0,0 +1,73 @@
+# Copyright (C) 2022  Sutou Kouhei <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+require "rabbit/image/pdf"
+
+module Rabbit
+  module ImageManipulable
+    class Mermaid < Base
+
+      unshift_loader(self)
+
+      include SystemRunner
+
+      class << self
+        def match?(filename)
+          File.extname(filename).downcase.end_with?(".mmd")
+        end
+      end
+
+      delegate
+
+      def initialize(filename, props, canvas: nil)
+        init_delegated_loader(filename, props, canvas)
+        super
+      end
+
+      private
+      def init_delegated_loader(filename, props, canvas)
+        background_color = props["background_color"] || "transparent"
+        pdf_path = File.open(filename, "rb") do |source|
+          cache_processed_data(canvas, [source, background_color], "pdf") do
+            @pdf_file = Tempfile.new(["rabbit-image-loader-mermaid", ".pdf"])
+            command_line = [
+              "npx",
+              "--yes",
+              "--package=@mermaid-js/mermaid-cli",
+              "mmdc",
+              "--backgroundColor", background_color,
+              "--input", filename,
+              "--output", @pdf_file.path,
+              "--pdfFit",
+            ]
+            unless SystemRunner.run(*command_line)
+              format = _("tried mermaid command: %s")
+              additional_info = format % command_line.inspect
+              raise MermaidCanNotHandleError.new(command_line.join(' '),
+                                                 additional_info)
+            end
+            @pdf_file.path
+          end
+        end
+        @delegated_loader = PDF.new(pdf_path, props)
+      end
+
+      def load_image
+        # do nothing
+      end
+    end
+  end
+end

data/lib/rabbit/image/pdf.rb

@@ -1,3 +1,19 @@
+# Copyright (C) 2006-2022  Sutou Kouhei <kou@cozmixng.org>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this program; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
 require "poppler"
 
 require "rabbit/gettext"
@@ -36,6 +52,11 @@ module Rabbit
         @pixbuf ||= to_pixbuf
       end
 
+      def update_size
+        @document = Poppler::Document.new(uri)
+        @width, @height = page.size
+      end
+
       private
       def page
         index = self["page"] || 1
@@ -53,11 +74,6 @@ module Rabbit
         _page
       end
 
-      def update_size
-        @document = Poppler::Document.new(uri)
-        @width, @height = page.size
-      end
-
       def filename
         File.expand_path(@filename)
       end

data/lib/rabbit/image.rb

@@ -21,6 +21,7 @@ require "rabbit/image/default"
 require "rabbit/image/dia"
 require "rabbit/image/eps"
 require "rabbit/image/gimp"
+require "rabbit/image/mermaid"
 require "rabbit/image/pdf"
 require "rabbit/image/svg"
 
@@ -37,12 +38,12 @@ module Rabbit
     def_delegators(:@loader, :properties)
     alias_method :scale, :resize
 
-    def initialize(filename, props=nil, *args, &block)
+    def initialize(filename, props=nil, *args, canvas: nil, &block)
       unless File.exist?(filename)
         raise ImageFileDoesNotExistError.new(filename)
       end
       super(*args, &block)
-      @loader = Base.find_loader(filename).new(filename, props)
+      @loader = Base.find_loader(filename).new(filename, props, canvas: canvas)
     end
   end
 

data/lib/rabbit/parser/base.rb

@@ -5,9 +5,10 @@ module Rabbit
     class Base
       extend ModuleLoader
 
-      def initialize(canvas, source)
+      def initialize(canvas, source, progress: nil)
         @canvas = canvas
         @source = source
+        @progress = progress
       end
     end
   end

data/lib/rabbit/parser/ext/blockdiag.rb

@@ -9,29 +9,31 @@ module Rabbit
         # "font" is treated as specially.
         AVAILABLE_VALUE_OPTIONS = []
         def make_image(path, prop, logger)
-          image_file = Tempfile.new("rabbit-image-blockdiag")
-          command = [
-            "blockdiag",
+          image_file = Tempfile.new(["rabbit-image-blockdiag", ".svg"])
+          command_line = [
             "-T", "svg",
             "-o", image_file.path,
           ]
           font = find_font(prop)
-          command.concat(["-f", font]) if font
+          command_line.concat(["-f", font]) if font
           AVAILABLE_FLAG_OPTIONS.each do |name|
-            command << "--#{name}" if /\A(?:true|yes)\z/i =~ prop[name].to_s
+            command_line << "--#{name}" if /\A(?:true|yes)\z/i =~ prop[name].to_s
           end
           AVAILABLE_VALUE_OPTIONS.each do |name|
-            command.concat(["--#{name}", prop[name]]) if prop.has_key?(name)
+            command_line.concat(["--#{name}", prop[name]]) if prop.has_key?(name)
           end
-          command << path
-          if SystemRunner.run(*command)
-            image_file
-          else
-            format = _("tried blockdiag command: %s")
-            additional_info = format % command.inspect
-            raise BlockDiagCanNotHandleError.new(command.join(' '),
-                                                 additional_info)
+          command_line << path
+          blockdiag_commands = ["blockdiag3", "blockdiag"]
+          blockdiag_commands.each do |blockdiag|
+            if SystemRunner.run(blockdiag, *command_line)
+              return image_file
+            end
           end
+          command_line.unshift(blockdiag_commands.first)
+          format = _("tried blockdiag command: %s")
+          additional_info = format % command_line
+          raise BlockDiagCanNotHandleError.new(command_line.join(' '),
+                                               additional_info)
         end
 
         def find_font(prop)

data/lib/rabbit/parser/ext/image.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2007-2018  Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2007-2022  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -27,31 +27,58 @@ module Rabbit
     module Ext
       module Image
         module_function
-        def make_image(canvas, uri_str, prop={})
+        def make_image(canvas, uri_str, prop={}, body: nil)
           path = Private.uri_string_to_image_filename(canvas, uri_str)
           begin
-            Element::Image.new(path, prop)
+            image = Element::Image.new(path, prop, canvas: canvas)
           rescue Error
             canvas.logger.warn($!.message)
             nil
+          else
+            if prop["align"] == "right" and body
+              if body["background-image"]
+                raise ParseError,
+                      _("multiple right aligns aren't supported.")
+              end
+              prop.each do |name, value|
+                name = name.gsub(/_/, "-")
+                next if name == "src"
+                property_name = "background-image-#{name}"
+                body[property_name] = value
+              end
+              body["background-image"] = uri_str
+              :no_element
+            else
+              image
+            end
           end
         end
 
-        def make_image_from_file(canvas, source)
-          src_file = Tempfile.new("rabbit-image-source")
+        def make_image_from_file(canvas, source, extension: nil, **options)
+          src_basename = "rabbit-image-source"
+          src_basename = [src_basename, extension] if extension
+          src_file = Tempfile.new(src_basename)
           src_file.open
           src_file.print(source)
           src_file.close
           image_file = prop = nil
           begin
-            image_file, prop = yield(src_file.path)
+            image_file, prop = yield(src_file)
           rescue ImageLoadError
             canvas.logger.warn($!.message)
           end
           return nil if image_file.nil?
-          image = make_image(canvas, %Q[file://#{image_file.path}], prop)
-          return nil if image.nil?
-          image["_src"] = image_file # for protecting from GC
+          image = make_image(canvas,
+                             "file://#{image_file.path}",
+                             prop,
+                             **options)
+          # Protect image from GC
+          case image
+          when Element::Image
+            image["_src"] = image_file
+          when :no_element
+            options[:body]["_background-image-src"] = image_file
+          end
           image
         end
 

data/lib/rabbit/parser/markdown/converter.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2012-2017  Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2012-2022  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -20,8 +20,8 @@ require "rabbit/gettext"
 require "rabbit/parser/pause-support"
 require "rabbit/parser/ext/blockdiag"
 require "rabbit/parser/ext/escape"
-require "rabbit/parser/ext/inline"
 require "rabbit/parser/ext/image"
+require "rabbit/parser/ext/inline"
 require "rabbit/parser/ext/rouge"
 require "rabbit/parser/ext/tex"
 
@@ -165,9 +165,15 @@ module Rabbit
           if child_types == [:img]
             convert_container(element)[0]
           else
-            if child_types.include?(:img)
+            if child_types.count(:img) > 1
               raise ParseError,
-                      _("multiple ![alt]{image} in a paragraph isn't supported.")
+                    _("multiple ![alt]{image}s in a paragraph isn't supported.")
+            end
+            if child_types.include?(:img)
+              message =
+                _("![alt]{image} and other contents in a paragraph " \
+                  "isn't supported: %{types}")
+              raise ParseError, message % {types: child_types}
             end
             if element.options[:transparent] and child_types == [:text]
               element.children.first.value.chomp!
@@ -325,12 +331,14 @@ module Rabbit
         def convert_codeblock_language(element, language, content)
           case language
           when "blockdiag"
-            args = [@canvas, content]
-            Ext::Image.make_image_from_file(*args) do |src_file_path|
-              [
-                Ext::BlockDiag.make_image(src_file_path, element.attr, @canvas),
-                element.attr,
-              ]
+            make_image_from_file(element, content) do |src_file, prop|
+              Ext::BlockDiag.make_image(src_file.path, prop, @canvas)
+            end
+          when "mermaid"
+            make_image_from_file(element,
+                                 content,
+                                 extension: ".mmd") do |src_file, prop|
+              src_file
             end
           else
             logger = @canvas.logger
@@ -349,23 +357,11 @@ module Rabbit
           alt = options.delete("alt")
           caption = title || alt
           options["caption"] ||= caption if caption
-          if options["align"] == "right"
-            body = @slides.last.body
-            if body["background-image"]
-              raise ParseError,
-                    _("multiple ![]('XXX.png'){:align='right'} " + \
-                      "isn't supported.")
-            end
-            body["background-image"] = uri
-            options.each do |name, value|
-              name = name.to_s.gsub(/_/, "-")
-              body["background-image-#{name}"] = value
-            end
-            :no_element
-          else
-            image = Ext::Image.make_image(@canvas, uri, options)
-            image || text(alt || src)
-          end
+          image = Ext::Image.make_image(@canvas,
+                                        uri,
+                                        options,
+                                        body: @slides.last.body)
+          image || text(alt || src)
         end
 
         def convert_em(element)
@@ -376,10 +372,20 @@ module Rabbit
           Emphasis.new(Emphasis.new(convert_container(element)))
         end
 
+        def make_image_from_file(element, source, **options)
+          Ext::Image.make_image_from_file(@canvas,
+                                          source,
+                                          body: @slides.last.body,
+                                          **options) do |src_file|
+            prop = element.attr
+            image = yield(src_file, prop)
+            [image, prop]
+          end
+        end
+
         def convert_math(element)
-          args = [@canvas, element.value]
-          Ext::Image.make_image_from_file(*args) do |src_file_path|
-            [Ext::TeX.make_image_by_LaTeX(src_file_path, {}, @canvas), {}]
+          make_image_from_file(element, element.value) do |src_file, prop|
+            Ext::TeX.make_image_by_LaTeX(src_file.path, prop, @canvas)
           end
         end
 

data/lib/rabbit/parser/rd/ext/block-verbatim.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2021  Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2004-2022  Sutou Kouhei <kou@cozmixng.org>
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -22,14 +22,14 @@ require "rabbit/parser/rd/rt/rt2rabbit-lib"
 require "rabbit/parser/rd/ext/base"
 require "rabbit/parser/rd/ext/image"
 require "rabbit/parser/rd/ext/video"
-require "rabbit/parser/ext/enscript"
-require "rabbit/parser/ext/tex"
 require "rabbit/parser/ext/aafigure"
 require "rabbit/parser/ext/blockdiag"
 require "rabbit/parser/ext/charty"
 require "rabbit/parser/ext/coderay"
 require "rabbit/parser/ext/emacs"
+require "rabbit/parser/ext/enscript"
 require "rabbit/parser/ext/rouge"
+require "rabbit/parser/ext/tex"
 
 module Rabbit
   module Parser
@@ -55,26 +55,7 @@ module Rabbit
             return nil unless /\A(?:image|img)\z/i =~ label
             src, prop = parse_source(source)
             return nil if prop["src"].nil?
-
-            if prop["align"] == "right"
-              body = visitor.current_body
-              if body["background-image"]
-                raise ParseError,
-                      _("multiple 'align = right' isn't supported.")
-              end
-              prop.each do |name, value|
-                name = name.gsub(/_/, "-")
-                if name == "src"
-                  property_name = "background-image"
-                else
-                  property_name = "background-image-#{name}"
-                end
-                body[property_name] = value
-              end
-              :no_element
-            else
-              make_image(visitor, prop["src"], prop)
-            end
+            make_image(visitor, prop["src"], prop, body: visitor.current_body)
           end
 
           def ext_block_verb_video(label, source, content, visitor)
@@ -101,30 +82,30 @@ module Rabbit
 
           def ext_block_verb_LaTeX(label, source, content, visitor)
             return nil unless /\ALaTeX\z/i =~ label
-            make_image_from_file(source, visitor) do |src_file_path, prop|
-              Parser::Ext::TeX.make_image_by_LaTeX(src_file_path, prop, visitor)
+            make_image_from_file(source, visitor) do |src_file, prop|
+              Parser::Ext::TeX.make_image_by_LaTeX(src_file.path, prop, visitor)
             end
           end
 
           def ext_block_verb_mimeTeX(label, source, content, visitor)
             return nil unless /\AmimeTeX\z/i =~ label
-            make_image_from_file(source, visitor) do |src_file_path, prop|
-              Parser::Ext::TeX.make_image_by_mimeTeX(src_file_path, prop,
+            make_image_from_file(source, visitor) do |src_file, prop|
+              Parser::Ext::TeX.make_image_by_mimeTeX(src_file.path, prop,
                                                      visitor)
             end
           end
 
           def ext_block_verb_aafigure(label, source, content, visitor)
             return nil unless /\Aaafigure\z/i =~ label
-            make_image_from_file(source, visitor) do |src_file_path, prop|
-              Parser::Ext::AAFigure.make_image(src_file_path, prop, visitor)
+            make_image_from_file(source, visitor) do |src_file, prop|
+              Parser::Ext::AAFigure.make_image(src_file.path, prop, visitor)
             end
           end
 
           def ext_block_verb_blockdiag(label, source, content, visitor)
             return nil unless /\Ablockdiag\z/i =~ label
-            make_image_from_file(source, visitor) do |src_file_path, prop|
-              Parser::Ext::BlockDiag.make_image(src_file_path, prop, visitor)
+            make_image_from_file(source, visitor) do |src_file, prop|
+              Parser::Ext::BlockDiag.make_image(src_file.path, prop, visitor)
             end
           end
 
@@ -205,8 +186,17 @@ module Rabbit
 
           def ext_block_verb_charty(label, source, content, visitor)
             return nil unless /\Acharty\z/i =~ label
-            make_image_from_file(source, visitor) do |src_file_path, prop|
-              Parser::Ext::Charty.make_image(src_file_path, prop, visitor)
+            make_image_from_file(source, visitor) do |src_file, prop|
+              Parser::Ext::Charty.make_image(src_file.path, prop, visitor)
+            end
+          end
+
+          def ext_block_verb_mermaid(label, source, content, visitor)
+            return nil unless /\Amermaid\z/i =~ label
+            make_image_from_file(source,
+                                 visitor,
+                                 extension: ".mmd") do |src_file, prop|
+              src_file
             end
           end
         end