bookbinder 0.3.4 → 0.4.0

data/lib/bookbinder/package/media_ripper.rb

@@ -1,47 +0,0 @@
-class Bookbinder::Package::MediaRipper < Bookbinder::Package
-
-  require_transforms('media_ripper')
-
-  DEFAULT_TRANSFORMS = [
-    Bookbinder::Transform::MediaRipper_Rendition,
-    Bookbinder::Transform::MediaRipper_Title,
-    Bookbinder::Transform::MediaRipper_Publisher,
-    Bookbinder::Transform::MediaRipper_EISBN,
-    Bookbinder::Transform::MediaRipper_Spine,
-    Bookbinder::Transform::MediaRipper_NavToc,
-    Bookbinder::Transform::MediaRipper_CoverImage,
-    Bookbinder::Transform::Organizer,
-    Bookbinder::Transform::Generator
-  ]
-
-
-  def self.recognize(path)
-    return path.match(/.odmr.zip$/);
-    # TODO: detect unzipped media-ripper audiobook?
-  end
-
-
-  def self.transforms
-    @transforms ||= DEFAULT_TRANSFORMS
-  end
-
-
-  def audio_paths
-    xml_paths.collect { |xml_path|
-      next  unless doc = file(xml_path).document('r')
-      next  unless markers_tag = doc.find('AudioBook > Markers')
-      markers_tag['file']
-    }.compact
-  end
-
-
-  def xml_paths
-    xml_paths = []
-    file_system.each { |path|
-      next  unless match = path.match(/Part(\d+)\.xml$/)
-      xml_paths[match[1].to_i] = path
-    }
-    xml_paths.compact!
-  end
-
-end

data/lib/bookbinder/package/mp3_audiobook.rb

@@ -1,43 +0,0 @@
-class Bookbinder::Package::MP3Audiobook < Bookbinder::Package
-
-  require_transforms('mp3_audiobook')
-
-  DEFAULT_TRANSFORMS = [
-    Bookbinder::Transform::MP3Audiobook_Rendition,
-    Bookbinder::Transform::MP3Audiobook_Title,
-    Bookbinder::Transform::MP3Audiobook_Creator,
-    Bookbinder::Transform::MP3Audiobook_Description,
-    Bookbinder::Transform::MP3Audiobook_Publisher,
-    Bookbinder::Transform::MP3Audiobook_Subject,
-    Bookbinder::Transform::MP3Audiobook_CoverImage,
-    Bookbinder::Transform::MP3Audiobook_Spine,
-    Bookbinder::Transform::MP3Audiobook_NavToc,
-    Bookbinder::Transform::Organizer,
-    Bookbinder::Transform::Generator
-  ]
-
-  MP3_EXT_RE = /.mp3$/i
-
-
-  def self.recognize(path)
-    File.directory?(path) && Dir.glob(File.join(path, '*')).all? { |path|
-      path.match(MP3_EXT_RE)
-    }
-  end
-
-
-  def self.transforms
-    @transforms ||= DEFAULT_TRANSFORMS
-  end
-
-
-  def audio_paths
-    [].tap { |aud_paths|
-      file_system.each { |path|
-        aud_paths << path  if path.match(MP3_EXT_RE)
-      }
-      aud_paths.sort!
-    }
-  end
-
-end

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

@@ -1,227 +0,0 @@
-# EPUB 3 only. Spec:
-#
-#   http://www.idpf.org/epub/301/spec/epub-mediaoverlays.html#sec-package-metadata
-#
-# Each spine item's manifest item may have a media-overlay attribute, which
-# is an idref pointing at a SMIL manifest item.
-#
-# Other properties to manage:
-#
-#   <meta property="media:active-class">-epub-media-overlay-active</meta>
-#   <meta property="media:playback-active-class">-epub-media-overlay-playing</meta>
-#   <meta property="media:duration" refines="#ch1_audio">0:32:29</meta>
-#   <meta property="media:duration">1:36:20</meta>
-#   <meta property="media:narrator">Bill Speaker</meta>
-#
-# Note: "The Package Document must include the duration of each
-# Media Overlay as well as of the entire Publication."
-#
-class Bookbinder::Transform::EPUB_AudioOverlay < Bookbinder::Transform
-
-  def dependencies
-    [
-      Bookbinder::Transform::EPUB_Metadata,
-      Bookbinder::Transform::EPUB_Resources,
-      Bookbinder::Transform::EPUB_Spine
-    ]
-  end
-
-
-  def to_map(package)
-    meta_to_prop(
-      package,
-      'media:active-class',
-      'audio-overlay-active-class'
-    )
-    meta_to_prop(
-      package,
-      'media:playback-active-class',
-      'audio-overlay-playback-active-class'
-    )
-    book_overlay_duration = meta_to_prop(
-      package,
-      'media:duration',
-      'audio-overlay-duration'
-    ) { |hashes|
-      hashes.detect { |hash|
-        unless hash.has_key?('refines')
-          hash['@'] = smil_clock_value_to_seconds(hash['@'])
-          true
-        end
-      }
-    }
-    # TODO: check that book does have a duration if there are any overlays.
-    meta_to_prop(
-      package,
-      'media:narrator',
-      'audio-overlay-narrator'
-    ) { |hashes|
-      hashes.detect { |hash| !hash.has_key?('refines') }
-    }
-    # Find each manifest item (SI) with media-overlay attribute:
-    #
-    #   - find the map['resources'] item that matches the media-overlay id
-    #   - find the map['spine'] item that matches the SI id
-    #     - set 'audio-overlay' to the AO path
-    #     - set 'audio-overlay-duration' to the refined duration
-    #     - set 'audio-overlay-narrator' to the refined narrator
-    #
-    opf_doc = package.file(:opf).document('r')
-    opf_doc.each('opf|manifest > opf|item[media-overlay]') { |cmpt_item|
-      cmpt_id = cmpt_item['id']
-      cmpt = package.map['spine'].detect { |c| c['id'] == cmpt_id }
-      # TODO: nil check cmpt
-      ao_id = cmpt_item['media-overlay']
-      rsrc = package.map['resources'].detect { |r| r['id'] == ao_id }
-      # TODO: nil check rsrc
-      cmpt['audio-overlay'] = rsrc['path']
-      cmpt_overlay_duration = meta_to_prop(
-        package,
-        'media:duration',
-        'audio-overlay-duration',
-        cmpt
-      ) { |hashes|
-        hashes.detect { |hash|
-          if hash['refines']['@'] == '#'+ao_id
-            hash['@'] = smil_clock_value_to_seconds(hash['@'])
-            true
-          end
-        }
-      }
-      # TODO: nil check cmpt_overlay_duration
-      meta_to_prop(
-        package,
-        'media:narrator',
-        'audio-overlay-narrator',
-        cmpt
-      ) { |hashes|
-        hash['refines']['@'] == '#'+ao_id
-      }
-    }
-  end
-
-
-  # Create a meta tag for:
-  #   audio-overlay-active-class => media:active-class
-  #   audio-overlay-playback-active-class => media:playback-active-class
-  #   audio-overlay-duration => media:duration
-  #   audio-overlay-narrator => media:narrator
-  #
-  # For each spine item with a 'media-overlay' key:
-  #
-  #   Find the corresponding map resource
-  #   Find the corresponding manifest item for component:
-  #     - set 'media-overlay' to rsrc['id']
-  #   Create a top-level meta tag:
-  #     cmpt['audio-overlay-duration'] => meta[property='media:duration'][refines='rsrc["id"]]
-  #   Also create a top-level meta tag for media:narrator if cmpt has 'audio-overlay-narrator'
-  #
-  def from_map(package)
-    opf_doc = package.file(:opf).document
-    metadata_tag = opf_doc.find('opf|metadata')
-    prop_to_meta(
-      package.map,
-      metadata_tag,
-      'audio-overlay-active-class',
-      'media:active-class'
-    )
-    prop_to_meta(
-      package.map,
-      metadata_tag,
-      'audio-overlay-playback-active-class',
-      'media:playback-active-class'
-    )
-    prop_to_meta(
-      package.map,
-      metadata_tag,
-      'audio-overlay-duration',
-      'media:duration'
-    )
-    prop_to_meta(
-      package.map,
-      metadata_tag,
-      'audio-overlay-narrator',
-      'media:narrator'
-    )
-    package.map['spine'].each { |cmpt|
-      next  unless cmpt['audio-overlay']
-      rsrc = package.map['resources'].detect { |r|
-        r['path'] == cmpt['audio-overlay']
-      }
-      cmpt_manifest_item = opf_doc.find("opf|manifest > opf|item##{cmpt['id']}")
-      cmpt_manifest_item['media-overlay'] = rsrc['id']
-      duration_meta_tag = prop_to_meta(
-        cmpt,
-        metadata_tag,
-        'audio-overlay-duration',
-        'media:duration'
-      )
-      duration_meta_tag['refines'] = '#'+rsrc['id']
-      narrator_meta_tag = prop_to_meta(
-        cmpt,
-        metadata_tag,
-        'audio-overlay-narrator',
-        'media:narrator'
-      )
-      narrator_meta_tag['refines'] = '#'+rsrc['id']  if narrator_meta_tag
-    }
-  end
-
-
-  protected
-
-    def meta_to_prop(package, meta_name, prop_name, target = nil)
-      return  unless package.map['metadata']
-      hashes = package.map['metadata'][meta_name]
-      return  unless hashes && hashes.any?
-      hash = block_given? ? yield(hashes) : hashes.first
-      if hash
-        hashes.delete(hash)
-        package.map['metadata'].delete(meta_name)  if hashes.empty?
-        (target || package.map)[prop_name] = hash['@']
-      end
-    end
-
-
-    # 5:34:31.396 = 5 hours, 34 minutes, 31 seconds and 396 milliseconds
-    # 124:59:36 = 124 hours, 59 minutes and 36 seconds
-    # 0:05:01.2 = 5 minutes, 1 second and 200 milliseconds
-    # 0:00:04 = 4 seconds
-    # 09:58 = 9 minutes and 58 seconds
-    # 00:56.78 = 56 seconds and 780 milliseconds
-    # 76.2s = 76.2 seconds = 76 seconds and 200 milliseconds
-    # 7.75h = 7.75 hours = 7 hours and 45 minutes
-    # 13min = 13 minutes
-    # 2345ms = 2345 milliseconds
-    # 12.345 = 12 seconds and 345 milliseconds
-    def smil_clock_value_to_seconds(clock)
-      return clock.to_f  if clock.kind_of?(Numeric)
-      clock = clock.to_s
-      if match = clock.match(/(\d+:)?(\d+:)(\d+\.?\d*)/)
-        h = match[1].to_s.to_f
-        m = match[2].to_s.to_f
-        s = match[3].to_s.to_f
-        h*60*60 + m*60 + s
-      elsif match = clock.match(/^(\d+\.?\d*)h$/)
-        match[1].to_f*60*60
-      elsif match = clock.match(/^(\d+\.?\d*)min$/)
-        match[1].to_f*60
-      elsif match = clock.match(/^(\d+\.?\d*)s?$/)
-        clock.to_f
-      elsif match = clock.match(/^(\d+\.?\d*)ms$/)
-        clock.to_f / 1000.0
-      end
-    end
-
-
-    def prop_to_meta(scope, metadata_tag, prop_name, meta_name)
-      if scope[prop_name]
-        meta_tag = Nokogiri::XML::Node.new('meta', metadata_tag)
-        meta_tag['property'] = meta_name
-        meta_tag.content = scope[prop_name]
-        metadata_tag.add_child(meta_tag)
-        return meta_tag
-      end
-    end
-
-end

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

