epuber 0.10.3 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c22c5e5a5820ba5dd1090ddc015276e877b4aa535d3b0cdd83c526a6604aa5b
-  data.tar.gz: c8ac2c195d24bfb1971656d64777b1849b1371d59506559942c00ac826b58963
+  metadata.gz: 8328dc282e1b8005c4f8bda2fbfa27e93631b7263546f91ad21c12782993cc43
+  data.tar.gz: f8e18cfad5ef58ba6cbcfb00163a0583336ca82a84fa51ee3f44bdf44c8512c7
 SHA512:
-  metadata.gz: e5bbc9209f434dd869bbc6ca75ebaf0eca0945597665e6d1fb984cdf3e11193e3b59ee284c89c5eb46abc3fc3932b7168282dc73340e72afc2419422d8da9918
-  data.tar.gz: bb1fe4b5fbad4f79d69b1f357ca58c58aaa7abd504b8c9fec96dd7b6105060a3ef53a93db579b0ef6ddb1565433c1d8f30dc8afbd484817dd92839aafb88109f
+  metadata.gz: a5f94c11d61f90ee7a7a1f1f0e302128b43af0565bd63418096712497df063cb20dc93cf98470b8a085e1195236dd05d22700613ebc1d6bee4fbc76692253ee4
+  data.tar.gz: 276943d5147aadb12e6d1514736b4023fa96875351c207fd1263b74c2706df986ed4c8ab8ed5579fe25bc99d096a858c4bdfc6e9d7f9dff23f47fc80b91de870

data/epuber.gemspec

@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rmagick', '>= 4.2', '< 7.0'
   spec.add_runtime_dependency 'rubyzip', '~> 2.3'
 
-  spec.add_runtime_dependency 'epubcheck-ruby', '>= 4.0', '< 6.0'
+  spec.add_runtime_dependency 'epubcheck-ruby', '>= 4.0', '< 6.0', '!= 5.2.0.0'
 
   spec.add_runtime_dependency 'bade', '~> 0.3', '>= 0.3.1'
   spec.add_runtime_dependency 'coffee-script', '~> 2.4'

data/lib/epuber/command/build.rb

@@ -74,7 +74,7 @@ module Epuber
 
             archive_name = compiler.epub_name
 
-            FileUtils.remove_file(archive_name) if ::File.exist?(archive_name)
+            FileUtils.rm_f(archive_name)
 
             archive_path = compiler.archive(archive_name)
             run_epubcheck(archive_path, build_path)

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

@@ -5,34 +5,44 @@ module Epuber
     module FileTypes
       require_relative 'generated_file'
 
-      class NavFile < GeneratedFile
-        # @return [Epuber::Version]
+      class NavAbstractFile < GeneratedFile
+        # @return [Class]
         #
-        attr_reader :epub_version
+        attr_reader :generator_type
 
-        # @param [Epuber::Version] epub_version
+        # @param [String] filename
+        # @param [Class] generator Class of generator (subclass of Epuber::Compiler::Generator)
         #
-        def initialize(epub_version)
+        def initialize(filename, generator_type, properties = [])
           super()
 
-          @epub_version = epub_version
-
-          properties << :navigation
-
-          self.destination_path = if epub_version >= 3
-                                    'nav.xhtml'
-                                  else
-                                    'nav.ncx'
-                                  end
+          @generator_type = generator_type
 
+          self.properties = properties
+          self.destination_path = filename
           self.path_type = :manifest
         end
 
         # @param [Compiler::CompilationContext] compilation_context
         #
         def process(compilation_context)
-          gen = NavGenerator.new(compilation_context)
-          write_generate(gen.generate_nav.to_s)
+          result = generator_type.new(compilation_context)
+                                 .generate
+                                 .to_s
+
+          write_generate(result)
+        end
+      end
+
+      class NavFile < NavAbstractFile
+        def initialize
+          super('nav.xhtml', NavGenerator, [:navigation])
+        end
+      end
+
+      class NcxFile < NavAbstractFile
+        def initialize
+          super('toc.ncx', NcxGenerator, [])
         end
       end
     end

data/lib/epuber/compiler/nav_generator.rb

@@ -2,17 +2,12 @@
 
 require_relative '../book/toc_item'
 
-
 module Epuber
   class Compiler
     require_relative 'file_resolver'
     require_relative 'generator'
 
     class NavGenerator < Generator
