epub-parser 0.1.4 → 0.1.5

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

@@ -2,6 +2,10 @@ module EPUB
   module Publication
     class Package
       class Metadata
+        include Inspector::PublicationModel
+        include MethodDecorators
+        extend MethodDecorators
+
         DC_ELEMS = [:identifiers, :titles, :languages] +
                    [:contributors, :coverages, :creators, :dates, :descriptions, :formats, :publishers,
                     :relations, :rights, :sources, :subjects, :types]
@@ -51,8 +55,8 @@ module EPUB
           end
         end
 
+        +Deprecated.new {|klass, method| "#{klass}##{method} is deprecated. Use #to_h instead."}
         def to_hash
-          warn "#{self.class}##{__method__} is obsolete"
           to_h
         end
 
@@ -83,15 +87,8 @@ module EPUB
 
           attr_accessor :content, :id, :lang, :dir
 
-          def inspect
-            ivs = instance_variables.map {|iv|
-              [iv, instance_variable_get(iv).inspect].join('=')
-            }.join(' ')
-            '<#%s:%#0x %s>' % [self.class, __id__, ivs]
-          end
-
           def to_s
-            content
+            content.to_s
           end
         end
 
@@ -133,7 +130,7 @@ module EPUB
           end
 
           def to_s
-            content
+            content.to_s
           end
         end
 

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

@@ -2,13 +2,17 @@ module EPUB
   module Publication
     class Package
       class Spine
+        include Inspector::PublicationModel
         attr_accessor :package,
                       :id, :toc, :page_progression_direction
         attr_reader :itemrefs
 
+        def initialize
+          @itemrefs = []
+        end
+
         # @return self
         def <<(itemref)
-          @itemrefs ||= []
           itemref.spine = self
           @itemrefs << itemref
           self
@@ -39,12 +43,16 @@ module EPUB
 
           attr_accessor :spine,
                         :idref, :linear, :id, :properties
-          alias linear? linear
 
           def initialize
             @properties = []
           end
 
+          # @return [true|false]
+          def linear?
+            !! linear
+          end
+
           # @return [Package::Manifest::Item] item referred by this object
           def item
             @item ||= @spine.package.manifest[idref]
@@ -56,9 +64,11 @@ module EPUB
           end
 
           def ==(other)
-            [:spine, :idref, :linear, :id].all? {|meth|
+            [:spine, :idref, :id].all? {|meth|
               self.__send__(meth) == other.__send__(meth)
-            } and (other.properties - properties).empty?
+            } and
+              (linear? == other.linear?) and
+              (other.properties - properties).empty?
           end
 
           # @return ["left", "right", nil]

data/lib/method_decorators/deprecated.rb

@@ -0,0 +1,84 @@
+require 'method_decorators'
+
+module MethodDecorators
+  # Example:
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     +MethodDecorators::Deprecated
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # When deprecated_method is called, message
+  #   "MyClass#deprecated_method is deprecated"
+  # is output.
+  #
+  # Another example:
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     +MethodDecorators::Deprecated.new('deprecated_method will be removed in the future')
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # Above output given message
+  #   "deprecated_method will be removed in the future"
+  #
+  # Custom message example:
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     +MethodDecorators::Deprecated.new {|class_name, method_name| "#{class_name}##{method_name} will be removed in the future. Use #{class_name}#brand_new_method instead"}
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # Outputs
+  #   "MyClass#deprecated_method will be removed in the future. Use MyClass#brand_new_method instead"
+  # As you see, you can use class name as the first argument and method name as the second in the block.
+  #
+  # Formatter example:
+  #   class Formatter2
+  #     def call(class_name, method_name)
+  #       "#{class_name}##{method_name} will be removed after the next version. Use #{class_name}#brand_new_method instead"
+  #     end
+  #   end
+  #   class MyClass
+  #     extend MethodDecorators
+  #
+  #     formatter1 = ->(class_mane, method_name) {"#{class_name}##{method_name} will be removed in the next version. Use #{class_name}#brand_new_method instead"}
+  #     +MethodDecorators::Deprecated.new(formatter1)
+  #     def very_old_method
+  #       brand_new_method
+  #     end
+  #
+  #     + MethodDecorators::Deprecated.new(Formatter2.new)
+  #     def deprecated_method
+  #       brand_new_method
+  #     end
+  #   end
+  # Outputs
+  #   "MyClass#deprecated_method will be removed in the future. Use MyClass#brand_new_method instead"
+  # You can give any object which responds to method "call" like Proc.
+  class Deprecated < Decorator
+    DEFAULT_FORMATTER = lambda {|class_name, method_name| "#{class_name}##{method_name} is deprecated"}
+    def initialize(message=nil, &blk)
+      @message = message || blk || DEFAULT_FORMATTER
+    end
+
+    def call(orig, this, *args, &blk)
+      warn message(this.class, orig.name)
+      orig.call(*args, &blk)
+    end
+
+    def message(class_name, method_name)
+      if @message.respond_to? :call
+        @message.call(class_name, method_name)
+      else
+        @message.to_s
+      end
+    end
+  end
+end

