repub 0.3.3 → 0.3.4

data/lib/repub/app/pre_filters.rb

@@ -0,0 +1,50 @@
+require 'repub/app/filter'
+
+module Repub
+  class App
+    class PreFilters
+      include Filter
+      
+      # Detect and convert source encoding
+      # Standard requires it to be UTF-8
+      #
+      filter :fix_encoding do |s|
+        encoding = options[:encoding]
+        unless encoding
+          log.info "Detecting encoding"
+          encoding = UniversalDetector.chardet(s)['encoding']
+        end
+        if encoding.downcase != 'utf-8'
+          log.info "Source encoding appears to be #{encoding}, converting to UTF-8"
+          s = Iconv.conv('utf-8', encoding, s)
+        end
+        s
+      end
+
+      # Convert line endings to LF
+      #
+      filter :fix_line_endings do |s|
+        s.gsub(/\r\n/, "\n")
+      end
+
+      # Fix all elements with broken id attribute
+      # In XHTML id must match [A-Za-z][A-Za-z0-9:_.-]*
+      # TODO: currently only testing for non-alpha first char...
+      #
+      filter :fix_ids do |s|
+        match = s.scan(/\s+((?:id|name)\s*?=\s*?['"])(\d+[^'"]*)['"]/im)
+        unless match.empty?
+          log.debug "-- Fixing broken element IDs"
+          match.each do |m|
+            # fix id so it starts with alpha char
+            s.gsub!(m.join(''), m.join('x'))
+            # update fragment references
+            s.gsub!(/##{m[1]}(['"])/, "#x#{m[1]}\\1")
+          end
+        end
+        s
+      end
+
+    end
+  end
+end

data/lib/repub/app/profile.rb

@@ -5,7 +5,7 @@ module Repub
   class App
     module Profile
 
-      PROFILE_KEYS = %w[css encoding fixup helper metadata remove rx selectors].map {|k| k.to_sym}
+      PROFILE_KEYS = %w[css encoding helper metadata remove rx selectors].map {|k| k.to_sym}
       
       def load_profile(name = nil)
         name ||= 'default'

data/lib/repub/epub.rb

@@ -1,3 +1,4 @@
-require 'repub/epub/container'
-require 'repub/epub/content'
-require 'repub/epub/toc'
+require 'repub/epub/container_item'
+require 'repub/epub/ocf'
+require 'repub/epub/opf'
+require 'repub/epub/ncx'

data/lib/repub/epub/container_item.rb

@@ -0,0 +1,49 @@
+require 'rubygems'
+
+module Repub
+  module Epub
+
+    # Mixin for stuff that can be added to the ePub package
+    #
+    module ContainerItem
+      attr_accessor :file_path
+      attr_accessor :media_type
+      
+      def document?
+        ['application/xhtml+xml', 'application/x-dtbook+xml'].include? self.media_type
+      end
+    end
+    
+    # Wrapper class for ePub items that do not have specialized classes
+    # e.g. HTML files, CSSs etc.
+    #
+    class Item
+      include ContainerItem
+      
+      def initialize(file_path, media_type = nil)
+        @file_path = file_path.strip
+        @media_type = media_type || case @file_path.downcase
+          when /.*\.html?$/
+            'application/xhtml+xml'
+          when /.*\.css$/
+            'text/css'
+          when /.*\.(jpeg|jpg)$/
+            'image/jpeg'
+          when /.*\.png$/
+            'image/png'
+          when /.*\.gif$/
+            'image/gif'
+          when /.*\.svg$/
+            'image/svg+xml'
+          when /.*\.ncx$/
+            'application/x-dtbncx+xml'
+          when /.*\.opf$/
+            'application/oebps-package+xml'
+          else
+            raise 'Unknown media type'
+        end
+      end
+    end
+
+  end
+end

data/lib/repub/epub/{toc.rb → ncx.rb}

@@ -1,139 +1,137 @@
-require 'rubygems'
-require 'builder'
-
-module Repub
-  module Epub
-  
-  class Toc
-    
-    def initialize(uid)
-      @head = Head.new(uid)
-      @doc_title = DocTitle.new('Untitled')
-      @nav_map = NavMap.new
-    end
-
-    def title
-      @doc_title.text
-    end
-    
-    def title=(text)
-      @doc_title = DocTitle.new(text)
-    end
-    
-    attr_reader :nav_map
-    
-    def to_xml
-      out = ''
-      builder = Builder::XmlMarkup.new(:target => out)
-      builder.instruct!
-      builder.declare! :DOCTYPE, :ncx, :PUBLIC, "-//NISO//DTD ncx 2005-1//EN", "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd"
-      builder.ncx :xmlns => "http://www.daisy.org/z3986/2005/ncx/", :version => "2005-1" do
-        @nav_map.calc_depth_and_play_order
-        @head.depth = @nav_map.depth
-        @head.to_xml(builder)
-        @doc_title.to_xml(builder)
-        @nav_map.to_xml(builder)
-      end
-      out
-    end
-    
-    def save(path = 'toc.ncx')
-      File.open(path, 'w') do |f|
-        f << to_xml
-      end
-    end
-    
-    class Head < Struct.new(
-        :uid
-      )
-      
-      attr_accessor :depth
-      
-      def to_xml(builder)
-        builder.head do 
-          builder.meta :name => "dtb:uid", :content => self.uid
-          builder.meta :name => "dtb:depth", :content => @depth
-          builder.meta :name => "dtb:totalPageCount", :content => 0
-          builder.meta :name => "dtb:maxPageNumber", :content => 0
-        end
-      end
-    end
-    
-    class DocTitle < Struct.new(
-        :text
-      )
-      
-      def to_xml(builder)
-        builder.docTitle do 
-          builder.text self.text
-        end
-      end
-    end
-    
-    class NavMap
-      class NavPoint < Struct.new(
-          :title,
-          :src
-        )
-        
-        def initialize(title, src)
-          super
-          @@last_play_order = 0
-          @play_order = 0
-          @child_points = []
-        end
-        
-        def add_nav_point(title, src)
-          nav_point = NavPoint.new(title, src)
-          @child_points << nav_point
-          nav_point
-        end
-        
-        def to_xml(builder)
-          builder.navPoint :id => "navPoint-#{@play_order}", :playOrder => @play_order do
-            builder.navLabel do
-              builder.text self.title
-            end
-            builder.content :src => self.src
-            @child_points.each { |child_point| child_point.to_xml(builder) }
-          end
-        end
-        
-        def calc_depth_and_play_order(nav_map, depth)
-          nav_map.depth = depth
-          @play_order = @@last_play_order += 1
-          @child_points.each { |child_point| child_point.calc_depth_and_play_order(nav_map, depth + 1) }
-        end
-      end
-      
-      def initialize
-        @nav_points = []
-        @depth = 1
-      end
-      
-      def add_nav_point(title, src)
-        nav_point = NavPoint.new(title, src)
-        @nav_points << nav_point
-        nav_point
-      end
-    
-      attr_reader :depth
-      
-      def depth=(value)
-        @depth = value if value > @depth
-      end
-      
-      def calc_depth_and_play_order
-        @nav_points.each { |nav_point| nav_point.calc_depth_and_play_order(self, 1) }
-      end
-      
-      def to_xml(builder)
-        builder.navMap do
-          @nav_points.each { |nav_point| nav_point.to_xml(builder) }
-        end
-      end
-    end
-  end
-
-  end
-end
+require 'rubygems'
+require 'builder'
+
+module Repub
+  module Epub
+  
+  class NCX
+    include ContainerItem
+    
+    def initialize(uid, file_path = 'toc.ncx')
+      @file_path = file_path
+      @media_type = 'application/x-dtbncx+xml'
+      @head = Head.new(uid)
+      @doc_title = DocTitle.new('Untitled')
+      @nav_map = NavMap.new
+    end
+
+    def title
+      @doc_title.text
+    end
+    
+    def title=(text)
+      @doc_title = DocTitle.new(text)
+    end
+
+    attr_reader :nav_map
+    
+    def to_xml
+      out = ''
+      builder = Builder::XmlMarkup.new(:target => out)
+      builder.instruct!
+      builder.declare! :DOCTYPE, :ncx, :PUBLIC, "-//NISO//DTD ncx 2005-1//EN", "http://www.daisy.org/z3986/2005/ncx-2005-1.dtd"
+      builder.ncx :xmlns => "http://www.daisy.org/z3986/2005/ncx/", :version => "2005-1" do
+        @nav_map.calc_depth_and_play_order
+        @head.depth = @nav_map.depth
+        @head.to_xml(builder)
+        @doc_title.to_xml(builder)
+        @nav_map.to_xml(builder)
+      end
+      out
+    end
+    
+    def save
+      File.open(@file_path, 'w') do |f|
+        f << to_xml
+      end
+    end
+    
+    class Head < Struct.new(
+        :uid
+      )
+      
+      attr_accessor :depth
+      
+      def to_xml(builder)
+        builder.head do 
+          builder.meta :name => "dtb:uid", :content => self.uid
+          builder.meta :name => "dtb:depth", :content => @depth
+          builder.meta :name => "dtb:totalPageCount", :content => 0
+          builder.meta :name => "dtb:maxPageNumber", :content => 0
+        end
+      end
+    end
+    
+    class DocTitle < Struct.new(
+        :text
+      )
+      
+      def to_xml(builder)
+        builder.docTitle do 
+          builder.text self.text
+        end
+      end
+    end
+    
+    class NavPoint < Struct.new(
+        :title,
+        :src
+      )
+      
+      def initialize(title, src, points = nil)
+        super(title, src)
+        @play_order = 0
+        @points = points || []
+      end
+      
+      attr_accessor :play_order
+      attr_accessor :points
+      
+      def to_xml(builder)
+        builder.navPoint :id => point_id(@play_order), :playOrder => @play_order do
+          builder.navLabel do
+            builder.text self.title
+          end
+          builder.content :src => self.src
+          @points.each { |point| point.to_xml(builder) }
+        end
+      end
+      
+      private
+      
+      def point_id(play_order)
+        "navPoint-#{play_order}"
+      end
+    end
+
+    class NavMap < NavPoint
+      
+      def initialize
+        super(nil, nil)
+        @depth = 1
+      end
+      
+      attr_reader :depth
+      
+      def calc_depth_and_play_order
+        play_order = 0
+        l = lambda do |points, depth|
+          @depth = depth if depth > @depth
+          points.each do |pt|
+            pt.play_order = (play_order += 1)
+            l.call(pt.points, depth + 1) unless pt.points.empty?
+          end
+        end
+        l.call(@points, @depth = 1)
+      end
+      
+      def to_xml(builder)
+        builder.navMap do
+          @points.each { |point| point.to_xml(builder) }
+        end
+      end
+    end
+  end
+
+  end
+end

data/lib/repub/epub/ocf.rb

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'fileutils'
+require 'builder'
+
+module Repub
+  module Epub
+
+  # OEBPS Container Format (OCF) 1.0 wrapper
+  # (see http://www.idpf.org/ocf/ocf1.0/download/ocf10.htm)
+  #
+  class OCF
+    
+    def initialize
+      @items = []
+    end
+    
+    attr_reader :items
+    
+    def <<(item)
+      if item.kind_of? ContainerItem
+        @items << item
+      elsif item.is_a? String
+        @items << Item.new(item)
+      else
+        raise "Unsupported item class: #{item.class}"
+      end
+    end
+    
+    def to_xml
+      out = ''
+      builder = Builder::XmlMarkup.new(:target => out)
+      builder.instruct!
+      builder.container :xmlns => "urn:oasis:names:tc:opendocument:xmlns:container", :version => "1.0" do
+        builder.rootfiles do
+          @items.each do |item|
+            builder.rootfile 'full-path' => item.file_path, 'media-type' => item.media_type
+          end
+        end
+      end
+      out
+    end
+  
+    def save
+      meta_inf = 'META-INF'
+      FileUtils.mkdir_p(meta_inf)
+      File.open(File.join(meta_inf, 'container.xml'), 'w') do |f|
+        f << to_xml
+      end
+    end
+    
+    def zip(output_path)
+      File.open('mimetype', 'w') do |f|
+        f << 'application/epub+zip'
+      end
+      # mimetype has to be first in the archive
+      %x(zip -X9 \"#{output_path}\" mimetype)
+      %x(zip -Xr9D \"#{output_path}\" * -xi mimetype)
+    end
+  end
+
+  end
+end