rabbit 3.0.3 → 3.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb9e983ee9412207b14cef6be805b3052ea475cb773b60663585cbc721749114
-  data.tar.gz: 6b40876e29a4ca2e7034bac14cc7452baa52114d98a774732b39a7a4f278e447
+  metadata.gz: 7f3fbfefe40c2abbea3572d6d22aec3ac5d5e3de069f61120cff0d82db031527
+  data.tar.gz: 6435432f528d3af5caeae8a8cd112be3f979c03fa2d431249344c08b7afd9810
 SHA512:
-  metadata.gz: ccf377086608db9d30d520fe83e6c235a7000435ea72bc8d9c6c1f70f429dd2f2076f5a2c78f5c61d36d2c7caf1144abca7a9d72163bf58ee302ac55c73ad98d
-  data.tar.gz: fabda81a44c7c844289dd4b8e78c9ef34cf21d1eb3f0c09b9540c30e6d7961b65361fabb97a1058fc3aeb2954547c9b389e28726703666eb743da9a67130492f
+  metadata.gz: 59f6d1c1f91e68727a981b1170d6d344c55118b140557282c8166cae84c5118364d73da505e9555dc6a44fed9600451c64dda5b3230811722dd6f8de93ddc464
+  data.tar.gz: f4f59780a8370a527da3aa6615fdb96003b3a1e1b5925f36269a3af6f174cde58058640900ff11153a49411894f796fc6c2b9ef09d827f574ead743ad56998cf

data/Gemfile

@@ -1,5 +1,37 @@
 # -*- ruby -*-
+#
+# Copyright (C) 2011-2025  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.
 
 source "https://rubygems.org"
 
+plugin "rubygems-requirements-system"
+
 gemspec
+
+group :development, :docs, :test do
+  gem "bundler"
+  gem "rake"
+  gem "open-uri"
+end
+
+group :docs do
+  gem "jekyll"
+end
+
+group :test do
+  gem "test-unit"
+end

data/Rakefile

@@ -1,6 +1,6 @@
 # -*- ruby -*-
 #
-# Copyright (C) 2008-2023  Kouhei Sutou <kou@cozmixng.org>
+# Copyright (C) 2008-2025  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
@@ -17,17 +17,17 @@
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 require "find"
-require "rubygems"
-require "rubygems/package_task"
+require "open-uri"
+require "tmpdir"
+
 require "bundler/gem_helper"
 require "gettext/tools/task"
 
 task :default => :test
 
 base_dir = File.expand_path(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(base_dir, 'lib'))
 
-rsync_local_path = "~/public_html/"
+rsync_local_path = ENV["LOCAL_DESTINATION_PATH"] || "~/public_html/"
 rsync_base_path = "rabbit@rabbit-shocker.org:#{rsync_local_path}"
 
 helper = Bundler::GemHelper.new(base_dir)
@@ -36,24 +36,19 @@ def helper.version_tag
 end
 
 helper.install
-spec = helper.gemspec
-version = spec.version.to_s
-
-def force_array(enumerable)
-  array = []
-  enumerable.each do |element|
-    array << element
-  end
-  array
-end
 
-def spec.files
-  @files = force_array(super)
+release_task = Rake.application["release"]
+# We use Trusted Publishing.
+release_task.prerequisites.delete("build")
+release_task.prerequisites.delete("release:rubygem_push")
+release_task_comment = release_task.comment
+if release_task_comment
+  release_task.clear_comments
+  release_task.comment = release_task_comment.gsub(/ and build.*$/, "")
 end
 
-def spec.extra_rdoc_files
-  @extra_rdoc_files = force_array(super)
-end
+spec = helper.gemspec
+version = spec.version.to_s
 
 GetText::Tools::Task.define do |task|
   task.spec = spec
@@ -62,10 +57,6 @@ GetText::Tools::Task.define do |task|
   task.mo_base_directory = "data/locale"
 end
 
