rabbit 3.0.1 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1ce2e5a227e5b700aab7ed9bf170bd44cdd322e2acf75fdfbd7e846d0a95f5f4
-  data.tar.gz: 73e79afd0c49ecb664fb98594b589521a4bbaf74bcd1b91209335a22e90f5d74
+  metadata.gz: 3bc7a134517bbe5f63d57298ef2843ca3acddbe99a995b7f41ba179a94ef1a97
+  data.tar.gz: 30b19d488840c4db1056eb8108c4b0581ebdcf486da9386d22669cc04730758e
 SHA512:
-  metadata.gz: 8a76046159d4c2dc9bb19703a59222f1c93d993f9c5928b41b57868b15377f2659629a15492058ede5e3dbeeb32592099dcadb39a8b686187fa45e47129f1107
-  data.tar.gz: aee5a1944c8fe477b7a879fae1641fcbfa4f02ea050aab9f82415e1eb194a21a994e33512182a51a36c5a595fb992a335e176e7eddc555812bb090b43139affe
+  metadata.gz: 20e0421868ffce5e36d65b0260999808b898b16152e2d9e7be4db94633922c80d37b89ca4a24494f77aa0f508e2186208c7bd23abebb1ff06ff83a31117291b2
+  data.tar.gz: 42766ca67a7e70a5b5c31ffeafae3aaab515be534a1a97fe977da864d42781e6700562d643c47ec34af6ad991352c9ff2386ee52967ff7c8a63ce83bb377915f

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 #
-# Copyright (C) 2008-2014  Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2008-2023  Kouhei Sutou <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
@@ -58,6 +58,7 @@ end
 GetText::Tools::Task.define do |task|
   task.spec = spec
   task.files -= Dir.glob("sample/**/*.*")
+  task.files -= Dir.glob("test/**/*.*")
   task.mo_base_directory = "data/locale"
 end
 

data/doc/_config.yml

@@ -1,6 +1,6 @@
 markdown: kramdown
-version: 3.0.1
-release_date: 2021-09-25
+version: 3.0.2
+release_date: 2023-06-25
 rabbiter_version: 2.0.3
 rabbiter_release_date: 2016-08-21
 rabbirack_version: 2.0.0

data/doc/_layouts/skeleton.html

@@ -7,8 +7,6 @@
     <link rel="shortcut icon" href="/favicon.ico"
           type="image/vnd.microsfot.icon">
     <link rel="icon" href="/favicon.png" type="image/png">
-    <link rel="stylesheet" href="/css/jquery-ui/themes/ui-lightness.css"
-          type="text/css">
     <link rel="stylesheet" href="/css/syntax.css" type="text/css">
     <link rel="stylesheet" href="/css/rabbit.css" type="text/css">
     <meta property="fb:page_id" content="rabbit.shocker">
@@ -17,11 +15,6 @@
     <meta property="og:image"
           content="http://rabbit-shocker.org/images/lavie.png">
     <meta property="og:site_name" content="Rabbit">
-    <script type="text/javascript" src="/javascripts/jquery.js"></script>
-    <script type="text/javascript" src="/javascripts/jquery-ui.js"></script>
-    <!--[if lt IE 9]>
-    <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
     <script>
       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),

data/doc/en/install/homebrew.rd

@@ -2,38 +2,33 @@
 layout: en
 title: Install with Homebrew
 ---
-== How to install Rabbit with Homebrew on Mac OS X
+== How to install Rabbit with Homebrew on macOS
 
-This document describes how to install Rabbit with Homebrew and RubyGems on Mac OS X.
+This document describes how to install Rabbit with Homebrew and RubyGems on macOS.
 
 === Requirements
 
-* An Intel CPU
-* OS X Leopard or higher
+* A macOS machine
 * Xcode with X11 (XQuartz is required)
 
 === Install Homebrew
 
