review-retrovert 0.3.3 → 0.9.1

data/testdata/mybook/lib/tasks/mytasks.rake

@@ -0,0 +1,31 @@
+# -*- coding: utf-8 -*-
+
+##
+## これはreviewstarterが用意したファイル。
+## ユーザ独自のRakeタスクをここに定義する。
+##
+
+
+#
+#def render_eruby_files(param)   # 要 Ruby >= 2.2
+#  Dir.glob('**/*.eruby').each do |erubyfile|
+#    origfile = erubyfile.sub(/\.eruby$/, '')
+#    sh "erb -T 2 '#{param}' #{erubyfile} > #{origfile}"
+#  end
+#end
+#
+#
+#namespace :setup do
+#
+#  desc "*印刷用に設定 (B5, 10pt, mono)"
+#  task :printing do
+#    render_eruby_files('buildmode=printing')
+#  end
+#
+#  desc "*タブレット用に設定 (A5, 10pt, color)"
+#  task :tablet do
+#    render_eruby_files('buildmode=tablet')
+#  end
+#
+#end
+#

data/testdata/mybook/lib/tasks/review.rake

@@ -0,0 +1,142 @@
+require 'fileutils'
+require 'rake/clean'
+
+BOOK = 'book'
+BOOK_PDF = BOOK + '.pdf'
+BOOK_EPUB = BOOK + '.epub'
+CONFIG_FILE = 'config.yml'
+WEBROOT = 'webroot'
+
+def build(mode, chapter)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml' }
+  FileUtils.mv 'tmp', chapter.gsub(/re\z/, mode_ext[mode])
+end
+
+def build_all(mode)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css"
+end
+
+def config_file()
+  conf = ENV['config']
+  conf = CONFIG_FILE if conf.nil? || conf.empty?
+  return conf
+end
+
+task default: :html_all
+
+desc 'build html (Usage: rake build re=target.re)'
+task :html => :prepare do
+  if ENV['re'].nil?
+    puts 'Usage: rake build re=target.re'
+    exit
+  end
+  build('html', ENV['re'])
+end
+
+desc 'build all html'
+task :html_all => :prepare do
+  build_all('html')
+end
+
+desc 'preproc all'
+task :preproc => :prepare do
+  Dir.glob('*.re').each do |file|
+    sh "review-preproc --replace #{file}"
+  end
+end
+
+desc 'generate PDF and EPUB file'
+task all: %i[pdf epub]
+
+desc 'generate PDF file'
+task :pdf => :prepare do
+  require 'review'
+  #require 'review/pdfmaker'
+  require './lib/ruby/review-pdfmaker'
+  #
+  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK + '-pdf']
+  begin
+    ReVIEW::PDFMaker.execute(config_file())
+  rescue RuntimeError => ex
+    if ex.message =~ /^failed to run command:/
+      abort "*\n* ERROR (review-pdfmaker):\n*  #{ex.message}\n*"
+    else
+      raise
+    end
+  end
+end
+
+desc 'generate EPUB file'
+task :epub => :prepare do
+  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK + '-epub']
+  #sh "review-epubmaker #{config_file()}"
+  require 'review'
+  require './lib/ruby/review-epubmaker'
+  ReVIEW::EpubMaker.execute(config_file())
+end
+
+desc 'generate stagic HTML file for web'
+task :web => :prepare do
+  FileUtils.rm_rf [WEBROOT]
+  #sh "review-webmaker #{config_file()}"
+  require 'review'
+  #require 'review/webmaker'
+  require './lib/ruby/review-webmaker'
+  ReVIEW::WEBMaker.execute(config_file())
+end
+
+
+#desc "+ copy *.re files under 'contents/' into here."
+task :prepare do
+  require 'yaml'
+  config = YAML.load_file(config_file())
+  PREPARES.each do |x|
+    case x
+    when Proc; x.call(config)
+    else     ; __send__(x, config)
+    end
+  end
+end
+
+## 前処理を追加したい場合は、関数名またはProcオブジェクトをこの配列に追加する
+PREPARES = [:copy_files_under_contentdir]
+
+def copy_files_under_contentdir(config)
+  ## 設定ファイル (config.yml) の「contentdir:」の値を調べる
+  contdir = config['contentdir']
+  if contdir && contdir != '.'  # '.' はカレントディレクトリを表すので対象外
+    ## もし contentdir が存在しなければエラー
+    unless File.directory?(contdir)
+      abort_with_message <<END
+ERROR: Content directory '#{contdir}' not exist.
+       Please check 'contentdir:' value in config file,
+       or create '#{contdir}' directory and put *.re files into there.
+END
+    end
+    ## カレントディレクトリに *.re ファイルがあればエラー
+    unless Dir.glob('*.re').empty?
+      re_file = Dir.glob('*.re').sort.first
+      abort_with_message <<END
+ERROR: File '#{re_file}' found in current directory.
+       When 'contentdir:' specifieid in config file,
+       you must put all *.re files into that directory.
+       Please remove *.re files from current directory.
+END
+    end
+    ## contentdir にある *.re ファイルをカレントディレクトリにコピー
+    cp Dir.glob(File.join(contdir, '*.re')), '.', :verbose=>false
+    ## コピーしたファイルをRakeプロセス終了時に削除
+    at_exit { rm_f Dir.glob('*.re'), :verbose=>false }
+  end
+end
+
+def abort_with_message(error_msg)
+  $stderr.puts "***"
+  $stderr.puts error_msg.gsub(/^/, '*** ')
+  $stderr.puts "***"
+  abort()
+end
+
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math'])

