docbook_xsl_wrapper 0.0.3 → 0.0.4

data/README.md

@@ -11,6 +11,8 @@ At present the wrapper will only convert DocBook to EPUB 2 and is
 intended to be run from the command-line - future versions will have more
 functionality (see Future Improvements).
 
+The original Ruby script can be found at: http://docbook.sourceforge.net/release/xsl/1.78.0/epub/bin/
+
 
 ## Requirements
 

data/bin/docbook_xsl_wrapper

@@ -2,23 +2,24 @@
 
 $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
 
-require 'fileutils'
 require 'tmpdir'
 require 'docbook_xsl_wrapper'
 
 
 options = DocbookXslWrapper::Options.parse(ARGV)
 
-options.docbooks.each {|docbook_file|
-  dir = File.expand_path(File.join(Dir.tmpdir, ".epubtmp#{Time.now.to_f.to_s}"))
-  FileUtils.mkdir_p(dir)
-  e = DocbookXslWrapper::Epub.new(docbook_file, dir, options.css, options.customization, options.fonts)
-
-  if options.output
-    epub_file = options.output
-  else
-    epub_file = File.join(File.dirname(docbook_file), File.basename(docbook_file, ".xml") + ".epub")
-  end
-  puts "Rendering DocBook file #{docbook_file} to #{epub_file}" if options.verbose
-  e.render_to_file(epub_file)
-}
+unless File.exist?(options.docbook)
+  raise ArgumentError.new("File #{options.docbook} does not exist")
+end
+
+tmp_dir = Dir.mktmpdir
+options.destination = tmp_dir
+
+begin
+  puts "Rendering DocBook file #{options.docbook} to #{options.output}" if options.verbose
+
+  epub = DocbookXslWrapper::Epub.new(options)
+  epub.render_to_file
+ensure
+  FileUtils.remove_entry_secure tmp_dir
+end

data/docbook_xsl_wrapper.gemspec

