gepub 0.6.9.2 → 0.7.0beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6790c94431137225f634825b8bb31fa4c17bf9fa
-  data.tar.gz: 6b8b2480b8892406e07f33a36563dc7448b20330
+  metadata.gz: da95a78f54f7a71d249dd06e76e9b18adacc7239
+  data.tar.gz: 7f50cc69320fbdb6664821690836dbdd3b2fddf5
 SHA512:
-  metadata.gz: 3f61337779cffc792a6d186fad5df3998437ec4a5f2785db9cce502af72c58d323037b63ccc0e102b9e9fe70514080056f35afe21a797646fd3d2c9a43c0d1b4
-  data.tar.gz: cffa739c71bbb81dddd083b03d5c2dedb4d203bd35d3f511cbdf96c1b288b70e30ab488462f38b9096a17b268d22ddb6af2f19c780cc04fa967f6899f78f960b
+  metadata.gz: 2de76d9b67b24bcd553a58a09efdbf9a1692831ccf44925ce06e863d0f1e1b826b5aeae5fb71545861a1bd2d6f5eab79af6a25358aee8bdac83a71de4e8bc3b7
+  data.tar.gz: 87688508687b17fadf099f34b8d6a83ce4d3f8c22d7bcc47052e40a1de12399e91c1ecd011091f010a922b89a6910438b73360625e3257b05481028ea8e0e574

data/.gitignore

