docbook_xsl_wrapper 0.0.5 → 0.1.1

data/README.md

@@ -1,13 +1,12 @@
 # DocBook XSL Wrapper
 
-_Initial 'gemification' of the DocBook XSL Ruby script. Please consider
-this as an Alpha release._
+_Please consider this as an Alpha release._
 
 The DocBook XSL stylesheets are very powerful and provide an easy way to output
 your DocBook XML documents into a usable format such as EPUB and PDF. This GEM
 hopes to make using these stylesheets even easier.
 
-At present the wrapper will only convert DocBook to EPUB 2 and is
+At present the wrapper will only convert DocBook to EPUB2 and EPUB3 and is
 intended to be run from the command-line - future versions will have more
 functionality (see Future Improvements).
 
@@ -17,7 +16,7 @@ The original Ruby script can be found at: http://docbook.sourceforge.net/release
 ## Requirements
 
 * DocBook
-* DocBook XSL (~> v1.78.0)
+* DocBook XSL (~> v1.78.1)
 * xsltproc
 
 ### NOTE
@@ -31,10 +30,10 @@ needed fixing before everything worked correctly.
 
 The catalog file ($XML_CATALOG_FILES) needed updating;
 
-1. Add an entry to your 1.78.0 path.
+1. Add an entry to your 1.78.1 path.
 2. Remove older XSL entries (e.g. 1.76.0 & 1.77.0).
 
-_Please make sure that xsltproc uses the *1.78.0* stylesheets as default_
+_Please make sure that xsltproc uses the *1.78.1* stylesheets as default_
 
 
 ## Installation
@@ -49,7 +48,6 @@ _Please make sure that xsltproc uses the *1.78.0* stylesheets as default_
 
   * Better design so it can be used from within other GEMs, as part of a larger tool-chain.
   * Test that the GEM also works on Linux.
-  * EPUB3 output
   * Other output formats (e.g. PDF)
 
 ## Contributing

data/bin/docbook_xsl_wrapper

@@ -19,7 +19,7 @@ begin
   puts "Rendering DocBook file #{options.docbook} to #{options.output}\n\n" if options.verbose
 
   epub = DocbookXslWrapper::Epub.new(options)
-  epub.render_to_file
+  epub.create
 ensure
   FileUtils.remove_entry_secure tmp_dir
 end

data/lib/docbook_xsl_wrapper/epub.rb

@@ -8,64 +8,58 @@ module DocbookXslWrapper
 
     def initialize(options)
       @options = options
-      @options.custom_xsl = File.join(options.docbook_xsl_root, 'epub', 'docbook.xsl') unless options.custom_xsl
+
+      case options.format
+      when 'epub3'
+        xsl = File.join('epub3', 'chunk.xsl')
+      else
+        xsl = File.join('epub', 'docbook.xsl')
+      end
+      official_docbook_xsl = File.join('http://docbook.sourceforge.net/release/xsl/current', xsl)
+
+      @options.stylesheet = official_docbook_xsl unless options.stylesheet
     end
 
-    def render_to_file
-      render_to_epub
-      bundle_epub
+    def create
+      begin
+        render_to_epub
+        bundle_epub
+      ensure
+        FileUtils.remove_entry_secure @collapsed_docbook_file
+      end
     end
 
   private
 
     def render_to_epub
-      @collapsed_docbook_file = collapse_docbook()
+      @collapsed_docbook_file = collapse_docbook
 
       # Double-quote stylesheet & file to help Windows cmd.exe
-      db2epub_cmd = %Q(cd "#{options.destination}" && xsltproc #{xsl_parser_options} "#{options.custom_xsl}" "#{@collapsed_docbook_file}")
+      db2epub_cmd = %Q(cd "#{options.destination}" && xsltproc #{xsl_parser_options} "#{options.stylesheet}" "#{@collapsed_docbook_file}")
       STDERR.puts db2epub_cmd if options.debug
       success = system(db2epub_cmd)
       raise "Could not render as .epub to #{options.output} (#{db2epub_cmd})" unless success
     end
 
     def xsl_parser_options
-      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_path}/"
+      chunk_quietly = "--stringparam chunk.quietly 1" if options.verbose == false
+      css           = "--stringparam html.stylesheet #{File.basename(options.css)}/" if options.css
+      base          = "--stringparam base.dir #{oebps_path}/"
       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_inf_path}/"
