epuber 0.7.4 → 0.8.0

data/lib/epuber/compiler/file_resolver.rb

@@ -25,7 +25,7 @@ module Epuber
     class FileResolver
       class ResolveError < StandardError; end
 
-      PATH_TYPES = [:spine, :manifest, :package, nil]
+      PATH_TYPES = [:spine, :manifest, :package, nil].freeze
 
       # @return [String] path where should look for source files
       #
@@ -125,24 +125,16 @@ module Epuber
         existing_file = @final_destination_path_to_file[file.final_destination_path]
 
         # save mapping from file_request to file, file_request can be different, but result file could be the same ...
-        unless file.try(:file_request).nil?
-          @request_to_files[file.file_request] << (existing_file || file)
-        end
+        @request_to_files[file.file_request] << (existing_file || file) unless file.try(:file_request).nil?
 
         # return existing file if already exists, new file will be thrown away
         return existing_file unless existing_file.nil?
 
-        if [:spine].include?(type)
-          @spine_files << file
-        end
+        @spine_files << file if [:spine].include?(type)
 
-        if [:spine, :manifest].include?(type)
-          @manifest_files << file
-        end
+        @manifest_files << file if %i[spine manifest].include?(type)
 
-        if [:spine, :manifest, :package].include?(type)
-          @package_files << file
-        end
+        @package_files << file if %i[spine manifest package].include?(type)
 
         @files << file
 
@@ -151,13 +143,11 @@ module Epuber
 
         @final_destination_path_to_file[file.final_destination_path] = file
 
-        if file.respond_to?(:source_path) && !file.source_path.nil?
-          @source_path_to_file[file.source_path] = file
-        end
+        @source_path_to_file[file.source_path] = file if file.respond_to?(:source_path) && !file.source_path.nil?
 
-        if file.respond_to?(:abs_source_path) && !file.abs_source_path.nil?
-          @abs_source_path_to_file[file.abs_source_path] = file
-        end
+        return unless file.respond_to?(:abs_source_path) && !file.abs_source_path.nil?
+
+        @abs_source_path_to_file[file.abs_source_path] = file
       end
 
       # Get instance of file from request instance
@@ -184,7 +174,7 @@ module Epuber
         end
 
         if file_request.only_one
-          files.first  # @request_to_files always returns array, see #initialize method
+          files.first # @request_to_files always returns array, see #initialize method
         else
           files
         end
@@ -219,99 +209,98 @@ module Epuber
       # @return [Array<String>] list of files that should be deleted in destination directory
       #
       def unneeded_files_in_destination
-        requested_paths = files.map do |file|
-          file.pkg_destination_path
-        end
+        requested_paths = files.map(&:pkg_destination_path)
 
         existing_paths = FileFinders::Normal.new(destination_path).find_all('*')
 
         unnecessary_paths = existing_paths - requested_paths
 
-        unnecessary_paths.select! do |path|
-          !::File.directory?(File.join(destination_path, path))
+        unnecessary_paths.reject! do |path|
+          ::File.directory?(File.join(destination_path, path))
         end
 
         unnecessary_paths
       end
 
-
       ##################################################################################################################
 
-      private
-
-      # @param [String] path  path to some file
-      #
-      # @return [String] path with changed extension
-      #
-      def self.renamed_file_with_path(path)
-        extname     = File.extname(path)
-        new_extname = FileFinders::EXTENSIONS_RENAME[extname]
-
-        if new_extname.nil?
-          path
-        else
-          path.sub(/#{Regexp.escape(extname)}$/, new_extname)
-        end
-      end
-
-      # @param file [Epuber::Compiler::AbstractFile]
-      #
-      # @return [nil]
-      #
-      def resolve_destination_path(file)
-        if file.final_destination_path.nil?
-          dest_path = if file.respond_to?(:source_path) && !file.source_path.nil?
-                        file.abs_source_path = File.expand_path(file.source_path, source_path)
-                        self.class.renamed_file_with_path(file.source_path)
-                      elsif !file.destination_path.nil?
-                        file.destination_path
-                      else
-                        raise ResolveError, "What should I do with file that doesn't have source path or destination path? file: #{file.inspect}"
-                      end
-
-          file.destination_path = dest_path
-          file.pkg_destination_path = File.join(*self.class.path_comps_for(file.path_type), dest_path)
-          file.final_destination_path = File.join(destination_path, file.pkg_destination_path)
+      class << self
+        # @param [String] path  path to some file
+        #
+        # @return [String] path with changed extension
+        #
+        def renamed_file_with_path(path)
+          extname     = File.extname(path)
+          new_extname = FileFinders::EXTENSIONS_RENAME[extname]
+
+          if new_extname.nil?
+            path
+          else
+            path.sub(/#{Regexp.escape(extname)}$/, new_extname)
+          end
         end
-      end
 
-      # @param [String] extname  extension of file
-      #
-      # @return [Class]
-      #
-      def self.file_class_for(extname)
-        mapping = {
-          '.styl'  => FileTypes::StylusFile,
+        # @param [String] extname  extension of file
+        #
+        # @return [Class]
+        #
+        def file_class_for(extname)
+          mapping = {
+            '.styl' => FileTypes::StylusFile,
 
-          '.coffee' => FileTypes::CoffeeScriptFile,
+            '.coffee' => FileTypes::CoffeeScriptFile,
 
-          '.bade'  => FileTypes::BadeFile,
-          '.xhtml' => FileTypes::XHTMLFile,
-          '.html'  => FileTypes::XHTMLFile,
+            '.bade' => FileTypes::BadeFile,
+            '.xhtml' => FileTypes::XHTMLFile,
+            '.html' => FileTypes::XHTMLFile,
 
-          '.jpg'   => FileTypes::ImageFile,
-          '.jpeg'  => FileTypes::ImageFile,
-          '.png'   => FileTypes::ImageFile,
-        }
+            '.jpg' => FileTypes::ImageFile,
+            '.jpeg' => FileTypes::ImageFile,
+            '.png' => FileTypes::ImageFile,
+          }
 
-        mapping[extname] || FileTypes::StaticFile
-      end
+          mapping[extname] || FileTypes::StaticFile
+        end
 
-      # @param [String] root_path  path to root of the package
-      # @param [Symbol] path_type  path type of file
-      #
-      # @return [Array<String>] path components
-      #
-      def self.path_comps_for(root_path = nil, path_type)
-        case path_type
+        # @param [String] root_path  path to root of the package
+        # @param [Symbol] path_type  path type of file
+        #
+        # @return [Array<String>] path components
+        #
+        def path_comps_for(root_path, path_type)
+          case path_type
           when :spine, :manifest
             Array(root_path) + [Compiler::EPUB_CONTENT_FOLDER]
           when :package
             Array(root_path)
-          else
-            nil
+          end
         end
       end
+
+      private
+
+      # @param file [Epuber::Compiler::AbstractFile]
+      #
+      # @return [nil]
+      #
+      def resolve_destination_path(file)
+        return unless file.final_destination_path.nil?
+
+        dest_path = if file.respond_to?(:source_path) && !file.source_path.nil?
+                      file.abs_source_path = File.expand_path(file.source_path, source_path)
+                      self.class.renamed_file_with_path(file.source_path)
+                    elsif !file.destination_path.nil?
+                      file.destination_path
+                    else
+                      raise ResolveError, <<~ERROR
+                        What should I do with file that doesn't have source path or destination path? file: #{file.inspect}
+                      ERROR
+                    end
+
+        file.destination_path = dest_path
+        file.pkg_destination_path = File.join(*self.class.path_comps_for(nil, file.path_type), dest_path)
+        file.final_destination_path = File.join(destination_path, file.pkg_destination_path)
+      end
     end
   end
 end

data/lib/epuber/compiler/file_stat.rb

@@ -36,7 +36,7 @@ module Epuber
             @mtime = stat.mtime
             @ctime = stat.ctime
             @size = stat.size
-          rescue
+          rescue StandardError
             # noop
           end
         end
@@ -66,9 +66,9 @@ module Epuber
         raise AttributeError, "other must be class of #{self.class}" unless other.is_a?(FileStat)
 
         file_path == other.file_path &&
-             size == other.size &&
-            mtime == other.mtime &&
-            ctime == other.ctime
+          size == other.size &&
+          mtime == other.mtime &&
+          ctime == other.ctime
       end
     end
   end

data/lib/epuber/compiler/file_types/abstract_file.rb

@@ -4,18 +4,18 @@ module Epuber
   class Compiler
     module FileTypes
       class AbstractFile
-
         # @return [String] relative destination path
         #
         attr_accessor :destination_path
 
-        # @return [Symbol] group of this file (:text, :image, :font, ...), see Epuber::Compiler::FileFinder::GROUP_EXTENSIONS
+        # @return [Symbol] group of this file (:text, :image, :font, ...), see
+        #                  Epuber::Compiler::FileFinder::GROUP_EXTENSIONS
         #
         attr_accessor :group
 
         # @return [Set<Symbol>] list of properties
         #
-        attr_accessor :properties
+        attr_writer :properties
 
         # @return [Set<Symbol>] list of properties
         #
@@ -23,7 +23,6 @@ module Epuber
           @properties ||= Set.new
         end
 
-
         # @return [String] final relative destination path from root of the package calculated by FileResolver
         #
         attr_accessor :pkg_destination_path

data/lib/epuber/compiler/file_types/bade_file.rb

@@ -26,10 +26,15 @@ module Epuber
             __file_resolver: file_resolver,
             __file: self,
             __toc_item: toc_item,
-            __const: Hash.new { |_hash, key| UI.warning("Undefined constant with key `#{key}`", location: caller_locations[0]) }.merge!(target.constants),
+            __const: Hash.new do |_hash, key|
+                       UI.warning("Undefined constant with key `#{key}`", location: caller_locations[0])
+                     end.merge!(target.constants),
           }
 
-          should_load_from_precompiled = up_to_date && precompiled_exists && compilation_context.incremental_build? && (!compilation_context.should_write)
+          should_load_from_precompiled = up_to_date &&
+                                         precompiled_exists &&
+                                         compilation_context.incremental_build? &&
+                                         !compilation_context.should_write
 
           precompiled = if should_load_from_precompiled
                           begin
@@ -49,7 +54,9 @@ module Epuber
               renderer.render(new_line: '', indent: '')
             end
           else
-            UI.print_processing_debug_info('Parsing new version of source file') if compilation_context.incremental_build?
+            if compilation_context.incremental_build?
+              UI.print_processing_debug_info('Parsing new version of source file')
+            end
 
             bade_content = load_source(compilation_context)
 
@@ -58,9 +65,7 @@ module Epuber
                                        .with_locals(variables)
 
               # turn on optimizations when can
-              if renderer.respond_to?(:optimize=)
-                renderer.optimize = true
-              end
+              renderer.optimize = true if renderer.respond_to?(:optimize=)
 
               FileUtils.mkdir_p(File.dirname(precompiled_path))
               renderer.precompiled.write_yaml_to_file(precompiled_path)
@@ -82,7 +87,7 @@ module Epuber
         # @return [String]
         #
         def precompiled_path
-          File.join(Config.instance.build_cache_path(PRECOMPILED_CACHE_NAME), source_path + '.precompiled.yml')
+          File.join(Config.instance.build_cache_path(PRECOMPILED_CACHE_NAME), "#{source_path}.precompiled.yml")
         end
 
         def pretty_precompiled_path

data/lib/epuber/compiler/file_types/coffee_script_file.rb

@@ -10,7 +10,7 @@ module Epuber
       class CoffeeScriptFile < SourceFile
         # @param [Compiler::CompilationContext] compilation_context
         #
-        def process(compilation_context)
+        def process(_compilation_context)
           return if destination_file_up_to_date?
 
           write_compiled(CoffeeScript.compile(File.new(abs_source_path)))

data/lib/epuber/compiler/file_types/generated_file.rb

@@ -12,7 +12,7 @@ module Epuber
 
         # @param [Compiler::CompilationContext] compilation_context
         #
-        def process(compilation_context)
+        def process(_compilation_context)
           write_generate(content.to_s)
         end
 

data/lib/epuber/compiler/file_types/image_file.rb

@@ -16,14 +16,16 @@ module Epuber
           dest = final_destination_path
           source = abs_source_path
 
-          img = Magick::Image::read(source).first
+          img = Magick::Image.read(source).first
 
           resolution = img.columns * img.rows
           max_resolution = 3_000_000
 
           if resolution > max_resolution
             img = img.change_geometry("#{max_resolution}@>") do |width, height, b_img|
-              UI.print_processing_debug_info("downscaling from resolution #{b_img.columns}x#{b_img.rows} to #{width}x#{height}")
+              UI.print_processing_debug_info(<<~MSG)
+                downscaling from resolution #{b_img.columns}x#{b_img.rows} to #{width}x#{height}
+              MSG
               b_img.resize!(width, height)
             end
 

data/lib/epuber/compiler/file_types/nav_file.rb

@@ -6,7 +6,6 @@ module Epuber
       require_relative 'generated_file'
 
       class NavFile < GeneratedFile
-
         # @return [Epuber::Version]
         #
         attr_reader :epub_version

data/lib/epuber/compiler/file_types/opf_file.rb

@@ -6,7 +6,6 @@ module Epuber
       require_relative 'generated_file'
 
       class OPFFile < GeneratedFile
-
         def initialize
           super
 

data/lib/epuber/compiler/file_types/source_file.rb

@@ -6,7 +6,6 @@ module Epuber
       require_relative 'abstract_file'
 
       class SourceFile < AbstractFile
-
         # @return [String] relative source path
         #
         attr_reader :source_path
@@ -22,6 +21,8 @@ module Epuber
         # @param [String] source_path  relative path from project root to source file
         #
         def initialize(source_path)
+          super()
+
           @source_path = source_path
         end
 
@@ -95,7 +96,9 @@ module Epuber
             UI.print_processing_debug_info("Writing compiled version to #{pkg_destination_path}")
             self.class.write_to_file!(content, final_destination_path)
           else
-            UI.print_processing_debug_info("Not writing to disk ... compiled version at #{pkg_destination_path} is same")
+            UI.print_processing_debug_info(<<~MSG)
+              Not writing to disk ... compiled version at #{pkg_destination_path} is same
+            MSG
           end
         end
 
@@ -104,7 +107,9 @@ module Epuber
             UI.print_processing_debug_info("Writing processed version to #{pkg_destination_path}")
             self.class.write_to_file!(content, final_destination_path)
           else
-            UI.print_processing_debug_info("Not writing to disk ... processed version at #{pkg_destination_path} is same")
+            UI.print_processing_debug_info(<<~MSG)
+              Not writing to disk ... processed version at #{pkg_destination_path} is same
+            MSG
           end
         end
       end

data/lib/epuber/compiler/file_types/xhtml_file.rb

@@ -12,6 +12,21 @@ module Epuber
         #
         attr_accessor :toc_item
 
+        # @return [Array<String>]
+        #
+        attr_accessor :global_ids
+
+        # @return [Array<String>]
+        #
+        attr_accessor :global_links
+
+        def initialize(source_path)
+          super
+
+          self.global_ids = []
+          self.global_links = []
+        end
+
         # @param [Book::Target] target
         # @param [FileResolver] file_resolver
         #
@@ -22,8 +37,9 @@ module Epuber
             Array(file_resolver.file_from_request(default_style_request))
           end.flatten
 
+          dirname = Pathname.new(File.dirname(final_destination_path))
           default_styles.map do |style|
-            Pathname.new(style.final_destination_path).relative_path_from(Pathname.new(File.dirname(final_destination_path))).to_s
+            Pathname.new(style.final_destination_path).relative_path_from(dirname).to_s
           end
         end
 
@@ -37,8 +53,9 @@ module Epuber
             Array(file_resolver.file_from_request(default_style_request))
           end.flatten
 
+          dirname = Pathname.new(File.dirname(final_destination_path))
           default_scripts.map do |style|
-            Pathname.new(style.final_destination_path).relative_path_from(Pathname.new(File.dirname(final_destination_path))).to_s
+            Pathname.new(style.final_destination_path).relative_path_from(dirname).to_s
           end
         end
 
@@ -58,10 +75,7 @@ module Epuber
             end
           end
 
-
-          if compilation_context.should_write
-            self.class.write_to_file(xhtml_content, abs_source_path)
-          end
+          self.class.write_to_file(xhtml_content, abs_source_path) if compilation_context.should_write
 
           xhtml_content
         end
@@ -88,9 +102,7 @@ module Epuber
             XHTMLProcessor.xml_doc_from_str_with_errors(content, source_path)
           end
 
-          if compilation_context.release_build && xhtml_doc.errors.count > 0
-            process_nokogiri_errors(errors)
-          end
+          process_nokogiri_errors(errors) if compilation_context.release_build && xhtml_doc.errors.count.positive?
 
           UI.print_step_processing_time('adding missing elements') do
             XHTMLProcessor.add_missing_root_elements(xhtml_doc, book.title, target.epub_version)
@@ -120,13 +132,13 @@ module Epuber
           XHTMLProcessor.resolve_mathml_namespace(xhtml_doc)
 
           UI.print_step_processing_time('investigating properties') do
-            self.properties << :remote_resources if XHTMLProcessor.using_remote_resources?(xhtml_doc)
-            self.properties << :scripted if XHTMLProcessor.using_javascript?(xhtml_doc)
-            self.properties << :mathml if XHTMLProcessor.using_mathml?(xhtml_doc)
+            properties << :remote_resources if XHTMLProcessor.using_remote_resources?(xhtml_doc)
+            properties << :scripted if XHTMLProcessor.using_javascript?(xhtml_doc)
+            properties << :mathml if XHTMLProcessor.using_mathml?(xhtml_doc)
           end
 
           xhtml_string = UI.print_step_processing_time('converting to XHTML') do
-             xhtml_doc.to_s
+            xhtml_doc.to_s
           end
 
           # perform transformations
@@ -145,6 +157,12 @@ module Epuber
             end
           end
 
+          if xhtml_string.include?('="$')
+            xhtml_doc = XHTMLProcessor.xml_document_from_string(xhtml_string, final_destination_path)
+            self.global_ids = XHTMLProcessor.find_global_ids(xhtml_doc)
+            self.global_links = XHTMLProcessor.find_global_links(xhtml_doc)
+          end
+
           xhtml_string
         end
 
@@ -153,6 +171,42 @@ module Epuber
         def process(compilation_context)
           write_processed(common_process(load_source(compilation_context), compilation_context))
         end
+
+        # @param [Compiler::CompilationContext] compilation_context
+        # @param [Hash<String, XHTMLFile>] global_ids
+        #
+        def process_global_ids(compilation_context, global_ids)
+          return if self.global_ids.empty? && global_links.empty?
+
+          xhtml_doc = XHTMLProcessor.xml_document_from_string(File.read(final_destination_path), final_destination_path)
+
+          XHTMLProcessor.find_global_ids_nodes(xhtml_doc).each do |node|
+            id = node['id']
+            node['id'] = id[1..-1]
+          end
+
+          XHTMLProcessor.find_global_links_nodes(xhtml_doc).each do |node|
+            href = node['href'][1..-1]
+
+            dest_file = global_ids[href]
+            if dest_file
+              rel_path = Pathname(dest_file.final_destination_path.unicode_normalize)
+                         .relative_path_from(Pathname(File.dirname(final_destination_path.unicode_normalize))).to_s
+
+              node['href'] = "#{rel_path}##{href}"
+            else
+              message = "Can't find global id '#{href}' from link in file #{source_path}"
+              location = UserInterface::Location.new(path: final_destination_path, lineno: node.line)
+              if compilation_context.release_build?
+                UI.error!(message, location: location)
+              else
+                UI.warning(message, location: location)
+              end
+            end
+          end
+
+          write_processed(xhtml_doc.to_s)
+        end
       end
     end
   end

data/lib/epuber/compiler/generator.rb

@@ -12,7 +12,6 @@ module Nokogiri
   end
 end
 
-
 module Epuber
   class Compiler
     class Generator
@@ -55,7 +54,7 @@ module Epuber
         builder = Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
           @xml = xml
 
-          block.call(xml) unless block.nil?
+          block&.call(xml)
 
           @xml = nil
         end

data/lib/epuber/compiler/meta_inf_generator.rb

@@ -15,7 +15,7 @@ module Epuber
         generate_xml do |xml|
           xml.container(version: 1.0, xmlns: 'urn:oasis:names:tc:opendocument:xmlns:container') do
             xml.rootfiles do
-              @file_resolver.package_files.select { |file| file.kind_of?(FileTypes::OPFFile) }.each do |file|
+              @file_resolver.package_files.select { |file| file.is_a?(FileTypes::OPFFile) }.each do |file|
                 path = file.pkg_destination_path
                 xml.rootfile('full-path' => path, 'media-type' => MIME::Types.of(path).first.content_type)
               end

data/lib/epuber/compiler/nav_generator.rb

@@ -9,7 +9,6 @@ module Epuber
     require_relative 'generator'
 
     class NavGenerator < Generator
-
       NCX_NAMESPACES = {
         'xmlns' => 'http://www.daisy.org/z3986/2005/ncx/',
       }.freeze
@@ -26,10 +25,10 @@ module Epuber
 
       # resource page http://www.idpf.org/epub/301/spec/epub-contentdocs.html#sec-xhtml-nav-def-types-landmarks
       LANDMARKS_MAP = {
-        landmark_cover:      { type: 'cover', text: 'Cover page' },
-        landmark_start_page: { type: %w(bodymatter ibooks:reader-start-page), text: 'Start Reading' },
-        landmark_copyright:  { type: 'copyright-page', text: 'Copyright page' },
-        landmark_toc:        { type: 'toc', text: 'Table of contents' },
+        landmark_cover: { type: 'cover', text: 'Cover page' },
+        landmark_start_page: { type: %w[bodymatter ibooks:reader-start-page], text: 'Start Reading' },
+        landmark_copyright: { type: 'copyright-page', text: 'Copyright page' },
+        landmark_toc: { type: 'toc', text: 'Table of contents' },
       }.freeze
 
       # Generates XML for toc document, the structure differs depend on epub_version
@@ -121,7 +120,7 @@ module Epuber
           end
         end
 
-        if @target.epub_version >= 3 && toc_items.length > 0 && contains_item_with_title(toc_items)
+        if @target.epub_version >= 3 && toc_items.length.positive? && contains_item_with_title(toc_items)
           @xml.ol do
             iterate_lambda.call
           end