@@ -1,73 +0,0 @@
-# For the specification, see the iBooks Asset Guide, specifically the
-# section titled "Ambient Soundtrack" in version 5.1:
-#
-#   https://itunesconnect.apple.com/docs/iBooksAssetGuide5.1Revision2.pdf
-#
-#
-class Bookbinder::Transform::EPUB_AudioSoundtrack < Bookbinder::Transform
-
-  def dependencies
-    [Bookbinder::Transform::EPUB_Spine]
-  end
-
-
-  # Iterate through each spine item, looking for
-  #
-  #   <audio epub:type="ibooks:soundtrack" src="..." />
-  #
-  def to_map(package)
-    package.map['spine'].each { |cmpt|
-      find_soundtrack_in_component(cmpt, package.file(cmpt['path']))
-    }
-  end
-
-
-  # Iterate through each spine item, adding an audio tag to components
-  # that don't have one, or setting the src if the audio tag exists.
-  #
-  def from_map(package)
-    package.map['spine'].each { |cmpt|
-      if cmpt['audio-soundtrack']
-        add_soundtrack_to_component(cmpt, package.file(cmpt['path']))
-      end
-    }
-  end
-
-
-  protected
-
-    def find_soundtrack_in_component(cmpt, cmpt_file)
-      soundtrack_tag = soundtrack_tag_in_document(cmpt_file.document)
-      cmpt['audio-soundtrack'] = soundtrack_tag ? soundtrack_tag['src'] : nil
-    end
-
-
-    def add_soundtrack_to_component(cmpt, cmpt_file)
-      cmpt_doc = cmpt_file.document
-      unless soundtrack_tag = soundtrack_tag_in_document(cmpt_doc)
-        cmpt_doc.add_namespace('epub')
-        cmpt_doc.add_prefix('ibooks', 'epub:prefix')
-
-        soundtrack_tag = cmpt_doc.new_node('audio', :append => 'body')
-        soundtrack_tag['epub:type'] = 'ibooks:soundtrack'
-
-        cmpt_doc.new_node('style', :append => 'head') { |style_tag|
-          style_tag['type'] = 'text/css'
-          style_tag['id'] = 'BB_HIDE_AUDIO_SOUNDTRACK'
-          style_tag.content = [
-            'audio[epub|type="ibooks:soundtrack"] {',
-              'position: absolute;',
-              'top: -100px;',
-            '}'
-          ].join
-        }
-      end
-      soundtrack_tag['src'] = cmpt['audio-soundtrack']
-    end
-
-
-    def soundtrack_tag_in_document(cmpt_doc)
-      cmpt_doc.find('audio[epub|type="ibooks:soundtrack"]')
-    end
-
-end

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