@@ -26,3 +26,6 @@ example_test*.epub
 Gemfile.lock
 vendor/**
 .bundle/**
+
+# rdoc
+rdoc/**

data/.travis.yml

@@ -3,4 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-script: bundle exec rspec spec
+script: bundle exec rake spec

data/README.md

@@ -1,7 +1,10 @@
 # gepub  
-[<img src="https://secure.travis-ci.org/skoji/gepub.png" />](http://travis-ci.org/skoji/gepub) [![Coverage Status](https://coveralls.io/repos/skoji/gepub/badge.png?branch=master)](https://coveralls.io/r/skoji/gepub?branch=master)
+[<img src="https://secure.travis-ci.org/skoji/gepub.png" />](http://travis-ci.org/skoji/gepub) 
+[![Coverage Status](https://coveralls.io/repos/skoji/gepub/badge.png?branch=master)](https://coveralls.io/r/skoji/gepub?branch=master)
+[![Dependency Status](https://gemnasium.com/skoji/gepub.png)](https://gemnasium.com/skoji/gepub)
+[![Gem Version](https://badge.fury.io/rb/gepub.png)](http://badge.fury.io/rb/gepub)
 
-* http://en.skoji.jp/category/gepub/
+* http://rdoc.info/github/skoji/gepub/master/frames
 
 ## DESCRIPTION:
 
@@ -15,6 +18,7 @@ a generic EPUB parser/generator library.
 
 * See [issues](https://github.com/skoji/gepub/issues/) for known problems.
 
+**GEPUB::Builder will be obsolete in gepub 0.7. GEPUB::Book#new will be enhanced instead of Builder DSL. **
 
 ## SYNOPSIS:
 

data/Rakefile

@@ -1 +1,13 @@
 require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require 'rdoc/task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+end

data/examples/new_book_example.rb

@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+require 'gepub'
+
+GEPUB::Book.new do |book|
+  book.set_unique_identifier 'http:/example.jp/bookid_in_url', 'BookID', 'URL'
+  book.set_title 'GEPUB Sample Book'
+  book.set_subtitle 'GEPUB Sample Book'
+  book.set_creator 'KOJIMA Satoshi'
+  book.set_contributors '電書部', 'アサガヤデンショ', '電子雑誌トルタル'
+
+  book.ordered {
+    book.add_item('name') do
+      |item|
+      item.content = StringIO.new()
+    end
+  }
+end
+
+
+

data/gepub.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_development_dependency "rspec", "~> 2.14"
   s.add_runtime_dependency "nokogiri", "~> 1.6.1"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
   s.add_runtime_dependency "rubyzip", ">= 1.1.1"
 end

data/lib/gepub/book.rb

@@ -72,8 +72,10 @@ module GEPUB
   # === Book#contributors_list (delegated to Metadata)
   # returns contributors list by display-seq or defined order.
   # the contributors without display-seq is appear after contributors with display-seq.
-  # === Book#set_lastmodified(date=nil) (delegated to Metadata#set_lastmodified)
-  # set last modified date.if date is nil, it sets current time.
+  # === Book#lastmodified(date) (delegated to Metadata#lastmodified)
+  # set last modified date.
+  # === Book#modified_now (delegated to Metadata#modified_now)
+  # set last modified date to current time.
   # === Book#lastmodified (delegated to Metadata#lastmodified)
   # returns Meta object contains last modified time.
   # === setting and reading other metadata: publisher, language, coverage, date, description, format, relation, rights, source, subject, type (delegated to Metadata)
@@ -116,14 +118,15 @@ module GEPUB
 
     # creates new empty Book object.
     # usually you do not need to specify any arguments.
-
-    def initialize(path='OEBPS/package.opf', attributes = {})
+    def initialize(path='OEBPS/package.opf', attributes = {}, &block)
       if File.extname(path) != '.opf'
         warn 'GEPUB::Book#new interface changed. You must supply path to package.opf as first argument. If you want to set title, please use GEPUB::Book#title='
       end
       @package = Package.new(path, attributes)
       @toc = []
-      yield book if block_given?
+      if block
+        block.arity < 1 ? instance_eval(&block) : block[self]        
+      end
     end
 
 
@@ -142,15 +145,7 @@ module GEPUB
       (@optional_files ||= {})[path] = io.read
     end
     
-    # add navigation text (which will appear on navigation document or table of contents) to an item.
-    # DEPRECATED: please use Item#toc_text or Item#toc_text_with_id, or Builder#heading
-
-    def add_nav(item, text, id = nil)
-      warn 'add_nav is deprecated: please use Item#toc_text'
-      @toc.push({ :item => item, :text => text, :id => id})      
-    end
-
-    def set_sigleton_methods_to_item(item)
+    def set_singleton_methods_to_item(item)
       toc = @toc
       metaclass = (class << item;self;end)
       metaclass.send(:define_method, :toc_text,
@@ -176,7 +171,7 @@ module GEPUB
     # the added item will be referenced by the first argument in the EPUB container.
     def add_item(href, io_or_filename = nil, id = nil, attributes = {})
       item = @package.add_item(href,nil,id,attributes)
-      set_sigleton_methods_to_item(item)
+      set_singleton_methods_to_item(item)
       item.add_content io_or_filename unless io_or_filename.nil?
       item
     end
@@ -184,7 +179,7 @@ module GEPUB
     # same as add_item, but the item will be added to spine of the EPUB.
     def add_ordered_item(href, io_or_filename = nil, id = nil, attributes = {})
       item = @package.add_ordered_item(href,io_or_filename,id,attributes)
-      set_sigleton_methods_to_item(item)
+      set_singleton_methods_to_item(item)
       yield item if block_given?
       item
     end
@@ -235,7 +230,7 @@ module GEPUB
       entries.sort_by { |k,v| k }.each {
         |k,v|
         epub.put_next_entry(k)
-        epub << v.force_to_bin
+        epub << v.force_encoding('us-ascii')
       }
     end
 
@@ -391,7 +386,7 @@ EOF
     end
     def cleanup_for_epub3
       if version.to_f >=3.0
-        @package.metadata.set_lastmodified
+        @package.metadata.modified_now
         
         if @package.manifest.item_list.select {
           |href, item|

data/lib/gepub/builder.rb

@@ -163,15 +163,15 @@ module GEPUB
       end
 
       def file_as(name)
-        @item.set_file_as(name)
+        @item.file_as(name)
       end
 
       def seq(num)
-        @item.set_display_seq(num)
+        @item.display_seq(num)
       end
 
       def group_position(num)
-        @item.set_group_position(num)
+        @item.group_position(num)
       end
 
       def id(val)
@@ -182,7 +182,7 @@ module GEPUB
     def initialize(attributes = {},  &block)
       @last_defined_item = nil
       @book = Book.new
-      instance_eval &block
+      instance_eval(&block)
       # TODO check @book's consistency
       true
     end
@@ -210,7 +210,7 @@ module GEPUB
 
     def collection(val, count = 1)
       @last_defined_item =
-        MetaItem.new(@book.add_title(val, nil, GEPUB::TITLE_TYPE::COLLECTION).set_group_position(count.to_s))
+        MetaItem.new(@book.add_title(val, nil, GEPUB::TITLE_TYPE::COLLECTION).group_position(count.to_s))
     end
 
     def creator(val, role = 'aut')
@@ -245,7 +245,7 @@ module GEPUB
     end
 
     def unique_identifier(val, id = 'BookID', scheme = 'nil')
-      @last_defined_item = MetaItem.new(@book.set_primary_identifier(val, id, scheme))
+      @last_defined_item = MetaItem.new(@book.primary_identifier(val, id, scheme))
     end
     
     def alts(alt_vals = {})
@@ -269,6 +269,11 @@ module GEPUB
     def ibooks_version(val)
       @book.ibooks_version=val
     end
+    # specify scroll axis for ibooks
+    def ibooks_scroll_axis(val)
+      @book.ibooks_scroll_axis = val
+    end
+    
     # set optional file.
     # val should be String or Hash.
     # if val is String, file is read from the File specified by string and stored in EPUB to the path specified by string.

data/lib/gepub/datemeta.rb

@@ -11,10 +11,10 @@ module GEPUB
     end
 
     def content=(date)
-      if content.is_a? String
-        content = Time.parse(content)
+      if date.is_a? String
+        date = Time.parse(date)
       end
-      @content = content
+      @content = date
     end
 
     def to_s(locale = nil)

data/lib/gepub/dsl_util.rb

@@ -0,0 +1,11 @@
+module GEPUB
+  module DSLUtil
+    UNASSIGNED = Object.new
+
+    private
+    def unassigned?(value)
+      return value === UNASSIGNED
+    end
+  end
+end
+

data/lib/gepub/item.rb

@@ -23,7 +23,7 @@ module GEPUB
         attributes['properties'] = attributes['properties'].split(' ')
       end
       @attributes = {'id' => itemid, 'href' => itemhref, 'media-type' => itemmediatype}.merge(attributes)
-      @attributes['media-type'] =  guess_mediatype if media_type.nil?
+      @attributes['media-type'] = GEPUB::Mime.guess_mediatype(itemhref) if media_type.nil?
       @parent = parent
       @parent.register_item(self) unless @parent.nil?
       self
@@ -125,7 +125,7 @@ module GEPUB
     # generate xml to supplied Nokogiri builder.
     def to_xml(builder, opf_version = '3.0')
       attr = @attributes.dup
-       if opf_version.to_f < 3.0
+      if opf_version.to_f < 3.0
         attr.reject!{ |k,v| k == 'properties' }
       end
       if !attr['properties'].nil?
@@ -136,32 +136,5 @@ module GEPUB
       end
       builder.item(attr)
     end
-
-    def guess_mediatype
-      case File.extname(href)
-      when /.(html|xhtml)/i
-        'application/xhtml+xml'
-      when /.css/i
-        'text/css'
-      when /.js/i
-        'text/javascript'
-      when /.(jpg|jpeg)/i
-        'image/jpeg'
-      when /.png/i
-        'image/png'
-      when /.gif/i
-        'image/gif'
-      when /.svg/i
-        'image/svg+xml'
-      when /.opf/i
-        'application/oebps-package+xml'
-      when /.ncx/i
-        'application/x-dtbncx+xml'
-      when /.(otf|ttf|ttc)/i
-        'application/vnd.ms-opentype'
-      when /.woff/i
-        'application/font-woff'
-      end
-    end
   end
-end  
+end

data/lib/gepub/meta.rb

@@ -4,6 +4,7 @@ require 'nokogiri'
 module GEPUB
   # Holds one metadata with refine meta elements.
   class Meta
+    include DSLUtil
     attr_accessor :content
     attr_reader :name
     def initialize(name, content, parent, attributes= {}, refiners = {})
@@ -64,17 +65,30 @@ module GEPUB
     ['title-type', 'identifier-type', 'display-seq', 'file-as', 'group-position', 'role'].each {
       |name|
       methodbase = name.sub('-','_')
-      define_method(methodbase + '=') { |val| refine(name, val); }
-      define_method('set_' + methodbase) { |val| refine(name, val); }        
-      define_method(methodbase) { refiner(name) }
+      define_method(methodbase + '=') { |val| refine(name, val) }
+      define_method('set_' + methodbase) { |val|
+        warn "set_#{methodbase} is obsolete. use #{methodbase} instead."
+        refine(name, val)
+      }        
+      define_method(methodbase, ->(value = UNASSIGNED) {
+                      if unassigned?(value)
+                        refiner(name)
+                      else
+                        refine(name,value)
+                      end
+                    })
     }
 
     def lang=(lang)
       @attributes['xml:lang'] = lang
     end
 
-    def lang
-      @attributes['xml:lang']
+    def lang(lang = UNASSIGNED)
+      if unassigned?(lang)
+        @attributes['xml:lang']
+      else
+        self.lang=(lang)
+      end
     end
     
     # add alternate script refiner.

data/lib/gepub/metadata.rb

@@ -17,7 +17,7 @@ module GEPUB
         nil
       end
     end
-    include XMLUtil
+    include XMLUtil, DSLUtil
     attr_accessor :opf_version
     # parse metadata element. metadata_xml should be Nokogiri::XML::Node object.
     def self.parse(metadata_xml, opf_version = '3.0', id_pool = Package::IDPool.new)
@@ -48,6 +48,8 @@ module GEPUB
               @spread = metanode
             when 'ibooks:version'
               @ibooks_version = metanode
+            when 'ibooks:scroll-axis'
+              @ibooks_scroll_axis = metanode
             end
 
           }
@@ -70,6 +72,7 @@ module GEPUB
       @orientation = NilContent
       @spread = NilContent
       @ibooks_version = NilContent
+      @ibooks_scroll_axis = NilContent
       yield self if block_given?
     end
 
@@ -106,7 +109,7 @@ module GEPUB
       @oldstyle_meta = []
     end
     
-    CONTENT_NODE_LIST = ['identifier','title', 'language', 'contributor', 'creator', 'coverage', 'date','description','format','publisher','relation','rights','source','subject','type'].each {
+    CONTENT_NODE_LIST = ['identifier', 'title', 'language', 'contributor', 'creator', 'coverage', 'date','description','format','publisher','relation','rights','source','subject','type'].each {
       |node|
       define_method(node + '_list') { @content_nodes[node].dup.sort_as_meta }
       define_method(node + '_clear') {
@@ -116,9 +119,14 @@ module GEPUB
         end
       }
 
-      define_method(node) {
-        get_first_node(node)
-      }
+      define_method(node, ->(content=UNASSIGNED, id=nil) {
+                      if unassigned?(content)
+                        get_first_node(node)
+                      else
+                        send(node + "_clear")
+                        add_metadata(node, content, id)
+                      end
+                    })
 
       define_method('add_' + node) {
         |content, id|
@@ -127,13 +135,15 @@ module GEPUB
       
       define_method('set_' + node) {
         |content, id|
+        warn "obsolete : set_#{node}. use #{node} instead."
         send(node + "_clear")
         add_metadata(node, content, id)
       }
       
       define_method(node+'=') {
         |content|
-        send('set_' + node, content, nil)
+        send(node + "_clear")
+        add_metadata(node, content, nil)
       }
     }
 
@@ -148,15 +158,23 @@ module GEPUB
       end
     end
 
-    def title
-      if !@content_nodes['title'].nil?
-        @content_nodes['title'].each do
-          |titlenode|
-          return titlenode if titlenode.title_type.to_s == TITLE_TYPE::MAIN
+    def title(content=UNASSIGNED, id = nil, title_type = nil)
+      if unassigned?(content)
+        if !@content_nodes['title'].nil?
+          @content_nodes['title'].each do
+            |titlenode|
+            return titlenode if titlenode.title_type.to_s == TITLE_TYPE::MAIN
+          end
         end
+        get_first_node('title')
+      else
+        title_clear
+        meta = add_title(content, id, title_type)
+        yield meta if block_given?
+        meta
       end
-      get_first_node('title')
     end
+
     
     def get_first_node(node)
       if !@content_nodes[node].nil? && @content_nodes[node].size > 0
@@ -198,6 +216,7 @@ module GEPUB
     end
 
     def set_title(content, id = nil, title_type = nil)
+      warn "obsolete : set_title. use title instead."
       title_clear
       meta = add_title(content, id, title_type)
       yield meta if block_given?
@@ -222,15 +241,31 @@ module GEPUB
       meta
     end
 
-    def lastmodified
-      ret = (@content_nodes['meta'] ||=[]).select {
-        |meta|
-        meta['property'] == 'dcterms:modified'
-      }
-      ret.size == 0 ? nil : ret[0]
+    def lastmodified(date=UNASSIGNED)
+      if unassigned?(date)
+        ret = (@content_nodes['meta'] ||=[]).select {
+          |meta|
+          meta['property'] == 'dcterms:modified'
+        }
+        ret.size == 0 ? nil : ret[0]
+      else
+        date ||= Time.now
+        (@content_nodes['meta'] ||= []).each {
+          |meta|
+          if (meta['property'] == 'dcterms:modified')
+            @content_nodes['meta'].delete meta
+          end
+        }
+        add_metadata('meta', date.utc.strftime('%Y-%m-%dT%H:%M:%SZ'), nil, DateMeta)['property'] = 'dcterms:modified'
+      end
     end
-    
+
+    def modified_now
+      lastmodified Time.now
+    end
+
     def set_lastmodified(date=nil)
+      warn "obsolete : set_lastmodified. use lastmodified instead."
       date ||= Time.now
       (@content_nodes['meta'] ||= []).each {
         |meta|
@@ -298,13 +333,25 @@ module GEPUB
       @ibooks_version = Meta.new('meta', val, self, { 'property' => 'ibooks:version' })
       (@content_nodes['meta'] ||= []) << @ibooks_version
     end
+
+    def ibooks_scroll_axis
+      @ibooks_scroll_axis.content || ''      
+    end
+
+    def ibooks_scroll_axis=(val)
+      if ![:vertical, :horizontal, :default].member? val.to_sym
+        raise 'ibooks_scroll_axis should be one of vertical, horizontal or default'
+      end
+      @ibooks_scroll_axis = Meta.new('meta', val, self, { 'property' => 'ibooks:scroll-axis' })
+      (@content_nodes['meta'] ||= []) << @ibooks_scroll_axis
+    end
     
     def rendition_specified?
       @layout.content || @orientation.content || @spread.content
     end
 
     def ibooks_vocaburaly_specified?
-      @ibooks_version.content
+      @ibooks_version.content || @ibooks_scroll_axis.content
     end
     
     private

data/lib/gepub/mime.rb

@@ -0,0 +1,49 @@
+module GEPUB
+  #
+  # Static Object to hold and operate with OEBPS data MIME types
+  #
+
+  class Mime
+
+    # compile mime_types regexp
+    def self.compile_mime_types
+      @@mime_types_compiled = Hash[@@mime_types.map { |expr, mime| [ /\A\.#{expr}\Z/i, mime ] }]
+    end
+    
+    # media types by file extension regexp seeds to mime types
+    @@mime_types =  { 
+      '(html|xhtml)' => 'application/xhtml+xml',
+      'css' => 'text/css',
+      'js' => 'text/javascript',
+      '(jpg|jpeg)' => 'image/jpeg',
+      'png' => 'image/png',
+      'gif' => 'image/gif',
+      'svg' => 'image/svg+xml',
+      'opf' => 'application/oebps-package+xml',
+      'ncx' => 'application/x-dtbncx+xml',
+      '(otf|ttf|ttc|eot)' => 'application/vnd.ms-opentype',
+      'woff' => 'application/font-woff',
+      'mp4' => 'video/mp4',
+      'mp3' => 'audio/mpeg'
+    }
+    compile_mime_types
+
+    # return mime media types => mime types hash
+    def self.mime_types
+       @@mime_types
+    end
+
+    # add new mediatype to @@mediatypes
+    def self.add_mimetype(mediatypes)
+      mediatypes.each { |expr, mime| @@mime_types[expr] ||= mime }
+      compile_mime_types
+    end
+
+     #guess mediatype by mime type mask
+    def self.guess_mediatype(href)
+      ext = File.extname(href)
+      @@mime_types_compiled.select { |pattern, mime| ext =~ pattern }.values[0]
+    end
+    
+  end
+end