-      NCX_NAMESPACES = {
-        'xmlns' => 'http://www.daisy.org/z3986/2005/ncx/',
-      }.freeze
-
       XHTML_NAMESPACES = {
         'xmlns' => 'http://www.w3.org/1999/xhtml',
         'xmlns:epub' => 'http://www.idpf.org/2007/ops',
@@ -37,13 +32,9 @@ module Epuber
       #
       # @return [Nokogiri::XML::Document]
       #
-      def generate_nav
+      def generate
         generate_xml do
-          if @target.epub_version >= 3
-            generate_xhtml_content
-          else
-            generate_ncx_content
-          end
+          generate_xhtml_content
         end
       end
 
@@ -53,13 +44,9 @@ module Epuber
       # @return [Hash<String, String>]
       #
       def nav_namespaces
-        if @target.epub_version >= 3
-          dict = XHTML_NAMESPACES
-          dict = dict.merge(XHTML_IBOOKS_NAMESPACES) if @target.ibooks?
-          dict
-        else
-          NCX_NAMESPACES
-        end
+        dict = XHTML_NAMESPACES
+        dict = dict.merge(XHTML_IBOOKS_NAMESPACES) if @target.ibooks?
+        dict
       end
 
       # @return nil
@@ -86,46 +73,15 @@ module Epuber
         end
       end
 
-      def generate_ncx_content
-        @xml.doc.create_internal_subset('ncx',
-                                        '-//NISO//DTD ncx 2005-1//EN',
-                                        'http://www.daisy.org/z3986/2005/ncx-2005-1.dtd')
-
-        @xml.ncx(nav_namespaces, version: '2005-1') do
-          # head
-          @xml.head do
-            @xml.meta(name: 'dtb:uid', content: @target.identifier || "urn:isbn:#{@target.isbn}")
-          end
-
-          # title
-          @xml.docTitle do
-            @xml.text_(@book.title)
-          end
-
-          @nav_nav_point_id = 1
-
-          # nav map
-          @xml.navMap do
-            visit_toc_items(@target.root_toc.sub_items)
-          end
-        end
-      end
-
       # @param [Array<Epuber::Book::TocItem>] toc_items
       #
       def visit_toc_items(toc_items)
-        iterate_lambda = lambda do
-          toc_items.each do |child_item|
-            visit_toc_item(child_item)
-          end
-        end
-
-        if @target.epub_version >= 3 && toc_items.length.positive? && contains_item_with_title(toc_items)
+        if toc_items.length.positive? && contains_item_with_title(toc_items)
           @xml.ol do
-            iterate_lambda.call
+            toc_items.each do |child_item|
+              visit_toc_item(child_item)
+            end
           end
-        else
-          iterate_lambda.call
         end
       end
 
@@ -140,23 +96,11 @@ module Epuber
 
         if toc_item.title.nil?
           visit_toc_items(toc_item.sub_items)
-        elsif @target.epub_version >= 3
+        else
           @xml.li do
             node_builder = @xml.a(href: result_file_path)
             node_builder.node.inner_html = toc_item.title
 
-            visit_toc_items(toc_item.sub_items)
-          end
-        else
-          @xml.navPoint(id: "navPoint_#{@nav_nav_point_id}") do
-            @xml.navLabel do
-              node_builder = @xml.text_
-              node_builder.node.inner_html = toc_item.title
-            end
-            @xml.content(src: result_file_path)
-
-            @nav_nav_point_id += 1
-
             visit_toc_items(toc_item.sub_items)
           end
         end

data/lib/epuber/compiler/ncx_generator.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require_relative '../book/toc_item'
+
+module Epuber
+  class Compiler
+    class NcxGenerator < Generator
+      NCX_NAMESPACES = {
+        'xmlns' => 'http://www.daisy.org/z3986/2005/ncx/',
+      }.freeze
+
+      def generate
+        generate_xml do
+          _generate_ncx_content
+        end
+      end
+
+      private
+
+      def _generate_ncx_content
+        @xml.doc.create_internal_subset('ncx',
+                                        '-//NISO//DTD ncx 2005-1//EN',
+                                        'http://www.daisy.org/z3986/2005/ncx-2005-1.dtd')
+
+        @xml.ncx(NCX_NAMESPACES, version: '2005-1') do
+          # head
+          @xml.head do
+            @xml.meta(name: 'dtb:uid', content: @target.identifier || "urn:isbn:#{@target.isbn}")
+          end
+
+          # title
+          @xml.docTitle do
+            @xml.text_(@book.title)
+          end
+
+          @nav_nav_point_id = 1
+
+          # nav map
+          @xml.navMap do
+            _visit_toc_items(@target.root_toc.sub_items)
+          end
+        end
+      end
+
+      # @param [Array<Epuber::Book::TocItem>] toc_items
+      #
+      def _visit_toc_items(toc_items)
+        toc_items.each do |child_item|
+          _visit_toc_item(child_item)
+        end
+      end
+
+      # @param [Epuber::Book::TocItem] toc_item
+      #
+      def _visit_toc_item(toc_item)
+        result_file_path = pretty_path_for_toc_item(toc_item)
+
+        if toc_item.title.nil?
+          _visit_toc_items(toc_item.sub_items)
+        else
+          @xml.navPoint(id: "navPoint_#{@nav_nav_point_id}", playOrder: @nav_nav_point_id.to_s) do
+            @xml.navLabel do
+              node_builder = @xml.text_
+              node_builder.node.inner_html = toc_item.title
+            end
+            @xml.content(src: result_file_path)
+
+            @nav_nav_point_id += 1
+
+            _visit_toc_items(toc_item.sub_items)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/epuber/compiler/opf_generator.rb

@@ -184,14 +184,12 @@ module Epuber
       # @return nil
       #
       def generate_spine
-        args = if @target.epub_version >= 3
-                 {}
-               else
-                 nav_file = @file_resolver.manifest_files.find { |file| file.destination_path.end_with?('.ncx') }
-                 raise 'not found nav file' if nav_file.nil?
-
-                 { toc: create_id_from_path(pretty_path(nav_file)) }
-               end
+        ncx_file = @file_resolver.manifest_files.find { |file| file.is_a?(FileTypes::NcxFile) }
+        raise 'not found NCX file' if ncx_file.nil?
+
+        args = {
+          toc: create_id_from_path(pretty_path(ncx_file)),
+        }
 
         all_items = @target.root_toc.flat_sub_items.map do |toc_item|
           result_file = @file_resolver.file_from_request(toc_item.file_request)

data/lib/epuber/compiler.rb

@@ -14,6 +14,7 @@ module Epuber
 
     require_relative 'compiler/opf_generator'
     require_relative 'compiler/nav_generator'
+    require_relative 'compiler/ncx_generator'
     require_relative 'compiler/meta_inf_generator'
 
     require_relative 'compiler/file_resolver'
@@ -199,10 +200,17 @@ module Epuber
     # @return nil
     #
     def generate_other_files
-      # generate nav file (nav.xhtml or nav.ncx)
-      nav_file = FileTypes::NavFile.new(@target.epub_version)
-      @file_resolver.add_file(nav_file)
-      process_file(nav_file)
+      # generate ncx file (nav.ncx)
+      ncx_file = FileTypes::NcxFile.new
+      @file_resolver.add_file(ncx_file)
+      process_file(ncx_file)
+
+      if @target.epub_version >= 3.0
+        # generate nav file (nav.xhtml)
+        nav_file = FileTypes::NavFile.new
+        @file_resolver.add_file(nav_file)
+        process_file(nav_file)
+      end
 
       # generate .opf file
       opf_file = FileTypes::OPFFile.new

data/lib/epuber/dsl/attribute.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'date'
-
 require 'active_support/core_ext/string/inflections'
 
 module Epuber
@@ -33,7 +32,6 @@ module Epuber
                      default_value: nil,
                      auto_convert: {},
                      types: nil)