- $ ruby <(curl -fsSkL raw.github.com/mxcl/homebrew/go)
-
-Then add /usr/local/bin to your PATH.
+Follow the instruction on ((<URL:https://brew.sh>)).
 
 === Install softwares Rabbit needs
 
   $ brew install cairo
-  $ brew link cairo
-  $ brew link --overwrite pixman
   $ brew install pango
   $ brew install gtk+
-  $ brew install poppler --with-glib
-  $ brew install libsvg
+  $ brew install gobject-introspection
+  $ brew install poppler
 
 === Install Rabbit
 
 Exec gem install.
 
-  $ sudo PKG_CONFIG_PATH=/usr/local/opt/libffi/lib/pkgconfig gem install rabbit
-  $ sudo gem install rabbiter # If you want to use Twitter related features
+  $ gem install rabbit
+  $ gem install rabbiter # If you want to use Twitter related features
 
 === Set environment variable
 

data/doc/en/news.rd

@@ -4,6 +4,73 @@ title: News
 ---
 {% raw %}
 
+== 3.0.2: 2023-06-25
+
+Image drawing support release.
+
+=== Improvements
+
+==== rabbit
+
+  * image: Added support for drawing on image.
+
+  * image: Added support for (({align=right})).
+
+  * Added support for Mermaid.
+
+  * blockdiag: Added support for (({blockdiag3})) command.
+
+==== rabbit-slide
+
+  * config: Added (({source_code_uri})).
+    ((<GH-144|URL:https://github.com/rabbit-shocker/rabbit/issues/144>))
+    [Patch by Yusuke Nakamura]
+
+  * Dropped support for uploading to SlideShare. Because SlideShare
+    API dropped support for uploading a slideshow.
+
+==== Theme
+
+  * image-slide-number: Changed to render images back to the main
+    content. It prevents hiding the main content.
+
+  * image-timer: Changed to render images back to the main
+    content. It prevents hiding the main content.
+
+  * background-image-toolkit: Added support for caption.
+
+  * clear-blue: Changed to replace (({\n})) with a space character
+    instead of just removing it in footer.
+
+  * pdf: Changed to use (({./theme.rb})) instead of (({canvas.title}))
+    theme by default.
+
+==== Document
+
+  * macos Homebrew: Updated how to install document.
+    ((<GH-150|URL:https://github.com/rabbit-shocker/rabbit/issues/150>))
+    [Patch by Yusuke Nakamura]
+
+=== Fixes
+
+==== rabbit
+
+  * formatter HTML: Fixed a bug that weight configuration is missing.
+    ((<GH-146|URL:https://github.com/rabbit-shocker/rabbit/issues/146>))
+    [Patch by HASUMI Hitoshi]
+
+==== Theme
+
+  * image-timer: Fixed a bug that images aren't showed with PDF.
+
+  * image-slide-number: Fixed a bug that images aren't showed with PDF.
+
+=== Thanks
+
+  * Yusuke Nakamura
+
+  * HASUMI Hitoshi
+
 == 3.0.1: 2021-09-25
 
 Ruby 3.0 support release.

data/doc/ja/install/homebrew.rd

@@ -2,37 +2,33 @@
 layout: ja
 title: Homebrewでインストール
 ---
-== Mac OS XでHomebrewを使ったインストール方法
+== macOSでHomebrewを使ったインストール方法
 
-Mac OS X のパッケージ管理システムのひとつである Homebrew と RubyGems を利用して
+macOS のパッケージ管理システムのひとつである Homebrew と RubyGems を利用して
 Rabbit をインストール、利用する手順について説明します。
 
 === 事前に準備するもの
 
-* Intel Mac
-* Mac OS X Leopard 以上
+* macOS
 * Xcode と X11（XQuartzをインストール）
 
 === Homebrew のインストール
 
- $ ruby <(curl -fsSkL raw.github.com/mxcl/homebrew/go)
+((<URL:https://brew.sh/>)) に記載の方法に従ってインストールしてください。
 
-環境変数 PATH に /usr/local/bin を追加します。
-
-==== brew install と brew link の実行
+==== brew install の実行
 
   $ brew install cairo
-  $ brew link cairo
-  $ brew link --overwrite pixman
   $ brew install pango
   $ brew install gtk+
-  $ brew install poppler --with-glib
+  $ brew install gobject-introspection
+  $ brew install poppler
 
 === Rabbit のインストール
 
 gem install を実行します。
 
-  $ sudo PKG_CONFIG_PATH=/usr/local/opt/libffi/lib/pkgconfig gem install rabbit
+  $ sudo gem install rabbit
   $ sudo gem install rabbiter # Twitter連携機能を使う場合
 
 === 環境変数の設定

data/doc/ja/news.rd

@@ -5,6 +5,73 @@ apply_data: false
 ---
 {% raw %}
 
+== 3.0.2: 2023-06-25
+
+画像への描画をサポートしたリリース。
+
+=== 改良
+
+==== rabbit
+
+  * image: 画像への描画をサポート。
+
+  * image: (({align=right}))をサポート。
+
+  * Mermaidをサポート。
+
+  * blockdiag: (({blockdiag3}))コマンドをサポート。
+
+==== rabbit-slide
+
+  * config: (({source_code_uri}))を追加。
+    ((<GH-144|URL:https://github.com/rabbit-shocker/rabbit/issues/144>))
+    [Yusuke Nakamuraさんがパッチ提供]
+
+  * SlideShareへのアップロード機能を削除。これはSlideShareのAPIからス
+    ライドアップロード機能が削除されたからです。
+
+==== テーマ
+
+  * image-slide-number: メインコンテンツの後ろに画像を描画するように変
+    更。これによりメインコンテンツを隠すことがなくなります。
+
+  * image-timer: メインコンテンツの後ろに画像を描画するように変更。こ
+    れによりメインコンテンツを隠すことがなくなります。
+
+  * background-image-toolkit: キャプションをサポート。
+
+  * clear-blue: フッターの(({\n}))を削除するのではなく空白文字に置換す
+    るように変更。
+
+  * pdf: デフォルトで(({canvas.title}))テーマではなく(({./theme.rb}))
+    テーマを使うように変更。
+
+==== ドキュメント
+
+  * macos Homebrew: インストールドキュメントを更新。
+    ((<GH-150|URL:https://github.com/rabbit-shocker/rabbit/issues/150>))
+    [Yusuke Nakamuraさんがパッチ提供]
+
+=== 修正
+
+==== rabbit
+
+  * formatter HTML: 重みの設定が反映されない問題を修正。
+    ((<GH-146|URL:https://github.com/rabbit-shocker/rabbit/issues/146>))
+    [HASUMI Hitoshiさんがパッチ提供]
+
+==== テーマ
+
+  * image-timer: PDFで画像が表示されない問題を修正。
+
+  * image-slide-number: PDFで画像が表示されない問題を修正。
+
+=== 感謝
+
+  * Yusuke Nakamuraさん
+
+  * HASUMI Hitoshiさん
+
 == 3.0.1: 2021-09-25
 
 Ruby 3.0をサポートしたリリース。

data/lib/rabbit/canvas.rb

@@ -83,6 +83,8 @@ module Rabbit
     def_delegators(:@renderer, :shear_context)
     def_delegators(:@renderer, :save_context, :restore_context)
     def_delegators(:@renderer, :draw_line, :draw_rectangle, :draw_arc)
+    def_delegators(:@renderer, :draw_lines)
+    def_delegators(:@renderer, :draw_polygon)
     def_delegators(:@renderer, :draw_circle, :draw_layout, :draw_pixbuf)
     def_delegators(:@renderer, :draw_arc_by_radius, :draw_circle_by_radius)
     def_delegators(:@renderer, :draw_slide, :draw_polygon, :draw_flag)
@@ -345,7 +347,7 @@ module Rabbit
       apply_theme(@theme_name, &block)
     end
 
-    def parse(source=nil, callback=nil, &block)
+    def parse(source=nil, progress=nil, &block)
       id = Object.new.__id__
       @parse_request_queue.push(id)
       @source = source || @source
@@ -355,7 +357,7 @@ module Rabbit
         keep_index do
           @renderer.pre_parse
           clear
-          Parser.parse(self, @source)
+          Parser.parse(self, @source, progress: progress)
           new_allotted_time = allotted_time
           reset_timer if new_allotted_time != current_allotted_time
           apply_timer
@@ -364,7 +366,7 @@ module Rabbit
             if @parse_request_queue.last != id
               raise ParseFinish
             end
-            callback.call if callback
+            progress.call if progress
           end
           @renderer.post_parse
           index = current_index
@@ -382,9 +384,9 @@ module Rabbit
       end
     end
 
-    def reload_source(callback=nil, &block)
+    def reload_source(progress=nil, &block)
       if need_reload_source?
-        parse(nil, callback, &block)
+        parse(nil, progress, &block)
       end
     end
 

data/lib/rabbit/element/base.rb

@@ -430,11 +430,7 @@ module Rabbit
 
       def make_prop_value(name, *values)
         formatter_name = to_class_name(name)
-        begin
-          unless Format.const_defined?(formatter_name)
-            raise NameError
-          end
-        rescue NameError
+        unless Format.const_defined?(formatter_name)
           raise UnknownPropertyError.new(name)
         end
         Format.const_get(formatter_name).new(*values)

data/lib/rabbit/element/image.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2004-2020  Sutou Kouhei <kou@cozmixng.org>
+# Copyright (C) 2004-2021  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
@@ -29,21 +29,27 @@ module Rabbit
       alias image_draw draw
       alias draw element_draw
 
-      def initialize(filename, props)
-        super(filename, props)
+      def initialize(filename, props, canvas: nil)
+        super(filename, props, canvas: canvas)
         setup_draw_parameters
         resize(properties.get_size("width", @filename),
                properties.get_size("height", @filename))
       end
 
       def draw_element(canvas, x, y, w, h, simulation)
-        draw_image(canvas, x, y, w, h, simulation)
+        result = draw_image(canvas, x, y, w, h, simulation)
+        draw_properties(canvas, x, y, w, h) unless simulation
+        result
       end
 
       def caption
         self["caption"]
       end
 
+      def caption_font_size
+        properties.get_float("caption-font-size")
+      end
+
       def text
         caption.to_s
       end
@@ -113,10 +119,12 @@ module Rabbit
         adjust_size(canvas, @x, @y, @w, @h)
       end
 
+      alias_method :width_without_padding, :width
       def width
         super + @padding_left + @padding_right
       end
 
+      alias_method :height_without_padding, :height
       def height
         super + @padding_top + @padding_bottom
       end
@@ -191,6 +199,64 @@ module Rabbit
         end
         resize(iw, ih)
       end
+
+      def draw_properties(canvas, base_x, base_y, base_w, base_h)
+        properties.draws.each do |type, *args|
+          case type
+          when "line"
+            if args.last.is_a?(Hash)
+              params = args.pop
+            else
+              params = nil
+            end
+            points = args.each_slice(2).collect do |x, y|
+              x = (x * width_without_padding) + base_x
+              y = (y * height_without_padding) + base_y
+              [x, y]
+            end
+            params = normalize_params(params)
+            color = params.delete(:color) || "black"
+            canvas.draw_lines(points, color, params)
+          when "rectangle"
+            filled, x, y, w, h, params = args
+            x = (x * width_without_padding) + base_x
+            y = (y * height_without_padding) + base_y
+            w = (w * width_without_padding)
+            h = (h * height_without_padding)
+            params = normalize_params(params)
+            color = params.delete(:color) || "black"
+            canvas.draw_rectangle(filled, x, y, w, h, color, params)
+          when "text"
+            text, x, y, params = args
+            params = normalize_params(params)
+            layout = canvas.make_layout(markup_text(text, params))
+            x = (x * width_without_padding) + base_x
+            y = (y * height_without_padding) + base_y
+            color = params.delete(:color) || "black"
+            canvas.draw_layout(layout, x, y, color, params)
+          end
+        end
+      end
+
+      def normalize_params(params)
+        return {} if params.nil?
+        normalized_params = {}
+        params.each do |key, value|
+          normalized_params[key.to_sym] = value
+        end
+        normalized_params
+      end
+
+      def markup_text(text, props)
+        props.each do |name, value|
+          formatter_name = Utils.to_class_name(name.to_s)
+          next unless Format.const_defined?(formatter_name)
+          formatter = Format.const_get(formatter_name).new(value)
+          next unless formatter.text_formatter?
+          text = formatter.format(text)
+        end
+        text
+      end
     end
   end
 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)

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/gem-pusher.rb

@@ -1,4 +1,4 @@
-# Copyright (C) 2016-2021  Sutou Kouhei <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
@@ -41,6 +41,7 @@ module Rabbit
       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