epub-parser 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2373a741e554fee584d9b3562e655a33e34420c6dd335ffc32f041da5507c1d5
-  data.tar.gz: 2224f8bf83deed854f8181f791bf0e5e58b0feaa40e39a5d94b754acef6f841c
+  metadata.gz: 5267c2c665a4fd1fe119e59ed905fdafee49e4f68f063750d80260424ef26ccc
+  data.tar.gz: 3d79ee849a6a7da2e0ac424e6aa5ef272beda4544af29e909f432fabb0f7d402
 SHA512:
-  metadata.gz: 5c9eeed9058f10661e27e42ad1366d831ebdebe06879b80c8e44114d0ea74de8f2b15e2909d9602a7deacc351ef1074cf37c5a2e7f4592a141ef2b336474efeb
-  data.tar.gz: c2b8c9f85ed82c2720816b80d393884be55c258084b89723adc84cdf490d6e721926df931ff660bb0d06234650018f09f8ef85604cacae5f4b0575c6c691168f
+  metadata.gz: eda5efdf8d48603ffe69b135011bbd8156d1dff9c78794971d2250162069d5e1b18f0ff579d7324511656df26e0202302c1ce991421eee0c286ad8c6104b6f92
+  data.tar.gz: 7f73b72cb0b7b7fc77c783ce643bd58fc99cf2644497c8eced82f002c412825025a1515a923f6b8a7bd7b7a4d76bc6335c5d520fa0176313cef9daa61529d400

data/CHANGELOG.adoc

@@ -2,12 +2,13 @@
 
 == 0.4.7
 
-* Remove version specification from Nokogiri to migrate to Ruby 3.1
+* [BUG FIX]Fix a bug that epubinfo doesn't handle navigation properly
 
 == 0.4.6
 
 * [BUG FIX]Prevent epubinfo tool raise exception when no nav elements
 * Tiny modifcation on Zip archive manipulation
+* Remove version specification from Nokogiri to migrate to Ruby 3.1
 
 == 0.4.5
 

data/README.adoc

@@ -178,12 +178,13 @@ If you find other gems, please tell me or request a pull request.
 
 === 0.4.7
 
-* Remove version specification from Nokogiri to migrate to Ruby 3.1
+* [BUG FIX]Fix a bug that epubinfo doesn't handle navigation properly
 
 === 0.4.6
 
 * [BUG FIX]Prevent epubinfo tool raise exception when no nav elements
 * Tiny modifcation on Zip archive manipulation
+* Remove version specification from Nokogiri to migrate to Ruby 3.1
 
 === 0.4.5
 

data/Steepfile

@@ -0,0 +1,27 @@
+# D = Steep::Diagnostic
+#
+# target :lib do
+#   signature "sig"
+#
+#   check "lib"                       # Directory name
+#   check "Gemfile"                   # File name
+#   check "app/models/**/*.rb"        # Glob
+#   # ignore "lib/templates/*.rb"
+#
+#   # library "pathname", "set"       # Standard libraries
+#   # library "strong_json"           # Gems
+#   
+#   # configure_code_diagnostics(D::Ruby.strict)       # `strict` diagnostics setting
+#   # configure_code_diagnostics(D::Ruby.lenient)      # `lenient` diagnostics setting
+#   # configure_code_diagnostics do |hash|             # You can setup everything yourself
+#   #   hash[D::Ruby::NoMethod] = :information
+#   # end
+# end
+
+# target :test do
+#   signature "sig", "sig-private"
+#
+#   check "test"
+#
+#   # library "pathname", "set"       # Standard libraries
+# end

data/bin/epubinfo

@@ -66,7 +66,7 @@ data['modified'] = book.modified
 data['unique identifier'] = book.metadata.unique_identifier
 data['epub version'] = book.package.version
 nav = book.manifest.navs.first
-data["navigations"] = nav ? nav.book.manifest.navs.first&.content_document&.navigations&.collect(&:type)&.join(", ") : []
+data["navigations"] = nav ? nav&.content_document&.navigations&.collect(&:type)&.join(", ") : []
 
 data.each_pair do |(key, value)|
   data[key] = value.respond_to?(:join) ? value.join(", ") : value.to_s

data/epub-parser.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rubygems-tasks'
-  s.add_development_dependency 'zipruby' unless RUBY_PLATFORM.match /mingw/
+  s.add_development_dependency 'zipruby' unless RUBY_PLATFORM.match /mingw|arm64-darwin/
   s.add_development_dependency 'pry'
   s.add_development_dependency 'pry-doc'
   s.add_development_dependency 'test-unit'