-
         @name = name
 
         @inherited     = inherited

data/lib/epuber/dsl/object.rb

@@ -3,6 +3,7 @@
 require_relative 'attribute'
 require_relative 'attribute_support'
 
+require 'logger' # for active_support to work in version 6.1.7.10
 require 'active_support'
 require 'active_support/core_ext/string/inflections'
 

data/lib/epuber/epubcheck.rb

@@ -34,7 +34,7 @@ module Epuber
       end
 
       def error?
-        level == :error || level == :fatal
+        %i[error fatal].include?(level)
       end
     end
 
@@ -48,7 +48,7 @@ module Epuber
 
         Dir.mktmpdir('epubcheck-') do |tmpdir|
           json_path = File.join(tmpdir, 'epubcheck.json')
-          Open3.popen2('epubcheck', path, '--json', json_path) do |_stdin, _stdout, wait_thr|
+          Open3.popen3('epubcheck', path, '--json', json_path) do |_in, _out, _err, wait_thr|
             wait_thr.value # wait for the process to finish
             report = _parse_json(File.read(json_path))
           end

data/lib/epuber/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Epuber
-  VERSION = '0.10.3'
+  VERSION = '0.11.1'
 
   HOME_URL = 'https://github.com/epuber-io/epuber'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: epuber
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.11.1
 platform: ruby
 authors:
 - Roman Kříž
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-03 00:00:00.000000000 Z
+date: 2025-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -246,6 +245,9 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 5.2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -256,6 +258,9 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 5.2.0.0
 - !ruby/object:Gem::Dependency
   name: bade
   requirement: !ruby/object:Gem::Requirement
@@ -330,7 +335,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.1
-description:
 email:
 - samnung@gmail.com
 executables:
@@ -385,6 +389,7 @@ files:
 - lib/epuber/compiler/generator.rb
 - lib/epuber/compiler/meta_inf_generator.rb
 - lib/epuber/compiler/nav_generator.rb
+- lib/epuber/compiler/ncx_generator.rb
 - lib/epuber/compiler/opf_generator.rb
 - lib/epuber/compiler/problem.rb
 - lib/epuber/compiler/xhtml_processor.rb
@@ -582,7 +587,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -597,8 +601,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.3
 specification_version: 4
 summary: Epuber is simple tool to compile and pack source files into EPUB format.
 test_files: []