data/test/fixtures/book/OPS/nav.xhtml

@@ -17,6 +17,8 @@
             <ol>
               <li><a href="item-2.xhtml#section1">第一節</a></li>
               <li><a href="item-2.xhtml#section2">第二節</a></li>
+              <li><a href="item-2.xhtml#section3"><img src="image/nav-2-3.png" alt="第三節"/></a></li>
+              <li><a href="item-2.xhtml#section4"><iframe src="external/document.html" name="第四節"></iframe></a></li>
             </ol>
           </li>
         </ol>

data/test/helper.rb

@@ -1,7 +1,9 @@
 require 'simplecov'
 SimpleCov.start do
-  add_filter '/test|deps/'
+  add_filter '/test|deps|method_decorators/'
 end
 
-require 'test/unit/full'
+require 'test/unit'
+require 'test/unit/rr'
+require 'test/unit/notify'
 require 'epub/parser'

data/test/test_content_document.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require_relative 'helper'
 
 class TestContentDocument < Test::Unit::TestCase
@@ -29,4 +30,24 @@ class TestContentDocument < Test::Unit::TestCase
     doc.item = item2
     assert_false doc.top_level?
   end
+
+  def test_read_returns_content_document_as_string
+    item = stub
+    stub(item).read {'content'}
+    content_doc = XHTML.new
+    content_doc.item = item
+    assert_equal 'content', content_doc.read
+  end
+
+  def test_title_returns_value_of_title_element
+    content_doc = XHTML.new
+    stub(content_doc).read {File.read(File.join(File.dirname(__FILE__), 'fixtures', 'book', 'OPS', '日本語.xhtml'))}
+    assert_equal '日本語', content_doc.title
+  end
+
+  def test_title_returns_empty_string_when_title_element_not_exist
+    content_doc = XHTML.new
+    stub(content_doc).read {'content'}
+    assert_equal '', content_doc.title
+  end
 end

data/test/test_epub.rb

@@ -12,5 +12,17 @@ class TestEUPB < Test::Unit::TestCase
       book.parse @file
     end
   end
+
+  def test_each_page_on_spine_returns_enumerator_when_block_not_given
+    book = EPUB::Parser.parse(@file)
+    assert_kind_of Enumerator, book.each_page_on_spine
+  end
+
+  def test_enumerator_each_page_on_spine_returns_yields_item
+    enum = EPUB::Parser.parse(@file).each_page_on_spine
+    enum.each do |entry|
+      assert_kind_of EPUB::Publication::Package::Manifest::Item, entry
+    end
+  end
 end
 

data/test/test_fixed_layout.rb

@@ -1,7 +1,6 @@
 require_relative 'helper'
 require 'epub/book'
 require 'epub/publication'
-require 'epub/publication/fixed_layout'
 
 class EPUB::Publication::Package
   include EPUB::Publication::FixedLayout

data/test/test_inspect.rb