@@ -36,7 +36,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'yard'
   s.add_development_dependency 'gem-man'
-  s.add_development_dependency 'ronn'
+  s.add_development_dependency 'ronn-ng'
   s.add_development_dependency 'pretty_backtrace'
   s.add_development_dependency 'epub-maker'
   s.add_development_dependency 'asciidoctor'

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.4.6"
+    VERSION = "0.4.7"
   end
 end

data/sig/epub-parser.rbs

@@ -0,0 +1,425 @@
+# TypeProf 0.21.3
+
+# Revealed types
+#  /Users/kitaitimakoto/.gem/ruby/3.1.3/gems/nokogiri-1.13.10-arm64-darwin/lib/nokogiri/html4/element_description_defaults.rb:570 #=> String
+
+# Classes
+module EPUB
+  NAMESPACES: Hash[String, String]
+
+  module Inspector
+    INSTANCE_VARIABLES_OPTION: {exclude: Array[untyped]}
+    SIMPLE_TEMPLATE: String
+
+    def inspect_simply: -> String
+    def inspect_object_id: -> String
+    def inspect_instance_variables: (?Hash[untyped, untyped] options) -> untyped
+
+    module PublicationModel
+      def self.included: (untyped mod) -> untyped
+      def inspect: -> String
+      def template: -> String
+    end
+  end
+
+  class OCF
+    MODULES: [String, String, String, String, String, String]
+
+    attr_accessor book: Book | Book::Features
+
+    class PhysicalContainer
+      self.@adapter: :UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(UnpackedDirectory)
+      @container_path: String | URI::Generic
+      @monitor: Monitor
+
+      def self.find_adapter: (:UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(UnpackedDirectory) adapter) -> (:UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(UnpackedDirectory))
+      def self.adapter: -> (:UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(UnpackedDirectory))
+      def self.adapter=: (:UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(UnpackedDirectory) adapter) -> (:UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(UnpackedDirectory))
+      def self.open: (String container_path) { (IO | UnpackedDirectory) -> (Parser::OCF | String) } -> String
+      def self.read: (String container_path, String path_name) -> String
+      def self._adapter: -> ((:UnpackedDirectory | :UnpackedURI | singleton(ArchiveZip) | singleton(PhysicalContainer) | singleton(UnpackedDirectory))?)
+      def initialize: (String | URI::Generic container_path) -> void
+
+      class ArchiveZip < PhysicalContainer
+        @entries: Hash[untyped, untyped]
+        @last_iterated_entry_index: Integer
+        @archive: nil
+
+        def initialize: (String container_path) -> void
+        def open: { (UnpackedDirectory) -> String } -> untyped
+        def read: (untyped path_name) -> untyped
+      end
+
+      class UnpackedDirectory < PhysicalContainer
+        def open: ?{ (UnpackedDirectory) -> String } -> String
+        def read: (String path_name) -> String
+      end
+
+      class UnpackedURI < PhysicalContainer
+        def initialize: (String | URI::Generic container_path) -> void
+        def open: -> untyped
+        def read: (String path_name) -> untyped
+      end
+
+      class NoEntry < StandardError
+        def self.from_error: (nil error) -> NoEntry
+      end
+
+      class Zipruby < PhysicalContainer
+        @archive: nil
+
+        def open: ?{ -> untyped } -> untyped
+        def read: (untyped path_name) -> untyped
+      end
+    end
+  end
+
+  module Publication
+    class Package
+      CONTENT_MODELS: [:metadata, :manifest, :spine, :guide, :bindings]
+      RESERVED_VOCABULARY_PREFIXES: Hash[String, String]
+      include Inspector
+      @metadata: bot
+
+      def self.define_content_model: (:bindings | :guide | :manifest | :metadata | :spine model_name) -> untyped
+      attr_accessor book: Book | Object
+      attr_accessor version: bot
+      attr_accessor prefix: Hash[String, String?]
+      attr_accessor xml_lang: bot
+      attr_accessor dir: bot
+      attr_accessor id: bot
+      alias lang xml_lang
+      alias lang= xml_lang=
+      def initialize: -> void
+      def unique_identifier: -> untyped
+      def rootfile: -> untyped
+      def full_path: -> nil
+      def inspect: -> String
+      def inspect_models: -> String
+    end
+
+    module FixedLayout
+      PREFIX_KEY: String
+      PREFIX_VALUE: String
+      RENDITION_PROPERTIES: Hash[String, Array[String]]
+
+      def self.included: (singleton(Package) package_class) -> [[singleton(Package), singleton(PackageMixin)], [untyped, singleton(MetadataMixin)], [untyped, singleton(ItemrefMixin)], [untyped, singleton(ItemMixin)], [singleton(ContentDocument::XHTML), singleton(ContentDocumentMixin)]]
+
+      class UnsupportedRenditionValue < StandardError
+      end
+
+      module Rendition
+        def def_rendition_methods: -> Array[String]
+        def def_rendition_layout_methods: -> Array[String]
+      end
+
+      module PackageMixin
+        def using_fixed_layout: -> untyped
+        alias using_fixed_layout? using_fixed_layout
+        def using_fixed_layout=: (untyped using_fixed_layout) -> String
+      end
+
+      module MetadataMixin
+        extend Rendition
+      end
+
+      module ItemrefMixin
+        PAGE_SPREAD_PROPERTY: String
+        PAGE_SPREAD_PREFIX: String
+        extend Rendition
+
+        def self.included: (untyped base) -> nil
+      end
+
+      module ItemMixin
+        extend Rendition
+      end
+
+      module ContentDocumentMixin
+        extend Rendition
+      end
+    end
+  end
+
+  module ContentDocument
+    class XHTML
+      @rexml: untyped
+      @oga: untyped
+      @nokogiri: Nokogiri::XML::Document
+
+      attr_accessor item: untyped
+      def read: (?detect_encoding: true) -> untyped
+      alias raw_document read
+      def top_level?: -> untyped
+      def title: -> String
+      def rexml: -> untyped
+      def oga: -> untyped
+      def nokogiri: -> Nokogiri::XML::Document
+    end
+
+    module Typable
+      attr_reader types: Set[bot]
+      def types: -> Set[bot]
+      def types=: (untyped ts) -> Set[bot]
+    end
+
+    class Navigation < XHTML
+      include Typable
+      @hidden: false
+      @parent: nil
+
+      attr_accessor navigations: Array[untyped]
+      def initialize: -> void
+      def toc: -> nil
+      def page_list: -> nil
+      def landmarks: -> nil
+      def contents: -> Array[untyped]
+      def pages: -> bot
+      def each_content: { -> bot } -> untyped
+      def each_page: -> bot
+      def each_landmark: -> bot
+      def navigation: -> nil
+
+      module Hidable
+        attr_accessor hidden: true?
+        attr_accessor parent: Item | ItemList | Navigation
+        def hidden?: -> bool
+      end
+
+      class Item
+        include Typable
+        include Hidable
+
+        attr_accessor items: ItemList
+        attr_accessor text: nil
+        attr_accessor content_document: untyped
+        attr_accessor item: untyped
+        attr_reader href: untyped
+        def initialize: -> void
+        def href=: (untyped iri) -> untyped
+        def traverse: (?Integer depth) -> ItemList
+        def type: -> nil
+        def type=: (untyped t) -> Set[bot]
+      end
+
+      class Navigation < Item
+        alias navigations items
+        alias navigations= items=
+        alias heading text
+        alias heading= text=
+
+        module Type
+          TOC: String
+          PAGE_LIST: String
+          LANDMARKS: String
+        end
+      end
+
+      class ItemList < Array[untyped]
+        include Hidable
+
+        def <<: (Item? item) -> ItemList
+      end
+    end
+  end
+
+  class Book
+    include Features
+    @adapter: :UnpackedDirectory | :UnpackedURI | singleton(OCF::PhysicalContainer::ArchiveZip) | singleton(OCF::PhysicalContainer::UnpackedDirectory)
+
+    module Features
+      extend Forwardable
+      @adapter: :UnpackedDirectory | :UnpackedURI | singleton(OCF::PhysicalContainer::ArchiveZip) | singleton(OCF::PhysicalContainer::UnpackedDirectory)
+
+      attr_reader ocf: OCF
+      attr_accessor epub_file: String
+      def ocf=: (OCF mod) -> OCF
+      def rootfiles: -> untyped
+      def packages: -> untyped
+      alias renditions packages
+      def default_rendition: -> untyped
+      alias package default_rendition
+      def container_adapter: -> (:UnpackedDirectory | :UnpackedURI | singleton(OCF::PhysicalContainer::ArchiveZip) | singleton(OCF::PhysicalContainer::UnpackedDirectory))
+      def container_adapter=: (:UnpackedDirectory | :UnpackedURI adapter) -> (:UnpackedDirectory | :UnpackedURI | singleton(OCF::PhysicalContainer::ArchiveZip) | singleton(OCF::PhysicalContainer::UnpackedDirectory))
+      def cover_image: -> untyped
+      def each_page_on_spine: ?{ -> untyped } -> untyped
+      def each_page_on_toc: -> untyped
+      def each_content: ?{ -> untyped } -> untyped
+      def other_navigation: -> untyped
+      def resources: -> untyped
+      def rootfile_path: -> untyped
+    end
+  end
+
+  module MediaType
+    EPUB: String
+    ROOTFILE: String
+    IMAGE: [String, String, String, String]
+    APPLICATION: [String, String, String, String, String, String]
+    AUDIO: [String, String]
+    TEXT: [String, String]
+    CORE: Array[String]
+
+    class UnsupportedMediaType < StandardError
+    end
+  end
+
+  module Type
+    DOCUMENT_NAVIGATION: [String, String]
+    PAGINATION: [String, String]
+    TYPES: Array[String]
+  end
+
+  class Parser
+    VERSION: String
+    @filepath: String
+    @book: Book
+
+    def self.parse: (String filepath, ?container_adapter: :UnpackedDirectory?, ?book: Object?, ?initialize_with: nil, **singleton(MyBook)) -> Book
+    def initialize: (String filepath, ?container_adapter: nil, ?book: nil, ?initialize_with: nil, **untyped) -> void
+    def parse: -> Book
+
+    private
+    def create_book: (?book: nil, ?initialize_with: nil, **untyped) -> Book
+
+    class XMLDocument
+      def self.new: (String? xml) -> Nokogiri::XML::Document
+    end
+
+    module Metadata
+      def parse_metadata: (untyped elem, untyped unique_identifier_id, String default_namespace) -> untyped
+      def build_model: (untyped elem, ?:DCMES | :Identifier | :Link | :Meta | :Title klass, ?Array[String] attributes) -> untyped
+      def build_unsupported_model: (untyped elem) -> untyped
+    end
+
+    class OCF
+      DIRECTORY: String
+      include Metadata
+      @container: (IO | OCF::PhysicalContainer::UnpackedDirectory)?
+      @ocf: OCF
+
+      def self.parse: (IO | OCF::PhysicalContainer::UnpackedDirectory container) -> OCF
+      def initialize: ((IO | OCF::PhysicalContainer::UnpackedDirectory)? container) -> void
+      def parse: -> OCF
+      def parse_container: (String xml) -> untyped
+      def parse_encryption: (String content) -> untyped
+      def parse_manifest: (untyped content) -> nil
+      def parse_metadata: (String content) -> untyped
+      def parse_rights: (untyped content) -> nil
+      def parse_signatures: (untyped content) -> nil
+
+      private
+      def multiple_rendition_metadata?: (Nokogiri::XML::Document doc) -> untyped
+    end
+
+    class Publication
+      include Metadata
+      @doc: Nokogiri::XML::Document
+
+      def self.parse: (IO container, untyped file) -> Publication::Package
+      def initialize: (String? opf) -> void
+      def parse: -> Publication::Package
+      def parse_package: (Nokogiri::XML::Document doc) -> Publication::Package
+      def parse_metadata: (Nokogiri::XML::Document doc) -> untyped
+      def parse_manifest: (Nokogiri::XML::Document doc) -> untyped
+      def parse_spine: (Nokogiri::XML::Document doc) -> untyped
+      def parse_guide: (Nokogiri::XML::Document doc) -> untyped
+      def parse_bindings: (Nokogiri::XML::Document doc, untyped handler_map) -> untyped
+      def parse_prefix: (untyped str) -> Hash[String, String?]
+    end
+
+    class ContentDocument
+      @item: untyped
+
+      def initialize: (untyped item) -> void
+      def parse: -> ((ContentDocument::Navigation | ContentDocument::XHTML)?)
+      def parse_navigations: (Nokogiri::XML::Document document) -> untyped
+      def parse_navigation: (untyped element) -> ContentDocument::Navigation::Navigation
+      def parse_navigation_item: (untyped element) -> ContentDocument::Navigation::Item?
+
+      private
+      def find_heading: (untyped element) -> nil
+    end
+  end
+
+  module Searcher
+    def self.search_text: (untyped epub, untyped word, **untyped) -> untyped
+    def self.search_element: (untyped epub, ?css: nil, ?xpath: nil, ?namespaces: Hash[untyped, untyped]) -> Array[untyped]
+    def self.search_by_cfi: (untyped epub, untyped cfi) -> [untyped, untyped]
+
+    class Result
+      def self.aggregate_step_intersection: (untyped steps1, untyped steps2) -> [Array[untyped], Array[untyped], Array[untyped]]
+      attr_reader parent_steps: Array[Step]
+      attr_reader start_steps: Array[Step]?
+      attr_reader end_steps: Array[Step]?
+      def initialize: (Array[Step] parent_steps, Array[Step]? start_steps, Array[Step]? end_steps) -> void
+      def to_cfi: -> untyped
+      def ==: (untyped other) -> bool
+
+      class Step
+        attr_reader type: :character | :element | :itemref | :text
+        attr_reader index: Complex | Float | Integer | Rational
+        attr_reader info: {name: String, id: String?}
+        def initialize: (:character | :element | :itemref | :text `type`, Complex | Float | Integer | Rational index, ?{name: String, id: String?} info) -> void
+        def ==: (untyped other) -> bool
+        def to_cfi: -> String?
+
+        private
+        def id_assertion: -> String?
+      end
+    end
+
+    class Publication
+      @package: Publication::Package?
+
+      def self.search_text: (Publication::Package? package, String word, **untyped) -> untyped
+      def self.search_element: (Publication::Package package, ?css: String?, ?xpath: String?, ?namespaces: Hash[String, String]) -> Array[untyped]
+      def self.search_by_cfi: (untyped package, untyped cfi) -> [untyped, untyped]
+      def initialize: (Publication::Package? package) -> void
+      def search_text: (untyped word, ?algorithm: :seamless) -> Array[untyped]
+      def search_element: (?css: String?, ?xpath: String?, ?namespaces: Hash[String, String]) -> Array[untyped]
+      def search_by_cfi: (untyped cfi) -> [untyped, untyped]
+
+      private
+      def find_path: (untyped elem) -> untyped
+    end
+
+    class XHTML
+      ALGORITHMS: Hash[untyped, untyped]
+      @element: Nokogiri::XML::Document
+
+      def self.search_text: (Nokogiri::XML::Document element, String word) -> Array[Result]
+      def initialize: (Nokogiri::XML::Document element) -> void
+
+      class Restricted < XHTML
+        def search_text: (String word, ?nil element) -> Array[untyped]
+      end
+
+      class Seamless < XHTML
+        @indices: Hash[untyped, untyped]?
+        @content: String
+
+        def initialize: (Nokogiri::XML::Document element) -> void
+        def search_text: (String word) -> Array[Result]
+        def build_indices: (Nokogiri::XML::Document element) -> [Hash[untyped, untyped], String]
+
+        private
+        def visit: (Hash[untyped, untyped]? indices, String? content, String word) -> Array[Result]
+        def find_offset: (Array[untyped] offsets, Complex | Float | Integer | Rational index, ?bool for_end_position) -> untyped
+        def to_result_steps: (nil steps) -> untyped
+      end
+    end
+  end
+end
+
+class TestInspect
+  class TestPackage < TestInspect
+    class TestMetadata < TestPackage
+      Metadata: untyped
+    end
+
+    class TestManifest < TestPackage
+      Manifest: untyped
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: epub-parser
 version: !ruby/object:Gem::Version
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors:
 - KITAITI Makoto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-26 00:00:00.000000000 Z
+date: 2023-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: zipruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -165,7 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: ronn
+  name: ronn-ng
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -352,6 +338,7 @@ files:
 - MIT-LICENSE
 - README.adoc
 - Rakefile
+- Steepfile
 - bin/epub-cover
 - bin/epub-open
 - bin/epubinfo
@@ -419,6 +406,7 @@ files:
 - lib/epub/searcher/result.rb
 - lib/epub/searcher/xhtml.rb
 - man/epubinfo.1.ronn
+- sig/epub-parser.rbs
 - test/fixtures/book/META-INF/container.xml
 - test/fixtures/book/META-INF/metadata.xml
 - test/fixtures/book/OEBPS/2_chapter-1.xhtml
@@ -457,7 +445,7 @@ licenses:
 - MIT
 metadata:
   yard.run: yard
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -472,8 +460,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key: 
+rubygems_version: 3.4.21
+signing_key:
 specification_version: 4
 summary: EPUB 3 Parser
 test_files: