bookbinder 0.4.0 → 0.4.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ff331a45d77240065dd23e0139986a4ff8e8831
+  data.tar.gz: 9065317c158365847af21a639dbd5d241a829757
+SHA512:
+  metadata.gz: 9605359ded0cae08c84e15a4b8efa92570454737bde6b19672b6fc323be3d3651dde0ae6c15a6103d4d958c992a9db56e85b0d25591ec998cf3081d3aedf707b
+  data.tar.gz: fdb07c5974b785688b5047da17e06dc7b4f664ee94adfe583520ac06d7d454ac8f6fa2180e0cedd187d748f163268010fbd3b8c5a7cd97ba883c1c51a7d0320e

data/README.md

@@ -1,40 +1,47 @@
 # Bookbinder
 
-Ebook format conversion.
+With Bookbinder you can convert content to common ebook formats.
 
 
 ## Basic use
 
-Display the contents of an EPUB as a JSON "map":
+Out of the box, Bookbinder supports only its native format: Openbook.
+Openbook is a simple JSON-based format that acts as a superset of all
+the information in other formats.
 
-    $ bookbinder map path/to/file.epub
+So, you should install some more formats, by adding other gems to your
+`Gemfile`:
 
+```ruby
+gem 'bookbinder'
+gem 'bb-epub'
+gem 'bb-pdf'
+```
 
-Convert an EPUB to an Openbook directory (the directory need not exist yet):
+Now do this:
 
-    $ bookbinder convert path/to/file.epub path/to/dir
+    $ bundle console
 
-Convert an EPUB to an Openbook archive:
+    >> puts Bookbinder::Operations.map('test.epub')
 
-    $ bookbinder convert path/to/file.epub path/to/file.openbook
+This displays the contents of the test EPUB as a JSON "map".
+(Supply your own test EPUB file.)
 
-Convert an Openbook to an EPUB (...is not yet fully implemented!)
+Convert an EPUB to an Openbook directory (the directory need not exist yet):
 
+    >> Bookbinder::Operations.convert('test.epub', 'test-output')
 
-## Use as a Ruby library
+Convert an EPUB to an Openbook archive:
 
-EPUB to Openbook:
+    >> Bookbinder::Operations.convert('test.epub', 'test.openbook')
 
-    require 'bookbinder'
-    epub = Bookbinder::Package::EPUB.read('book.epub')
-    openbook = epub.export(Bookbinder::Package::Openbook)
-    openbook.write('book.openbook')
+Convert an Openbook to an EPUB (...is not yet fully implemented!)
 
-For other basic actions, take a look at `lib/bookbinder/operations.rb`. This
-class provides a basic layer of convenience, such as reducing the above to:
+Convert a PDF to an Openbook archive:
 
-    require 'bookbinder'
-    Bookbinder::Operations.convert('book.epub', 'book.openbook')
+    >> Bookbinder::Operations.convert('test.pdf', 'test.openbook')
+
+Convert an openbook to a PDF (..is not yet fully implemented!)
 
 
 ## Improving Bookbinder
@@ -48,37 +55,29 @@ currently maintained here:
 
 The key to Bookbinder is this: for every feature of an ebook format, we create
 a "transform" class that does two things:
+
 - parses the raw config from the package into standard Openbook properties
   on the map; and
 - generates raw config into the package from those same standard Openbook
   properties on the map
 
-Basically, for every feature, the transform class describes how to read it, 
+Basically, for every feature, the transform class describes how to read it,
 and how to write it.
 
 The nice thing about this set-up is that if multiple package formats
-support the same feature, their transform classes work on the same map. Say
-you are converting from EPUB3 to Openbook - the book's title is parsed out of
-the EPUB file into the map using the transform at
-`lib/bookbinder/transform/epub/title.rb`. Then the map is handed over to
-the Openbook package, and the transform at
-`lib/bookbinder/transform/openbook/title.rb` would write it out to the 
-new package file.
+support the same feature, their transform classes work on the same map.
+Say you are converting from EPUB3 to Openbook - the book's title is
+parsed out of the EPUB file into the map using the 'Title' transform
+in the `bb-epub` gem. Then the map is handed over to the Openbook
+package, and the transform in the Bookbinder package writes it out
+to the new package file.
 
 You can of course convert a package to its own format: in this case the same
 transform class does both the reading and the writing out -- the effect of
 this is to "tidy" the package.
 
-To add a package format Bookbinder, you should create the package class in
-`lib/bookbinder/package`, then create directory of transforms in
-`lib/bookbinder/transform`. You can borrow transforms from other packages. For
-instance, it might make sense for a DAISY package to share some of the
-transforms in EPUB, or for a hPub package to borrow some transforms 
-from Openbook.
-
-If you are adding a new feature to Bookbinder, you create the
-appropriate transform class for each package that supports the feature, and
-then add the equivalent tests.
+To add a package format to Bookbinder, you can borrow the simple structure
+of the `bb-epub` and `bb-pdf` gems.
 
 
 ## Planned format support
@@ -86,9 +85,9 @@ then add the equivalent tests.
 * Openbook
 * EPUB3
 * EPUB2
-* hPub
 * PDF
-* ...
+* MP3 audiobooks
+* hPub
 
 
 ## Attribution and licensing

data/lib/bookbinder/transform/organizer.rb

@@ -14,6 +14,7 @@ class Bookbinder::Transform::Organizer < Bookbinder::Transform
     pisbn
     publisher
     subject
+    i18n-*
     rendition-*
     audio-*
     spine

data/lib/bookbinder/version.rb

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

metadata

@@ -1,69 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: bookbinder
 version: !ruby/object:Gem::Version
-  version: 0.4.0
-  prerelease: 
+  version: 0.4.1
 platform: ruby
 authors:
 - Joseph Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &20788320 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20788320
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
-  requirement: &20794420 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *20794420
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: mime-types
-  requirement: &20809240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *20809240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &20804560 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *20804560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Convert easily between common ebook formats.
 email:
 - jpearson@overdrive.com
-executables:
-- bookbinder
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/bookbinder
 - lib/bookbinder/document_proxy.rb
 - lib/bookbinder/file.rb
 - lib/bookbinder/file_system/directory.rb
@@ -85,26 +94,25 @@ files:
 - README.md
 homepage: http://github.com/bksh/bookbinder
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.14
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ebook format conversion.
 test_files: []

data/bin/bookbinder

@@ -1,17 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'bookbinder'
-
-if ARGV[0] == 'map'
-  puts Bookbinder::Operations.map(ARGV[1])
-elsif ARGV[0] == 'validate'
-  puts('Validate: not yet implemented.')
-elsif ARGV[0] == 'normalize'
-  puts('Normalize: still too dangerous.')
-elsif ARGV[0] == 'convert'
-  src_path = ARGV[1]
-  dest_path = ARGV[2]
-  src_pkg, dest_pkg = Bookbinder::Operations.convert(src_path, dest_path)
-  puts("Converted #{src_pkg.class} at #{src_path}")
-  puts("------ to #{dest_pkg.class} at #{dest_path}")
-end