-Gem::PackageTask.new(spec) do |package|
-  package.need_tar_gz = true
-end
-
 rule '.png' => ['.svg'] do |t|
   sh("inkscape", "--export-png", t.name, t.source)
 end
@@ -87,10 +78,46 @@ namespace :entity do
   end
 end
 
+languages = ["ja", "en"]
+related_products = [
+  "rabwii",
+  "rabbirack",
+]
+related_product_paths = []
+related_products.each do |related_product|
+  related_product_directory = "../#{related_product}"
+  related_product_paths << related_product_directory
+  directory related_product_directory do
+    sh("git",
+       "clone",
+       "https://github.com/rabbit-shocker/#{related_product}.git",
+       related_product_directory)
+  end
+
+  languages.each do |language|
+    related_product_link = "doc/#{language}/#{related_product}"
+    related_product_paths << related_product_link
+    file related_product_link do
+      sh("ln",
+         "-s",
+         "../../../#{related_product}/doc/#{language}",
+         related_product_link)
+    end
+  end
+end
+
+namespace :doc do
+  desc "Run documentation server"
+  task :server => related_product_paths do
+    Dir.chdir("doc") do
+      sh("jekyll", "server", "--watch")
+    end
+  end
+end
+
 namespace :html do
   screenshots = []
 
-  languages = ["ja", "en"]
   languages.each do |lang|
     screenshots_dir = "doc/images/screenshots/#{lang}"
     directory screenshots_dir
@@ -153,7 +180,7 @@ EOC
   end
 
   desc "generate HTML and needed files."
-  task :generate => screenshots do
+  task :generate => related_product_paths + screenshots do
     Dir.chdir("doc") do
       rm_rf("_site")
       ruby("-S", "jekyll", "build")
@@ -162,24 +189,67 @@ EOC
 
   namespace :publish do
     dependencies = ["html:generate"]
-    rsync_command_line = [
-      "rsync", "-avz", "--delete",
-      "--exclude", "*.svn",
+    exclude_paths = [
       "--exclude", "*-raw.png",
       "--exclude", "*.svg",
       "--exclude", "*.rab",
       "--exclude", "/download/",
       "--exclude", "/samples/",
-      "doc/_site/",
     ]
     desc "publish HTML to remote."
-    task :remote => dependencies do
-      sh(*(rsync_command_line + [rsync_base_path]))
+    task :remote do
+      Dir.mktmpdir do |dir|
+        chdir(dir) do
+          if (ENV["USE_RELEASE"] || "yes") == "yes"
+            url = "https://github.com/rabbit-shocker/rabbit/releases/download/" +
+                  "#{version}/docs.tar.gz"
+            URI.open(url) do |response|
+              File.open("docs.tar.gz", "wb") do |output|
+                IO.copy_stream(response, output)
+              end
+            end
+          else
+            workflow_id = IO.pipe do |input, output|
+              sh("gh",
+                 "run",
+                 "list",
+                 "--jq", ".[].databaseId",
+                 "--json", "databaseId",
+                 "--limit", "1",
+                 "--repo", "rabbit-shocker/rabbit",
+                 "--status", "success",
+                 "--workflow", "release.yaml",
+                 out: output)
+              output.close
+              input.read.chomp
+            end
+            sh("gh",
+               "run",
+               "download",
+               "--repo", "rabbit-shocker/rabbit",
+               workflow_id)
+            mv("docs/docs.tar.gz", "./")
+          end
+          sh("tar", "xf", "docs.tar.gz")
+          sh("rsync",
+             "-avz",
+             # "--delete",
+             # "--dry-run",
+             *exclude_paths,
+             "docs/",
+             rsync_base_path)
+        end
+      end
     end
 
     desc "publish HTML to local."
     task :local => dependencies do
-      sh(*(rsync_command_line + [File.expand_path(rsync_local_path)]))
+      sh("rsync",
+         "-avz",
+         "--delete",
+         *exclude_paths,
+         "doc/_site/",
+         File.expand_path(rsync_local_path))
     end
   end
 end
@@ -187,7 +257,7 @@ end
 task :update do
   update_command = ["git", "pull", "--quiet", "--rebase"]
   sh(*update_command)
-  related_projects = ["rabbirack", "rabbiter", "rabwii"]
+  related_projects = ["rabbirack", "rabwii"]
   related_projects.each do |project|
     project_dir = "../#{project}"
     next unless File.exist?(project_dir)
@@ -200,26 +270,6 @@ end
 task :build => "gettext"
 task :package => "gettext"
 
-namespace :package do
-  desc "Upload tar.gz."
-  task :upload => :package do
-    htaccess = ".htaccess"
-    rabbit_tar_gz = "rabbit.tar.gz"
-    current_rabbit_tar_gz = "rabbit-#{version}.tar.gz"
-    File.open(htaccess, "w") do |file|
-      file.puts("Options +Indexes +FollowSymlinks")
-    end
-    ln_s(current_rabbit_tar_gz, rabbit_tar_gz)
-    sh("rsync", "-avz",
-       htaccess,
-       rabbit_tar_gz,
-       "pkg/#{current_rabbit_tar_gz}",
-       "#{rsync_base_path}download/")
-    rm(rabbit_tar_gz)
-    rm(htaccess)
-  end
-end
-
 namespace :github do
   namespace :post_receiver do
     desc "Restart GitHub POST receiver"
@@ -233,29 +283,3 @@ desc "Run test"
 task :test do
   ruby("test/run-test.rb")
 end
-
-namespace :doc do
-  related_products = [
-    "rabwii",
-    "rabbirack",
-    "rabbiter",
-  ]
-  related_product_directories = []
-  related_products.each do |related_product|
-    related_product_directory = "../#{related_product}"
-    related_product_directories << related_product_directory
-    directory related_product_directory do
-      sh("git",
-         "clone",
-         "https://github.com/rabbit-shocker/#{related_product}.git",
-         related_product_directory)
-    end
-  end
-
-  desc "Run documentation server"
-  task :server => related_product_directories do
-    Dir.chdir("doc") do
-      sh("jekyll", "server", "--watch")
-    end
-  end
-end

data/doc/_config.yml

@@ -1,6 +1,6 @@
 markdown: kramdown
-version: 3.0.3
-release_date: 2023-07-02
+version: 3.0.5
+release_date: 2025-03-30
 rabbiter_version: 2.0.3
 rabbiter_release_date: 2016-08-21
 rabbirack_version: 2.0.0

data/doc/en/how-to-make/markdown.md

@@ -40,8 +40,34 @@ title page.
 This example shows the author is Kouhei Sutou and his
 institution is COZMIXNG.
 
-At the moment, you can specify subtitle, content_source and
-even the theme. "theme" is for the default theme of this slide.
+Available attributes are:
+
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  The default allotted time in presentation. Used if not
+  specified when starting Rabbit. If both `start_time`
+  and `end_time` are specified, no need to specify
+  `allotted_time` as it will be calculated from those
+  attributes.
+
+* theme
+
+  The default theme of this slide. Used if not specified
+  when starting Rabbit.
 
 ### Emphasis
 

data/doc/en/how-to-make/rd.rd

@@ -41,8 +41,34 @@ title page.
 This example shows the author is Kouhei Sutou and his
 institution is COZMIXNG.
 
-At the moment, you can specify subtitle, content_source and
-even the theme. "theme" is for the default theme of this slide.
+Available attributes are:
+
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  The default allotted time in presentation. Used if not
+  specified when starting Rabbit. If both (({start_time}))
+  and (({end_time})) are specified, no need to specify
+  (({allotted_time})) as it will be calculated from those
+  attributes.
+
+* theme
+
+  The default theme of this slide. Used if not specified
+  when starting Rabbit.
 
 == Image
 

data/doc/en/install/homebrew.rd

@@ -15,23 +15,8 @@ This document describes how to install Rabbit with Homebrew and RubyGems on macO
 
 Follow the instruction on ((<URL:https://brew.sh>)).
 
-=== Install softwares Rabbit needs
-
-  $ brew install cairo
-  $ brew install pango
-  $ brew install gtk+
-  $ brew install gobject-introspection
-  $ brew install poppler
-
 === Install Rabbit
 
 Exec gem install.
 
   $ gem install rabbit
-  $ gem install rabbiter # If you want to use Twitter related features
-
-=== Set environment variable
-
-Add the following to your ~/.bach_login or ~/.zshenv:
-
-  export DYLD_LIBRARY_PATH=/usr/local/opt/cairo/lib

data/doc/en/news.rd

@@ -4,6 +4,87 @@ title: News
 ---
 {% raw %}
 
+== 3.0.5: 2025-03-30
+
+=== Improvements
+
+==== rabbit
+
+  * Improved source content detection.
+    * ((<GH-172|URL:https://github.com/rabbit-shocker/rabbit/issues/172>))
+    * Reported by NAITOH Jun
+
+=== Thanks
+
+  * NAITOH Jun
+
+== 3.0.4: 2025-03-23
+
+=== Improvements
+
+==== Documentation
+
+  * Added metadata for title slide.
+    * ((<GH-165|URL:https://github.com/rabbit-shocker/rabbit/issues/165>))
+    * Patch by makicamel
+
+==== rabbit
+
+  * Draw: Added support for dash.
+
+  * Highlight: Dropped support for highlighting by Emacs.
+
+  * RD: Added support for Font Awesome.
+
+  * Chart: Added support for
+    ((<Charty|URL:https://github.com/red-data-tools/charty>))
+
+  * Info window: Changed to set color explicitly.
+
+  * Removed NKF dependency.
+
+  * Added support for Ruby 3.4.
+    * ((<GH-170|URL:https://github.com/rabbit-shocker/rabbit/issues/170>))
+    * Patch by HASUMI Hitoshi
+
+  * Dropped support for Clutter.
+
+  * GL: Removed methods that render build-in 3D objects.
+
+=== Fixes
+
+==== All
+
+  * Fixed typos.
+    * ((<GH-159|URL:https://github.com/rabbit-shocker/rabbit/issues/159>))
+    * Patch by kojix2
+
+==== Docs
+
+  * Fixed the default public level.
+    * ((<GH-162|URL:https://github.com/rabbit-shocker/rabbit/issues/162>))
+    * Patch by makicamel
+
+==== rabbit
+
+  * Fixed a bug that timer isn't reset by ((%Alt+t%)).
+    * ((<GH-158|URL:https://github.com/rabbit-shocker/rabbit/issues/158>))
+    * Reported by Kingdon Barrett
+
+  * dRuby: Fixed a crash bug with slide move operations on macOS.
+    * ((<GH-161|URL:https://github.com/rabbit-shocker/rabbit/issues/161>))
+    * Reported by makicamel
+
+=== Thanks
+
+  * Kingdon Barrett
+
+  * kojix2
+
+  * makicamel
+
+  * HASUMI Hitoshi
+
 == 3.0.3: 2023-07-02
 
 Minor bug fix release.

data/doc/en/sample/hiki/rabbit.hiki

@@ -163,7 +163,7 @@ A presentation tool
 	   :relative_margin_right => -5,
 	 })}}
 
-* Right justified backgorund image
+* Right justified background image
 * Specify in slide
 ** :align => "right"
 

data/doc/en/sample/markdown/rabbit.md

@@ -148,7 +148,7 @@ background-image-relative-margin-right
 
 ![](lavie.png){:relative_width="30" align="right" relative_margin_right="-5"}
 
-* Right justified backgorund image
+* Right justified background image
 * Specify in slide
   * \{:align="right"\}
 

data/doc/en/sample/rd/rabbit.rd

@@ -171,7 +171,7 @@ title: "Sample slide: Rabbit"
   #    # vertical-align = top
       # relative-margin-right = -5
 
-    * Right justified backgorund image
+    * Right justified background image
     * Specify in slide
       * align = right
 

data/doc/en/usage/rabbit-slide.rd

@@ -95,7 +95,7 @@ You can confirm all patermeters by ((%--help%)):
           --tags=TAG,TAG,...           Tags of the new slide
                                        (e.g.: --tags=rabbit,presentation,ruby)
                                        (optional)
-          --allotted-time=TIME         Allotted time in presentaion
+          --allotted-time=TIME         Allotted time in presentation
                                        (e.g.: --allotted-time=5m)
                                        (optional)
           --presentation-date=DATE     Presentation date with the new slide

data/doc/en/usage/rabbit.rd

@@ -333,7 +333,7 @@ with the following.
    change-source, source and all. The later the public level
    indicates that Rabbit publishes more functions.
 
-   Default is strict.
+   Default is all.
 
 : --comment-source=FILE
    Specifies initial comment source file name.

data/doc/ja/how-to-make/markdown.md

@@ -43,12 +43,32 @@ title: Markdown記法でのスライドの作り方
 この例では、作者が須藤功平で、所属がCOZMIXNGであるということ
 を示しています。
 
-現在のところ、authorとinstitution以外にsubtitle、
-content_source、themeというメタ情報が指定できます。themeは、
-Rabbitを起動するときにテーマが指定されなかった場合に使用され
-るテーマになります。
+以下の属性が指定可能です:
 
-TODO: 他にもメタデータが増えているはず。
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  プレゼンの持ち時間です。Rabbitを起動するときに指定しなかった場合に
+  使用されます。`start_time`と`end_time`を両方指定している
+  場合はそれらの属性から計算されるため、`allotted_time`を指定する
+  必要はありません。
+
+* theme
+
+  テーマです。Rabbitを起動するときに指定しなかった場合に使用されます。
 
 ### 強調
 

data/doc/ja/how-to-make/rd.rd

@@ -41,12 +41,32 @@ RDではマークアップの使い方が通常の文書の場合と異なりま
 この例では、作者が須藤功平で、所属がCOZMIXNGであるということ
 を示しています。
 
-現在のところ、authorとinstitution以外にsubtitle、
-content_source、themeというメタ情報が指定できます。themeは、
-Rabbitを起動するときにテーマが指定されなかった場合に使用され
-るテーマになります。
+以下の属性が指定可能です:
 
-TODO: 他にもメタデータが増えているはず。
+* author
+
+* institution
+
+* subtitle
+
+* content_source
+
+* date
+
+* start_time
+
+* end_time
+
+* allotted_time
+
+  プレゼンの持ち時間です。Rabbitを起動するときに指定しなかった場合に
+  使用されます。(({start_time}))と(({end_time}))を両方指定している
+  場合はそれらの属性から計算されるため、(({allotted_time}))を指定する
+  必要はありません。
+
+* theme
+
+  テーマです。Rabbitを起動するときに指定しなかった場合に使用されます。
 
 === 画像
 

data/doc/ja/install/homebrew.rd

@@ -16,23 +16,8 @@ Rabbit をインストール、利用する手順について説明します。
 
 ((<URL:https://brew.sh/>)) に記載の方法に従ってインストールしてください。
 
-==== brew install の実行
-
-  $ brew install cairo
-  $ brew install pango
-  $ brew install gtk+
-  $ brew install gobject-introspection
-  $ brew install poppler
-
 === Rabbit のインストール
 
 gem install を実行します。
 
   $ sudo gem install rabbit
-  $ sudo gem install rabbiter # Twitter連携機能を使う場合
-
-=== 環境変数の設定
-
-~/.bash_loginあるいは~/.zshenvで以下のようにDYLD_LIBRARY_PATH環境変数を設定します。
-
-  export DYLD_LIBRARY_PATH=/usr/local/opt/cairo/lib