bookbinder 0.3.4 → 0.4.0

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

@@ -1,38 +0,0 @@
-class Bookbinder::Transform::EPUB_Resources < Bookbinder::Transform
-
-  def dependencies
-    [Bookbinder::Transform::EPUB_OPF]
-  end
-
-
-  # Find all the items in the manifest -- except all spine items, the NCX,
-  # and the NAV.
-  #
-  def to_map(package)
-    opf_doc = package.file(:opf).document('r')
-    items = opf_doc.search('opf|manifest > opf|item')
-    package.map['resources'] = items.collect { |item|
-      path = package.make_path(item['href'])
-      {
-        'path' => path,
-        'media-type' => item['media-type'],
-        'id' => item['id'] || package.make_id(path)
-      }
-    }
-  end
-
-
-  def from_map(package)
-    return  unless package.map['resources']
-    opf_doc = package.file(:opf).document
-    manifest_tag = opf_doc.find('opf|manifest')
-    package.map['resources'].each { |rsrc|
-      opf_doc.new_node('item', :append => manifest_tag) { |manifest_item_tag|
-        manifest_item_tag['href'] = package.make_href(rsrc['path'])
-        manifest_item_tag['media-type'] = rsrc['media-type']
-        manifest_item_tag['id'] = rsrc['id']
-      }
-    }
-  end
-
-end

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

@@ -1,79 +0,0 @@
-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

@@ -1,92 +0,0 @@
-# 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

@@ -1,39 +0,0 @@
-# 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/media_ripper/cover_image.rb

@@ -1,12 +0,0 @@
-class Bookbinder::Transform::MediaRipper_CoverImage < Bookbinder::Transform
-
-  def to_map(package)
-    if package.file('cover.jpg')
-      package.map['cover'] = { 'front' => {
-        'path' => 'cover.jpg',
-        'media-type' => 'image/jpeg'
-      } }
-    end
-  end
-
-end

data/lib/bookbinder/transform/media_ripper/eisbn.rb

@@ -1,15 +0,0 @@
-class Bookbinder::Transform::MediaRipper_EISBN < Bookbinder::Transform
-
-  def dependencies
-    [Bookbinder::Transform::MediaRipper_Metadata]
-  end
-
-
-  def to_map(package)
-    return  unless md = package.map['metadata']
-    return  unless md['Identifier'] && (id = md['Identifier'].first)
-    package.map['eisbn'] = id['@']  if id['type'] && id['type']['@'] == 'ISBN'
-    md.delete('Identifier')
-  end
-
-end

data/lib/bookbinder/transform/media_ripper/metadata.rb

@@ -1,27 +0,0 @@
-class Bookbinder::Transform::MediaRipper_Metadata < Bookbinder::Transform
-
-  def to_map(package)
-    return  unless mm_file = find_first_mediamarker_file(package)
-    mm_doc = mm_file.document('r')
-    md = {}
-    mm_doc.each('AudioBook > TitleInfo > *') { |tag|
-      name = tag.node_name
-      value = { '@' => tag.content.strip }
-      tag.attributes.each_pair { |key, attr|
-        value[key] = { '@' => attr.value }
-      }
-      md[name] = [md[name], value].flatten.compact
-    }
-    package.map['metadata'] = md
-  end
-
-
-  protected
-
-    def find_first_mediamarker_file(package)
-      package.file_system.each { |path|
-        return package.file(path)  if File.extname(path) == '.xml'
-      }
-    end
-
-end

data/lib/bookbinder/transform/media_ripper/nav_toc.rb

