bookbinder 0.3.4 → 0.4.0

data/lib/bookbinder.rb

@@ -4,12 +4,12 @@ require 'zip'
 require 'json'
 require 'time'
 require 'cgi'
-require 'mp3info'
 
 module Bookbinder
 end
 
 require 'bookbinder/version'
+require 'bookbinder/scratch'
 require 'bookbinder/media_type'
 require 'bookbinder/operations'
 require 'bookbinder/file_system'
@@ -25,8 +25,9 @@ require 'bookbinder/file_system/memory'
 require 'bookbinder/file_system/directory'
 require 'bookbinder/file_system/zip_file'
 
-# Package types
+# Core package types
 require 'bookbinder/package/openbook'
-require 'bookbinder/package/epub'
-require 'bookbinder/package/media_ripper'
-require 'bookbinder/package/mp3_audiobook'
+begin
+  require 'bb-epub'
+rescue LoadError
+end

data/lib/bookbinder/file.rb

@@ -108,7 +108,7 @@ class Bookbinder::File
   # Proxy through to FileSystem#set_file.
   #
   def set_file(file_io)
-    @file_system.set_file(path, io)
+    @file_system.set_file(path, file_io)
   end
 
 
@@ -145,5 +145,4 @@ class Bookbinder::File
       end
     end
 
-
 end

data/lib/bookbinder/file_system/zip_file.rb

@@ -8,7 +8,9 @@ class Bookbinder::FileSystem::ZipFile < Bookbinder::FileSystem
 
 
   def exists?(path)
-    @zipfile && @zipfile.find_entry(path) ? true : false
+    ascii_path = path
+    ascii_path.force_encoding('ASCII-8BIT')
+    @zipfile && @zipfile.find_entry(ascii_path) ? true : false
   end
 
 
@@ -36,9 +38,7 @@ class Bookbinder::FileSystem::ZipFile < Bookbinder::FileSystem
     write_after = mode[0] != 'r'
     if read_before
       must_exist(path)