+      meta  = "--stringparam epub.metainf.dir #{meta_inf_directory}/"
       oebps = "--stringparam epub.oebps.dir #{oebps_directory}/"
-      [chunk_quietly,
-       co_path,
-       co_limit,
-       co_ext,
-       base,
-       font,
-       meta,
-       oebps,
-       html_stylesheet,
-      ].join(" ")
-    end
 
-    def bundle_epub
-      quiet = options.verbose ? "" : "-q"
-      mimetype_filename = write_mimetype()
-      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 "#{options.destination}" && zip #{quiet} -X -r  "#{File.expand_path(options.output)}" "#{mimetype_filename}" "#{meta_inf_directory}" "#{oebps_directory}")
-      puts zip_cmd if options.debug
-      success = system(zip_cmd)
-      raise "Could not bundle into .epub file to #{options.output}" unless success
+      [
+        chunk_quietly,
+        base,
+        font,
+        meta,
+        oebps,
+        css,
+      ].join(" ")
     end
 
     def collapse_docbook
@@ -84,91 +78,108 @@ module DocbookXslWrapper
       xinclude_success = system(xinclude_collapse_command)
       raise "Could not collapse XIncludes in #{options.docbook}" unless xinclude_success
 
-      return collapsed_file
+      collapsed_file
+    end
+
+    def bundle_epub
+      quiet = options.verbose ? "" : "-q"
+      mimetype_filename = write_mimetype
+      images = copy_images
+      csses  = copy_css
+      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 "#{options.destination}" && zip #{quiet} -X -r  "#{File.expand_path(options.output)}" "#{mimetype_filename}" "#{meta_inf_directory}" "#{oebps_directory}")
+      puts zip_cmd if options.debug
+      success = system(zip_cmd)
+      raise "Could not bundle into .epub file to #{options.output}" unless success
+    end
+
+    def write_mimetype
+      filename = File.join(options.destination, "mimetype")
+      File.open(filename, "w") {|f| f.print "application/epub+zip"}
+      File.basename(filename)
     end
 
     def copy_callouts
-      new_callout_images = []
-      if has_callouts?
-        calloutglob = "#{options.callout_full_path}/*#{options.callout_ext}"
-        Dir.glob(calloutglob).each {|img|
-          img_new_filename = File.join(oebps_path, 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)
-          new_callout_images << img
-        }
+      return unless has_callouts?
+
+      images = Array.new
+      calloutglob = "#{options.callout_full_path}/*#{options.callout_ext}"
+      Dir.glob(calloutglob).each do |image|
+        new_filename = File.join(oebps_path, options.callout_path, File.basename(image))
+
+        # TODO: What to rescue for these two?
+        FileUtils.mkdir_p(File.dirname(new_filename))
+        FileUtils.cp(image, new_filename)
+        images << image
       end
-      return new_callout_images
+      images
+    end
+
+    # Returns true if the document has code callouts
+    def has_callouts?
+      parser = REXML::Parsers::PullParser.new(File.new(@collapsed_docbook_file))
+      while parser.has_next?
+        element = parser.pull
+        return true if element.start_element? and (element[0] == "calloutlist" or element[0] == "co")
+      end
+      false
     end
 
     def copy_fonts
-      new_fonts = []
-      options.fonts.each {|font_file|
-        font_new_filename = File.join(oebps_path, File.basename(font_file))
-        FileUtils.cp(font_file, font_new_filename)
-        new_fonts << font_file
+      fonts = Array.new
+      options.fonts.each {|font|
+        new_filename = File.join(oebps_path, File.basename(font))
+        FileUtils.cp(font, new_filename)
+        fonts << font
       }
-      return new_fonts
+      fonts
     end
 
-    def copy_csses
-      if options.css
-        css_new_filename = File.join(oebps_path, File.basename(options.css))
-        FileUtils.cp(options.css, css_new_filename)
-      end
+    def copy_css
+      return unless options.css
+
+      filename = File.join(oebps_path, File.basename(options.css))
+      FileUtils.cp(options.css, filename)
     end
 
     def copy_images
-      image_references = get_image_refs()
-      new_images = []
-      image_references.each {|img|
-        # 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_path, 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 options.debug
-          FileUtils.cp(img_full, img_new_filename)
-          new_images << img_full
-        end
-      }
-      return new_images
+      images = Array.new
+      xml_image_references.each do |image|
+        images << copy_image(image)
+      end
+      images
     end
 
-    def write_mimetype
-      mimetype_filename = File.join(options.destination, "mimetype")
-      File.open(mimetype_filename, "w") {|f| f.print "application/epub+zip"}
-      return File.basename(mimetype_filename)
+    def copy_image(image)
+      source_file      = File.join(File.expand_path(File.dirname(options.docbook)), image)
+      destination_file = File.join(oebps_path, image)
+
+      FileUtils.mkdir_p(File.dirname(destination_file))
+
+      puts "Copying image: #{source_file} to #{destination_file}" if options.debug
+      FileUtils.cp(source_file, destination_file)
+
+      destination_file
     end
 
-    # Returns an Array of all of the (image) @filerefs in a document
-    def get_image_refs
+    def xml_image_references
       parser = REXML::Parsers::PullParser.new(File.new(@collapsed_docbook_file))
-      image_refs = []
+      references = Array.new
       while parser.has_next?
-        el = parser.pull
-        if el.start_element? and (el[0] == "imagedata" or el[0] == "graphic")
-          image_refs << el[1]['fileref']
-        end
+        element = parser.pull
+        references << element[1]['fileref'] if is_valid_image_reference?(element)
       end
-      return image_refs.uniq
+      references.uniq
     end
 
-    # Returns true if the document has code callouts
-    def has_callouts?
-      parser = REXML::Parsers::PullParser.new(File.new(@collapsed_docbook_file))
-      while parser.has_next?
-        el = parser.pull
-        if el.start_element? and (el[0] == "calloutlist" or el[0] == "co")
-          return true
-        end
-      end
-      return false
+    def is_valid_image_reference?(element)
+      return false unless element.start_element?
+      return false unless element[0] == 'graphic' or element[0] == 'imagedata'
+      return true if element[1]['fileref'].match(/\.(jpe?g|png|gif|svg|xml)\Z/i)
+      false
     end
 
     def oebps_directory
@@ -183,9 +194,5 @@ module DocbookXslWrapper
       'META-INF'
     end
 
-    def meta_inf_path
-      @meta_inf_path ||= File.join(options.destination, meta_inf_directory)
-    end
-
   end
 end

data/lib/docbook_xsl_wrapper/options.rb

@@ -6,16 +6,11 @@ module DocbookXslWrapper
 
     def self.parse(args)
       options = OpenStruct.new
-      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.stylesheet        = nil
       options.fonts             = []
-      options.output            = nil
+      options.format            = 'epub'
       options.debug             = false
       options.verbose           = false
       options.docbook           = nil
@@ -33,20 +28,25 @@ module DocbookXslWrapper
         opts.separator "Specific options:"
 
 
-        opts.on("-c", "--css [FILE]", "Use FILE for CSS on generated XHTML.") do |css|
-          options.css = css
+        opts.on("-c", "--css [FILE]", "Custom CSS for generated HTML") do |css|
+          options.css = File.expand_path(css)
         end
 
-        opts.on("-s", "--stylesheet [XSL FILE]", "Use XSL FILE as a custom_xsl layer (imports epub/docbook.xsl).") do |xsl|
-          options.custom_xsl = xsl
+        opts.on("-s", "--stylesheet [XSL FILE]", "Custom XSL layer (imports epub/docbook.xsl, overrides --type)") do |xsl|
+          options.stylesheet = File.expand_path(xsl)
         end
 
-        opts.on("-f", "--font [OTF FILE]", "Embed OTF FILE in .epub.") do |otf|
-          options.fonts << otf
+        opts.on("-f", "--font [OTF FILE]", "OpenType Font file for inclusion in the EPUB") do |otf|
+          options.fonts << File.expand_path(otf)
         end
 
-        opts.on("-o", "--output [OUTPUT FILE]", "Output EPUB file as OUTPUT FILE.") do |output|
-          options.output = output
+        opts.on("-o", "--output [OUTPUT FILE]", "Filename for the generated document") do |output|
+          options.output = File.expand_path(output)
+        end
+
+        opts.on("-t", "--type [BOOK TYPE]", "eBook type (format) that you wish to output: epub, epub3", /\Aepub[23]?\z/i) do |format|
+          format = format.downcase if format
+          options.format = "#{format}"
         end
 
         opts.separator ""
@@ -79,7 +79,7 @@ module DocbookXslWrapper
       args = ['-h'] if args.empty?
       opts.parse!(args)
 
-      options.docbook = args.first
+      options.docbook = File.expand_path(args.first)
       unless options.docbook
         puts "No DocBook XML file(s) specified"
         exit

data/lib/docbook_xsl_wrapper/version.rb

@@ -1,3 +1,3 @@
 module DocbookXslWrapper
-  VERSION = "0.0.5"
+  VERSION = "0.1.1"
 end

data/spec/docbook_xsl_wrapper/options_spec.rb

@@ -9,12 +9,14 @@ module DocbookXslWrapper
         options.css.should be nil
         options.customization.should be nil
         options.fonts.should eql []
+        options.format.should eq 'epub'
+        options.output.should match /etext\.epub\z/
         options.debug.should be false
         options.verbose.should be false
       end
       it "should assign docbook with the XML file path" do
         options = Options.parse(['etext.xml'])
-        options.docbook.should eql 'etext.xml'
+        options.docbook.should match /etext\.xml\z/
       end
       it "should set the EPUB output filename from the XML filename" do
         options = Options.parse(['/path/to/etext.xml'])
@@ -40,19 +42,20 @@ module DocbookXslWrapper
       context "when css option used" do
         it "should assign value to .css" do
           options = Options.parse(['--css', 'stylesheet.css', 'etext.xml'])
-          options.css.should eq 'stylesheet.css'
+          options.css.should match /stylesheet\.css\z/
         end
       end
       context "when customization stylsheet given option" do
-        it "should set .custom_xsl with the value" do
+        it "should set .stylesheet with the value" do
           options = Options.parse(['--stylesheet', 'some.xsl', 'etext.xml'])
-          options.custom_xsl.should eq 'some.xsl'
+          options.stylesheet.should match /some\.xsl\z/
         end
       end
       context "when fonts option" do
         it "should sets fonts with the OTF files" do
           options = Options.parse(['--font', 'one.otf', '--font', 'two.otf', 'etext.xml'])
-          options.fonts.should eq ['one.otf', 'two.otf']
+          options.fonts[0].should match /one\.otf\z/
+          options.fonts[1].should match /two\.otf\z/
         end
       end
       context "when output file given" do
@@ -61,6 +64,12 @@ module DocbookXslWrapper
           options.output.should eq '/path/to/new.epub'
         end
       end
+      context "when output ebook format is given" do
+        it "should assign format with the given book format" do
+          options = Options.parse(['--type', 'ePub3', 'etext.xml'])
+          options.format.should eq 'epub3'
+        end
+      end
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: docbook_xsl_wrapper
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-05 00:00:00.000000000 Z
+date: 2013-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec