gepub 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 877e717beb44a21df9afc0a5427d5576a162e27dfad1cb562cb5b36bd2adcdc9
-  data.tar.gz: 2ea4a07ae25bf2a85af439a1b49b429ce70961e958a8deba1882f2f46075ec55
+  metadata.gz: 88666fd75b90a68e50f920648d1a459b2beb59bc47aa9a1ca3ef9fb39dc7b746
+  data.tar.gz: c455873460659bc89b70f725129bf462ae5478beb68fb8be99de2ba04c49e4dc
 SHA512:
-  metadata.gz: 7e58686f88c0d9e80dd4db6c3749a571ba53b2b4d92579fde57af40802438d64e344629d59d2d6667da83eca35bf2202616ac4097e2c5caca7bc833ad188874e
-  data.tar.gz: 59065a6eea1f705bda13722f677928730e7b23565dbd778a1c9174e3f0919880f9a504c90f0ba86c3d75bdeb914207473f13f6ad64596420d382090d5517f4c1
+  metadata.gz: d121c4ea9dbabaa8e61ddebf98c79a63d6358e25c49c46d3692a36a1f97c2e0adeba226ae1e7455dddc1aaa9ef2c674336991d38d8a04d3cca3fa931a0892973
+  data.tar.gz: 8a4ffe1aa6c98483f9cd64637145802911326a7ef5d766d9526cbbcfb7a62835eefc2d52fa6ac51421f39b8d4f12a7fdf0f2b221bcc2678c5dac058072aec1cd

data/.travis.yml

@@ -1,5 +1,5 @@
 language: ruby
 rvm:
-  - 2.4.5  
-  - 2.5.3
+  - 2.5.3  
+  - 2.6.0
 script: bundle exec rake spec

data/README.md

