epuber 0.7.4 → 0.9.0

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/stylus_file.rb

@@ -5,9 +5,9 @@ require 'epuber-stylus'
 module Epuber
   class Compiler
     module FileTypes
-      require_relative 'source_file'
+      require_relative 'css_file'
 
-      class StylusFile < SourceFile
+      class StylusFile < CSSFile
         # @param [Compiler::CompilationContext] compilation_context
         #
         def process(compilation_context)
@@ -19,7 +19,8 @@ module Epuber
           Stylus.define('__book_title', compilation_context.book.title)
           Stylus.define('__const', compilation_context.target.constants)
 
-          write_compiled(Stylus.compile(File.new(abs_source_path)))
+          css = Stylus.compile(File.new(abs_source_path))
+          write_compiled(process_css(css, compilation_context))
 
           update_metadata!
         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
@@ -95,7 +94,7 @@ module Epuber
         @xml.ncx(nav_namespaces, version: '2005-1') do
           # head
           @xml.head do
-            @xml.meta(name: 'dtb:uid', content: (@target.identifier || "urn:isbn:#{@target.isbn}"))
+            @xml.meta(name: 'dtb:uid', content: @target.identifier || "urn:isbn:#{@target.isbn}")
           end
 
           # title
@@ -112,7 +111,7 @@ module Epuber
         end
       end
 
-      # @param toc_items [Array<Epuber::Book::TocItem>]
+      # @param [Array<Epuber::Book::TocItem>] toc_items
       #
       def visit_toc_items(toc_items)
         iterate_lambda = lambda do
@@ -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
@@ -134,7 +133,7 @@ module Epuber
         toc_items.any? { |a| a.title || contains_item_with_title(a.sub_items) }
       end
 
-      # @param toc_item [Epuber::Book::TocItem]
+      # @param [Epuber::Book::TocItem] toc_item
       #
       def visit_toc_item(toc_item)
         result_file_path = pretty_path_for_toc_item(toc_item)
@@ -166,7 +165,7 @@ module Epuber
 
       # --------------- landmarks -----------------------------
 
-      # @param toc_items [Array<Epuber::Book::TocItem>]
+      # @param [Array<Epuber::Book::TocItem>] toc_items
       #
       def landmarks_visit_toc_items(toc_items)
         toc_items.each do |child_item|
@@ -174,7 +173,7 @@ module Epuber
         end
       end
 
-      # @param toc_item [Epuber::Book::TocItem]
+      # @param [Epuber::Book::TocItem] toc_item
       #
       def landmarks_visit_toc_item(toc_item)
         landmarks = toc_item.landmarks

data/lib/epuber/compiler/opf_generator.rb

@@ -11,20 +11,19 @@ require_relative '../book/toc_item'
 module Epuber
   class Compiler
     class OPFGenerator < Generator
-
       EPUB2_NAMESPACES = {
-        'xmlns'     => 'http://www.idpf.org/2007/opf',
-        'xmlns:dc'  => 'http://purl.org/dc/elements/1.1/',
+        'xmlns' => 'http://www.idpf.org/2007/opf',
+        'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
         'xmlns:opf' => 'http://www.idpf.org/2007/opf',
       }.freeze
 
       EPUB3_NAMESPACES = {
-        'prefix'     => 'rendition: http://www.idpf.org/vocab/rendition/',
+        'prefix' => 'rendition: http://www.idpf.org/vocab/rendition/',
         'xmlns:epub' => 'http://www.idpf.org/2007/ops',
       }.freeze
 
       IBOOKS_NAMESPACES = {
-        'prefix'       => 'rendition: http://www.idpf.org/vocab/rendition/# ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/',
+        'prefix' => 'rendition: http://www.idpf.org/vocab/rendition/# ibooks: http://vocabulary.itunes.apple.com/rdf/ibooks/vocabulary-extensions-1.0/',
         'xmlns:ibooks' => 'http://apple.com/ibooks/html-extensions',
       }.freeze
 
@@ -32,32 +31,32 @@ module Epuber
       LANDMARKS_MAP = {
 
         # my favorite
-        landmark_cover:      'cover',
+        landmark_cover: 'cover',
         landmark_start_page: 'text',
-        landmark_copyright:  'copyright-page',
-        landmark_toc:        'toc',
+        landmark_copyright: 'copyright-page',
+        landmark_toc: 'toc',
 
         # others
-        landmark_title:                 'title-page',
-        landmark_index:                 'index',
-        landmark_glossary:              'glossary',
-        landmark_acknowledgements:      'acknowledgements',
-        landmark_bibliography:          'bibliography',
-        landmark_colophon:              'colophon',
-        landmark_dedication:            'dedication',
-        landmark_epigraph:              'epigraph',
-        landmark_foreword:              'foreword',
+        landmark_title: 'title-page',
+        landmark_index: 'index',
+        landmark_glossary: 'glossary',
+        landmark_acknowledgements: 'acknowledgements',
+        landmark_bibliography: 'bibliography',
+        landmark_colophon: 'colophon',
+        landmark_dedication: 'dedication',
+        landmark_epigraph: 'epigraph',
+        landmark_foreword: 'foreword',
         landmark_list_of_illustrations: 'loi',
-        landmark_list_of_tables:        'lot',
-        landmark_notes:                 'notes',
-        landmark_preface:               'preface',
+        landmark_list_of_tables: 'lot',
+        landmark_notes: 'notes',
+        landmark_preface: 'preface',
 
       }.freeze
 
       PROPERTIES_MAP = {
         cover_image: 'cover-image',
-        navigation:  'nav',
-        scripted:    'scripted',
+        navigation: 'nav',
+        scripted: 'scripted',
         remote_resources: 'remote-resources',
         mathml: 'mathml',
       }.freeze
