asciidoctor-epub3 1.5.0.alpha.12

data/lib/asciidoctor-epub3/spine_item_processor.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Epub3
+    class SpineItemProcessor < Extensions::IncludeProcessor
+      include ::Asciidoctor::Logging
+
+      def initialize document
+        @document = document
+      end
+
+      # NOTE only fires for includes in spine document if registered directly on the instance of the spine document
+      def process doc, reader, target, _attributes
+        spine_doc = doc
+        # TODO: allow URI value
+        unless ::File.file? (include_file = (spine_doc.normalize_system_path target, reader.dir, nil, target_name: 'include file'))
+          logger.warn %(#{reader.line_info}: include file not found: #{include_file})
+          return
+        end
+        inherited_attrs = spine_doc.attributes.dup
+        # QUESTION should we keep backend-epub3 for convenience?
+        %w(backend-epub3 backend-epub3-doctype-book docdir docfile docname doctitle outfilesuffix spine).each {|key| inherited_attrs.delete key }
+        if (leveloffset = inherited_attrs['leveloffset'])
+          leveloffset = inherited_attrs['leveloffset'] = %(#{leveloffset}@) unless leveloffset.end_with? '@'
+        end
+
+        # parse header to get author information
+        spine_item_doc_meta = ::Asciidoctor.load_file include_file,
+            safe: spine_doc.safe,
+            backend: 'epub3-xhtml5',
+            doctype: :article,
+            parse_header_only: true,
+            attributes: leveloffset ? { 'leveloffset' => leveloffset } : nil
+
+        # blank out author information if present in sub-document
+        # FIXME this is a huge hack...we need a cleaner way to do this; perhaps an API method that retrieves all the author attribute names
+        if spine_item_doc_meta.attr? 'author'
+          %w(author firstname lastname email authorinitials authors authorcount).each {|key| inherited_attrs.delete key }
+          idx = 1
+          while inherited_attrs.key? %(author_#{idx})
+            %W[author_#{idx} firstname_#{idx} lastname_#{idx} email_#{idx} authorinitials_#{idx}].each {|key| inherited_attrs.delete key }
+            idx += 1
+          end
+        end
+
+        # REVIEW: reaching into converter to resolve document id feels like a hack; should happen in Asciidoctor parser
+        # also, strange that "id" doesn't work here
+        idprefix = (spine_doc.attr 'idprefix') || (spine_item_doc_meta.attr 'idprefix')
+        idseparator = (spine_doc.attr 'idseparator') || (spine_item_doc_meta.attr 'idseparator')
+        inherited_attrs['css-signature'] = DocumentIdGenerator.generate_id spine_item_doc_meta, idprefix, idseparator
+        inherited_attrs['docreldir'] = ::File.dirname target
+
+        # NOTE can't assign spine document as parent since there's too many assumptions in the Asciidoctor processor
+        spine_item_doc = ::Asciidoctor.load_file include_file,
+            # setting base_dir breaks if outdir is not a subdirectory of spine_doc.base_dir
+            #base_dir: spine_doc.base_dir,
+            # NOTE won't write to correct directory if safe mode is :secure
+            safe: spine_doc.safe,
+            backend: 'epub3-xhtml5',
+            doctype: :article,
+            header_footer: true,
+            catalog_assets: true,
+            attributes: inherited_attrs
+
+        # restore attributes to those defined in the document header
+        spine_item_doc.restore_attributes
+
+        # FIXME: core should register document ID if specified
+        unless (refs = spine_item_doc.references)[:ids].include? spine_item_doc.id
+          spine_item_doc.register :ids, [spine_item_doc.id, (spine_item_doc.attr 'docreftext') || spine_item_doc.doctitle]
+        end
+
+        refs[:spine] = spine_doc
+        refs[:spine_items] = ((spine_doc.references[:spine_items] ||= []) << spine_item_doc)
+        # NOTE if there are attribute assignments between the include directives,
+        # then this ordered list is not continguous, so bailing on the idea
+        #reader.replace_line %(. link:#{::File.basename(spine_item_doc.attr 'outfile')}[#{spine_item_doc.doctitle}])
+        nil
+      end
+
+      # handles? should get the attributes on include directive as the second argument
+      def handles? target
+        (@document.attr? 'spine') && (ASCIIDOC_EXTENSIONS.include? ::File.extname(target))
+      end
+
+      # FIXME: this method shouldn't be required
+      def update_config config
+        (@config ||= {}).update config
+      end
+    end
+  end
+end

data/lib/asciidoctor-epub3/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Asciidoctor
+  module Epub3
+    VERSION = '1.5.0.alpha.12'
+  end
+end

metadata

@@ -0,0 +1,237 @@
+--- !ruby/object:Gem::Specification
+name: asciidoctor-epub3
+version: !ruby/object:Gem::Version
+  version: 1.5.0.alpha.12
+platform: ruby
+authors:
+- Dan Allen
+- Sarah White
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.79.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.37.0
+- !ruby/object:Gem::Dependency
+  name: asciidoctor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.3
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: epubcheck-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.2.0
+- !ruby/object:Gem::Dependency
+  name: gepub
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: kindlegen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+description: 'An extension for Asciidoctor that converts AsciiDoc documents to EPUB3
+  and KF8/MOBI (Kindle) e-book archives.
+
+'
+email: dan@opendevise.com
+executables:
+- asciidoctor-epub3
+- adb-push-ebook
+extensions: []
+extra_rdoc_files: []
+files:
+- ".yardopts"
+- CHANGELOG.adoc
+- Gemfile
+- LICENSE.adoc
+- NOTICE.adoc
+- README.adoc
+- Rakefile
+- asciidoctor-epub3.gemspec
+- bin/adb-push-ebook
+- bin/asciidoctor-epub3
+- data/fonts/assorted-icons.ttf
+- data/fonts/fontawesome-icons.ttf
+- data/fonts/mplus1mn-bold-ascii.ttf
+- data/fonts/mplus1mn-bolditalic-ascii.ttf
+- data/fonts/mplus1mn-italic-ascii.ttf
+- data/fonts/mplus1mn-regular-ascii-conums.ttf
+- data/fonts/mplus1p-bold-latin-cyrillic.ttf
+- data/fonts/mplus1p-bold-latin-ext.ttf
+- data/fonts/mplus1p-bold-latin.ttf
+- data/fonts/mplus1p-bold-multilingual.ttf
+- data/fonts/mplus1p-light-latin-cyrillic.ttf
+- data/fonts/mplus1p-light-latin-ext.ttf
+- data/fonts/mplus1p-light-latin.ttf
+- data/fonts/mplus1p-light-multilingual.ttf
+- data/fonts/mplus1p-regular-latin-cyrillic.ttf
+- data/fonts/mplus1p-regular-latin-ext.ttf
+- data/fonts/mplus1p-regular-latin.ttf
+- data/fonts/mplus1p-regular-multilingual.ttf
+- data/fonts/notoserif-bold-latin-cyrillic.ttf
+- data/fonts/notoserif-bold-latin-ext.ttf
+- data/fonts/notoserif-bold-latin.ttf
+- data/fonts/notoserif-bold-multilingual.ttf
+- data/fonts/notoserif-bolditalic-latin-cyrillic.ttf
+- data/fonts/notoserif-bolditalic-latin-ext.ttf
+- data/fonts/notoserif-bolditalic-latin.ttf
+- data/fonts/notoserif-bolditalic-multilingual.ttf
+- data/fonts/notoserif-italic-latin-cyrillic.ttf
+- data/fonts/notoserif-italic-latin-ext.ttf
+- data/fonts/notoserif-italic-latin.ttf
+- data/fonts/notoserif-italic-multilingual.ttf
+- data/fonts/notoserif-regular-latin-cyrillic.ttf
+- data/fonts/notoserif-regular-latin-ext.ttf
+- data/fonts/notoserif-regular-latin.ttf
+- data/fonts/notoserif-regular-multilingual.ttf
+- data/images/default-avatar.jpg
+- data/images/default-avatar.png
+- data/images/default-avatar.svg
+- data/images/default-cover.svg
+- data/images/default-headshot.jpg
+- data/images/default-headshot.png
+- data/styles/color-palette.css
+- data/styles/epub3-css3-only.css
+- data/styles/epub3-fonts.css
+- data/styles/epub3.css
+- lib/asciidoctor-epub3.rb
+- lib/asciidoctor-epub3/converter.rb
+- lib/asciidoctor-epub3/ext.rb
+- lib/asciidoctor-epub3/ext/asciidoctor.rb
+- lib/asciidoctor-epub3/ext/asciidoctor/logging_shim.rb
+- lib/asciidoctor-epub3/ext/core.rb
+- lib/asciidoctor-epub3/ext/core/string.rb
+- lib/asciidoctor-epub3/font_icon_map.rb
+- lib/asciidoctor-epub3/packager.rb
+- lib/asciidoctor-epub3/spine_item_processor.rb
+- lib/asciidoctor-epub3/version.rb
+homepage: https://github.com/asciidoctor/asciidoctor-epub3
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Converts AsciiDoc documents to EPUB3 and KF8/MOBI (Kindle) e-book formats
+test_files: []