review 2.5.0 → 3.0.0.preview1

data/lib/epubmaker/epubv3.rb

@@ -18,7 +18,9 @@ module EPUBMaker
     def initialize(producer)
       super
       @opf_prefix = {}
-      @producer.config['opf_prefix'].each { |k, v| @opf_prefix[k] = v } if @producer.config['opf_prefix'].present?
+      if @producer.config['opf_prefix'].present?
+        @producer.config['opf_prefix'].each { |k, v| @opf_prefix[k] = v }
+      end
     end
 
     # Return opf file content.
@@ -124,7 +126,11 @@ module EPUBMaker
       end
 
       ## add custom <meta> element
-      @producer.config['opf_meta'].each { |k, v| s << %Q(    <meta property="#{k}">#{CGI.escapeHTML(v)}</meta>\n) } if @producer.config['opf_meta'].present?
+      if @producer.config['opf_meta'].present?
+        @producer.config['opf_meta'].each do |k, v|
+          s << %Q(    <meta property="#{k}">#{CGI.escapeHTML(v)}</meta>\n)
+        end
+      end
 
       s
     end
@@ -178,7 +184,9 @@ EOT
       @producer.contents.each do |item|
         next if item.media !~ /xhtml\+xml/ # skip non XHTML
         if toc.nil? && item.chaptype != 'pre'
-          s << %Q(    <itemref idref="#{@producer.config['bookname']}-toc.#{@producer.config['htmlext']}" />\n) if @producer.config['toc']
+          if @producer.config['toc']
+            s << %Q(    <itemref idref="#{@producer.config['bookname']}-toc.#{@producer.config['htmlext']}" />\n)
+          end
           toc = true
         end
         s << %Q(    <itemref idref="#{item.id}"/>\n)

data/lib/epubmaker/producer.rb

@@ -29,14 +29,18 @@ module EPUBMaker
 
     # Take YAML +file+ and return parameter hash.
     def self.load(file)
-      raise "Can't open #{file}." if file.nil? || !File.exist?(file)
+      if file.nil? || !File.exist?(file)
+        raise "Can't open #{file}."
+      end
       loader = ReVIEW::YAMLLoader.new
       loader.load_file(file)
     end
 
     # Take YAML +file+ and update parameter hash.
     def load(file)
-      raise "Can't open #{file}." if file.nil? || !File.exist?(file)
+      if file.nil? || !File.exist?(file)
+        raise "Can't open #{file}."
+      end
       loader = ReVIEW::YAMLLoader.new
       merge_config(@config.deep_merge(loader.load_file(file)))
     end
@@ -79,33 +83,43 @@ module EPUBMaker
           raise "Invalid EPUB version (#{@config['epubversion']}.)"
         end
       end
-      ReVIEW::I18n.locale = config['language'] if config['language']
+      if config['language']
+        ReVIEW::I18n.locale = config['language']
+      end
       support_legacy_maker
     end
 
     # Write mimetype file to IO object +wobj+.
     def mimetype(wobj)
       s = @epub.mimetype
-      wobj.print s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.print s
+      end
     end
 
     # Write opf file to IO object +wobj+.
     def opf(wobj)
       s = @epub.opf
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # Write ncx file to IO object +wobj+. +indentarray+ defines prefix
     # string for each level.
     def ncx(wobj, indentarray = [])
       s = @epub.ncx(indentarray)
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # Write container file to IO object +wobj+.
     def container(wobj)
       s = @epub.container
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # Write cover file to IO object +wobj+.
@@ -114,32 +128,40 @@ module EPUBMaker
     def cover(wobj)
       type = @config['epubversion'] >= 3 ? 'cover' : nil
       s = @epub.cover(type)
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # Write title file (copying) to IO object +wobj+.
     def titlepage(wobj)
       s = @epub.titlepage
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # Write colophon file to IO object +wobj+.
     def colophon(wobj)
       s = @epub.colophon
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # Write own toc file to IO object +wobj+.
     def mytoc(wobj)
       s = @epub.mytoc
-      wobj.puts s if !s.nil? && !wobj.nil?
+      if !s.nil? && !wobj.nil?
+        wobj.puts s
+      end
     end
 
     # 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)
       return nil unless File.exist?(path)
-      allow_exts = @config['image_ext'] if allow_exts.nil?
+      allow_exts ||= @config['image_ext']
       Dir.foreach(path) do |f|
         next if f.start_with?('.')
         if f =~ /\.(#{allow_exts.join('|')})\Z/i
@@ -150,7 +172,9 @@ module EPUBMaker
             @contents.push(EPUBMaker::Content.new('file' => "#{path.sub(base + '/', '')}/#{f}"))
           end
         end
-        import_imageinfo("#{path}/#{f}", base) if FileTest.directory?("#{path}/#{f}")
+        if FileTest.directory?("#{path}/#{f}")
+          import_imageinfo("#{path}/#{f}", base)
+        end
       end
     end
 
@@ -161,10 +185,12 @@ module EPUBMaker
     # +tmpdir+ defines temporary directory.
     def produce(epubfile, basedir = nil, tmpdir = nil)
       current = Dir.pwd
-      basedir = current if basedir.nil?
+      basedir ||= current
 
       new_tmpdir = tmpdir.nil? ? Dir.mktmpdir : tmpdir
-      epubfile = "#{current}/#{epubfile}" if epubfile !~ %r{\A/}
+      if epubfile !~ %r{\A/}
+        epubfile = "#{current}/#{epubfile}"
+      end
 
       # FIXME: error check
       File.unlink(epubfile) if File.exist?(epubfile)
@@ -188,8 +214,12 @@ module EPUBMaker
     def isbn_hyphen
       str = @config['isbn'].to_s
 
-      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/
+      if str =~ /\A\d{10}\Z/
+        return "#{str[0..0]}-#{str[1..5]}-#{str[6..8]}-#{str[9..9]}"
+      end
+      if str =~ /\A\d{13}\Z/
+        return "#{str[0..2]}-#{str[3..3]}-#{str[4..8]}-#{str[9..11]}-#{str[12..12]}"
+      end
       nil
     end
 
@@ -197,7 +227,7 @@ module EPUBMaker
 
     # Complement parameters.
     def complement
-      @config['htmlext'] = 'html' if @config['htmlext'].nil?
+      @config['htmlext'] ||= 'html'
       defaults = ReVIEW::Configure.new.merge(
         'language' => 'ja',
         'date' => Time.now.strftime('%Y-%m-%d'),
@@ -237,6 +267,7 @@ module EPUBMaker
           'cover_linear' => nil
         },
         'externallink' => true,
+        'contentdir' => '.',
         'imagedir' => 'images',
         'fontdir' => 'fonts',
         'image_ext' => %w[png gif jpg jpeg svg ttf woff otf],
@@ -274,7 +305,9 @@ module EPUBMaker
         @config.delete(k)
       end
 
-      @config['htmlversion'] = 5 if @config['epubversion'] >= 3
+      if @config['epubversion'] >= 3
+        @config['htmlversion'] = 5
+      end
 
       @config.maker = 'epubmaker'
       @config['cover'] = "#{@config['bookname']}.#{@config['htmlext']}" unless @config['cover']
@@ -290,7 +323,9 @@ module EPUBMaker
          ill lyr mdc mus nrt oth pht pbl prt red rev spn ths trc trl
          stylesheet rights].each do |item|
         next unless @config[item]
-        @config[item] = [@config[item]] if @config[item].is_a?(String)
+        if @config[item].is_a?(String)
+          @config[item] = [@config[item]]
+        end
       end
       # optional
       # type, format, identifier, source, relation, coverpage, aut

data/lib/review/book/base.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2009-2017 Minero Aoki, Kenshi Muto
+# Copyright (c) 2009-2018 Minero Aoki, Kenshi Muto
 #               2002-2008 Minero Aoki
 #
 # This program is free software.
@@ -13,47 +13,36 @@ require 'review/catalog'
 module ReVIEW
   module Book
     class Base
-      attr_writer :config
+      attr_accessor :config
       attr_writer :parts
       attr_writer :catalog
       attr_reader :basedir
 
-      def self.load_default
-        ReVIEW.logger.warn 'Book::Base.load_default() is obsoleted. Use Book::Base.load().'
-        load
-      end
-
       def self.load(dir = '.')
-        update_rubyenv dir
         new(dir)
       end
 
-      @basedir_seen = {}
-
-      def self.update_rubyenv(dir)
-        return if @basedir_seen.key?(dir)
-        if File.file?(File.join(dir, 'review-ext.rb'))
-          if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
-            ReVIEW.logger.warn 'review-ext.rb is prohibited in safe mode. ignored.'
-          else
-            Kernel.load File.expand_path(File.join(dir, 'review-ext.rb'))
-          end
-        end
-        @basedir_seen[dir] = true
-      end
-
-      def self.clear_rubyenv
-        @basedir_seen = {}
-      end
-
-      def initialize(basedir)
+      def initialize(basedir = '.')
         @basedir = basedir
+        @logger = ReVIEW.logger
         @parts = nil
         @chapter_index = nil
         @config = ReVIEW::Configure.values
         @catalog = nil
         @read_part = nil
         @warn_old_files = {} # XXX for checking CHAPS, PREDEF, POSTDEF
+        @basedir_seen = {}
+        update_rubyenv
+      end
+
+      def update_rubyenv
+        if File.file?(File.join(@basedir, 'review-ext.rb'))
+          if ENV['REVIEW_SAFE_MODE'].to_i & 2 > 0
+            @logger.warn 'review-ext.rb is prohibited in safe mode. ignored.'
+          else
+            Kernel.load(File.expand_path(File.join(@basedir, 'review-ext.rb')))
+          end
+        end
       end
 
       def bib_file
@@ -68,8 +57,8 @@ module ReVIEW
         config['ext']
       end
 
-      def image_dir
-        config['image_dir']
+      def imagedir
+        File.join(@basedir, config['imagedir'])
       end
 
       def image_types
@@ -80,6 +69,14 @@ module ReVIEW
         config['image_types'] = types
       end
 
+      def contentdir
+        if !config['contentdir'].present? || config['contentdir'] == '.'
+          @basedir
+        else
+          File.join(@basedir, config['contentdir'])
+        end
+      end
+
       def page_metric
         if config['page_metric'].respond_to?(:downcase) && config['page_metric'].upcase =~ /\A[A-Z0-9_]+\Z/
           ReVIEW::Book::PageMetric.const_get(config['page_metric'].upcase)
@@ -103,7 +100,10 @@ module ReVIEW
       end
 
       def parts_in_file
-        parts.find_all { |part| part if part.present? and part.file? }
+        # TODO: should be `parts.find_all{|part| part.present? and part.file?}` ?
+        parts.find_all do |part|
+          part if part.present? and part.file?
+        end
       end
 
       def part(n)
@@ -139,7 +139,12 @@ module ReVIEW
         return @chapter_index if @chapter_index
 
         contents = chapters
-        parts.each { |prt| contents << prt if prt.id.present? }
+        # TODO: contents += parts.find_all { |prt| prt.id.present? }
+        parts.each do |prt|
+          if prt.id.present?
+            contents << prt
+          end
+        end
         @chapter_index = ChapterIndex.new(contents)
       end
 
@@ -151,7 +156,9 @@ module ReVIEW
         finded = false
         each_chapter do |c|
           return c if finded
-          finded = true if c == chapter
+          if c == chapter
+            finded = true
+          end
         end
         nil # not found
       end
@@ -160,7 +167,9 @@ module ReVIEW
         finded = false
         each_chapter_r do |c|
           return c if finded
-          finded = true if c == chapter
+          if c == chapter
+            finded = true
+          end
         end
         nil # not found
       end
@@ -171,10 +180,6 @@ module ReVIEW
         vol
       end
 
-      def config
-        @config ||= Configure.values
-      end
-
       def load_config(filename)
         new_conf = YAML.load_file(filename)
         @config.merge!(new_conf)
@@ -184,9 +189,11 @@ module ReVIEW
         return @catalog if @catalog.present?
 
         catalogfile_path = filename_join(@basedir, config['catalogfile'])
-        @catalog = File.open(catalogfile_path, 'r:BOM|utf-8') { |f| Catalog.new(f) } if File.file? catalogfile_path
+        if File.file? catalogfile_path
+          @catalog = File.open(catalogfile_path, 'r:BOM|utf-8') { |f| Catalog.new(f) }
+        end
         if @catalog
-          @catalog.validate!(basedir)
+          @catalog.validate!(@config, basedir)
         end
         @catalog
       end
@@ -256,7 +263,9 @@ module ReVIEW
 
         begin
           predef_file = filename_join(@basedir, config['predef_file'])
-          mkpart_from_namelistfile(predef_file) if File.file?(predef_file)
+          if File.file?(predef_file)
+            mkpart_from_namelistfile(predef_file)
+          end
         rescue FileNotFound => err
           raise FileNotFound, "preface #{err.message}"
         end
@@ -271,14 +280,18 @@ module ReVIEW
 
         begin
           postdef_file = filename_join(@basedir, config['postdef_file'])
-          mkpart_from_namelistfile(postdef_file) if File.file?(postdef_file)
+          if File.file?(postdef_file)
+            mkpart_from_namelistfile(postdef_file)
+          end
         rescue FileNotFound => err
           raise FileNotFound, "postscript #{err.message}"
         end
       end
 
       def postscripts
-        mkpart_from_namelist(catalog.postdef.split("\n")) if catalog
+        if catalog
+          mkpart_from_namelist(catalog.postdef.split("\n"))
+        end
       end
 
       private
@@ -308,12 +321,12 @@ module ReVIEW
           return catalog.parts_with_chaps.map do |entry|
             if entry.is_a?(Hash)
               chaps = entry.values.first.map do |chap|
-                chap = Chapter.new(self, num += 1, chap, File.join(@basedir, chap))
+                chap = Chapter.new(self, num += 1, chap, File.join(contentdir, chap))
                 chap
               end
               Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1])
             else
-              chap = Chapter.new(self, num += 1, entry, File.join(@basedir, entry))
+              chap = Chapter.new(self, num += 1, entry, File.join(contentdir, entry))
               if chap.number
                 num = chap.number
               else
@@ -327,7 +340,7 @@ module ReVIEW
         chap = read_chaps.
                strip.lines.map(&:strip).join("\n").split(/\n{2,}/).
                map do |part_chunk|
-          chaps = part_chunk.split.map { |chapid| Chapter.new(self, num += 1, chapid, File.join(@basedir, chapid)) }
+          chaps = part_chunk.split.map { |chapid| Chapter.new(self, num += 1, chapid, File.join(contentdir, chapid)) }
           if part_exist? && read_part.split("\n").size > part
             Part.new(self, part += 1, chaps, read_part.split("\n")[part - 1])
           else
@@ -359,14 +372,14 @@ module ReVIEW
 
       def mkchap(name, number = nil)
         name += ext if File.extname(name).empty?
-        path = File.join(@basedir, name)
+        path = File.join(contentdir, name)
         raise FileNotFound, "file not exist: #{path}" unless File.file?(path)
         Chapter.new(self, number, name, path)
       end
 
       def mkchap_ifexist(name, idx = nil)
         name += ext if File.extname(name).empty?
-        path = File.join(@basedir, name)
+        path = File.join(contentdir, name)
         if File.file?(path)
           idx += 1 if idx
           Chapter.new(self, idx, name, path)
@@ -376,7 +389,9 @@ module ReVIEW
       def read_file(filename)
         unless @warn_old_files[filename]
           @warn_old_files[filename] = true
-          ReVIEW.logger.warn "!!! #{filename} is obsoleted. please use catalog.yml." if caller.none? { |item| item =~ %r{/review/test/test_} }
+          if caller.none? { |item| item =~ %r{/review/test/test_} }
+            @logger.warn "!!! #{filename} is obsoleted. please use catalog.yml."
+          end
         end
         res = ''
         File.open(filename_join(@basedir, filename), 'r:BOM|utf-8') do |f|

data/lib/review/book/chapter.rb

@@ -51,7 +51,7 @@ module ReVIEW
       end
 
       def find_first_header_option
-        f = LineInput.new(Preprocessor::Strip.new(StringIO.new(@content)))
+        f = LineInput.new(StringIO.new(@content))
         while f.next?
           case f.peek
           when /\A=+[\[\s\{]/
@@ -59,7 +59,9 @@ module ReVIEW
             return m[2] # tag
           when %r{/\A//[a-z]+/}
             line = f.gets
-            f.until_match(%r{\A//\}}) if line.rstrip[-1, 1] == '{'
+            if line.rstrip[-1, 1] == '{'
+              f.until_match(%r{\A//\}})
+            end
           end
           f.gets
         end
@@ -72,18 +74,28 @@ module ReVIEW
 
       def format_number(heading = true)
         return '' unless @number
-        return @number.to_s if on_predef?
+        if on_predef?
+          return @number.to_s
+        end
 
         if on_appendix?
-          return @number.to_s if @number < 1 || @number > 27
-          raise ReVIEW::ConfigError, %Q('appendix_format:' in config.yml is obsoleted.) if @book.config['appendix_format']
+          # XXX: should be extracted with magic number
+          if @number < 1 || @number > 27
+            return @number.to_s
+          end
+          if @book.config['appendix_format']
+            raise ReVIEW::ConfigError, %Q('appendix_format:' in config.yml is obsoleted.)
+          end
 
           i18n_appendix = I18n.get('appendix')
           fmt = i18n_appendix.scan(/%\w{1,3}/).first || '%s'
           I18n.update('appendix_without_heading' => fmt)
 
-          return I18n.t('appendix', @number) if heading
-          return I18n.t('appendix_without_heading', @number)
+          if heading
+            return I18n.t('appendix', @number)
+          else
+            return I18n.t('appendix_without_heading', @number)
+          end
         end
 
         if heading

data/lib/review/book/compilable.rb

@@ -14,10 +14,7 @@ module ReVIEW
       include TextUtils
       attr_reader :book
       attr_reader :path
-
-      def env
-        @book
-      end
+      attr_accessor :content
 
       def dirname
         return nil unless @path
@@ -62,18 +59,6 @@ module ReVIEW
         @volume
       end
 
-      # deprecated; use content()
-      def open(&_block)
-        return (block_given? ? yield(@io) : @io) if @io
-        StringIO.new(content)
-      end
-
-      attr_writer :content
-
-      def content
-        @content
-      end
-
       def lines
         # FIXME: we cannot duplicate Enumerator on ruby 1.9 HEAD
         (@lines ||= content.lines.to_a).dup
@@ -116,20 +101,20 @@ module ReVIEW
       def numberless_image_index
         @numberless_image_index ||=
           NumberlessImageIndex.parse(lines, id,
-                                     "#{book.basedir}/#{@book.config['imagedir']}",
+                                     @book.imagedir,
                                      @book.image_types, @book.config['builder'])
       end
 
       def image_index
         @image_index ||= ImageIndex.parse(lines, id,
-                                          "#{book.basedir}/#{@book.config['imagedir']}",
+                                          @book.imagedir,
                                           @book.image_types, @book.config['builder'])
         @image_index
       end
 
       def icon_index
         @icon_index ||= IconIndex.parse(lines, id,
-                                        "#{book.basedir}/#{@book.config['imagedir']}",
+                                        @book.imagedir,
                                         @book.image_types, @book.config['builder'])
         @icon_index
       end
@@ -137,7 +122,7 @@ module ReVIEW
       def indepimage_index
         @indepimage_index ||=
           IndepImageIndex.parse(lines, id,
-                                "#{book.basedir}/#{@book.config['imagedir']}",
+                                @book.imagedir,
                                 @book.image_types, @book.config['builder'])
       end
 

data/lib/review/book/image_finder.rb

@@ -1,5 +1,5 @@
 #
-# Copyright (c) 2014-2017 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
+# Copyright (c) 2014-2018 Minero Aoki, Kenshi Muto, Masayoshi Takahashi
 #
 # This program is free software.
 # You can distribute or modify this program under the terms of
@@ -22,7 +22,7 @@ module ReVIEW
       end
 
       def dir_entries
-        Dir.glob(File.join(@basedir, '**{,/*/**}/*.*')).uniq
+        Dir.glob(File.join(@basedir, '**{,/*/**}/*.*')).uniq.sort
       end
 
       def add_entry(path)
@@ -33,7 +33,14 @@ module ReVIEW
       def find_path(id)
         targets = target_list(id)
         targets.each do |target|
-          @exts.each { |ext| return "#{target}#{ext}" if @entries.include?("#{target}#{ext}") }
+          @exts.each do |ext|
+            @entries.find do |entry|
+              downname = entry.sub(/\.[^.]+$/, File.extname(entry).downcase)
+              if downname == "#{target}#{ext}"
+                return entry
+              end
+            end
+          end
         end
         nil
       end