data/testdata/mybook/lib/tasks/review.rake.orig

@@ -0,0 +1,72 @@
+require 'fileutils'
+require 'rake/clean'
+
+BOOK = 'book'
+BOOK_PDF = BOOK + '.pdf'
+BOOK_EPUB = BOOK + '.epub'
+CONFIG_FILE = 'config.yml'
+WEBROOT = 'webroot'
+
+def build(mode, chapter)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css #{chapter} > tmp"
+  mode_ext = { 'html' => 'html', 'latex' => 'tex', 'idgxml' => 'xml' }
+  FileUtils.mv 'tmp', chapter.gsub(/re\z/, mode_ext[mode])
+end
+
+def build_all(mode)
+  sh "review-compile --target=#{mode} --footnotetext --stylesheet=style.css"
+end
+
+task default: :html_all
+
+desc 'build html (Usage: rake build re=target.re)'
+task :html do
+  if ENV['re'].nil?
+    puts 'Usage: rake build re=target.re'
+    exit
+  end
+  build('html', ENV['re'])
+end
+
+desc 'build all html'
+task :html_all do
+  build_all('html')
+end
+
+desc 'preproc all'
+task :preproc do
+  Dir.glob('*.re').each do |file|
+    sh "review-preproc --replace #{file}"
+  end
+end
+
+desc 'generate PDF and EPUB file'
+task all: %i[pdf epub]
+
+desc 'generate PDF file'
+task pdf: BOOK_PDF
+
+desc 'generate stagic HTML file for web'
+task web: WEBROOT
+
+desc 'generate EPUB file'
+task epub: BOOK_EPUB
+
+SRC = FileList['*.re'] + [CONFIG_FILE]
+
+file BOOK_PDF => SRC do
+  FileUtils.rm_rf [BOOK_PDF, BOOK, BOOK + '-pdf']
+  sh "review-pdfmaker #{CONFIG_FILE}"
+end
+
+file BOOK_EPUB => SRC do
+  FileUtils.rm_rf [BOOK_EPUB, BOOK, BOOK + '-epub']
+  sh "review-epubmaker #{CONFIG_FILE}"
+end
+
+file WEBROOT => SRC do
+  FileUtils.rm_rf [WEBROOT]
+  sh "review-webmaker #{CONFIG_FILE}"
+end
+
+CLEAN.include([BOOK, BOOK_PDF, BOOK_EPUB, BOOK + '-pdf', BOOK + '-epub', WEBROOT, 'images/_review_math'])

data/testdata/mybook/lib/tasks/starter.rake

