review 2.3.0 → 2.4.0

data/lib/epubmaker/producer.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # = producer.rb -- EPUB producer.
 #
 # Copyright (c) 2010-2017 Kenshi Muto
@@ -25,12 +23,12 @@ module EPUBMaker
     # Array of content objects.
     attr_accessor :contents
     # Parameter hash.
-    attr_accessor :params
+    attr_accessor :config
     # Message resource object.
     attr_reader :res
 
     # Take YAML +file+ and return parameter hash.
-    def Producer.load(file)
+    def self.load(file)
       raise "Can't open #{file}." if file.nil? || !File.exist?(file)
       loader = ReVIEW::YAMLLoader.new
       loader.load_file(file)
@@ -40,52 +38,48 @@ module EPUBMaker
     def load(file)
       raise "Can't open #{file}." if file.nil? || !File.exist?(file)
       loader = ReVIEW::YAMLLoader.new
-      merge_params(@params.deep_merge(loader.load_file(file)))
+      merge_config(@config.deep_merge(loader.load_file(file)))
     end
 
     # Construct producer object.
-    # +params+ takes initial parameter hash. This parameters can be overriden by EPUBMaker#load or EPUBMaker#merge_params.
+    # +config+ takes initial parameter hash. This parameters can be overriden by EPUBMaker#load or EPUBMaker#merge_config.
     # +version+ takes EPUB version (default is 2).
-    def initialize(params=nil, version=nil)
+    def initialize(config = nil, version = nil)
       @contents = []
-      @params = ReVIEW::Configure.new
+      @config = ReVIEW::Configure.new
       @epub = nil
-      @params["epubversion"] = version unless version.nil?
+      @config['epubversion'] = version unless version.nil?
       @res = ReVIEW::I18n
 
-      if params
-        merge_params(params)
-      end
+      merge_config(config) if config
     end
 
     def coverimage
-      return nil unless params["coverimage"]
+      return nil unless config['coverimage']
       @contents.each do |item|
-        if item.media.start_with?('image') && item.file =~ /#{params["coverimage"]}\Z/ # /
+        if item.media.start_with?('image') && item.file =~ /#{config['coverimage']}\Z/
           return item.file
         end
       end
-      return nil
+      nil
     end
 
-    # Update parameters by merging from new parameter hash +params+.
-    def merge_params(params)
-      @params.deep_merge!(params)
+    # Update parameters by merging from new parameter hash +config+.
+    def merge_config(config)
+      @config.deep_merge!(config)
       complement
 
-      unless @params["epubversion"].nil?
-        case @params["epubversion"].to_i
+      unless @config['epubversion'].nil?
+        case @config['epubversion'].to_i
         when 2
           @epub = EPUBMaker::EPUBv2.new(self)
         when 3
           @epub = EPUBMaker::EPUBv3.new(self)
         else
-          raise "Invalid EPUB version (#{@params["epubversion"]}.)"
+          raise "Invalid EPUB version (#{@config['epubversion']}.)"
         end
       end
-      if params["language"]
-        ReVIEW::I18n.locale = params["language"]
-      end
+      ReVIEW::I18n.locale = config['language'] if config['language']
       support_legacy_maker
     end
 
@@ -103,7 +97,7 @@ module EPUBMaker
 
     # Write ncx file to IO object +wobj+. +indentarray+ defines prefix
     # string for each level.
-    def ncx(wobj, indentarray=[])
+    def ncx(wobj, indentarray = [])
       s = @epub.ncx(indentarray)
       wobj.puts s if !s.nil? && !wobj.nil?
     end
@@ -115,10 +109,10 @@ module EPUBMaker
     end
 
     # Write cover file to IO object +wobj+.
-    # If Producer#params["coverimage"] is defined, it will be used for
+    # If Producer#config["coverimage"] is defined, it will be used for
     # the cover image.
     def cover(wobj)
-      type = (@params["epubversion"] >= 3) ? "cover" : nil
+      type = @config['epubversion'] >= 3 ? 'cover' : nil
       s = @epub.cover(type)
       wobj.puts s if !s.nil? && !wobj.nil?
     end
@@ -143,22 +137,20 @@ module EPUBMaker
 
     # Add informations of figure files in +path+ to contents array.
     # +base+ defines a string to remove from path name.
-    def import_imageinfo(path, base=nil, allow_exts=nil)
+    def import_imageinfo(path, base = nil, allow_exts = nil)
       return nil unless File.exist?(path)
-      allow_exts = @params["image_ext"] if allow_exts.nil?
+      allow_exts = @config['image_ext'] if allow_exts.nil?
       Dir.foreach(path) do |f|
         next if f.start_with?('.')
-        if f =~ /\.(#{allow_exts.join("|")})\Z/i
-          path.chop! if path =~ /\/\Z/
+        if f =~ /\.(#{allow_exts.join('|')})\Z/i
+          path.chop! if path =~ %r{/\Z}
           if base.nil?
-            @contents.push(EPUBMaker::Content.new({"file" => "#{path}/#{f}"}))
+            @contents.push(EPUBMaker::Content.new('file' => "#{path}/#{f}"))
           else
-            @contents.push(EPUBMaker::Content.new({"file" => "#{path.sub(base + "/", '')}/#{f}"}))
+            @contents.push(EPUBMaker::Content.new('file' => "#{path.sub(base + '/', '')}/#{f}"))
           end
         end
-        if FileTest.directory?("#{path}/#{f}")
-          import_imageinfo("#{path}/#{f}", base)
-        end
+        import_imageinfo("#{path}/#{f}", base) if FileTest.directory?("#{path}/#{f}")
       end
     end
 
@@ -167,12 +159,12 @@ module EPUBMaker
     # Produce EPUB file +epubfile+.
     # +basedir+ points the directory has contents (default: current directory.)
     # +tmpdir+ defines temporary directory.
-    def produce(epubfile, basedir=nil, tmpdir=nil)
+    def produce(epubfile, basedir = nil, tmpdir = nil)
       current = Dir.pwd
       basedir = current if basedir.nil?
 
       new_tmpdir = tmpdir.nil? ? Dir.mktmpdir : tmpdir
-      epubfile = "#{current}/#{epubfile}" if epubfile !~ /\A\// # /
+      epubfile = "#{current}/#{epubfile}" if epubfile !~ %r{\A/}
 
       # FIXME: error check
       File.unlink(epubfile) if File.exist?(epubfile)
@@ -185,115 +177,110 @@ module EPUBMaker
     end
 
     def call_hook(filename, *params)
-      if !filename.nil? && File.exist?(filename) && FileTest.executable?(filename)
-        if ENV["REVIEW_SAFE_MODE"].to_i & 1 > 0
-          warn "hook is prohibited in safe mode. ignored."
-        else
-          system(filename, *params)
-        end
+      return if !filename.present? || !File.exist?(filename) || !FileTest.executable?(filename)
+      if ENV['REVIEW_SAFE_MODE'].to_i & 1 > 0
+        warn 'hook is prohibited in safe mode. ignored.'
+      else
+        system(filename, *params)
       end
     end
 
     def isbn_hyphen
-      str = @params["isbn"].to_s
+      str = @config['isbn'].to_s
 
-      if str =~ /\A\d{10}\Z/
-        "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}"
-      elsif str =~ /\A\d{13}\Z/
-        "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}"
-      else
-        nil
-      end
+      return "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}" if str =~ /\A\d{10}\Z/
+      return "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}" if str =~ /\A\d{13}\Z/
+      nil
     end
 
     private
 
     # Complement parameters.
     def complement
-      @params["htmlext"] = "html" if @params["htmlext"].nil?
-      defaults = ReVIEW::Configure.new.merge({
-                                               "language" => "ja",
-                                               "date" => Time.now.strftime("%Y-%m-%d"),
-                                               "modified" => Time.now.strftime("%Y-%02m-%02dT%02H:%02M:%02SZ"),
-                                               "isbn" => nil,
-                                               "toclevel" => 2,
-                                               "stylesheet" => [],
-                                               "epubversion" => 3,
-                                               "htmlversion" => 5,
-                                               "secnolevel" => 2,
-                                               "pre_secnolevel" => 0,
-                                               "post_secnolevel" => 1,
-                                               "part_secnolevel" => 1,
-                                               "titlepage" => nil,
-                                               "titlefile" => nil,
-                                               "originaltitlefile" => nil,
-                                               "profile" => nil,
-                                               "colophon" => nil,
-                                               "colophon_order" => %w[aut csl trl dsr ill edt pbl prt pht],
-                                               "direction" => "ltr",
-                                               "epubmaker" => {
-                                                 "flattoc" => nil,
-                                                 "flattocindent" => true,
-                                                 "ncx_indent" => [],
-                                                 "zip_stage1" => "zip -0Xq",
-                                                 "zip_stage2" => "zip -Xr9Dq",
-                                                 "zip_addpath" => nil,
-                                                 "hook_beforeprocess" => nil,
-                                                 "hook_afterfrontmatter" => nil,
-                                                 "hook_afterbody" => nil,
-                                                 "hook_afterbackmatter" => nil,
-                                                 "hook_aftercopyimage" => nil,
-                                                 "hook_prepack" => nil,
-                                                 "rename_for_legacy" => nil,
-                                                 "verify_target_images" => nil,
-                                                 "force_include_images" => [],
-                                                 "cover_linear" => nil,
-                                               },
-                                               "externallink" => true,
-                                               "imagedir" => "images",
-                                               "fontdir" => "fonts",
-                                               "image_ext" => %w(png gif jpg jpeg svg ttf woff otf),
-                                               "font_ext" => %w(ttf woff otf),
-                                             })
-
-      @params = defaults.deep_merge(@params)
-      @params["title"] = @params["booktitle"] unless @params["title"]
+      @config['htmlext'] = 'html' if @config['htmlext'].nil?
+      defaults = ReVIEW::Configure.new.merge(
+        'language' => 'ja',
+        'date' => Time.now.strftime('%Y-%m-%d'),
+        'modified' => Time.now.strftime('%Y-%02m-%02dT%02H:%02M:%02SZ'),
+        'isbn' => nil,
+        'toclevel' => 2,
+        'stylesheet' => [],
+        'epubversion' => 3,
+        'htmlversion' => 5,
+        'secnolevel' => 2,
+        'pre_secnolevel' => 0,
+        'post_secnolevel' => 1,
+        'part_secnolevel' => 1,
+        'titlepage' => true,
+        'titlefile' => nil,
+        'originaltitlefile' => nil,
+        'profile' => nil,
+        'colophon' => nil,
+        'colophon_order' => %w[aut csl trl dsr ill edt pbl prt pht],
+        'direction' => 'ltr',
+        'epubmaker' => {
+          'flattoc' => nil,
+          'flattocindent' => true,
+          'ncx_indent' => [],
+          'zip_stage1' => 'zip -0Xq',
+          'zip_stage2' => 'zip -Xr9Dq',
+          'zip_addpath' => nil,
+          'hook_beforeprocess' => nil,
+          'hook_afterfrontmatter' => nil,
+          'hook_afterbody' => nil,
+          'hook_afterbackmatter' => nil,
+          'hook_aftercopyimage' => nil,
+          'hook_prepack' => nil,
+          'rename_for_legacy' => nil,
+          'verify_target_images' => nil,
+          'force_include_images' => [],
+          'cover_linear' => nil
+        },
+        'externallink' => true,
+        'imagedir' => 'images',
+        'fontdir' => 'fonts',
+        'image_ext' => %w[png gif jpg jpeg svg ttf woff otf],
+        'image_maxpixels' => 4_000_000,
+        'font_ext' => %w[ttf woff otf]
+      )
+
+      @config = defaults.deep_merge(@config)
+      @config['title'] = @config['booktitle'] unless @config['title']
 
       deprecated_parameters = {
-        "ncxindent" => "epubmaker:ncxindent",
-        "flattoc" => "epubmaker:flattoc",
-        "flattocindent" => "epubmaker:flattocindent",
-        "hook_beforeprocess" => "epubmaker:hook_beforeprocess",
-        "hook_afterfrontmatter" => "epubmaker:hook_afterfrontmatter",
-        "hook_afterbody" => "epubmaker:hook_afterbody",
-        "hook_afterbackmatter" => "epubmaker:hook_afterbackmatter",
-        "hook_aftercopyimage" => "epubmaker:hook_aftercopyimage",
-        "hook_prepack" => "epubmaker:hook_prepack",
-        "rename_for_legacy" => "epubmaker:rename_for_legacy",
-        "zip_stage1" => "epubmaker:zip_stage1",
-        "zip_stage2" => "epubmaker:zip_stage2",
-        "zip_addpath" => "epubmaker:zip_addpath",
-        "verify_target_images" => "epubmaker:verify_target_images",
-        "force_include_images" => "epubmaker:force_include_images",
-        "cover_linear" => "epubmaker:cover_linear",
+        'ncxindent' => 'epubmaker:ncxindent',
+        'flattoc' => 'epubmaker:flattoc',
+        'flattocindent' => 'epubmaker:flattocindent',
+        'hook_beforeprocess' => 'epubmaker:hook_beforeprocess',
+        'hook_afterfrontmatter' => 'epubmaker:hook_afterfrontmatter',
+        'hook_afterbody' => 'epubmaker:hook_afterbody',
+        'hook_afterbackmatter' => 'epubmaker:hook_afterbackmatter',
+        'hook_aftercopyimage' => 'epubmaker:hook_aftercopyimage',
+        'hook_prepack' => 'epubmaker:hook_prepack',
+        'rename_for_legacy' => 'epubmaker:rename_for_legacy',
+        'zip_stage1' => 'epubmaker:zip_stage1',
+        'zip_stage2' => 'epubmaker:zip_stage2',
+        'zip_addpath' => 'epubmaker:zip_addpath',
+        'verify_target_images' => 'epubmaker:verify_target_images',
+        'force_include_images' => 'epubmaker:force_include_images',
+        'cover_linear' => 'epubmaker:cover_linear'
       }
 
       deprecated_parameters.each_pair do |k, v|
-        unless @params[k].nil?
-          sa = v.split(":", 2)
-          warn "Parameter #{k} is deprecated. Use:\n#{sa[0]}:\n  #{sa[1]}: ...\n\n"
-          @params[sa[0]][sa[1]] = @params[k]
-          @params.delete(k)
-        end
+        next if @config[k].nil?
+        sa = v.split(':', 2)
+        warn "Parameter #{k} is deprecated. Use:\n#{sa[0]}:\n  #{sa[1]}: ...\n\n"
+        @config[sa[0]][sa[1]] = @config[k]
+        @config.delete(k)
       end
 
-      @params["htmlversion"] = 5 if @params["epubversion"] >= 3
+      @config['htmlversion'] = 5 if @config['epubversion'] >= 3
 
-      @params.maker = "epubmaker"
-      @params["cover"] = "#{@params["bookname"]}.#{@params["htmlext"]}" unless @params["cover"]
+      @config.maker = 'epubmaker'
+      @config['cover'] = "#{@config['bookname']}.#{@config['htmlext']}" unless @config['cover']
 
       %w[bookname title].each do |k|
-        raise "Key #{k} must have a value. Abort." unless @params[k]
+        raise "Key #{k} must have a value. Abort." unless @config[k]
       end
       # array
       %w[subject aut
@@ -302,8 +289,8 @@ module EPUBMaker
          adp ann arr art asn aut aqt aft aui ant bkp clb cmm dsr edt
          ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl
          stylesheet rights].each do |item|
-        next unless @params[item]
-        @params[item] = [@params[item]] if @params[item].kind_of?(String)
+        next unless @config[item]
+        @config[item] = [@config[item]] if @config[item].is_a?(String)
       end
       # optional
       # type, format, identifier, source, relation, coverpage, aut
@@ -311,36 +298,36 @@ module EPUBMaker
 
     def support_legacy_maker
       # legacy review-epubmaker support
-      if @params["flag_legacy_coverfile"].nil? && !@params["coverfile"].nil? && File.exist?(@params["coverfile"])
-        @params["cover"] = "#{@params["bookname"]}-cover.#{@params["htmlext"]}"
-        @epub.legacy_cover_and_title_file(@params["coverfile"], @params["cover"])
-        @params["flag_legacy_coverfile"] = true
-        warn "Parameter 'coverfile' is obsolete. Please use 'cover' and make complete html file with header and footer."
+      if @config['flag_legacy_coverfile'].nil? && !@config['coverfile'].nil? && File.exist?(@config['coverfile'])
+        @config['cover'] = "#{@config['bookname']}-cover.#{@config['htmlext']}"
+        @epub.legacy_cover_and_title_file(@config['coverfile'], @config['cover'])
+        @config['flag_legacy_coverfile'] = true
+        warn %Q(Parameter 'coverfile' is obsolete. Please use 'cover' and make complete html file with header and footer.)
       end
 
-      if @params["flag_legacy_titlepagefile"].nil? && !@params["titlepagefile"].nil? && File.exist?(@params["titlepagefile"])
-        @params["titlefile"] = "#{@params["bookname"]}-title.#{@params["htmlext"]}"
-        @params["titlepage"] = true
-        @epub.legacy_cover_and_title_file(@params["titlepagefile"], @params["titlefile"])
-        @params["flag_legacy_titlepagefile"] = true
-        warn "Parameter 'titlepagefile' is obsolete. Please use 'titlefile' and make complete html file with header and footer."
+      if @config['flag_legacy_titlepagefile'].nil? && !@config['titlepagefile'].nil? && File.exist?(@config['titlepagefile'])
+        @config['titlefile'] = "#{@config['bookname']}-title.#{@config['htmlext']}"
+        @config['titlepage'] = true
+        @epub.legacy_cover_and_title_file(@config['titlepagefile'], @config['titlefile'])
+        @config['flag_legacy_titlepagefile'] = true
+        warn %Q(Parameter 'titlepagefile' is obsolete. Please use 'titlefile' and make complete html file with header and footer.)
       end
 
-      if @params["flag_legacy_backcoverfile"].nil? && !@params["backcoverfile"].nil? && File.exist?(@params["backcoverfile"])
-        @params["backcover"] = "#{@params["bookname"]}-backcover.#{@params["htmlext"]}"
-        @epub.legacy_cover_and_title_file(@params["backcoverfile"], @params["backcover"])
-        @params["flag_legacy_backcoverfile"] = true
-        warn "Parameter 'backcoverfile' is obsolete. Please use 'backcover' and make complete html file with header and footer."
+      if @config['flag_legacy_backcoverfile'].nil? && !@config['backcoverfile'].nil? && File.exist?(@config['backcoverfile'])
+        @config['backcover'] = "#{@config['bookname']}-backcover.#{@config['htmlext']}"
+        @epub.legacy_cover_and_title_file(@config['backcoverfile'], @config['backcover'])
+        @config['flag_legacy_backcoverfile'] = true
+        warn %Q(Parameter 'backcoverfile' is obsolete. Please use 'backcover' and make complete html file with header and footer.)
       end
 
-      if @params["flag_legacy_pubhistory"].nil? && !@params["pubhistory"].nil?
-        @params["history"] = [[]]
-        @params["pubhistory"].split("\n").each do |date|
-          @params["history"][0].push(date.sub(/(\d+)年(\d+)月(\d+)日/, '\1-\2-\3'))
-        end
-        @params["flag_legacy_pubhistory"] = true
-        warn "Parameter 'pubhistory' is obsolete. Please use 'history' array."
+      if @config['flag_legacy_pubhistory'].nil? && @config['pubhistory']
+        @config['history'] = [[]]
+        @config['pubhistory'].split("\n").each { |date| @config['history'][0].push(date.sub(/(\d+)年(\d+)月(\d+)日/, '\1-\2-\3')) }
+        @config['flag_legacy_pubhistory'] = true
+        warn %Q(Parameter 'pubhistory' is obsolete. Please use 'history' array.)
       end
+
+      true
     end
   end
 end

data/lib/epubmaker/zip_exporter.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 # Copyright (c) 2010-2017 Kenshi Muto and Masayoshi Takahashi
 #
 # This program is free software.
@@ -13,21 +11,19 @@ begin
   require 'zip'
 rescue LoadError
   ## I cannot find rubyzip library, so I use external zip command.
-  warn "rubyzip not found, so use external zip command"
+  warn 'rubyzip not found, so use external zip command'
 end
 
 module EPUBMaker
-
   ##
   # Export into zip file for EPUB producer.
   #
   class ZipExporter
-
     attr_reader :tmpdir
 
-    def initialize(tmpdir, params)
+    def initialize(tmpdir, config)
       @tmpdir = tmpdir
-      @params = params
+      @config = config
     end
 
     def export_zip(epubfile)
@@ -39,43 +35,42 @@ module EPUBMaker
     end
 
     def export_zip_extcmd(epubfile)
-      stage1 = @params["epubmaker"]["zip_stage1"].to_s.split
-      path1 = stage1[0] || "zip"
-      opt1 = stage1[1] || "-0Xq"
-      stage2 = @params["epubmaker"]["zip_stage2"].to_s.split
-      path2 = stage2[0] || "zip"
-      opt2 = stage2[1] || "-Xr9Dq"
+      stage1 = @config['epubmaker']['zip_stage1'].to_s.split
+      path1 = stage1[0] || 'zip'
+      opt1 = stage1[1] || '-0Xq'
+      stage2 = @config['epubmaker']['zip_stage2'].to_s.split
+      path2 = stage2[0] || 'zip'
+      opt2 = stage2[1] || '-Xr9Dq'
 
-      Dir.chdir(tmpdir) do |d|
-        system(path1, opt1, epubfile, "mimetype")
-        addpath = @params["epubmaker"]["zip_addpath"]
+      Dir.chdir(tmpdir) do
+        system(path1, opt1, epubfile, 'mimetype')
+        addpath = @config['epubmaker']['zip_addpath']
         if addpath
-          system(path2, opt2, epubfile, "META-INF", "OEBPS", addpath)
+          system(path2, opt2, epubfile, 'META-INF', 'OEBPS', addpath)
         else
-          system(path2, opt2, epubfile, "META-INF", "OEBPS")
+          system(path2, opt2, epubfile, 'META-INF', 'OEBPS')
         end
       end
     end
 
     def export_zip_rubyzip(epubfile)
-      Dir.chdir(tmpdir) do |d|
+      Dir.chdir(tmpdir) do
         Zip::OutputStream.open(epubfile) do |epub|
           root_pathname = Pathname.new(tmpdir)
-          # relpath = Pathname.new(File.join(tmpdir,'mimetype')).relative_path_from(root_pathname)
           epub.put_next_entry('mimetype', nil, nil, Zip::Entry::STORED)
-          epub << "application/epub+zip"
+          epub << 'application/epub+zip'
 
-          export_zip_rubyzip_addpath(epub, File.join(tmpdir,'META-INF'), root_pathname)
-          export_zip_rubyzip_addpath(epub, File.join(tmpdir,'OEBPS'), root_pathname)
-          if @params["zip_addpath"].present?
-            export_zip_rubyzip_addpath(epub, File.join(tmpdir, @params["zip_addpath"]), root_pathname)
+          export_zip_rubyzip_addpath(epub, File.join(tmpdir, 'META-INF'), root_pathname)
+          export_zip_rubyzip_addpath(epub, File.join(tmpdir, 'OEBPS'), root_pathname)
+          if @config['zip_addpath'].present?
+            export_zip_rubyzip_addpath(epub, File.join(tmpdir, @config['zip_addpath']), root_pathname)
           end
         end
       end
     end
 
     def export_zip_rubyzip_addpath(epub, dirname, rootdir)
-      Dir[File.join(dirname,'**','**')].each do |path|
+      Dir[File.join(dirname, '**', '**')].each do |path|
         next if File.directory?(path)
         relpath = Pathname.new(path).relative_path_from(rootdir)
         epub.put_next_entry(relpath)