@@ -22,7 +22,7 @@ If you are using GEPUB::Builder and do not like its behaviour(e.g. the block ins
 
 ## SYNOPSIS:
 
-### Builder Example
+### Example
 
 ```ruby
 require 'rubygems'

data/gepub.gemspec

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

data/lib/gepub/book.rb

@@ -9,7 +9,6 @@ require 'fileutils'
 # namespace for gepub library.
 # The core class is GEPUB::Book. It holds metadata and contents of EPUB file. metadata and contents can be accessed
 # through GEPUB::Meta and GEPUB::Item.
-# For generating EPUB file,  use GEPUB::Builder.
 # GEPUB::Item holds information and data  of resources like xhtml text, css, scripts, images, videos, etc.
 # GEPUB::Meta holds metadata(title, creator, publisher, etc.) with its information (alternate script, display sequence, etc.)
 
@@ -18,10 +17,6 @@ module GEPUB
   # 
   # It can generate and parse EPUB2/EPUB3 files.
   #
-  # If you want to generate a new EPUB file, consider using GEPUB::Builder instead
-  # of using Book directly.
-  # Builder is a wrapper class of Book specialized for generating EPUB.
-  # 
   # Book delegates many methods to objects in other class, so you can't find
   # them in Book#methods or in ri/rdoc documentation. Their descriptions are below.
   #
@@ -93,7 +88,7 @@ module GEPUB
     def self.rootfile_from_container(rootfile)
       doc = Nokogiri::XML::Document.parse(rootfile)
       ns = doc.root.namespaces
-      defaultns = ns.select{ |name, value| value == CONTAINER_NS }.to_a[0][0]
+      defaultns = ns.select{ |_name, value| value == CONTAINER_NS }.to_a[0][0]
       doc.css("#{defaultns}|rootfiles > #{defaultns}|rootfile")[0]['full-path']
     end
 
@@ -200,13 +195,13 @@ module GEPUB
       entries['META-INF/container.xml'] = container_xml
       entries[@package.path] = opf_xml
       @package.manifest.item_list.each {
-        |k, item|
+        |_k, item|
         if item.content != nil
           entries[@package.contents_prefix + item.href] = item.content
         end
       }
 
-      entries.sort_by { |k,v| k }.each {
+      entries.sort_by { |k,_v| k }.each {
         |k,v|
         epub.put_next_entry(k)
         epub << v.force_encoding('us-ascii')
@@ -411,7 +406,7 @@ EOF
     def  cleanup_for_epub2
       if version.to_f < 3.0 || @package.epub_backward_compat
         if @package.manifest.item_list.select {
-          |x,item|
+          |_x,item|
           item.media_type == 'application/x-dtbncx+xml'
         }.size == 0
           if (@toc.size == 0)
@@ -426,14 +421,14 @@ EOF
         @package.metadata.modified_now
         
         if @package.manifest.item_list.select {
-          |href, item|
+          |_href, item|
           (item.properties||[]).member? 'nav'
           }.size == 0
           generate_nav_doc
         end
         
         @package.spine.remove_with_idlist @package.manifest.item_list.map {
-          |href, item|
+          |_href, item|
           item.fallback
         }.reject(&:nil?)
       end

data/lib/gepub/builder.rb

@@ -3,6 +3,8 @@ module GEPUB
   #
   # Builder is a wrapper class of Book. It provides DSL to create new EPUB file.
   #
+  # * Builder is obsolete on v0.7 and after. We will continue to support GEPUB::Builder works fine on version 1.x, but Builder will not be updated any more. For example, landmarks are not supported with Builder.
+  #
   # = Synopsys
   #      # -*- coding: utf-8 -*-
   #      # GEPUB::Builder example.
@@ -179,7 +181,7 @@ module GEPUB
       end
     end
 
-    def initialize(attributes = {},  &block)
+    def initialize(_attributes = {},  &block)
       @last_defined_item = nil
       @book = Book.new
       instance_eval(&block)

data/lib/gepub/datemeta.rb

@@ -17,7 +17,7 @@ module GEPUB
       @content = date
     end
 
-    def to_s(locale = nil)
+    def to_s(_locale = nil)
       # date type don't have alternate scripts.
       @content.utc.iso8601
     end

data/lib/gepub/item.rb

@@ -9,7 +9,7 @@ module GEPUB
     attr_accessor :content
     def self.create(parent, attributes = {})
       Item.new(attributes['id'], attributes['href'], attributes['media-type'], parent,
-               attributes.reject { |k,v| ['id','href','media-type'].member?(k) })
+               attributes.reject { |k,_v| ['id','href','media-type'].member?(k) })
     end
 
     #
@@ -152,7 +152,7 @@ module GEPUB
     def to_xml(builder, opf_version = '3.0')
       attr = @attributes.dup
       if opf_version.to_f < 3.0
-        attr.reject!{ |k,v| k == 'properties' }
+        attr.reject!{ |k,_v| k == 'properties' }
       end
       if !attr['properties'].nil?
         attr['properties'] = attr['properties'].uniq.join(' ')

data/lib/gepub/manifest.rb

@@ -62,7 +62,7 @@ module GEPUB
     def to_xml(builder)
       builder.manifest(@attributes) {
         @items.each {
-          |itemid, item|
+          |_itemid, item|
           item.to_xml(builder, @opf_version)
         }
       }

data/lib/gepub/meta.rb

@@ -116,7 +116,7 @@ module GEPUB
 
       # using __send__ to parametarize Namespace and content.
       target = ns.nil? || @name == 'meta' ? builder : builder[ns]
-      attr = @attributes.reject{|k,v| v.nil?}.merge(additional_attr)
+      attr = @attributes.reject{|_k,v| v.nil?}.merge(additional_attr)
       if @content.nil?
         target.__send__(@name, attr)
       else
@@ -126,7 +126,7 @@ module GEPUB
       if @refiners.size > 0 && opf_version.to_f >= 3.0
         additional_attr['refines'] = "##{@attributes['id']}"
         @refiners.each {
-          |k, ref_list|
+          |_k, ref_list|
           ref_list.each {
             |ref|
             ref.to_xml(builder, id_pool, nil, additional_attr)

data/lib/gepub/metadata.rb

@@ -79,7 +79,7 @@ module GEPUB
     def to_xml(builder) 
       builder.metadata(@namespaces) {
         @content_nodes.each {
-          |name, list|
+          |_name, list|
           list.each {
             |meta|
             meta.to_xml(builder, @id_pool, ns_prefix(DC_NS), nil, @opf_version)

data/lib/gepub/mime.rb

@@ -42,7 +42,7 @@ module GEPUB
      #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]
+      @@mime_types_compiled.select { |pattern, _mime| ext =~ pattern }.values[0]
     end
     
   end

data/lib/gepub/package.rb

@@ -249,7 +249,7 @@ module GEPUB
           }.length == 0
           
           @manifest.item_list.each {
-            |k, item|
+            |_k, item|
             if item.properties && item.properties.member?('cover-image')
               @metadata.add_oldstyle_meta(nil, 'name' => 'cover', 'content' => item.id)
             end

data/lib/gepub/resource_builder.rb

@@ -45,12 +45,12 @@ module GEPUB
       raise "can't specify multiple files on file keyword" if Hash === val && val.length > 1
 
       @file_preprocess.each {
-        |k,p|
+        |_k,p|
         p.call
       }
       @last_defined_item = ResourceItem.new(create_one_file(val))
       @file_postprocess.each {
-        |k,p|
+        |_k,p|
         p.call
       }
     end
@@ -58,7 +58,7 @@ module GEPUB
     def files(*arg)
       arg = arg[0] if arg.size == 1 && Hash === arg[0]
       @files_preprocess.each {
-        |k,p|
+        |_k,p|
         p.call
       }
       @last_defined_item = arg.map {
@@ -66,7 +66,7 @@ module GEPUB
         ResourceItem.new(create_one_file(val))
       }
       @files_postprocess.each {
-        |k,p|
+        |_k,p|
         p.call
       }
     end

data/lib/gepub/sorted_array.rb

@@ -5,7 +5,7 @@ class SortedArray < Array
     self.sort!() &sort_by
   end
 
-  def insert(i, v)
+  def insert(_i, v)
     insert_before = index(find { |x| @sort_by.call(x, v) == 1 })
     super(insert_before ? insert_before : -1, v)
   end

data/lib/gepub/spine.rb

@@ -6,7 +6,7 @@ module GEPUB
     attr_accessor :opf_version
     class Itemref
       def self.create(parent, attributes = {})
-        Itemref.new(attributes['idref'], parent, attributes.reject{|k,v| k == 'idref'})
+        Itemref.new(attributes['idref'], parent, attributes.reject{|k,_v| k == 'idref'})
       end
       
       def initialize(idref, parent = nil, attributes = {})
@@ -70,7 +70,7 @@ module GEPUB
       def to_xml(builder, opf_version)
         attr = @attributes.dup
         if opf_version.to_f < 3.0
-          attr.reject!{ |k,v| k == 'properties' }
+          attr.reject!{ |k,_v| k == 'properties' }
         end
         if !attr['properties'].nil?
           attr['properties'] = attr['properties'].join(' ')

data/lib/gepub/version.rb

@@ -1,4 +1,4 @@
 module GEPUB
-  # GEPUB gem version 
-	VERSION = "1.0.0"
+  # GEPUB gem version
+  VERSION = "1.0.1"
 end

data/spec/package_spec.rb

@@ -43,7 +43,7 @@ describe GEPUB::Package do
         package['xml:lang'] = 'ja'
 
         # metadata add: style 1
-        package.metadata.add_title('EPUB3 Sample', nil, GEPUB::TITLE_TYPE::MAIN) {
+        package.metadata.add_title('EPUB3 Sample', title_type: GEPUB::TITLE_TYPE::MAIN) {
           |title|
           title.display_seq = 1
           title.file_as = 'Sample EPUB3'
@@ -53,7 +53,7 @@ describe GEPUB::Package do
                                'th' => 'EPUB3 ตัวอย่าง (ญี่ปุ่น)')
         }
         # metadata add: style2
-        package.metadata.add_title('これでEPUB3もばっちり', nil, GEPUB::TITLE_TYPE::SUBTITLE).display_seq(2).add_alternates('en' => 'you need nothing but this book!')
+        package.metadata.add_title('これでEPUB3もばっちり', title_type: GEPUB::TITLE_TYPE::SUBTITLE).display_seq(2).add_alternates('en' => 'you need nothing but this book!')
         package.metadata.add_creator('小嶋智').display_seq(1).add_alternates('en' => 'KOJIMA Satoshi')
         package.metadata.add_contributor('電書部').display_seq(1).add_alternates('en' => 'Denshobu')
         package.metadata.add_contributor('アサガヤデンショ').display_seq(2).add_alternates('en' => 'Asagaya Densho')
@@ -117,7 +117,7 @@ describe GEPUB::Package do
         package['xml:lang'] = 'ja'
 
         # metadata add: style 1
-        package.metadata.add_title('EPUB3 Sample', nil, GEPUB::TITLE_TYPE::MAIN) {
+        package.metadata.add_title('EPUB3 Sample', title_type: GEPUB::TITLE_TYPE::MAIN) {
           |title|
           title.display_seq = 1
           title.file_as = 'Sample EPUB3'
@@ -127,7 +127,7 @@ describe GEPUB::Package do
                                'th' => 'EPUB3 ตัวอย่าง (ญี่ปุ่น)')
         }
         # metadata add: style2
-        package.metadata.add_title('これでEPUB3もばっちり', nil, GEPUB::TITLE_TYPE::SUBTITLE).display_seq(2).add_alternates('en' => 'you need nothing but this book!')
+        package.metadata.add_title('これでEPUB3もばっちり', title_type: GEPUB::TITLE_TYPE::SUBTITLE).display_seq(2).add_alternates('en' => 'you need nothing but this book!')
         package.metadata.add_creator('小嶋智').display_seq(1).add_alternates('en' => 'KOJIMA Satoshi')
         package.metadata.add_contributor('電書部').display_seq(1).add_alternates('en' => 'Denshobu')
         package.metadata.add_contributor('アサガヤデンショ').display_seq(2).add_alternates('en' => 'Asagaya Densho')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - KOJIMA Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-07 00:00:00.000000000 Z
+date: 2019-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -19,7 +19,7 @@ dependencies:
         version: 1.8.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: 1.8.2
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.11'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -185,8 +185,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: gepub
-rubygems_version: 2.7.6
+rubygems_version: 3.0.1
 signing_key: 
 specification_version: 4
 summary: a generic EPUB library for Ruby.