bookbinder 0.2.0

data/lib/bookbinder/transform/epub/spine.rb

@@ -0,0 +1,79 @@
+class Bookbinder::Transform::EPUB_Spine < Bookbinder::Transform
+
+  def dependencies
+    [Bookbinder::Transform::EPUB_Resources]
+  end
+
+
+  def to_map(package)
+    opf_doc = package.file(:opf).document('r')
+    itemrefs = opf_doc.search('opf|spine > opf|itemref')
+    package.map['spine'] = itemrefs.collect { |itemref|
+      cmpt = package.map['resources'].detect { |r| r['id'] == itemref['idref'] }
+      if cmpt
+        package.map['resources'].delete(cmpt)
+        cmpt['linear'] = itemref['linear'] == 'no' ? false : true
+        cmpt
+      else
+        package.warn("No manifest item for spine idref: #{itemref['idref']}")
+      end
+    }.compact
+  end
+
+
+  def from_map(package)
+    opf_doc = package.file(:opf).document
+
+    package.map['spine'].each { |cmpt|
+      # Convert component to valid XHTML
+      cmpt_file = package.file(cmpt['path'])
+      cmpt_doc = cmpt_file.document
+      # Add the EPUB namespace:
+      # FIXME: only add the EPUB namespace if there are any epub:* attrs?
+      cmpt_doc.add_namespace('epub')
+
+      # Update the OPF manifest
+      opf_doc.new_node('item', :append => 'opf|manifest') { |manifest_item_tag|
+        manifest_item_tag['href'] = package.make_href(cmpt['path'])
+        manifest_item_tag['id'] = cmpt['id']
+        manifest_item_tag['media-type'] = cmpt['media-type']
+        props = component_properties(cmpt, cmpt_doc)
+        manifest_item_tag['properties'] = props.join(' ')  if props.any?
+      }
+
+      # Update the OPF spine
+      opf_doc.new_node('itemref', :append => 'opf|spine') { |spine_item_tag|
+        spine_item_tag['idref'] = cmpt['id']
+        spine_item_tag['linear'] = 'no'  unless cmpt['linear']
+      }
+    }
+  end
+
+
+  protected
+
+    # Assemble the component properties by inspecting the HTML...
+    # because some reading systems can't do this themselves, I guess.
+    #
+    # NB: the 'cover-image' and 'nav' properties will be set in
+    # other tranforms.
+    #
+    def component_properties(cmpt, cmpt_doc)
+      [].tap { |props|
+        # 'scripted': check whether there are any script tags in the component.
+        props.push('scripted')  if cmpt_doc.find('script')
+
+        # 'mathml': look for a math element
+        props.push('mathml')  if cmpt_doc.find('math, mathml:math')
+
+        # 'remote-resources': TODO
+
+        # 'svg': look for an svg element
+        props.push('svg')  if cmpt_doc.find('svg, svg:svg')
+
+        # 'switch': look for an epub:switch element
+        props.push('switch')  if cmpt_doc.find('epub|switch')
+      }
+    end
+
+end

data/lib/bookbinder/transform/epub/title.rb

@@ -0,0 +1,92 @@
+# EPUB2 spec:
+#
+#   http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm#Section2.2.1
+#
+# EPUB3 spec:
+#
+#   http://www.idpf.org/epub/30/spec/epub30-publications.html#sec-opf-dctitle
+#
+# On title types:
+#
+# "When the title-type value is drawn from a code list or other formal
+# enumeration, the scheme attribute should be attached to identify its source.
+# When a scheme is not specified, Reading Systems should recognize the
+# following title type values: main, subtitle, short, collection, edition
+# and expanded."
+#
+class Bookbinder::Transform::EPUB_Title < Bookbinder::Transform
+
+  TITLE_TYPES = %w[main subtitle short collection edition expanded]
+
+
+  def dependencies
+    [Bookbinder::Transform::EPUB_Metadata, Bookbinder::Transform::EPUB_NCX]
+  end
+
+
+  def to_map(package)
+    package.map['title'] = titles = {}
+    return  unless package.map['metadata']
+    return  unless metadata_array = package.map['metadata']['title']
+    title_data = metadata_array.sort { |a, b|
+      if a['display-seq'] && b['display-seq']
+        a['display-seq']['@'].to_i <=> b['display-seq']['@'].to_i
+      else
+        0
+      end
+    }
+    title_data.each { |tdata|
+      t = tdata['@']
+      type = tdata['title-type'] ? tdata['title-type']['@'] : 'main'
+      next  unless TITLE_TYPES.include?(type)
+      if titles[type]
+        package.warn("Existing title for '#{type}' - discarding '#{t}'")
+      else
+        titles[type] = t
+        metadata_array.delete(tdata)
+      end
+    }
+    # Now that we have "used" the raw metadata for titles, remove it.
+    package.map['metadata'].delete('title')  if metadata_array.empty?
+  end
+
+
+  def from_map(package)
+    titles = package.map['title']
+    opf_doc = package.file(:opf).document
+    metadata_tag = opf_doc.find('opf|metadata')
+    seq = 0
+    titles.each_pair { |type, title|
+      title_tag = opf_doc.new_node('dc:title', :append => metadata_tag)
+      title_tag.content = title
+      if titles.length > 1
+        seq += 1
+        title_id = "dc-title-metadata-#{seq}"
+        title_tag['id'] = title_id
+        opf_doc.new_node('meta', :append => metadata_tag) { |type_meta_tag|
+          type_meta_tag.content = type
+          type_meta_tag['property'] = 'title-type'
+          type_meta_tag['refines'] = '#'+title_id
+        }
+        opf_doc.new_node('meta', :append => metadata_tag) { |seq_meta_tag|
+          seq_meta_tag.content = seq
+          seq_meta_tag['property'] = 'display-seq'
+          seq_meta_tag['refines'] = '#'+title_id
+        }
+      end
+    }
+
+    # Add it to the NCX if that file exists in the package
+    package.if_file(:ncx) { |ncx_file|
+      ncx_title = [titles['main'], titles['subtitle']].compact.join(': ')
+      ncx_doc = ncx_file.document
+      ncx_doc.new_node('docTitle') { |doc_title_tag|
+        ncx_doc.new_node('text', :append => doc_title_tag) { |text_tag|
+          text_tag.content = ncx_title
+        }
+        ncx_doc.find('ncx|head').add_next_sibling(doc_title_tag)
+      }
+    }
+  end
+
+end

data/lib/bookbinder/transform/epub/version.rb

@@ -0,0 +1,39 @@
+# See https://itunesconnect.apple.com/docs/iBooksAssetGuide5.1Revision2.pdf
+# pages 22 and 23.
+#
+# "The version of your book is specified within a `meta` element
+# in the Package Document. The `meta` element has a property value
+# of `ibooks:version':
+#
+#   <meta property="ibooks:version">1.1.2</meta>
+#
+class Bookbinder::Transform::EPUB_Version < Bookbinder::Transform
+
+  def dependencies
+    [Bookbinder::Transform::EPUB_Metadata]
+  end
+
+
+  def to_map(package)
+    ver_hashes = package.map['metadata'].delete('ibooks:version')
+    if ver_hashes && ver_hashes.any?
+      package.map['version'] = ver_hashes.first['@']
+    end
+  end
+
+
+  def from_map(package)
+    if package.map['version']
+      # Add the ibooks prefix to the package root.
+      opf_doc = package.file(:opf).document
+      opf_doc.add_prefix('ibooks')
+
+      # Create the meta node and append it to <metadata>
+      opf_doc.new_node('meta', :append => 'opf|metadata') { |ver_tag|
+        ver_tag['property'] = 'ibooks:version'
+        ver_tag.content = package.map['version']
+      }
+    end
+  end
+
+end

data/lib/bookbinder/transform/generator.rb

@@ -0,0 +1,8 @@
+class Bookbinder::Transform::Generator < Bookbinder::Transform
+
+  def to_map(package)
+    package.map['generator'] = "Bookbinder #{Bookbinder::VERSION}"
+  end
+
+end
+

data/lib/bookbinder/transform/openbook/json.rb

@@ -0,0 +1,15 @@
+class Bookbinder::Transform::Openbook_JSON < Bookbinder::Transform
+
+  JSON_PATH = 'book.json'
+
+
+  def to_map(package)
+    package.map.update(JSON.load(package.file(JSON_PATH)))
+  end
+
+
+  def from_map(package)
+    package.file(JSON_PATH).write(JSON.pretty_generate(package.mip))
+  end
+
+end

data/lib/bookbinder/transform/organizer.rb