-      tmp_path = Dir::Tmpname.create(File.basename(path)) { |tmp_path|
-        raise Errno::EEXIST  if File.exists?(tmp_path)
-      }
+      tmp_path = Bookbinder::Scratch.file(path)
       @zipfile.commit
       @zipfile.extract(path, tmp_path)
       File.open(tmp_path, mode) { |tmp_file|

data/lib/bookbinder/operations.rb

@@ -27,7 +27,11 @@ class Bookbinder::Operations
     def validate(path)
       pkg_klass = recognize(path)
       pkg = pkg_klass.read(path)
-      # TODO: emit warnings?
+      # TODO: Warnings?
+      # pkg.warnings.each { |warn|
+      #   STDERR.puts("#{warn[:transform]}##{warn[:method]}: #{warn[:message]}")
+      # }
+      Bookbinder::Scratch.cleanup
       pkg
     end
 
@@ -40,6 +44,7 @@ class Bookbinder::Operations
       pkg_klass = recognize(path)
       pkg = pkg_klass.read(path)
       pkg.write(path)
+      Bookbinder::Scratch.cleanup
       pkg
     end
 
@@ -54,6 +59,7 @@ class Bookbinder::Operations
       src_pkg = src_klass.read(src_path)
       dest_pkg = src_pkg.export(dest_klass)
       dest_pkg.write(dest_path)
+      Bookbinder::Scratch.cleanup
       [src_pkg, dest_pkg]
     end
 

data/lib/bookbinder/package.rb

@@ -13,19 +13,8 @@ class Bookbinder::Package
   end
 
 
-  # This will require() all the .rb files within the given subdirectory
-  # of 'bookbinder/transform'. So, for the EPUB package, you'd just call:
-  #
-  #   require_transforms('epub')
-  #
-  # ... to load all the EPUB-specific transforms.
-  #
-  def self.require_transforms(dir)
-    Dir.glob(
-      File.join(File.dirname(__FILE__), 'transform', dir, '*.rb')
-    ).each { |rb|
-      require("bookbinder/transform/#{dir}/#{File.basename(rb, '.rb')}")
-    }
+  def self.require_transforms(path)
+    Dir[File.join(path, '*.rb')].each { |rb| require(rb) }
   end
 
 
@@ -115,7 +104,7 @@ class Bookbinder::Package
     if path_or_file_system.kind_of?(String)
       dest_file_system = file_system_from_path(dest_file_system)
     end
-    all_book_content.each { |ref|
+    copy_file = lambda { |ref|
       rsrc = file(ref['path'])
       dest_path = ref['path']
       if content_root && !content_root.empty?
@@ -124,28 +113,33 @@ class Bookbinder::Package
       end
       rsrc.copy_to(dest_file_system, dest_path)
     }
+    map['cover'].values.each(&copy_file)  if map['cover']
+    map['spine'].each(&copy_file)  if map['spine']
+    if map['resources']
+      missing = []
+      map['resources'].each { |ref|
+        begin
+          copy_file.call(ref)
+        rescue Bookbinder::FileSystem::UnknownPath
+          missing << ref
+        end
+      }
+      missing.each { |ref|
+        map['resources'].delete(ref)
+        warn("Resource not found: #{ref['path']}. IGNORED.")
+      }
+    end
     self.class.new.tap { |pkg|
       pkg.import(@map, dest_file_system, content_root, @options)
     }
   end
 
 
-  def all_book_content
-    book_content = []
-    book_content += map['cover'].values  if map['cover']
-    book_content += map['spine']  if map['spine']
-    book_content += map['resources']  if map['resources']
-    book_content
-  end
-
-
   # Writes package to path. This is destructive! Anything already
   # at the path will be replaced.
   #
   def write(path)
-    tmp_path = Dir::Tmpname.create(File.basename(path)) { |tmp_path|
-      raise Errno::EEXIST  if File.exists?(tmp_path)
-    }
+    tmp_path = Bookbinder::Scratch.file(path)
     dest_fs = file_system_from_path(tmp_path)
     write_to_file_system(dest_fs)
     dest_fs.close  if dest_fs.respond_to?(:close)
@@ -273,7 +267,11 @@ class Bookbinder::Package
       if File.directory?(path) || File.extname(path).empty?
         Bookbinder::FileSystem::Directory.new(path)
       else
-        Bookbinder::FileSystem::ZipFile.new(path)
+        begin
+          Bookbinder::FileSystem::ZipFile.new(path)
+        rescue Zip::ZipError
+          path
+        end
       end
     end
 

data/lib/bookbinder/package/openbook.rb

@@ -1,6 +1,6 @@
 class Bookbinder::Package::Openbook < Bookbinder::Package
 
-  require_transforms('openbook')
+  require('bookbinder/transform/book_json')
 
   DEFAULT_CONTENT_ROOT = ''
   attr_accessor(:mip)
@@ -19,7 +19,7 @@ class Bookbinder::Package::Openbook < Bookbinder::Package
   def self.transforms
     @transforms ||= [
       Bookbinder::Transform::Generator,
-      Bookbinder::Transform::Openbook_JSON
+      Bookbinder::Transform::BookJSON
     ]
   end
 
@@ -29,5 +29,4 @@ class Bookbinder::Package::Openbook < Bookbinder::Package
     super
   end
 
-
 end

data/lib/bookbinder/scratch.rb

@@ -0,0 +1,36 @@
+# Manages temporary files and temporary directories, which are
+# removed when the Ruby process exits.
+#
+class Bookbinder::Scratch
+
+  def self.directory(path)
+    @paths ||= []
+    create_tmpname(path).tap { |path| @paths << path }
+  end
+
+
+  def self.file(path)
+    @paths ||= []
+    ext = File.extname(path)
+    base = File.basename(path, ext)
+    create_tmpname([base, ext]).tap { |path| @paths << path }
+  end
+
+
+  def self.cleanup
+    return  unless defined?(@paths)
+    while @paths.size > 0
+      path = @paths.shift
+      FileUtils.rm_r(path)  if File.exists?(path)
+    end
+  end
+
+
+  def self.create_tmpname(parts)
+    Dir::Tmpname.create(parts) { |p| raise Errno::EEXIST  if File.exists?(p) }
+  end
+
+
+  at_exit { cleanup }
+
+end

data/lib/bookbinder/transform/{openbook/json.rb → book_json.rb}

@@ -1,4 +1,4 @@
-class Bookbinder::Transform::Openbook_JSON < Bookbinder::Transform
+class Bookbinder::Transform::BookJSON < Bookbinder::Transform
 
   JSON_PATH = 'book.json'
 

data/lib/bookbinder/version.rb

@@ -1,5 +1,5 @@
 module Bookbinder
 
-  VERSION = "0.3.4"
+  VERSION = "0.4.0"
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bookbinder
 version: !ruby/object:Gem::Version
-  version: 0.3.4
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-29 00:00:00.000000000 Z
+date: 2015-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &15331860 !ruby/object:Gem::Requirement
+  requirement: &20788320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15331860
+  version_requirements: *20788320
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &15331360 !ruby/object:Gem::Requirement
+  requirement: &20794420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - =
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *15331360
+  version_requirements: *20794420
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &15330940 !ruby/object:Gem::Requirement
+  requirement: &20809240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,21 +43,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *15330940
-- !ruby/object:Gem::Dependency
-  name: ruby-mp3info
-  requirement: &15330460 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *15330460
+  version_requirements: *20809240
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &15330040 !ruby/object:Gem::Requirement
+  requirement: &20804560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *15330040
+  version_requirements: *20804560
 description: Convert easily between common ebook formats.
 email:
 - jpearson@overdrive.com
@@ -83,51 +72,11 @@ files:
 - lib/bookbinder/file_system.rb
 - lib/bookbinder/media_type.rb
 - lib/bookbinder/operations.rb
-- lib/bookbinder/package/epub.rb
-- lib/bookbinder/package/media_ripper.rb
-- lib/bookbinder/package/mp3_audiobook.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/scratch.rb
+- lib/bookbinder/transform/book_json.rb
 - lib/bookbinder/transform/generator.rb
-- lib/bookbinder/transform/media_ripper/cover_image.rb
-- lib/bookbinder/transform/media_ripper/eisbn.rb
-- lib/bookbinder/transform/media_ripper/metadata.rb
-- lib/bookbinder/transform/media_ripper/nav_toc.rb
-- lib/bookbinder/transform/media_ripper/publisher.rb
-- lib/bookbinder/transform/media_ripper/rendition.rb
-- lib/bookbinder/transform/media_ripper/spine.rb
-- lib/bookbinder/transform/media_ripper/title.rb
-- lib/bookbinder/transform/mp3_audiobook/cover_image.rb
-- lib/bookbinder/transform/mp3_audiobook/creator.rb
-- lib/bookbinder/transform/mp3_audiobook/description.rb
-- lib/bookbinder/transform/mp3_audiobook/metadata.rb
-- lib/bookbinder/transform/mp3_audiobook/nav_toc.rb
-- lib/bookbinder/transform/mp3_audiobook/publisher.rb
-- lib/bookbinder/transform/mp3_audiobook/rendition.rb
-- lib/bookbinder/transform/mp3_audiobook/spine.rb
-- lib/bookbinder/transform/mp3_audiobook/subject.rb
-- lib/bookbinder/transform/mp3_audiobook/title.rb
-- lib/bookbinder/transform/openbook/json.rb
 - lib/bookbinder/transform/organizer.rb
 - lib/bookbinder/transform.rb
 - lib/bookbinder/version.rb

data/lib/bookbinder/package/epub.rb

@@ -1,64 +0,0 @@
-class Bookbinder::Package::EPUB < Bookbinder::Package
-
-  require_transforms('epub')
-
-  DEFAULT_TRANSFORMS = [
-    Bookbinder::Transform::EPUB_PackageIdentifier,
-    Bookbinder::Transform::EPUB_Title,
-    Bookbinder::Transform::EPUB_Creator,
-    Bookbinder::Transform::EPUB_Contributor,
-    Bookbinder::Transform::EPUB_Language,
-    Bookbinder::Transform::EPUB_CoverImage,
-    Bookbinder::Transform::EPUB_Description,
-    Bookbinder::Transform::EPUB_Version,
-    Bookbinder::Transform::EPUB_Spine,
-    Bookbinder::Transform::EPUB_Resources,
-    Bookbinder::Transform::EPUB_NavToc,
-    Bookbinder::Transform::EPUB_CoverPage,
-    Bookbinder::Transform::EPUB_Rendition,
-    Bookbinder::Transform::EPUB_AudioOverlay,
-    Bookbinder::Transform::Organizer,
-    Bookbinder::Transform::Generator
-  ]
-
-  DEFAULT_CONTENT_ROOT = 'EPUB'
-
-
-  def self.recognize(path)
-    return (
-      File.extname(path).downcase == '.epub' ||
-      File.directory?(File.join(path, 'META-INF'))
-    )
-  end
-
-
-  def self.transforms
-    @transforms ||= DEFAULT_TRANSFORMS
-  end
-
-
-  def make_id(path)
-    path.gsub(/[^\w]/, '-')
-  end
-
-
-  def make_path(href)
-    CGI.unescape(href)
-  end
-
-
-  def make_href(path)
-    CGI.escape(path)
-  end
-
-
-  protected
-
-    # Overriding this Package method to inject EPUB's mimetype file.
-    #
-    def write_to_file_system(dest_file_system)
-      dest_file_system.write('mimetype', 'application/epub+zip')
-      super
-    end
-
-end