@@ -164,7 +163,7 @@ module Epuber
             attrs['media-type'] = mime_type_for(file)
 
             properties = file.properties
-            if properties.length > 0 && @target.epub_version >= 3
+            if properties.length.positive? && @target.epub_version >= 3
               pretty_properties = properties.to_a.map { |property| PROPERTIES_MAP[property] }.join(' ')
               attrs['properties'] = pretty_properties
             end
@@ -218,7 +217,7 @@ module Epuber
         end
       end
 
-      # @param toc_items [Array<Epuber::Book::TocItem>]
+      # @param [Array<Epuber::Book::TocItem>] toc_items
       #
       # @return nil
       #
@@ -228,7 +227,7 @@ module Epuber
         end
       end
 
-      # @param toc_item [Epuber::Book::TocItem]
+      # @param [Epuber::Book::TocItem] toc_item
       #
       # @return nil
       #
@@ -252,7 +251,7 @@ module Epuber
 
       # Creates id from file path
       #
-      # @param path [String]
+      # @param [String] path
       #
       # @return [String]
       #
@@ -264,7 +263,7 @@ module Epuber
 
       # Creates proper mime-type for file
       #
-      # @param file [Epuber::Compiler::FileTypes::AbstractFile | String]
+      # @param [Epuber::Compiler::FileTypes::AbstractFile | String] file
       #
       # @return [String]
       #

data/lib/epuber/compiler/problem.rb

@@ -4,9 +4,7 @@ module Epuber
   class Compiler
     class Problem
       class Location
-        attr_reader :line
-        attr_reader :column
-        attr_reader :length
+        attr_reader :line, :column, :length
 
         def initialize(line, column, length = nil)
           @line = line
@@ -15,20 +13,14 @@ module Epuber
         end
       end
 
-      attr_reader :level
-      attr_reader :message
-      attr_reader :source
-      attr_reader :location
-      attr_reader :file_path
+      attr_reader :level, :message, :source, :location, :file_path
 
       def initialize(level, message, source, location: nil, line: nil, column: nil, length: nil, file_path: nil)
         @level = level
         @message = message
         @source = source
         @location = location
-        if @location.nil? && line && column
-          @location = Location.new(line, column, length)
-        end
+        @location = Location.new(line, column, length) if @location.nil? && line && column
 
         @file_path = file_path
       end
@@ -40,7 +32,7 @@ module Epuber
       # @return [String]
       #
       def self.caret_symbol(indent)
-        ' ' * indent + '^'
+        "#{' ' * indent}^"
       end
 
       # Formats caret symbols for indent and length
@@ -53,7 +45,7 @@ module Epuber
       def self.caret_symbols(indent, length)
         start_sign = caret_symbol(indent)
         end_sign = if length > 1
-                     caret_symbol(length-2)
+                     caret_symbol(length - 2)
                    else
                      ''
                    end
@@ -74,10 +66,11 @@ module Epuber
         lines = text.split("\n")
 
         line = lines[line_index] || ''
-        matched_text = line[column_index ... column_index + location.length] || ''
+        matched_text = line[column_index...column_index + location.length] || ''
 
-        pre = (lines[0 ... line_index] + [line[0 ... column_index]]).join("\n")
-        post = ([line[column_index + location.length .. line.length]] + (lines[location.line .. lines.count] || [])).join("\n")
+        pre = (lines[0...line_index] + [line[0...column_index]]).join("\n")
+        post = ([line[column_index + location.length..line.length]] + (lines[location.line..lines.count] || []))
+               .join("\n")
 
         [pre, matched_text, post]
       end
@@ -89,9 +82,7 @@ module Epuber
         post_line = post.split("\n").first || ''
 
         pre = match_pre_line = pre_line
-        if remove_tabs(match_pre_line).length > 100
-          pre = "#{match_pre_line.first(20)}...#{match_pre_line.last(30)}"
-        end
+        pre = "#{match_pre_line.first(20)}...#{match_pre_line.last(30)}" if remove_tabs(match_pre_line).length > 100
 
         pre = remove_tabs(pre)
 
@@ -114,8 +105,8 @@ module Epuber
 
         [
           "#{@file_path}:#{line} column: #{column} --- #{@message}",
-          '  ' + pre + colored_match_text + post,
-          '  ' + pointers,
+          "  #{pre}#{colored_match_text}#{post}",
+          "  #{pointers}",
         ].join("\n")
       end
     end