@@ -8,7 +8,6 @@ Gem::Specification.new do |gem|
   gem.email         = ["m@mikecook.co.uk"]
   gem.summary       = %q{Wrapper for the DocBook XSL stylesheets for easy XML to EPUB}
   gem.description   = %q{DocBook XSL Wrapper let's you easily convert DocBook XML to EPUB using the official DocBook XSL stylesheets.}
-  gem.homepage      = ""
 
   gem.platform      = Gem::Platform::RUBY
   gem.files         = `git ls-files`.split($\)

data/lib/docbook_xsl_wrapper/epub.rb

@@ -4,81 +4,39 @@ require 'rexml/parsers/pullparser'
 module DocbookXslWrapper
 
   class Epub
-    DOCBOOK_URI = "http://docbook.sourceforge.net/release/xsl/current"
-    CHECKER = "epubcheck"
-    STYLESHEET = File.join(DOCBOOK_URI, "epub", "docbook.xsl")
-    CALLOUT_PATH = File.join('images', 'callouts')
-    CALLOUT_FULL_PATH = File.join(DOCBOOK_URI, CALLOUT_PATH)
-    CALLOUT_LIMIT = 15
-    CALLOUT_EXT = ".png"
-    XSLT_PROCESSOR = "xsltproc"
-    OUTPUT_DIR = ".epubtmp#{Time.now.to_f.to_s}"
-    MIMETYPE = "application/epub+zip"
-    META_DIR = "META-INF"
-    OEBPS_DIR = "OEBPS"
-    ZIPPER = "zip"
-
-    attr_reader :output_dir
-
-    def initialize(docbook_file, output_dir=OUTPUT_DIR, css_file=nil, customization_layer=nil, embedded_fonts=[])
-      @docbook_file = docbook_file
-      @output_dir = output_dir
-      @meta_dir  = File.join(@output_dir, META_DIR)
-      @oebps_dir = File.join(@output_dir, OEBPS_DIR)
-      @css_file = css_file ? File.expand_path(css_file) : css_file
-      @embedded_fonts = embedded_fonts
-      @to_delete = []
-
-      if customization_layer
-        @stylesheet = File.expand_path(customization_layer)
-      else
-        @stylesheet = STYLESHEET
-      end
+    attr_reader :options
 
-      unless File.exist?(@docbook_file)
-        raise ArgumentError.new("File #{@docbook_file} does not exist")
-      end
+    def initialize(options)
+      @options = options
+      @options.custom_xsl = File.join(options.docbook_xsl_root, 'epub', 'docbook.xsl') unless options.custom_xsl
     end
 
-    def render_to_file(output_file, verbose=false)
-      render_to_epub(output_file, verbose)
-      bundle_epub(output_file, verbose)
-      cleanup_files(@to_delete)
+    def render_to_file
+      render_to_epub
+      bundle_epub
     end
 
-    def self.invalid?(file)
-      # Obnoxiously, we can't just check for a non-zero output...
-      cmd = %Q(#{CHECKER} "#{file}")
-      output = `#{cmd} 2>&1`
-
-      if $?.to_i == 0
-        return false
-      else
-        STDERR.puts output if $DEBUG
-        return output
-      end
-    end
+  private
 
-    private
-    def render_to_epub(output_file, verbose)
+    def render_to_epub
       @collapsed_docbook_file = collapse_docbook()
 
-      chunk_quietly =   "--stringparam chunk.quietly " + (verbose ? '0' : '1')
-      callout_path =    "--stringparam callout.graphics.path #{CALLOUT_PATH}/"
-      callout_limit =   "--stringparam callout.graphics.number.limit #{CALLOUT_LIMIT}"
-      callout_ext =     "--stringparam callout.graphics.extension #{CALLOUT_EXT}"
-      html_stylesheet = "--stringparam html.stylesheet #{File.basename(@css_file)}" if @css_file
-      base =            "--stringparam base.dir #{OEBPS_DIR}/"
-      unless @embedded_fonts.empty?
-        embedded_fonts = @embedded_fonts.map {|f| File.basename(f)}.join(',')
-        font =            "--stringparam epub.embedded.fonts \"#{embedded_fonts}\""
+      chunk_quietly =   "--stringparam chunk.quietly " + (options.verbose ? '0' : '1')
+      co_path =    "--stringparam callout.graphics.path #{options.callout_path}/"
+      co_limit =   "--stringparam callout.graphics.number.limit #{options.callout_limit}"
+      co_ext =     "--stringparam callout.graphics.extension #{options.callout_ext}"
+      html_stylesheet = "--stringparam html.stylesheet #{File.basename(options.css)}" if options.css
+      base =            "--stringparam base.dir #{oebps_directory}/"
+      unless options.fonts.empty?
+        fonts = options.fonts.map {|f| File.basename(f)}.join(',')
+        font =            "--stringparam epub.embedded.fonts \"#{fonts}\""
       end
-      meta =            "--stringparam epub.metainf.dir #{META_DIR}/"
-      oebps =           "--stringparam epub.oebps.dir #{OEBPS_DIR}/"
-      options = [chunk_quietly,
-                 callout_path,
-                 callout_limit,
-                 callout_ext,
+      meta =            "--stringparam epub.metainf.dir #{meta_inf_directory}/"
+      oebps =           "--stringparam epub.oebps.dir #{oebps_directory}/"
+      parser_opts = [chunk_quietly,
+                 co_path,
+                 co_limit,
+                 co_ext,
                  base,
                  font,
                  meta,
@@ -86,62 +44,58 @@ module DocbookXslWrapper
                  html_stylesheet,
                 ].join(" ")
       # Double-quote stylesheet & file to help Windows cmd.exe
-      db2epub_cmd = %Q(cd "#{@output_dir}" && #{XSLT_PROCESSOR} #{options} "#{@stylesheet}" "#{@collapsed_docbook_file}")
+      db2epub_cmd = %Q(cd "#{options.destination}" && xsltproc #{parser_opts} "#{options.custom_xsl}" "#{@collapsed_docbook_file}")
       STDERR.puts db2epub_cmd if $DEBUG
       success = system(db2epub_cmd)
-      raise "Could not render as .epub to #{output_file} (#{db2epub_cmd})" unless success
-      @to_delete << Dir["#{@meta_dir}/*"]
-      @to_delete << Dir["#{@oebps_dir}/*"]
+      raise "Could not render as .epub to #{options.output} (#{db2epub_cmd})" unless success
     end
 
-    def bundle_epub(output_file, verbose)
-
-      quiet = verbose ? "" : "-q"
+    def bundle_epub
+      quiet = options.verbose ? "" : "-q"
       mimetype_filename = write_mimetype()
-      meta   = File.basename(@meta_dir)
-      oebps  = File.basename(@oebps_dir)
+      meta   = File.basename(meta_inf_directory)
+      oebps  = File.basename(oebps_directory)
       images = copy_images()
       csses  = copy_csses()
       fonts  = copy_fonts()
       callouts = copy_callouts()
       # zip -X -r ../book.epub mimetype META-INF OEBPS
       # Double-quote stylesheet & file to help Windows cmd.exe
-      zip_cmd = %Q(cd "#{@output_dir}" &&  #{ZIPPER} #{quiet} -X -r  "#{File.expand_path(output_file)}" "#{mimetype_filename}" "#{meta}" "#{oebps}")
+      zip_cmd = %Q(cd "#{options.destination}" && zip #{quiet} -X -r  "#{File.expand_path(options.output)}" "#{mimetype_filename}" "#{meta}" "#{oebps}")
       puts zip_cmd if $DEBUG
       success = system(zip_cmd)
-      raise "Could not bundle into .epub file to #{output_file}" unless success
+      raise "Could not bundle into .epub file to #{options.output}" unless success
     end
 
-    # Input must be collapsed because REXML couldn't find figures in files that
-    # were XIncluded or added by ENTITY
-    #   http://sourceforge.net/tracker/?func=detail&aid=2750442&group_id=21935&atid=373747
     def collapse_docbook
+      # Input must be collapsed because REXML couldn't find figures in files that
+      # were XIncluded or added by ENTITY
+      #   http://sourceforge.net/tracker/?func=detail&aid=2750442&group_id=21935&atid=373747
+
       # Double-quote stylesheet & file to help Windows cmd.exe
-      collapsed_file = File.join(File.expand_path(File.dirname(@docbook_file)),
-                                 '.collapsed.' + File.basename(@docbook_file))
-      entity_collapse_command = %Q(xmllint --loaddtd --noent -o "#{collapsed_file}" "#{@docbook_file}")
+      collapsed_file = File.join(File.expand_path(File.dirname(options.docbook)),
+                                 '.collapsed.' + File.basename(options.docbook))
+      entity_collapse_command = %Q(xmllint --loaddtd --noent -o "#{collapsed_file}" "#{options.docbook}")
       entity_success = system(entity_collapse_command)
-      raise "Could not collapse named entites in #{@docbook_file}" unless entity_success
+      raise "Could not collapse named entites in #{options.docbook}" unless entity_success
 
       xinclude_collapse_command = %Q(xmllint --xinclude -o "#{collapsed_file}" "#{collapsed_file}")
       xinclude_success = system(xinclude_collapse_command)
-      raise "Could not collapse XIncludes in #{@docbook_file}" unless xinclude_success
+      raise "Could not collapse XIncludes in #{options.docbook}" unless xinclude_success
 
-      @to_delete << collapsed_file
       return collapsed_file
     end
 
     def copy_callouts
       new_callout_images = []
       if has_callouts?
-        calloutglob = "#{CALLOUT_FULL_PATH}/*#{CALLOUT_EXT}"
+        calloutglob = "#{options.callout_full_path}/*#{options.callout_ext}"
         Dir.glob(calloutglob).each {|img|
-          img_new_filename = File.join(@oebps_dir, CALLOUT_PATH, File.basename(img))
+          img_new_filename = File.join(oebps_directory, options.callout_path, File.basename(img))
 
           # TODO: What to rescue for these two?
           FileUtils.mkdir_p(File.dirname(img_new_filename))
           FileUtils.cp(img, img_new_filename)
-          @to_delete << img_new_filename
           new_callout_images << img
         }
       end
@@ -150,8 +104,8 @@ module DocbookXslWrapper
 
     def copy_fonts
       new_fonts = []
-      @embedded_fonts.each {|font_file|
-        font_new_filename = File.join(@oebps_dir, File.basename(font_file))
+      options.fonts.each {|font_file|
+        font_new_filename = File.join(oebps_directory, File.basename(font_file))
         FileUtils.cp(font_file, font_new_filename)
         new_fonts << font_file
       }
@@ -159,9 +113,9 @@ module DocbookXslWrapper
     end
 
     def copy_csses
-      if @css_file
-        css_new_filename = File.join(@oebps_dir, File.basename(@css_file))
-        FileUtils.cp(@css_file, css_new_filename)
+      if options.css
+        css_new_filename = File.join(oebps_directory, File.basename(options.css))
+        FileUtils.cp(options.css, css_new_filename)
       end
     end
 
@@ -172,14 +126,13 @@ module DocbookXslWrapper
         # TODO: It'd be cooler if we had a filetype lookup rather than just
         # extension
         if img =~ /\.(svg|png|gif|jpe?g|xml)/i
-          img_new_filename = File.join(@oebps_dir, img)
-          img_full = File.join(File.expand_path(File.dirname(@docbook_file)), img)
+          img_new_filename = File.join(oebps_directory, img)
+          img_full = File.join(File.expand_path(File.dirname(options.docbook)), img)
 
           # TODO: What to rescue for these two?
           FileUtils.mkdir_p(File.dirname(img_new_filename))
           puts(img_full + ": " + img_new_filename) if $DEBUG
           FileUtils.cp(img_full, img_new_filename)
-          @to_delete << img_new_filename
           new_images << img_full
         end
       }
@@ -187,19 +140,11 @@ module DocbookXslWrapper
     end
 
     def write_mimetype
-      mimetype_filename = File.join(@output_dir, "mimetype")
-      File.open(mimetype_filename, "w") {|f| f.print MIMETYPE}
-      @to_delete << mimetype_filename
+      mimetype_filename = File.join(options.destination, "mimetype")
+      File.open(mimetype_filename, "w") {|f| f.print "application/epub+zip"}
       return File.basename(mimetype_filename)
     end
 
-    def cleanup_files(file_list)
-      file_list.flatten.each {|f|
-        # Yikes
-        FileUtils.rm_r(f, :force => true )
-      }
-    end
-
     # Returns an Array of all of the (image) @filerefs in a document
     def get_image_refs
       parser = REXML::Parsers::PullParser.new(File.new(@collapsed_docbook_file))
@@ -224,5 +169,14 @@ module DocbookXslWrapper
       end
       return false
     end
+
+    def oebps_directory
+      @oebps_directory ||= File.join(options.destination, 'OEBPS')
+    end
+
+    def meta_inf_directory
+      @meta_inf_directory ||= File.join(options.destination, 'META-INF')
+    end
+
   end
 end

data/lib/docbook_xsl_wrapper/options.rb

@@ -6,13 +6,19 @@ module DocbookXslWrapper
 
     def self.parse(args)
       options = OpenStruct.new
-      options.css           = nil
-      options.customization = nil
-      options.fonts         = []
-      options.output        = nil
-      options.debug         = false
-      options.verbose       = false
-      options.docbooks      = []
+      options.docbook_xsl_root  = 'http://docbook.sourceforge.net/release/xsl/current'
+      options.callout_path      = File.join('images', 'callouts')
+      options.callout_full_path = File.join(options.docbook_xsl_root, options.callout_path)
+      options.callout_limit     = 15
+      options.callout_ext       = '.png'
+
+      options.css               = nil
+      options.custom_xsl        = nil
+      options.fonts             = []
+      options.output            = nil
+      options.debug             = false
+      options.verbose           = false
+      options.docbook           = nil
 
       opts = OptionParser.new do |opts|
         opts.banner = "Usage: #{opts.program_name} [OPTIONS] [DocBook Files]"
@@ -31,8 +37,8 @@ module DocbookXslWrapper
           options.css = css
         end
 
-        opts.on("-s", "--stylesheet [XSL FILE]", "Use XSL FILE as a customization layer (imports epub/docbook.xsl).") do |xsl|
-          options.customization = xsl
+        opts.on("-s", "--stylesheet [XSL FILE]", "Use XSL FILE as a custom_xsl layer (imports epub/docbook.xsl).") do |xsl|
+          options.custom_xsl = xsl
         end
 
         opts.on("-f", "--font [OTF FILE]", "Embed OTF FILE in .epub.") do |otf|
@@ -73,14 +79,21 @@ module DocbookXslWrapper
       args = ['-h'] if args.empty?
       opts.parse!(args)
 
-      options.docbooks = args
-      if options.docbooks.empty?
+      options.docbook = args.first
+      unless options.docbook
         puts "No DocBook XML file(s) specified"
         exit
       end
+      options.output = epub_filename_from_given_filename(options.docbook) unless options.output
 
       options
     end
 
+  private
+
+    def self.epub_filename_from_given_filename(filename)
+      File.join(File.dirname(filename), File.basename(filename, File.extname(filename)) + ".epub")
+    end
+
   end
 end

data/lib/docbook_xsl_wrapper/version.rb

@@ -1,3 +1,3 @@
 module DocbookXslWrapper
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/docbook_xsl_wrapper/options_spec.rb

@@ -9,13 +9,16 @@ module DocbookXslWrapper
         options.css.should be nil
         options.customization.should be nil
         options.fonts.should eql []
-        options.output.should be nil
         options.debug.should be false
         options.verbose.should be false
       end
-      it "should put the XML file in the docbooks array" do
+      it "should assign docbook with the XML file path" do
         options = Options.parse(['etext.xml'])
-        options.docbooks.should eql ['etext.xml']
+        options.docbook.should eql 'etext.xml'
+      end
+      it "should set the EPUB output filename from the XML filename" do
+        options = Options.parse(['/path/to/etext.xml'])
+        options.output.should eql '/path/to/etext.epub'
       end
 
       context "when verbose option" do
@@ -41,9 +44,9 @@ module DocbookXslWrapper
         end
       end
       context "when customization stylsheet given option" do
-        it "should set .customiztion with the value" do
+        it "should set .custom_xsl with the value" do
           options = Options.parse(['--stylesheet', 'some.xsl', 'etext.xml'])
-          options.customization.should eq 'some.xsl'
+          options.custom_xsl.should eq 'some.xsl'
         end
       end
       context "when fonts option" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_xsl_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-27 00:00:00.000000000 Z
+date: 2013-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -52,7 +52,7 @@ files:
 - spec/docbook_xsl_wrapper/options_spec.rb
 - spec/spec_helper.rb
 - xslt/obfuscate.xsl
-homepage: ''
+homepage: 
 licenses: []
 post_install_message: 
 rdoc_options: []