@@ -0,0 +1,41 @@
+class Bookbinder::Transform::Organizer < Bookbinder::Transform
+
+  PREFERRED_ORDER = %w(
+    title
+    creator
+    contributor
+    language
+    cover
+    description
+    unique-identifier
+    modified
+    version
+    rendition-*
+    audio-*
+    spine
+    nav
+    resources
+  )
+
+  def to_map(package)
+    new_map = {}
+    PREFERRED_ORDER.each { |prop|
+      if prop.match(/\*$/)
+        prefix = prop.chop
+        package.map.delete_if { |key, val|
+          new_map[key] = val  if key.match(/^#{prefix}/)
+        }
+      else
+        new_map[prop] = package.map.delete(prop)  if package.map[prop]
+      end
+    }
+    if package.map['metadata'] && package.map['metadata'].empty?
+      package.map.delete('metadata')
+    end
+    package.map.each_pair { |key, val|
+      new_map[key] = val  if val
+    }
+    package.map = new_map
+  end
+
+end

data/lib/bookbinder/transform.rb

@@ -0,0 +1,7 @@
+class Bookbinder::Transform
+
+  def dependencies
+    []
+  end
+
+end

data/lib/bookbinder/version.rb

@@ -0,0 +1,5 @@
+module Bookbinder
+
+  VERSION = "0.2.0"
+
+end

data/lib/bookbinder.rb

@@ -0,0 +1,29 @@
+require 'fileutils'
+require 'nokogiri'
+require 'zip'
+require 'json'
+require 'time'
+require 'cgi'
+
+module Bookbinder
+end
+
+require 'bookbinder/version'
+require 'bookbinder/media_type'
+require 'bookbinder/operations'
+require 'bookbinder/file_system'
+require 'bookbinder/package'
+require 'bookbinder/file'
+require 'bookbinder/document_proxy'
+require 'bookbinder/transform'
+require 'bookbinder/transform/organizer'
+require 'bookbinder/transform/generator'
+
+# File system types
+require 'bookbinder/file_system/memory'
+require 'bookbinder/file_system/directory'
+require 'bookbinder/file_system/zip_file'
+
+# Package types
+require 'bookbinder/package/epub'
+require 'bookbinder/package/openbook'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: bookbinder
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Joseph Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &11209620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11209620
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: &11208800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *11208800
+- !ruby/object:Gem::Dependency
+  name: mime-types
+  requirement: &11208160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *11208160
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &11207480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *11207480
+description: Convert easily between common ebook formats.
+email:
+- jpearson@overdrive.com
+executables:
+- bookbinder
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/bookbinder
+- lib/bookbinder/document_proxy.rb
+- lib/bookbinder/file.rb
+- lib/bookbinder/file_system/directory.rb
+- lib/bookbinder/file_system/memory.rb
+- lib/bookbinder/file_system/zip_file.rb
+- lib/bookbinder/file_system.rb
+- lib/bookbinder/media_type.rb
+- lib/bookbinder/operations.rb
+- lib/bookbinder/package/epub.rb
+- lib/bookbinder/package/openbook.rb
+- lib/bookbinder/package.rb
+- lib/bookbinder/transform/epub/audio_overlay.rb
+- lib/bookbinder/transform/epub/audio_soundtrack.rb
+- lib/bookbinder/transform/epub/contributor.rb
+- lib/bookbinder/transform/epub/cover_image.rb
+- lib/bookbinder/transform/epub/cover_page.rb
+- lib/bookbinder/transform/epub/creator.rb
+- lib/bookbinder/transform/epub/description.rb
+- lib/bookbinder/transform/epub/language.rb
+- lib/bookbinder/transform/epub/metadata.rb
+- lib/bookbinder/transform/epub/nav.rb
+- lib/bookbinder/transform/epub/nav_toc.rb
+- lib/bookbinder/transform/epub/ncx.rb
+- lib/bookbinder/transform/epub/ocf.rb
+- lib/bookbinder/transform/epub/opf.rb
+- lib/bookbinder/transform/epub/package_identifier.rb
+- lib/bookbinder/transform/epub/rendition.rb
+- lib/bookbinder/transform/epub/resources.rb
+- lib/bookbinder/transform/epub/spine.rb
+- lib/bookbinder/transform/epub/title.rb
+- lib/bookbinder/transform/epub/version.rb
+- lib/bookbinder/transform/generator.rb
+- lib/bookbinder/transform/openbook/json.rb
+- lib/bookbinder/transform/organizer.rb
+- lib/bookbinder/transform.rb
+- lib/bookbinder/version.rb
+- lib/bookbinder.rb
+- Rakefile
+- README.md
+homepage: http://github.com/bksh/bookbinder
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Ebook format conversion.
+test_files: []
+has_rdoc: