epuber 0.7.4 → 0.9.0

data/lib/epuber/from_file/nav_file.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Epuber
+  class NavFile
+    class NavItem
+      # @return [String]
+      attr_accessor :href
+      # @return [String]
+      attr_accessor :title
+      # @return [Array<NavItem>]
+      attr_accessor :children
+
+      # @param [String] href
+      # @param [String] title
+      #
+      def initialize(href, title)
+        @href = href
+        @title = title
+        @children = []
+      end
+
+      # @param [String] other_href
+      # @param [Boolean] ignore_fragment
+      #
+      # @return [NavItem, nil]
+      #
+      def find_by_href(other_href, ignore_fragment: false)
+        if ignore_fragment
+          other_href = other_href.split('#').first
+          self_href = @href.split('#').first
+          return self if self_href == other_href
+        elsif @href == other_href
+          return self
+        end
+
+        @children.find { |item| item.find_by_href(other_href) }
+      end
+    end
+
+    class LandmarkItem
+      # @return [String]
+      #
+      attr_accessor :href
+
+      # @return [String]
+      #
+      attr_accessor :type
+
+      # @param [String] href
+      # @param [String] type
+      #
+      def initialize(href, type)
+        @href = href
+        @type = type
+      end
+
+      # @param [Nokogiri::XML::Node] node
+      #
+      # @return [LandmarkItem]
+      #
+      def self.from_node(node)
+        new(node['href'], node['type'])
+      end
+    end
+
+    LANDMARKS_MAP = {
+      'cover' => :landmark_cover,
+      'bodymatter' => :landmark_start_page,
+      'copyright-page' => :landmark_copyright,
+      'toc' => :landmark_toc,
+    }.freeze
+
+    MODE_NCX = :ncx
+    MODE_XHTML = :xhtml
+
+    # @return [Nokogiri::XML::Document]
+    #
+    attr_reader :document
+
+    # @return [:ncx, :xhtml]
+    #
+    attr_reader :mode
+
+    # @return [Array<NavItem>]
+    #
+    attr_reader :items
+
+    # @return [Array<LandmarkItem>, nil]
+    #
+    attr_reader :landmarks
+
+    # @param [string] document
+    # @param [:ncx, :xhtml] mode
+    #
+    def initialize(document, mode)
+      raise ArgumentError, 'mode must be :ncx or :xhtml' unless [MODE_NCX, MODE_XHTML].include?(mode)
+
+      @document = Nokogiri::XML(document)
+      @document.remove_namespaces!
+
+      @mode = mode
+      @items = _parse
+
+      @landmarks = _parse_landmarks
+    end
+
+    # @param [String] href
+    # @param [Boolean] ignore_fragment
+    #
+    # @return [NavItem, nil]
+    #
+    def find_by_href(href, ignore_fragment: false)
+      @items.find { |item| item.find_by_href(href, ignore_fragment: ignore_fragment) }
+    end
+
+    private
+
+    # @param [Nokogiri::XML::Element] li_node
+    #
+    # @return [NavItem]
+    #
+    def _parse_nav_xhtml_item(li_node)
+      href = li_node.at_css('a')['href'].strip
+      title = li_node.at_css('a').text.strip
+
+      item = NavItem.new(href, title)
+      item.children = li_node.css('ol > li').map { |p| _parse_nav_xhtml_item(p) }
+      item
+    end
+
+    # @param [Nokogiri::XML::Element] point_node
+    #
+    # @return [NavItem]
+    #
+    def _parse_nav_ncx_item(point_node)
+      href = point_node.at_css('content')['src'].strip
+      title = point_node.at_css('navLabel text').text.strip
+
+      item = NavItem.new(href, title)
+      item.children = point_node.css('> navPoint').map { |p| _parse_nav_ncx_item(p) }
+      item
+    end
+
+    # @return [Array<NavItem>]
+    #
+    def _parse
+      if @mode == MODE_XHTML
+        @document.css('nav[type="toc"] > ol > li')
+                 .map { |point| _parse_nav_xhtml_item(point) }
+      elsif @mode == MODE_NCX
+        @document.css('navMap > navPoint')
+                 .map { |point| _parse_nav_ncx_item(point) }
+      end
+    end
+
+    def _parse_landmarks
+      return nil if @mode != MODE_XHTML
+
+      @document.css('nav[type="landmarks"] > ol > li > a')
+               .map { |node| LandmarkItem.from_node(node) }
+    end
+  end
+end

data/lib/epuber/from_file/opf_file.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+module Epuber
+  class OpfFile
+    class ManifestItem
+      # @return [String]
+      #
+      attr_accessor :id
+
+      # @return [String]
+      #
+      attr_accessor :href
+
+      # @return [String]
+      #
+      attr_accessor :media_type
+
+      # @return [String, nil]
+      #
+      attr_accessor :properties
+
+      def initialize(id, href, media_type, properties)
+        @id = id
+        @href = href
+        @media_type = media_type
+        @properties = properties
+      end
+
+      # @param [ManifestItem] other
+      #
+      # @return [Boolean]
+      #
+      def ==(other)
+        @id == other.id
+      end
+
+      # @param [Nokogiri::XML::Node] node
+      #
+      # @return [ManifestItem]
+      #
+      def self.from_node(node)
+        new(node['id'], node['href'], node['media-type'], node['properties'])
+      end
+    end
+
+    class SpineItem
+      # @return [String]
+      #
+      attr_accessor :idref
+
+      # @return [String]
+      #
+      attr_accessor :linear
+
+      def initialize(idref, linear)
+        @idref = idref
+        @linear = linear
+      end
+
+      # @param [SpineItem] other
+      #
+      # @return [Boolean]
+      #
+      def ==(other)
+        @idref == other.idref
+      end
+
+      # @param [Nokogiri::XML::Node] node
+      #
+      # @return [SpineItem]
+      #
+      def self.from_node(node)
+        new(node['idref'], node['linear'])
+      end
+    end
+
+    class GuideItem
+      # @return [String]
+      #
+      attr_accessor :type
+
+      # @return [String]
+      #
+      attr_accessor :href
+
+      def initialize(type, href)
+        @type = type
+        @href = href
+      end
+
+      # @param [Nokogiri::XML::Node] node
+      #
+      # @return [GuideItem]
+      #
+      def self.from_node(node)
+        new(node['type'], node['href'])
+      end
+    end
+
+    # reversed map of generator's map
+    LANDMARKS_MAP = Compiler::OPFGenerator::LANDMARKS_MAP.map { |k, v| [v, k] }
+                                                         .to_h
+                                                         .freeze
+
+    # @return [Nokogiri::XML::Document]
+    #
+    attr_reader :document
+
+    # @return [Nokogiri::XML::Node, nil]
+    #
+    attr_reader :package, :metadata, :manifest, :spine
+
+    # @return [Hash<String, ManifestItem>]
+    #
+    attr_reader :manifest_items
+
+    # @return [Array<SpineItem>]
+    #
+    attr_reader :spine_items
+
+    # @return [Array<GuideItem>]
+    #
+    attr_reader :guide_items
+
+    # @param [String] document
+    def initialize(xml)
+      @document = Nokogiri::XML(xml)
+      @document.remove_namespaces!
+
+      @package = @document.at_css('package')
+      @metadata = @document.at_css('package metadata')
+      @manifest = @document.at_css('package manifest')
+      @spine = @document.at_css('package spine')
+
+      @manifest_items = @document.css('package manifest item')
+                                 .map { |node| ManifestItem.from_node(node) }
+                                 .map { |item| [item.id, item] }
+                                 .to_h
+      @spine_items = @document.css('package spine itemref')
+                              .map { |node| SpineItem.from_node(node) }
+      @guide_items = @document.css('package guide reference')
+                              .map { |node| GuideItem.from_node(node) }
+    end
+
+    # Find nav file in EPUB (both EPUB 2 and EPUB 3). Returns array with nav and type of nav (:xhtml or :ncx).
+    #
+    # @return [Array<ManifestItem, [:ncx, :xhtml]>, nil] nav, ncx
+    #
+    def find_nav
+      nav = @manifest_items.find { |_, item| item.properties == 'nav' }&.last
+      return [nav, NavFile::MODE_XHTML] if nav
+
+      ncx_id = @spine['toc'] if @spine
+      ncx = manifest_file_by_id(ncx_id) if ncx_id
+      return [ncx, NavFile::MODE_NCX] if ncx
+
+      nil
+    end
+
+    # Returns main unique identifier of this EPUB
+    #
+    # @return [String, nil]
+    #
+    def raw_unique_identifier
+      id = @package['unique-identifier']
+      return unless id
+
+      @metadata.at_css(%(identifier[id="#{id}"]))&.text
+    end
+
+    # Return all identifiers from EPUB metadata
+    #
+    # @return [Array<Nokogiri::XML::Node>]
+    #
+    def identifiers
+      @metadata.css('identifier')
+    end
+
+    # Find meta refines in EPUB 3 metadata
+    #
+    # @param [String] id
+    # @param [String] property
+    #
+    # @return [String, nil]
+    #
+    def find_refines(id, property)
+      @metadata.at_css(%(meta[refines="##{id}"][property="#{property}"]))&.text
+    end
+
+    # Find file in <manifest> by id. Throws exception when not found.
+    #
+    # @param [String] id
+    #
+    # @return [ManifestItem]
+    #
+    def manifest_file_by_id(id)
+      item = @manifest_items[id]
+      raise "Manifest item with id #{id.inspect} not found" unless item
+
+      item
+    end
+
+    # Find file in <manifest> by href. Throws exception when not found.
+    #
+    # @param [String] href
+    #
+    # @return [ManifestItem]
+    #
+    def manifest_file_by_href(href)
+      # remove anchor
+      href = href.sub(/#.*$/, '')
+
+      item = @manifest_items.find { |_, i| i.href == href }&.last
+      raise "Manifest item with href #{href.inspect} not found" unless item
+
+      item
+    end
+  end
+end

data/lib/epuber/helper.rb

@@ -2,7 +2,6 @@
 
 module Epuber
   module Helper
-
     # @param [Book::TocItem] toc_item
     # @param [Compiler::FileResolver] file_resolver
     # @param [String] context_path

data/lib/epuber/lockfile.rb

@@ -18,18 +18,16 @@ module Epuber
     # @return [self]
     #
     def self.from_file(file_path)
-      if File.exist?(file_path)
-        hash = YAML.safe_load(File.read(file_path))
-      else
-        hash = {}
-      end
+      hash = if File.exist?(file_path)
+               YAML.safe_load(File.read(file_path))
+             else
+               {}
+             end
 
       # backward compatibility for version 0.5 and older
-      if hash.include?('version')
-        hash['epuber_version'] = hash.delete('version')
-      end
+      hash['epuber_version'] = hash.delete('version') if hash.include?('version')
 
-      inst = self.new(hash)
+      inst = new(hash)
       inst.defined_from_file = file_path
       yield inst if hash.empty? && block_given?
       inst

data/lib/epuber/plugin.rb

@@ -18,7 +18,7 @@ module Epuber
         super(file_path)
         @instances = []
 
-        eval(::File.read(file_path), binding, file_path)
+        eval(::File.read(file_path), binding, file_path) # rubocop:disable Security/Eval
       end
 
       # @param [Symbol] name  name of the plugin function
@@ -66,7 +66,7 @@ module Epuber
     #
     attr_reader :files
 
-    # @param path [String]
+    # @param [String] path
     #
     def initialize(path)
       @path = path
@@ -97,7 +97,6 @@ module Epuber
       end.flatten
     end
 
-
     # @return [Array<Checker>]
     #
     def checkers

data/lib/epuber/ruby_extensions/match_data.rb

@@ -17,7 +17,7 @@ class MatchData
   #
   def line_number
     n = pre_match_lines.length
-    n += 1 if n == 0 # it can't be zero, this happens only when the match is at the beginning of file or string
+    n += 1 if n.zero? # it can't be zero, this happens only when the match is at the beginning of file or string
     n
   end
 

data/lib/epuber/ruby_extensions/thread.rb

@@ -6,6 +6,7 @@ class Thread
       def hash
         to_s.hash
       end
+
       def ==(other)
         to_s == other.to_s
       end

data/lib/epuber/server/base.styl

@@ -1,3 +1,2 @@
 
-main_font_family = AvenirNext
 text_color = #B87B4A

data/lib/epuber/server/basic.styl

@@ -9,7 +9,7 @@ body, div, html, p
 
 
 body
-  font-family main_font_family
+  font-family system-ui, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
   font-weight normal
   font-size 20px
 
@@ -184,32 +184,3 @@ p.file
   span.arrow
     font-family monospace
     color text_color
-
-
-
-
-
-
-@font-face
-  font-family AvenirNext
-  font-style normal
-  font-weight bold
-  src url(fonts/AvenirNext/AvenirNext-Bold.ttf)
-
-@font-face
-  font-family AvenirNext
-  font-style italic
-  font-weight bold
-  src url(fonts/AvenirNext/AvenirNext-BoldItalic.ttf)
-
-@font-face
-  font-family AvenirNext
-  font-style italic
-  font-weight normal
-  src url(fonts/AvenirNext/AvenirNext-Italic.ttf)
-
-@font-face
-  font-family AvenirNext
-  font-style normal
-  font-weight normal
-  src url(fonts/AvenirNext/AvenirNext-Regular.ttf)

data/lib/epuber/server/handlers.rb

@@ -49,7 +49,7 @@ module Epuber
     #
     def handle_bade(file_path)
       [200, self.class.render_bade(file_path)]
-    rescue => e
+    rescue StandardError => e
       env['sinatra.error'] = e
       ShowExceptions.new(self).call(env)
     end