@@ -0,0 +1,121 @@
+require_relative 'helper'
+require 'epub'
+
+class TestInspect < Test::Unit::TestCase
+  class TestPackage < TestInspect
+    include EPUB::Publication
+
+    def setup
+      @package = Package.new
+    end
+
+    def test_package_inspects_object_id
+      assert_match (@package.__id__ << 1).to_s(16), @package.inspect
+    end
+
+    def test_package_inspects_attributes
+      @package.xml_lang = "zh"
+      @package.prefix = {'foaf' => 'http://xmlns.com/foaf/spec/'}
+
+      assert_match %Q|@xml_lang="zh"|, @package.inspect
+      assert_match %Q|@prefix={"foaf"=>"http://xmlns.com/foaf/spec/"}|, @package.inspect
+    end
+
+    def test_package_inspects_content_models
+      @package.metadata = Package::Metadata.new
+
+      assert_match '@metadata=#<EPUB::Publication::Package::Metadata:', @package.inspect
+    end
+
+    class TestMetadata < TestPackage
+      Metadata = Package::Metadata
+
+      def setup
+        super
+        @metadata = Metadata.new
+        @package.metadata = @metadata
+      end
+
+      def test_inspects_package_simply
+        assert_match /@package=\#<EPUB::Publication::Package:[^ ]+>/, @metadata.inspect
+      end
+
+      def test_inspects_attributes
+        title = Metadata::Title.new
+        title.content = 'Book Title'
+        @metadata.titles << title
+
+        title_pattern = RUBY_VERSION >= '2.0' ? '@dc_titles=[#<EPUB::Publication::Package::Metadata::Title' : 'Book Title'
+
+        assert_match title_pattern, @metadata.inspect
+      end
+
+      def test_dcmes_inspect_includes_class_name
+        meta = Package::Metadata::Title.new
+        meta.content = 'Book Title'
+
+        title_pattern = RUBY_VERSION >= '2.0' ? '#<EPUB::Publication::Package::Metadata::Title' : 'Book Title'
+
+        assert_match title_pattern, meta.inspect
+      end
+
+      def test_dcmes_inspect_includes_instance_variables
+        meta = Package::Metadata::DCMES.new
+        meta.lang = 'en-US'
+        meta.dir = 'rtl'
+
+        if RUBY_VERSION >= '2.0'
+          assert_match /@lang/, meta.inspect
+          assert_match /en\-US/, meta.inspect
+          assert_match /@dir/, meta.inspect
+          assert_match /rtl/, meta.inspect
+        else
+          assert_equal '', meta.inspect
+        end
+      end
+
+      def test_meta_inspect_includes_class_name
+        meta = Package::Metadata::Meta.new
+
+        assert_match /Package::Metadata::Meta/, meta.inspect
+      end
+
+      def test_meta_inspect_includes_instance_variables
+        meta = Package::Metadata::Meta.new
+        meta.id = 'meta-id'
+        meta.content = 'meta content'
+
+        assert_match /@id/, meta.inspect
+        assert_match /meta\-id/, meta.inspect
+        assert_match /@content/, meta.inspect
+        assert_match /meta content/, meta.inspect
+      end
+    end
+
+    class TestManifest < TestPackage
+      Manifest = Package::Manifest
+
+      def setup
+        super
+        @manifest = Manifest.new
+        @package.manifest = @manifest
+      end
+
+      def test_inspects_package_simply
+        assert_match /@package=\#<EPUB::Publication::Package:[^ ]+>/, @manifest.inspect
+      end
+
+      class TestItem < TestManifest
+        def setup
+          super
+          @item = Manifest::Item.new
+          @manifest << @item
+        end
+
+        def test_inspects_manifest_simply
+          assert_match /\#<EPUB::Publication::Package::Manifest:[^ ]+>/, @item.inspect
+        end
+      end
+    end
+  end
+end

data/test/test_parser_content_document.rb

@@ -1,3 +1,4 @@
+# -*- coding: utf-8 -*-
 require_relative 'helper'
 
 class TestParserContentDocument < Test::Unit::TestCase
@@ -27,5 +28,7 @@ class TestParserContentDocument < Test::Unit::TestCase
     assert_equal @manifest.items.first, nav.items.first.item
     assert_equal @manifest.items[1], nav.items[1].items[0].item
     assert_equal @manifest.items[1], nav.items[1].items[1].item
+
+    assert_equal '第四節', nav.items.last.items.last.text
   end
 end

data/test/test_parser_fixed_layout.rb

@@ -11,6 +11,6 @@ class TestParserFixedLayout < Test::Unit::TestCase
     </package>
 OPF
     package = parser.parse_package
-    assert_true package.using_fixed_layout
+    assert_true package.using_fixed_layout?
   end
 end

data/test/test_parser_ocf.rb

@@ -20,7 +20,7 @@ class TestParserOCF < Test::Unit::TestCase
   def test_parse_container_can_find_primary_rootfile
     container = @parser.parse_container(@container_xml)
 
-    assert_equal 'OPS/ルートファイル.opf', container.rootfile.full_path
+    assert_equal 'OPS/ルートファイル.opf', container.rootfile.full_path.to_s
   end
 
   def test_parse_encryption_do_nothing_excluding_to_have_content

data/test/test_publication.rb

@@ -3,16 +3,18 @@ require 'epub/publication'
 
 class TestPublication < Test::Unit::TestCase
   include EPUB::Publication
+  def setup
+    @package = EPUB::Publication::Package.new
+  end
 
   def test_package_clear_package_attribute_of_submodules_when_attribute_writer_called
     metadata = EPUB::Publication::Package::Metadata.new
     another_metadata = EPUB::Publication::Package::Metadata.new
-    package = EPUB::Publication::Package.new
 
-    package.metadata = metadata
-    assert_equal metadata.package, package
+    @package.metadata = metadata
+    assert_equal metadata.package, @package
 