@@ -0,0 +1,326 @@
+# -*- coding: utf-8 -*-
+
+
+WEBSERVER_PORT = 9000
+
+
+##
+## 生成したファイルを削除
+##
+task :clean do
+  require 'yaml'
+  config = File.open("config.yml", 'r', encoding: 'utf-8') {|f| YAML.load(f) }
+  x = config['bookname']  or abort("ERROR: missing 'bookname' in config.yml")
+  files = [x+".pdf", x+"-pdf", x+".epub", x+"-epub", "webroot"]
+  files = files.select {|x| File.exist?(x) }
+  rm_rf files unless files.empty?
+end
+
+
+
+##
+## Docker用のタスク。
+##
+namespace :docker do
+
+  docker_image = ENV['DOCKER_IMAGE']
+  docker_image = "kauplan/review2.5" if docker_image.to_s.empty?
+  docker_opts  = "--rm -v $PWD:/work -w /work"
+  docker_opts += ENV.keys().grep(/^STARTER_/).map {|k| " -e #{k}" }.join()
+
+  desc "+ pull docker image for building PDF file"
+  task :setup do
+    sh "docker pull #{docker_image}"
+  end
+
+  docker_run = proc do |command, opt=nil|
+    sh "docker run #{docker_opts} #{opt} #{docker_image} #{command}"
+  end
+
+  desc "+ run 'rake pdf' on docker"
+  task :pdf do docker_run.call('rake pdf') end
+
+  desc "+ run 'rake pdf:nombre' on docker"
+  task :'pdf:nombre' do docker_run.call('rake pdf:nombre') end
+
+  desc "+ run 'rake epub' on docker"
+  task :epub do docker_run.call('rake epub') end
+
+  desc "+ run 'rake web' on docker"
+  task :web do docker_run.call('rake web') end
+
+  desc "+ run 'rake web:server' on docker"
+  task :'web:server' do
+    port = WEBSERVER_PORT
+    opt  = "-it -p #{port}:#{port+1} -e WEBSERVER_PORT=#{port+1}"
+    docker_run.call('rake web:server', opt)
+  end
+
+end
+
+
+##
+## PDFにノンブルを入れるためのRakeタスク。
+## ノンブルについては「ワンストップ！技術同人誌を書こう」第10章を参照のこと。
+## https://booth.pm/ja/items/708196
+##
+namespace :pdf do
+
+  desc "+ add nombre (rake pdf:nombre [file=*.pdf] [out=*.pdf])"
+  task :nombre do
+    infile  = ENV['file']; infile  = nil if infile  && infile.empty?
+    outfile = ENV['out'] ; outfile = nil if outfile && outfile.empty?
+    #
+    begin
+      require 'combine_pdf'
+    rescue LoadError
+      abort "ERROR: 'combine_pdf' gem not installed; please run `gem install combine_pdf` at first."
+    end
+    #
+    class CombinePDF::PDF
+      def add_nombre(options={})
+        start    = options[:start]    || 1
+        margin_h = options[:margin_h] || 5
+        margin_w = options[:margin_w] || 2
+        font     = options[:font]     || :Helvetica
+        size     = options[:size]     || 6
+        color    = options[:color]    || [0.5, 0.5, 0.5]  # gray
+        binding  = options[:binding]  || :left
+        digit_w, digit_h = CombinePDF::Fonts.dimensions_of("9", font, size)
+        box_w = digit_w * 1.2
+        box_h = digit_h * 1.3
+        is_left = binding == :left
+        params = {
+          x: nil, y: nil, width: box_w, height: box_h,
+          font: font, font_size: size, font_color: color,
+        }
+        self.pages.each.with_index(start) do |page, page_num|
+          mediabox = page[:CropBox] || page[:MediaBox]  or
+            abort "ERROR: failed to get page size of pdf"
+          page_w = mediabox[2]
+          page_h = mediabox[3]
+          top    = page_h - margin_h
+          bottom = margin_h
+          left   = margin_w
+          right  = page_w - margin_w - box_w
+          params[:x] = is_left ? left : right
+          params[:y] = bottom
+          page_num.to_s.reverse.each_char do |c|
+            page.textbox(c, params)
+            params[:y] += box_h
+          end
+          is_left = ! is_left
+        end
+        self
+      end
+    end
+    #
+    if infile.nil?
+      require 'yaml'
+      config = File.open("config.yml", 'r', encoding: 'utf-8') {|f| YAML.load(f) }
+      bookname = config['bookname']  or abort("ERROR: missing 'bookname' in config.yml")
+      infile = bookname + ".pdf"
+    end
+    File.file?(infile)  or abort("ERROR: #{infile}: pdf file not found.")
+    if outfile.nil?
+      #outfile = infile.sub(/\.pdf$/, '_nombre.pdf')
+      outfile = infile
+    end
+    #
+    #pdf = CombinePDF.parse(File.binread(infile))
+    #pdf.add_nombre()
+    #File.binwrite(outfile, pdf.to_pdf())
+    pdf = CombinePDF.load(infile)
+    pdf.add_nombre()
+    pdf.save(outfile)
+  end
+
+end
+
+
+##
+## プレビュー用のサーバを起動する
+##
+namespace :web do
+
+  invoke_web_task = proc do
+    #sh "rake web"
+    Process.fork { Rake::Task['web'].invoke() }
+    Process.wait()
+  end
+
+  helper_message_when_start_server = <<END
+*
+* Please open http://localhost:#{WEBSERVER_PORT}/ in browser.
+*
+END
+
+  helper_message_when_address_already_in_use = <<END
+**
+** ERROR: Failed to start web server.
+**
+** Other webserver process seems running. Kill it and restart webserver.
+**
+** How to:
+**   $ ps | head -1; ps | grep web[:]server
+**     PID TTY           TIME CMD
+**   12345 ttys002    0.00.35 /usr/bin/ruby /usr/bin/rake web:server
+**   $ kill -KILL 12345
+**   $ rake web:server
+**
+END
+
+  favicon_base64 = <<END
+AAABAAEAEBACAAEAAQCwAAAAFgAAACgAAAAQAAAAIAAAAAEAAQAAAAAAgAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAA////AAAAAAAAAAAAAAAAAAAAAAAAAAAA
+AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD/
+/wAA//8AAP//AAD//wAA//8AAP//AAD//wAA//8AAP//AAD//wAA//8AAP//
+AAD//wAA//8AAP//AAD//wAA
+END
+
+  desc "+ start web server for preview"
+  task :server do
+    rebuild_js = (ENV['STARTER_REBUILD_JS'] ||= '/rebuild.js')
+    invoke_web_task.call()
+    #
+    require 'yaml'
+    config = File.open('config.yml') {|f| YAML.load(f) }
+    contdir = config['contentdir']
+    #
+    require 'webrick'
+    root = 'webroot/'
+    host = '0.0.0.0'   # don't use '127.0.0.1' to work on Docker
+    port = ENV['WEBSERVER_PORT'] ? ENV['WEBSERVER_PORT'].to_i : WEBSERVER_PORT
+    onstart = proc { puts helper_message_when_start_server }
+    srvconf = {DocumentRoot: root, BindAddress: host, Port: port, StartCallback: onstart}
+    begin
+      srv = WEBrick::HTTPServer.new(srvconf)
+    rescue Errno::EADDRINUSE => ex
+      at_exit { $stderr.puts helper_message_when_address_already_in_use }
+      raise
+    end
+    #
+    srv.mount_proc('/favicon.ico') do |req, res|
+      res.content_type     = "image/x-icon"
+      res['Cache-Control'] = "public, max-age=#{60*60*24}"
+      res.body = favicon_base64.unpack("m")[0]
+    end
+    #
+    flag_quit = false
+    interval  = 0.8  # seconds
+    srv.mount_proc(rebuild_js) do |req, res|
+      file = nil
+      if req.query_string =~ /\Afile=([^&]*)/
+        file = $1.strip
+        file = nil if file.empty?
+      end
+      #
+      errmsg = nil
+      if file.nil?
+        # pass
+      elsif file !~ /\A[-\w]+\.re\z/
+        errmsg = "invalid file"
+      else
+        file = File.join(contdir, file) if contdir
+        errmsg = "file not found." if ! File.exist?(file)
+      end
+      #
+      if errmsg
+        body = "alert('ERROR: #{errmsg}');"
+      else
+        body = "window.location.reload();"
+        ## sleep until '*.re' file modified
+        if file
+          mtime = File.mtime(file)
+          sleep interval while !flag_quit && mtime == File.mtime(file)
+        end
+        ## generate html file from '*.re'
+        invoke_web_task.call() unless flag_quit
+      end
+      res.content_type = "application/javascript"
+      msg = "Server seems down. Press OK to reload."
+      res.body = !flag_quit ? body : "alert('#{msg}');window.location.reload();"
+    end
+    #
+    trap(:INT) { flag_quit = true; srv.shutdown() }
+    srv.start()
+  end
+
+end
+
+
+##
+## 高解像度用の画像から低解像度の画像を生成するRakeタスク。
+## 詳細は「ワンストップ！技術同人誌を書こう」第8章を参照のこと。
+## https://booth.pm/ja/items/708196
+##
+desc "+ convert images (high resolution -> low resolution)"
+task :images do
+  ## macOSならsipsコマンドを使い、それ以外ではImageMagickを使う
+  has_sips = File.exist?("/usr/bin/sips")
+  if ! has_sips
+    ok = system("convert --version >/dev/null")
+    if ! ok
+      abort "ERROR: 'convert' command not found; please install ImageMagick."
+    end
+  end
+  ## 高解像度の画像をもとに低解像度の画像を作成する
+  for src in Dir.glob("images_highres/**/*.{png,jpg,jpeg}")
+    ## 低解像度の画像を作成済みなら残りの処理をスキップ
+    dest = src.sub("images_highres/", "images_lowres/")
+    next if File.exist?(dest) && File.mtime(src) == File.mtime(dest)
+    ## 必要ならフォルダを作成
+    dir = File.dirname(dest)
+    mkdir_p dir if ! File.directory?(dir)
+    ## 高解像度の画像のDPIを変更（72dpi→360dpi）
+    if has_sips
+      sh "sips -s dpiHeight 360 -s dpiWidth 360 #{src}"
+    else
+      sh "convert -density 360 -units PixelsPerInch #{src} #{src}"
+    end
+    ## 低解像度の画像を作成（72dpi、横幅1/5）
+    if has_sips
+      `sips -g pixelWidth #{src}` =~ /pixelWidth: (\d+)/
+      option = "-s dpiHeight 72 -s dpiWidth 72 --resampleWidth #{$1.to_i / 5}"
+      sh "sips #{option} --out #{dest} #{src}"
+    else
+      sh "convert -density 72 -units PixelsPerInch -resize 20% #{src} #{dest}"
+    end
+    ## 低解像度の画像のタイムスタンプを、高解像度の画像と同じにする
+    ## （＝画像のタイムスタンプが違ったら、画像が更新されたと見なす）
+    File.utime(File.atime(dest), File.mtime(src), dest)
+  end
+  ## 高解像度の画像が消されたら、低解像度の画像も消す
+  for dest in Dir.glob("images_lowres/**/*").sort().reverse()
+    src = dest.sub("images_lowres/", "images_highres/")
+    rm_r dest if ! File.exist?(src)
+  end
+end
+
+
+##
+## 低解像度と高解像度を切り替えるRakeタスク。
+## 詳細は「ワンストップ！技術同人誌を書こう」第8章を参照のこと。
+## https://booth.pm/ja/items/708196
+##
+namespace "images" do
+
+  desc "+ toggle image directories ('images_{lowres,highres}')"
+  task :toggle do
+    if ! File.symlink?("images")
+      msg =  "ERROR: 'images' directory should be a symbolic link.\n"
+      msg << "       rename it and create symbolic link, for example:\n"
+      msg << "  $ mv images images_highres\n"
+      msg << "  $ ln -s images_highres images\n"
+      abort msg
+    end
+    link = File.readlink("images")
+    rm "images"
+    if link == "images_lowres"
+      ln_s "images_highres", "images"
+    else
+      ln_s "images_lowres", "images"
+    end
+  end
+
+end