epub-parser 0.1.3 → 0.1.4

data/lib/epub/parser/publication.rb

@@ -41,6 +41,10 @@ module EPUB
         end
         @unique_identifier_id = elem['unique-identifier']
         @package.prefix = parse_prefix(extract_attribute(elem, 'prefix'))
+        if @package.prefix.key? 'rendition'
+          require 'epub/publication/fixed_layout'
+          EPUB::Publication.__send__ :include, EPUB::Publication::FixedLayout
+        end
 
         @package
       end

data/lib/epub/parser/version.rb

@@ -1,5 +1,5 @@
 module EPUB
   class Parser
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/lib/epub/publication/fixed_layout.rb

@@ -0,0 +1,209 @@
+module EPUB
+  module Publication
+    module FixedLayout
+      PREFIX_KEY = 'rendition'.freeze
+      PREFIX_VALUE = 'http://www.idpf.org/vocab/rendition/#'.freeze
+
+      RENDITION_PROPERTIES = {
+        'layout'      => ['reflowable'.freeze, 'pre-paginated'.freeze].freeze,
+        'orientation' => ['auto'.freeze, 'landscape'.freeze, 'portrait'.freeze].freeze,
+        'spread'      => ['auto'.freeze, 'none'.freeze, 'landscape'.freeze, 'portrait'.freeze, 'both'.freeze].freeze
+      }.freeze
+
+      class UnsupportedRenditionValue < StandardError; end
+
+      class << self
+        def included(package_class)
+          [
+           [Package, PackageMixin],
+           [Package::Metadata, MetadataMixin],
+           [Package::Spine::Itemref, ItemrefMixin],
+           [Package::Manifest::Item, ItemMixin],
+           [ContentDocument::XHTML, ContentDocumentMixin],
+          ].each do |(base, mixin)|
+            base.__send__ :include, mixin
+          end
+        end
+      end
+
+      module Rendition
+        # @note Call after defining #rendition_xxx and #renditionn_xxx=
+        def def_rendition_methods
+          RENDITION_PROPERTIES.each_key do |property|
+            alias_method property, "rendition_#{property}"
+            alias_method "#{property}=", "rendition_#{property}="
+          end
+          def_rendition_layout_methods
+        end
+
+        def def_rendition_layout_methods
+          property = 'layout'
+          RENDITION_PROPERTIES[property].each do |value|
+            method_name_base = value.gsub('-', '_')
+            writer_name = "#{method_name_base}="
+            define_method writer_name do |new_value|
+              new_prop = new_value ? value : values.find {|l| l != value}
+              __send__ "rendition_#{property}=", new_prop
+            end
+
+            maker_name = "make_#{method_name_base}"
+            define_method maker_name do
+              __send__ "rendition_#{property}=", value
+            end
+            destructive_method_name = "#{method_name_base}!"
+            alias_method destructive_method_name, maker_name
+
+            predicate_name = "#{method_name_base}?"
+            define_method predicate_name do
+              __send__("rendition_#{property}") == value
+            end
+          end
+        end
+      end
+
+      module PackageMixin
+        # @return [true, false]
+        def using_fixed_layout
+          prefix.has_key? PREFIX_KEY and
+            prefix[PREFIX_KEY] == PREFIX_VALUE
+        end
+        alias using_fixed_layout? using_fixed_layout
+
+        # @param using_fixed_layout [true, false]
+        def using_fixed_layout=(using_fixed_layout)
+          if using_fixed_layout
+            prefix[PREFIX_KEY] = PREFIX_VALUE
+          else
+            prefix.delete PREFIX_KEY
+          end
+        end
+      end
+
+      module MetadataMixin
+        extend Rendition
+
+        RENDITION_PROPERTIES.each_pair do |property, values|
+          define_method "rendition_#{property}" do
+            meta = metas.find {|m| m.property == "rendition:#{property}"}
+            meta ? meta.content : values.first
+          end
+
+          define_method "rendition_#{property}=" do |new_value|
+            raise UnsupportedRenditionValue, new_value unless values.include? new_value
+
+            prefixed_property = "rendition:#{property}"
+            values_to_be_deleted = values - [new_value]
+            metas.delete_if {|meta| meta.property == prefixed_property && values_to_be_deleted.include?(meta.content)}
+            unless metas.any? {|meta| meta.property == prefixed_property && meta.content == new_value}
+              meta = Package::Metadata::Meta.new
+              meta.property = prefixed_property
+              meta.content = new_value
+              metas << meta
+            end
+            new_value
+          end
+        end
+
+        def_rendition_methods
+      end
+
+      module ItemrefMixin
+        extend Rendition
+
+        PAGE_SPREAD_PROPERTY = 'center'
+        PAGE_SPREAD_PREFIX = 'rendition:page-spread-'
+
+        class << self
+          # @todo Define using Module#prepend after Ruby 2.0 will become popular
+          def included(base)
+            return if base.instance_methods.include? :page_spread_without_fixed_layout
+            base.__send__ :alias_method, :page_spread_without_fixed_layout, :page_spread
+            base.__send__ :alias_method, :page_spread_writer_without_fixed_layout, :page_spread=
+
+            prefixed_page_spread_property = "#{PAGE_SPREAD_PREFIX}#{PAGE_SPREAD_PROPERTY}"
+            base.__send__ :define_method, :page_spread do
+              property = page_spread_without_fixed_layout
+              return property if property
+              property = properties.find {|prop| prop == prefixed_page_spread_property}
+              property ? PAGE_SPREAD_PROPERTY : nil
+            end
+
+            base.__send__ :define_method, :page_spread= do |new_value|
+              if new_value == PAGE_SPREAD_PROPERTY
+                page_spread_writer_without_fixed_layout nil
+                properties << prefixed_page_spread_property
+              else
+                page_spread_writer_without_fixed_layout new_value
+              end
+              new_value
+            end
+          end
+        end
+
+        RENDITION_PROPERTIES.each do |property, values|
+          rendition_property_prefix = "rendition:#{property}-"
+
+          reader_name = "rendition_#{property}"
+          define_method reader_name do
+            prop_value = properties.find {|prop| prop.start_with? rendition_property_prefix}
+            prop_value ? prop_value.gsub(/\A#{Regexp.escape(rendition_property_prefix)}/, '') :
+              spine.package.metadata.__send__(reader_name)
+          end
+
+          writer_name = "#{reader_name}="
+          define_method writer_name do |new_value|
+            if new_value.nil?
+              properties.delete_if {|prop| prop.start_with? rendition_property_prefix}
+              return new_value
+            end
+
+            raise UnsupportedRenditionValue, new_value unless values.include? new_value
+
+            values_to_be_deleted = (values - [new_value]).map {|value| "#{rendition_property_prefix}#{value}"}
+            properties.delete_if {|prop| values_to_be_deleted.include? prop}
+            new_property = "#{rendition_property_prefix}#{new_value}"
+            properties << new_property unless properties.any? {|prop| prop == new_property}
+            new_value
+          end
+        end
+
+        def_rendition_methods
+      end
+
+      module ItemMixin
+        extend Rendition
+
+        RENDITION_PROPERTIES.each_key do |property|
+          define_method "rendition_#{property}" do
+            itemref.__send__ property
+          end
+
+          writer_name = "rendition_#{property}="
+          define_method writer_name do |value|
+            itemref.__send__ writer_name, value
+          end
+        end
+
+        def_rendition_methods
+      end
+
+      module ContentDocumentMixin
+        extend Rendition
+
+        RENDITION_PROPERTIES.each_key do |property|
+          reader_name = "rendition_#{property}"
+          define_method reader_name do
+            item.__send__ reader_name
+          end
+
+          writer_name = "rendition_#{property}="
+          define_method writer_name do |value|
+            item.__send__ writer_name, value
+          end
+        end
+
+        def_rendition_methods
+      end
+    end
+  end
+end

data/lib/epub/publication/package.rb

@@ -33,6 +33,10 @@ module EPUB
         define_content_model model
       end
 
+      def initialize
+        @prefix = {}
+      end
+
       def unique_identifier
         @metadata.unique_identifier
       end

data/lib/epub/publication/package/manifest.rb

@@ -9,10 +9,12 @@ module EPUB
         attr_accessor :package,
                       :id
 
+        # @return self
         def <<(item)
           @items ||= {}
           item.manifest = self
           @items[item.id] = item
+          self
         end
 
         def navs
@@ -90,7 +92,13 @@ module EPUB
 
           def content_document
             return nil unless %w[application/xhtml+xml image/svg+xml].include? media_type
-            @content_document ||= Parser::ContentDocument.parse(self)
+            @content_document ||= Parser::ContentDocument.new(self).parse
+          end
+
+          # @return [Package::Spine::Itemref]
+          # @return nil when no Itemref refers this Item
+          def itemref
+            manifest.package.spine.itemrefs.find {|itemref| itemref.idref == id}
           end
 
           protected

data/lib/epub/publication/package/spine.rb

@@ -6,10 +6,12 @@ module EPUB
                       :id, :toc, :page_progression_direction
         attr_reader :itemrefs
 
+        # @return self
         def <<(itemref)
           @itemrefs ||= []
           itemref.spine = self
           @itemrefs << itemref
+          self
         end
 
         # @yield [itemref]
@@ -32,20 +34,54 @@ module EPUB
         end
 
         class Itemref
+          PAGE_SPREAD_PROPERTIES = ['left'.freeze, 'right'.freeze].freeze
+          PAGE_SPREAD_PREFIX = 'page-spread-'.freeze
+
           attr_accessor :spine,
                         :idref, :linear, :id, :properties
           alias linear? linear
 
+          def initialize
+            @properties = []
+          end
+
           # @return [Package::Manifest::Item] item referred by this object
           def item
             @item ||= @spine.package.manifest[idref]
           end
 
+          def item=(item)
+            self.idref = item.id
+            item
+          end
+
           def ==(other)
             [:spine, :idref, :linear, :id].all? {|meth|
               self.__send__(meth) == other.__send__(meth)
             } and (other.properties - properties).empty?
           end
+
+          # @return ["left", "right", nil]
+          def page_spread
+            property = properties.find {|prop| prop.start_with? PAGE_SPREAD_PREFIX}
+            property ? property.gsub(/\A#{Regexp.escape(PAGE_SPREAD_PREFIX)}/, '') : nil
+          end
+
+          # @param new_value ["left", "right", nil]
+          def page_spread=(new_value)
+            if new_value.nil?
+              properties.delete_if {|prop| prop.start_with? PAGE_SPREAD_PREFIX}
+              return new_value
+            end
+
+            raise "Unsupported page-spread property: #{new_value}" unless PAGE_SPREAD_PROPERTIES.include? new_value
+
+            props_to_be_deleted = (PAGE_SPREAD_PROPERTIES - [new_value]).map {|prop| "#{PAGE_SPREAD_PREFIX}#{prop}"}
+            properties.delete_if {|prop| props_to_be_deleted.include? prop}
+            new_property = "#{PAGE_SPREAD_PREFIX}#{new_value}"
+            properties << new_property unless properties.include? new_property
+            new_value
+          end
         end
       end
     end

data/test/test_content_document.rb

@@ -0,0 +1,32 @@
+require_relative 'helper'
+
+class TestContentDocument < Test::Unit::TestCase
+  include EPUB::ContentDocument
+
+  def test_top_level?
+    manifest = EPUB::Publication::Package::Manifest.new
+    spine = EPUB::Publication::Package::Spine.new
+
+    item1 = EPUB::Publication::Package::Manifest::Item.new
+    item1.id = 'item1'
+    item2 = EPUB::Publication::Package::Manifest::Item.new
+    item2.id = 'item2'
+    manifest << item1 << item2
+
+    itemref = EPUB::Publication::Package::Spine::Itemref.new
+    itemref.idref = 'item1'
+    spine << itemref
+
+    package = EPUB::Publication::Package.new
+    package.manifest = manifest
+    package.spine = spine
+
+    doc = XHTML.new
+    doc.item = item1
+    assert_true doc.top_level?
+
+    doc = XHTML.new
+    doc.item = item2
+    assert_false doc.top_level?
+  end
+end

data/test/test_fixed_layout.rb

@@ -0,0 +1,258 @@
+require_relative 'helper'
+require 'epub/book'
+require 'epub/publication'
+require 'epub/publication/fixed_layout'
+
+class EPUB::Publication::Package
+  include EPUB::Publication::FixedLayout
+end
+
+class TestFixedLayout < Test::Unit::TestCase
+  include EPUB::Publication
+
+  class TestPackage < TestFixedLayout
+    def test_package_dont_use_fixed_layout_by_default
+      assert_false Package.new.using_fixed_layout?
+    end
+
+    def test_make_package_use_fixed_layout
+      package = Package.new
+      package.using_fixed_layout = true
+      assert_true package.using_fixed_layout?
+
+      package.using_fixed_layout = false
+      assert_false package.using_fixed_layout?
+    end
+  end
+
+  class TestMetadata < TestFixedLayout
+    def setup
+      @metadata = Package::Metadata.new
+    end
+
+    def test_default_layout_is_reflowable
+      assert_equal 'reflowable', @metadata.rendition_layout
+      assert_true @metadata.reflowable?
+    end
+
+    def test_deafult_layout_is_not_pre_paginated
+      assert_false @metadata.pre_paginated?
+    end
+
+    def test_layout_is_pre_paginated_when_has_meta_with_rendition_layout
+      meta = Package::Metadata::Meta.new
+      meta.property = 'rendition:layout'
+      meta.content = 'pre-paginated'
+      @metadata.metas << meta
+      assert_equal 'pre-paginated', @metadata.rendition_layout
+      assert_true @metadata.pre_paginated?
+    end
+
+    def test_layout_is_reflowable_when_has_meta_with_rendition_layout
+      meta = Package::Metadata::Meta.new
+      meta.property = 'rendition:layout'
+      meta.content = 'reflowable'
+      @metadata.metas << meta
+      assert_equal 'reflowable', @metadata.rendition_layout
+      assert_true @metadata.reflowable?
+    end
+
+    def test_can_set_rendition_layout_by_method_of_metadata
+      @metadata.pre_paginated = true
+      assert_equal 'pre-paginated', @metadata.rendition_layout
+      assert_false @metadata.reflowable?
+      assert_true @metadata.pre_paginated?
+
+      @metadata.reflowable = true
+      assert_equal 'reflowable', @metadata.rendition_layout
+      assert_true @metadata.reflowable?
+      assert_false @metadata.pre_paginated?
+    end
+
+    def test_remove_meta_for_pre_paginated_when_making_reflowable
+      meta = Package::Metadata::Meta.new
+      meta.property = 'rendition:layout'
+      meta.content = 'pre-paginated'
+      @metadata.metas << meta
+
+      @metadata.reflowable = true
+      assert_false @metadata.metas.any? {|m| m.property == 'rendition:layout' && m.content == 'pre-paginated'}
+    end
+
+    def test_remove_meta_for_reflowable_when_making_pre_paginated
+      meta = Package::Metadata::Meta.new
+      meta.property = 'rendition:layout'
+      meta.content = 'pre-paginated'
+      @metadata.metas << meta
+      meta = Package::Metadata::Meta.new
+      meta.property = 'rendition:layout'
+      meta.content = 'reflowable'
+      @metadata.metas << meta
+
+      @metadata.pre_paginated = true
+      assert_false @metadata.metas.any? {|m| m.property == 'rendition:layout' && m.content == 'reflowable'}
+    end
+
+    def test_layout_setter
+      @metadata.rendition_layout = 'reflowable'
+      assert_equal 'reflowable', @metadata.rendition_layout
+
+      @metadata.rendition_layout = 'pre-paginated'
+      assert_equal 'pre-paginated', @metadata.rendition_layout
+
+      assert_raise FixedLayout::UnsupportedRenditionValue do
+        @metadata.rendition_layout = 'undefined'
+      end
+    end
+
+    def test_utility_methods_for_rendition_layout_setter
+      @metadata.make_pre_paginated
+      assert_equal 'pre-paginated', @metadata.rendition_layout
+
+      @metadata.make_reflowable
+      assert_equal 'reflowable', @metadata.rendition_layout
+
+      @metadata.pre_paginated!
+      assert_equal 'pre-paginated', @metadata.rendition_layout
+
+      @metadata.reflowable!
+      assert_equal 'reflowable', @metadata.rendition_layout
+    end
+
+    def test_default_orientation_is_auto
+      assert_equal 'auto', @metadata.rendition_orientation
+    end
+  end
+
+  class TestItemref < TestFixedLayout
+    def setup
+      @itemref = Package::Spine::Itemref.new
+      @package = Package.new
+      @package.metadata = Package::Metadata.new
+      @package.spine = Package::Spine.new
+      @package.spine << @itemref
+    end
+
+    def test_inherits_metadatas_rendition_layout_by_default
+      assert_equal 'reflowable', @itemref.rendition_layout
+
+      @package.metadata.rendition_layout = 'pre-paginated'
+      assert_equal 'pre-paginated', @itemref.rendition_layout
+    end
+
+    def test_overwrite_rendition_layout_of_metadata_when_set_explicitly
+      @package.metadata.rendition_layout = 'pre-paginated'
+      @itemref.properties << 'rendition:layout-reflowable'
+      assert_equal 'reflowable', @itemref.rendition_layout
+    end
+
+    def test_can_set_explicitly
+      @itemref.rendition_layout = 'pre-paginated'
+      assert_equal 'pre-paginated', @itemref.rendition_layout
+    end
+
+    def test_can_unset_explicitly
+      @itemref.rendition_layout = 'pre-paginated'
+      @itemref.rendition_layout = nil
+      assert_equal 'reflowable', @itemref.rendition_layout
+      assert_not_include @itemref.properties, 'rendition:layout-reflowable'
+    end
+
+    def test_property_added_when_rendition_layout_set
+      @itemref.rendition_layout = 'pre-paginated'
+      assert_include @itemref.properties, 'rendition:layout-pre-paginated'
+    end
+
+    def test_opposite_property_removed_if_exists_when_rendition_layout_set
+      @itemref.rendition_layout = 'reflowable'
+      @itemref.rendition_layout = 'pre-paginated'
+      assert_not_include @itemref.properties, 'rendition:layout-reflowable'
+    end
+
+    def test_utility_methods
+      assert_true @itemref.reflowable?
+
+      @itemref.make_pre_paginated
+      assert_false @itemref.reflowable?
+      assert_true @itemref.pre_paginated?
+      assert_not_include @itemref.properties, 'rendition:layout-reflowbale'
+      assert_include @itemref.properties, 'rendition:layout-pre-paginated'
+    end
+
+    def test_inherits_metadatas_rendition_spread_by_default
+      assert_equal 'auto', @itemref.rendition_spread
+
+      @package.metadata.rendition_spread = 'portrait'
+      assert_equal 'portrait', @itemref.rendition_spread
+    end
+
+    def test_rendition_property_reader_has_alias
+      assert_equal 'auto', @itemref.orientation
+
+      @itemref.orientation = 'landscape'
+      assert_equal 'landscape', @itemref.rendition_orientation
+    end
+
+    def test_page_spread_center_defined
+      @itemref.properties << 'rendition:page-spread-center'
+      assert_equal 'center', @itemref.page_spread
+    end
+
+    def test_can_make_page_spread_center_explicitly
+      @itemref.page_spread = 'center'
+      assert_include @itemref.properties, 'rendition:page-spread-center'
+    end
+
+    def test_page_spread_is_exclusive
+      @itemref.page_spread = 'right'
+      @itemref.page_spread = 'center'
+      assert_not_include @itemref.properties, 'page-spread-right'
+    end
+  end
+
+  class TestItem < TestFixedLayout
+    def setup
+      package = Package.new
+      package.manifest = Package::Manifest.new
+      @item = Package::Manifest::Item.new
+      @item.id = 'item'
+      package.manifest << @item
+      package.spine = Package::Spine.new
+      @itemref = Package::Spine::Itemref.new
+      @itemref.idref = 'item'
+      package.spine << @itemref
+    end
+
+    def test_can_access_rendition_attributes
+      @itemref.rendition_layout = 'pre-paginated'
+      assert_true @item.pre_paginated?
+
+      @item.rendition_orientation = 'portrait'
+      assert_equal 'portrait', @itemref.rendition_orientation
+    end
+  end
+
+  class TestContentDocument < TestFixedLayout
+    def setup
+      package = Package.new
+      package.manifest = Package::Manifest.new
+      item = Package::Manifest::Item.new
+      item.id = 'item'
+      package.manifest << item
+      package.spine = Package::Spine.new
+      @itemref = Package::Spine::Itemref.new
+      @itemref.idref = 'item'
+      package.spine << @itemref
+      @doc = EPUB::ContentDocument::XHTML.new
+      @doc.item = item
+    end
+
+    def test_can_access_rendition_attributes
+      @itemref.rendition_layout = 'pre-paginated'
+      assert_true @doc.pre_paginated?
+
+      @doc.rendition_spread = 'none'
+      assert_equal 'none', @itemref.rendition_spread
+    end
+  end
+end