@@ -1,11 +0,0 @@
-require 'bookbinder/transform/epub/creator'
-
-class Bookbinder::Transform::EPUB_Contributor < Bookbinder::Transform::EPUB_Creator
-
-  protected
-
-    def actor_type
-      'contributor'
-    end
-
-end

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

@@ -1,80 +0,0 @@
-# The best source of information about wading through the EPUB
-# cover image quagmire has always been Keith's article on the
-# Threepress blog:
-#
-#   http://blog.safaribooksonline.com/2009/11/20/best-practices-in-epub-cover-images/
-#
-# He added an update for EPUB3, which follows the spec but is
-# a bit easier to grok:
-#
-#   http://blog.safaribooksonline.com/2011/05/26/covers-in-epub3/
-#
-class Bookbinder::Transform::EPUB_CoverImage < Bookbinder::Transform
-
-  def dependencies
-    [
-      Bookbinder::Transform::EPUB_Resources,
-      Bookbinder::Transform::EPUB_Metadata
-    ]
-  end
-
-
-  # If it's EPUB3, the cover will be in the 'properties' attribute
-  # of the manifest item: 'cover-image'
-  #
-  # Otherwise, look for a manifest item with an 'id' of 'cover-image'.
-  #
-  # Or, look for a meta tag with a 'name' of 'cover', then find the
-  # manifest item that has the 'id' that matches meta's 'content'.
-  #
-  # Set map['cover'] to this item (and remove it from map['resources']).
-  #
-  def to_map(package)
-    opf_doc = package.file(:opf).document('r')
-    cover_item = opf_doc.find('opf|manifest > opf|item[properties~="cover-image"]')
-    cover_item ||= opf_doc.find('opf|manifest > opf|item[id="cover-image"]')
-    cover_item ||= opf_doc.find('opf|manifest > opf|item[id="cover_image"]')
-    cover_meta_props = (package.map['metadata'] || {}).delete('cover')
-    if !cover_item && cover_meta_props && cover_meta_props.any?
-      cover_image_id = cover_meta_props.first['content']['@']
-      cover_item = opf_doc.find('opf|manifest > opf|item[id="'+cover_image_id+'"]')
-    end
-    covers = {}
-    if cover_item
-      rsrc = package.map['resources'].detect { |r|
-        r['id'] == cover_item['id']
-      }
-      covers.update("front" => package.map['resources'].delete(rsrc))
-    end
-    package.map['cover'] = covers
-  end
-
-
-  # Belt and braces: give the manifest item a property of
-  # 'cover-image', an 'id' of 'cover-image' (updating any
-  # idrefs) and create a meta tag with 'name'='cover' and
-  # 'content'='cover-image'.
-  #
-  def from_map(package)
-    return  unless package.map['cover'] && cover = package.map['cover']['front']
-    opf_doc = package.file(:opf).document
-
-    opf_doc.new_node('item', :append => 'opf|manifest') { |manifest_item_tag|
-      manifest_item_tag['href'] = package.make_href(cover['path'])
-      manifest_item_tag['media-type'] = cover['media-type']
-      manifest_item_tag['id'] = 'cover-image'
-      manifest_item_tag['properties'] = 'cover-image'
-    }
-
-    cover_id = package.make_id(cover['path'])
-    opf_doc.each('[idref="'+cover_id+'"]') { |idref|
-      idref['idref'] = cover_id
-    }
-
-    opf_doc.new_node('meta', :append => 'opf|metadata') { |cover_meta_tag|
-      cover_meta_tag['name'] = 'cover'
-      cover_meta_tag['content'] = 'cover-image'
-    }
-  end
-
-end