rabbit 3.0.0 → 3.0.2

data/lib/rabbit/element/video.rb

@@ -14,7 +14,6 @@ module Rabbit
       include TextRenderer
 
       attr_reader :filename
-      attr_reader :normalized_width, :normalized_height
       attr_reader :relative_width, :relative_height
       attr_reader :relative_margin_top, :relative_margin_bottom
       attr_reader :relative_margin_left, :relative_margin_right
@@ -34,7 +33,6 @@ module Rabbit
           instance_variable_set("@#{name}", true_value?(prop[name]))
         end
         %w(width height
-           normalized_width normalized_height
            relative_width relative_height
            relative_margin_top relative_margin_bottom
            relative_margin_left relative_margin_right
@@ -44,7 +42,7 @@ module Rabbit
           begin
             instance_variable_set("@#{name}", prop[name] && Integer(prop[name]))
           rescue ArgumentError
-            raise InvalidImageSizeError.new(filename, name, prop[name])
+            raise InvalidSizeError.new(filename, name, prop[name])
           end
         end
 
@@ -126,12 +124,10 @@ module Rabbit
           iw = base_w
           ih = base_h
         else
-          nw = make_normalized_size(@normalized_width)
-          nh = make_normalized_size(@normalized_height)
           rw = make_relative_size(@relative_width, base_w)
           rh = make_relative_size(@relative_height, base_h)
-          iw = nw || rw || base_w
-          ih = nh || rh || base_h
+          iw = rw || base_w
+          ih = rh || base_h
         end
         resize(iw, ih)
       end
@@ -151,10 +147,6 @@ module Rabbit
         end
       end
 
-      def make_normalized_size(size)
-        size && screen_size(size)
-      end
-
       def make_relative_size(size, parent_size)
         size && parent_size && ((size / 100.0) * parent_size).ceil
       end

data/lib/rabbit/error.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2017  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
@@ -87,6 +87,12 @@ module Rabbit
     end
   end
 
+  class MermaidCanNotHandleError < ImageLoadWithExternalCommandError
+    def initialize(command, additional_info=nil)
+      super("Mermaid", command, additional_info)
+    end
+  end
+
   class UnknownPropertyError < Error
     attr_reader :name
     def initialize(name)
@@ -181,7 +187,7 @@ module Rabbit
     end
   end
 
-  class InvalidImageSizeError < Error
+  class InvalidSizeError < Error
     attr_reader :filename, :prop_name, :value
     def initialize(filename, prop_name, value)
       @filename = filename
@@ -193,7 +199,7 @@ module Rabbit
         :value => value,
       }
       super(_("invalid value of size property \"%{prop_name}\" " \
-              "of image \"%{filename}\": %{value}") % params)
+              "of \"%{filename}\": %{value}") % params)
     end
   end
 

data/lib/rabbit/formatter.rb

@@ -131,7 +131,7 @@ EOC
       end
     end
 
-    class Weigth
+    class Weight
       private
       def css_name
         "font-weight"

data/lib/rabbit/frame.rb

@@ -2,13 +2,16 @@ require "forwardable"
 require "rabbit/gtk"
 require "rexml/text"
 
+begin
+  require "vte3"
+rescue LoadError
+end
+
 require "rabbit/rabbit"
 require "rabbit/utils"
 
 module Rabbit
-
   class Frame
-
     include ScreenInfo
     extend Forwardable
 
@@ -31,6 +34,9 @@ module Rabbit
       @logger = logger
       @canvas = canvas
       @geometry = nil
+      @notebook = nil
+      @terminal = nil
+      @running = true
     end
 
     def destroyed?
@@ -38,6 +44,7 @@ module Rabbit
     end
 
     def quit
+      @running = false
       @window.destroy unless destroyed?
       @window = nil
       true
@@ -87,6 +94,8 @@ module Rabbit
       init_window(width, height, window_type)
       @fullscreen = false
       @main_window = main_window