@@ -1,57 +0,0 @@
-# MediaMarker XML format is like this:
-#
-# <AudioBook>
-#   <Markers file="HP-136127-Part08.mp3">
-#     <Marker>
-#       <Name>Chapter 15</Name>
-#       <Time>74:48.000</Time>
-#     </Marker>
-#    ... etc ...
-#   </Markers>
-# </AudioBook>
-#
-class Bookbinder::Transform::MediaRipper_NavToc < Bookbinder::Transform
-
-  def to_map(package)
-    toc = []
-    package.xml_paths.each { |xml_path|
-      doc = package.file(xml_path).document('r')
-      markers_tag = doc.find('AudioBook > Markers')
-      aud_path = markers_tag['file']
-      doc.each_within(markers_tag, 'Marker') { |marker_tag|
-        seconds = translate_time(doc.find_within(marker_tag, 'Time').content)
-        toc << {
-          'title' => doc.find_within(marker_tag, 'Name').content.strip,
-          'path' => "#{aud_path}#{seconds ? "##{seconds}" : ''}"
-        }
-      }
-    }
-    package.map['nav'] = { 'toc' => toc }
-  end
-
-
-  protected
-
-    # MediaMarker time string comes in like:
-    #
-    #   74:48.000
-    #
-    # We should translate to 74*60+48.0 ==> 4488
-    #
-    def translate_time(time_str)
-      if match = time_str.match(/^(\d+):(\d+):([\d\.]+)$/)
-        minutes = match[1].to_i*60 + match[2].to_i
-        seconds = match[3].to_f
-      elsif match = time_str.match(/^(\d+):([\d\.]+)$/)
-        minutes = match[1].to_i
-        seconds = match[2].to_f
-      else
-        puts("Unknown time format: #{time_str}")
-        return nil
-      end
-      seconds = seconds.round  if seconds % 1 == 0
-      out = minutes * 60 + seconds
-      out > 0 ? out : nil
-    end
-
-end

data/lib/bookbinder/transform/media_ripper/publisher.rb

@@ -1,15 +0,0 @@
-class Bookbinder::Transform::MediaRipper_Publisher < Bookbinder::Transform
-
-  def dependencies
-    [Bookbinder::Transform::MediaRipper_Metadata]
-  end
-
-
-  def to_map(package)
-    return  unless md = package.map['metadata']
-    return  unless md['Publisher'] &&  md['Publisher'].first
-    package.map['publisher'] = md['Publisher'].first['@']
-    md.delete('Publisher')
-  end
-
-end

data/lib/bookbinder/transform/media_ripper/rendition.rb

@@ -1,7 +0,0 @@
-class Bookbinder::Transform::MediaRipper_Rendition < Bookbinder::Transform
-
-  def to_map(package)
-    package.map['rendition-format'] = 'audiobook'
-  end
-
-end

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

@@ -1,34 +0,0 @@
-class Bookbinder::Transform::MediaRipper_Spine < Bookbinder::Transform
-
-  def to_map(package)
-    package.map['resources'] = []
-    package.map['spine'] = package.audio_paths.collect { |path|
-      {
-        'path' => path,
-        'media-type' => 'audio/mpeg'
-      }.tap { |cmpt|
-        break  unless cmpt_info = audio_info(package, path)
-        cmpt.update('audio-duration' => cmpt_info.length)
-        cmpt.update('audio-bitrate' => cmpt_info.bitrate)  unless cmpt_info.vbr
-      }
-    }
-  end
-
-
-  protected
-
-    def audio_info(package, path)
-      info = nil
-      begin
-        package.file_system.get_io(path) { |zip_io|
-          io = StringIO.new(zip_io.read)
-          Mp3Info.open(io) { |inf| info = inf }
-        }
-      rescue => e
-        # TODO - is there error handling to do here?
-        raise e
-      end
-      info
-    end
-
-end

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

@@ -1,16 +0,0 @@
-class Bookbinder::Transform::MediaRipper_Title < Bookbinder::Transform
-
-  def dependencies
-    [Bookbinder::Transform::MediaRipper_Metadata]
-  end
-
-
-  def to_map(package)
-    package.map['title'] = titles = {}
-    return  unless md = package.map['metadata']
-    return  unless md['Title'] && md['Title'].first
-    titles['main'] = md['Title'].first['@']
-    md.delete('Title')
-  end
-
-end