-    package.metadata = another_metadata
+    @package.metadata = another_metadata
     assert_nil metadata.package
   end
 
@@ -62,6 +64,76 @@ class TestPublication < Test::Unit::TestCase
 
       assert_equal 'Extended Title', package.title
     end
+
+    def test_title_returns_compositted_title_when_it_is_not_empty
+      main_title = Package::Metadata::Title.new
+      main_title.id = 'main-title'
+      main_title.content = 'main title'
+      main_refiner = Package::Metadata::Meta.new
+      main_refiner.property = 'title-type'
+      main_refiner.content = 'main'
+      main_refiner.refines = main_title
+      main_order = Package::Metadata::Meta.new
+      main_order.property = 'display-seq'
+      main_order.content = 1
+      main_order.refines = main_title
+
+      subtitle = Package::Metadata::Title.new
+      subtitle.id = 'subtitle'
+      subtitle.content = 'subtitle'
+      sub_refiner = Package::Metadata::Meta.new
+      sub_refiner.property = 'title-type'
+      sub_refiner.content = 'subtitle'
+      sub_refiner.refines = subtitle
+      sub_order = Package::Metadata::Meta.new
+      sub_order.property = 'display-seq'
+      sub_order.content = 2
+      sub_order.refines = subtitle
+
+      package = Package::Metadata.new
+      package.titles << main_title << subtitle
+
+      assert_equal "main title\nsubtitle", package.title
+    end
+
+    def test_title_returns_main_title_when_no_title_has_order
+      main_title = Package::Metadata::Title.new
+      main_title.id = 'main-title'
+      main_title.content = 'main title'
+      main_refiner = Package::Metadata::Meta.new
+      main_refiner.property = 'title-type'
+      main_refiner.content = 'main'
+      main_refiner.refines = main_title
+
+      subtitle = Package::Metadata::Title.new
+      subtitle.id = 'subtitle'
+      subtitle.content = 'subtitle'
+      sub_refiner = Package::Metadata::Meta.new
+      sub_refiner.property = 'title-type'
+      sub_refiner.content = 'subtitle'
+      sub_refiner.refines = subtitle
+
+      package = Package::Metadata.new
+      package.titles << subtitle << main_title
+
+      assert_equal "main title", package.title
+    end
+
+    def test_meta_refining_publication_is_primary_expression
+      meta = Package::Metadata::Meta.new
+      meta.property = 'dcterms:modified'
+
+      assert_true meta.primary_expression?
+    end
+
+    def test_meta_refining_other_element_is_subexpression
+      title = Package::Metadata::Title.new
+      title.id = 'title'
+      meta = Package::Metadata::Meta.new
+      meta.refines = title
+
+      assert_true meta.subexpression?
+    end
   end
 
   class TestManifest < TestPublication
@@ -93,6 +165,20 @@ class TestPublication < Test::Unit::TestCase
 
         assert_same itemref, item.itemref
       end
+
+      def test_xhtml_returns_true_when_xhtml
+        item = Package::Manifest::Item.new
+        item.media_type = 'application/xhtml+xml'
+
+        assert_true item.xhtml?
+      end
+
+      def test_xhtml_returns_false_when_not_xhtml
+        item = Package::Manifest::Item.new
+        item.media_type = 'text/css'
+
+        assert_false item.xhtml?
+      end
     end
   end
 
@@ -138,6 +224,41 @@ class TestPublication < Test::Unit::TestCase
         assert_include spine.items, item
         assert_same item, @itemref.item
       end
+
+      def test_itemref_equals_itemref_with_same_attributes
+        base = Package::Spine::Itemref.new
+        another = Package::Spine::Itemref.new
+        [base, another].each do |itemref|
+          [:spine, :idref, :id].each do |attr|
+            itemref.__send__ "#{attr}=", attr.to_s
+          end
+          itemref.linear = false
+        end
+        base.properties = ['property1', 'property2']
+        another.properties = ['property2', 'property1']
+
+        assert_true base == another
+
+        base.linear = true
+        another.linear = 'yes'
+
+        assert_true base == another
+      end
+
+      def test_itemref_doesnt_equal_itemref_with_different_attributes
+        base = Package::Spine::Itemref.new
+        another = Package::Spine::Itemref.new
+        [base, another].each do |itemref|
+          [:spine, :idref, :id].each do |attr|
+            itemref.__send__ "#{attr}=", attr.to_s
+          end
+          itemref.linear = false
+        end
+        base.properties = ['property1', 'property2']
+        another.properties = ['property1', 'property2', 'property3']
+
+        assert_false base == another
+      end
     end
   end
 end