+      @terminal.show if @terminal
+      @notebook.show if @notebook
       @window.show
       @canvas.post_init_gui
     end
@@ -99,6 +108,21 @@ module Rabbit
       true
     end
 
+    def toggle_terminal
+      return if @terminal.nil?
+      terminal_page = @notebook.page_num(@terminal)
+      if @notebook.current_page == terminal_page
+        @notebook.current_page = 0
+      else
+        @notebook.current_page = terminal_page
+      end
+    end
+
+    def in_terminal?
+      return false if @terminal.nil?
+      @notebook.current_page == @notebook.page_num(@terminal)
+    end
+
     private
     def init_window(width, height, window_type=nil)
       window_type ||= :toplevel
@@ -106,9 +130,29 @@ module Rabbit
       @window.set_default_size(width, height)
       @window.parse_geometry(@geometry) if @geometry
       @window.set_app_paintable(true)
+      if defined?(Vte::Terminal)
+        init_notebook
+      end
       set_window_signal
       setup_dnd
-      @canvas.attach_to(self, @window)
+      @canvas.attach_to(self, @window, @notebook)
+      if defined?(Vte::Terminal)
+        init_terminal
+      end
+    end
+
+    def init_notebook
+      @notebook = Gtk::Notebook.new
+      @notebook.show_tabs = false
+      provider = Gtk::CssProvider.new
+      provider.load(data: <<-CSS)
+        notebook {
+          border-width: 0px;
+        }
+      CSS
+      @notebook.style_context.add_provider(provider,
+                                           Gtk::StyleProvider::PRIORITY_USER)
+      @window.add(@notebook)
     end
 
     def set_window_signal
@@ -160,6 +204,47 @@ module Rabbit
         true
       end
     end
+
+    def init_terminal
+      @terminal = Vte::Terminal.new
+      # TODO: Support theme
+      terminal_font_description = ENV["RABBIT_TERMINAL_FONT_DESCRIPTION"]
+      if terminal_font_description
+        @terminal.font_desc =
+          Pango::FontDescription.new(terminal_font_description)
+      end
+      terminal_color_foreground = ENV["RABBIT_TERMINAL_COLOR_FOREGROUND"]
+      if terminal_color_foreground
+        @terminal.color_foreground = terminal_color_foreground
+      end
+      terminal_color_background = ENV["RABBIT_TERMINAL_COLOR_BACKGROUND"]
+      if terminal_color_background
+        @terminal.color_background = terminal_color_background
+      end
+      @terminal.enable_sixel = true if @terminal.respond_to?(:enable_sixel=)
+      @notebook.add(@terminal)
+      pid = nil
+      in_terminal = false
+      @notebook.signal_connect(:switch_page) do |_, page,|
+        if page == @terminal
+          if @running
+            pid = @terminal.spawn if pid.nil?
+            @canvas.pre_terminal unless in_terminal
+            in_terminal = true
+          end
+        else
+          @canvas.post_terminal if in_terminal
+          in_terminal = false
+        end
+      end
+      @terminal.signal_connect(:child_exited) do
+        pid = nil
+        terminal_page = @notebook.page_num(@terminal)
+        if @notebook.current_page == terminal_page
+          @canvas.activate("ToggleTerminal")
+        end
+      end
+    end
   end
 
   class NullFrame
@@ -184,10 +269,16 @@ module Rabbit
     def iconify_available?
       false
     end
+
+    def toggle_terminal
+    end
+
+    def in_terminal?
+      false
+    end
   end
 
   class EmbedFrame < Frame
-
     def update_title(new_title)
     end
 
@@ -199,6 +290,13 @@ module Rabbit
       false
     end
 
+    def toggle_terminal
+    end
+
+    def in_terminal?
+      false
+    end
+
     def init_gui(width, height, main_window, window_type=nil)
       @window = Gtk::EventBox.new
       @window.set_size_request(width, height)

data/lib/rabbit/gem-pusher.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016 Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2016-2023  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
@@ -15,11 +15,11 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 require "rake"
-require "yaml"
 require "open-uri"
 
 require "rabbit/gettext"
 require "rabbit/password-reader"
+require "rabbit/yaml-loader"
 
 module Rabbit
   class GemPusher
@@ -35,12 +35,13 @@ module Rabbit
       credentials_path = File.expand_path("~/.gem/credentials")
       credentials_path_exist = File.exist?(credentials_path)
       if credentials_path_exist
-        credentials = YAML.load(File.read(credentials_path))
+        credentials = YAMLLoader.load(File.read(credentials_path))
       else
         credentials = {}
       end
       unless credentials.key?(@user.to_sym)
         credentials[@user.to_sym] = retrieve_api_key
+        FileUtils.mkdir_p(File.dirname(credentials_path))
         File.open(credentials_path, "w") do |credentials_file|
           credentials_file.print(credentials.to_yaml)
         end
@@ -57,10 +58,32 @@ module Rabbit
       prompt = _("Enter password on RubyGems.org [%{user}]: ") % {:user => @user}
       reader = PasswordReader.new(prompt)
       password = reader.read
-      open("https://rubygems.org/api/v1/api_key.yaml",
-           :http_basic_authentication => [@user, password]) do |response|
-        YAML.load(response.read)[:rubygems_api_key]
+      begin
+        URI.open("https://rubygems.org/api/v1/api_key.yaml",
+                 :http_basic_authentication => [@user, password]) do |response|
+          YAMLLoader.load(response.read)[:rubygems_api_key]
+        end
+      rescue OpenURI::HTTPError => error
+        if mfa_error?(error)
+          prompt = _("Enter OTP on RubyGems.org [%{user}]: ") % {:user => @user}
+          # TODO: We don't need to hide input.
+          reader = PasswordReader.new(prompt)
+          otp = reader.read
+          URI.open("https://rubygems.org/api/v1/api_key.yaml",
+                   :http_basic_authentication => [@user, password],
+                   "OTP" => otp) do |response|
+            YAMLLoader.load(response.read)[:rubygems_api_key]
+          end
+        else
+          raise
+        end
       end
     end
+
+    def mfa_error?(error)
+      return false unless error.message.start_with?("401 ")
+      body = error.io.read
+      body.start_with?("You have enabled multifactor authentication")
+    end
   end
 end

data/lib/rabbit/image/base.rb

@@ -1,20 +1,64 @@
+# 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
+# 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 "forwardable"
+require "digest/sha2"
+
 require "gdk_pixbuf2"
 
-require "rabbit/utils"
 require "rabbit/image-data-loader"
+require "rabbit/properties"
 
 module Rabbit
   module ImageManipulable
-
     class Base
       extend ModuleLoader
 
-      attr_reader :width, :height, :original_width, :original_height
+      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
-        @props = normalize_props(props)
+        @properties = Properties.new(props)
+        @canvas = canvas
+        initialize_keep_ratio
         @animation = nil
         @animation_iterator = nil
         @animation_timeout = nil
@@ -24,29 +68,57 @@ module Rabbit
       end
 
       def [](key)
-        @props[normalize_prop_key(key)]
+        @properties[key]
       end
 
       def []=(key, value)
-        @props[normalize_prop_key(key)] = value
+        @properties[key] = value
       end
 
-      def keep_ratio
-        self["keep_ratio"]
+      def keep_ratio?
+        @properties.keep_ratio
       end
+      # For backward compatibility
+      alias_method :keep_ratio, :keep_ratio?
 
       def keep_ratio=(value)
-        self["keep_ratio"] = value
+        @properties.keep_ratio = value
       end
 
       def pixbuf
         @pixbuf
       end
 
+      def width
+        (relative_clip_width&.resolve(@width) || @width) -
+          (relative_clip_x&.resolve(@width) || 0)
+      end
+
+      def height
+        (relative_clip_height&.resolve(@height) || @height) -
+          (relative_clip_y&.resolve(@height) || 0)
+      end
+
+      def relative_clip_x
+        @properties.get_relative_size("relative_clip_x", @filename)
+      end
+
+      def relative_clip_y
+        @properties.get_relative_size("relative_clip_y", @filename)
+      end
+
+      def relative_clip_width
+        @properties.get_relative_size("relative_clip_width", @filename)
+      end
+
+      def relative_clip_height
+        @properties.get_relative_size("relative_clip_height", @filename)
+      end
+
       def resize(w, h)
         if w.nil? and h.nil?
           return
-        elsif keep_ratio
+        elsif keep_ratio?
           if w and h.nil?
             h = (original_height * w.to_f / original_width).ceil
           elsif w.nil? and h
@@ -65,10 +137,7 @@ module Rabbit
       end
 
       def draw(canvas, x, y, params={})
-        default_params = {
-          :width => width,
-          :height => height,
-        }
+        default_params = default_draw_params(x, y)
         target_pixbuf = pixbuf
         if @animation_iterator
           @animation_iterator.advance
@@ -79,20 +148,15 @@ module Rabbit
       end
 
       private
-      def normalize_props(props)
-        normalized_props = {}
-        (props || {}).each do |key, value|
-          normalized_props[normalize_prop_key(key)] = value
-        end
-        keep_ratio_key = normalize_prop_key("keep_ratio")
-        unless normalized_props.has_key?(keep_ratio_key)
-          normalized_props[keep_ratio_key] = true
+      def initialize_keep_ratio
+        return unless @properties["keep_ratio"].nil?
+        # For backward compatibility
+        keep_scale = @properties["keep_scale"]
+        if keep_scale.nil?
+          @properties["keep_ratio"] = true
+        else
+          @properties["keep_ratio"] = keep_scale
         end
-        normalized_props
-      end
-
-      def normalize_prop_key(key)
-        key.to_s.gsub(/-/, "_")
       end
 
       def load_data(data)
@@ -129,6 +193,77 @@ module Rabbit
           end
         end
       end
+
+      def default_draw_params(x, y)
+        _relative_clip_x = relative_clip_x
+        _relative_clip_y = relative_clip_y
+        _relative_clip_width = relative_clip_width
+        _relative_clip_height = relative_clip_height
+        if _relative_clip_x or
+           _relative_clip_y or
+           _relative_clip_width or
+           _relative_clip_height
+          clip_x = _relative_clip_x&.resolve(@width) || 0
+          clip_y = _relative_clip_y&.resolve(@height) || 0
+          clip_width = _relative_clip_width&.resolve(@width) || @width
+          clip_height = _relative_clip_height&.resolve(@height) || @height
+          uncliped_width = width - (clip_width - clip_x) + @width
+          uncliped_height = height - (clip_height - clip_y) + @height
+          {
+            width: uncliped_width,
+            height: uncliped_height,
+            clip_x: x + clip_x,
+            clip_y: y + clip_y,
+            clip_width: clip_width,
+            clip_height: clip_height,
+          }
+        else
+          {
+            width: width,
+            height: height,
+          }
+        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,6 +1,19 @@
-require "forwardable"
+# 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
+# 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/utils"
 require "rabbit/image/base"
 
 module Rabbit
@@ -11,7 +24,6 @@ module Rabbit
 
       DIA_COMMANDS = %w(dia)
 
-      extend Forwardable
       include SystemRunner
 
       class << self
@@ -33,26 +45,21 @@ module Rabbit
         end
       end
 
-      def_delegators(:@svg_loader, :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, keep_ratio)
-        init_svg_loader(filename, keep_ratio)
+      def initialize(filename, props, canvas: nil)
+        init_delegated_loader(filename, props, canvas)
         super
       end
 
       private
-      def init_svg_loader(filename, keep_ratio)
-        @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, keep_ratio)
+          @delegated_loader = SVG.new(@svg_file.path, props)
         else
           raise DiaCanNotHandleError.new("dia #{args.join(' ')}",
                                          DIA_COMMANDS)