gepub 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294cefe070bfd2c4a87e0fd46c45f10f08f75857045ad62ed02b83694ca9e9ae
-  data.tar.gz: 1df169f042577cd0ae74db3565e92f7f70b0b87fd9bafd7de5e3802574ab1578
+  metadata.gz: fb1c03b3da62d08f1ba3098494831c199f51dce6157ac83f757ae361274373ca
+  data.tar.gz: e7d95774470bc40930f5eac2cba5dbe7ad10c9e9c4a113cc35660cee49d7cb9a
 SHA512:
-  metadata.gz: 403d05c6d0a0d0121526d5ce92c8e95dfcb11aae052c84af6bec3303f8039b56852cc64fd4e1d171c715ad2b728a6eee2cee6043cedca2576999c7ccf1f35ae8
-  data.tar.gz: 89e1b455c6d1653fc4ec60ada97da3da50d508260ce5309ca3ec3aceabecd528b1941723ac5a4e594ec0bb34ea99d7ef64a5c4c573f22d5dc7627ea9e8d4b3f0
+  metadata.gz: 72e09291759ff4e826db2d53424bc06c60ef0b4c1b70870c64975c31b9bc09ca69974f1d3a9e01e49a93772d0036ad0ba3d4b46067444d9c731c3dddd4572112
+  data.tar.gz: 2d5eb3487b3db35d5a30db928bff337cafa569c64b4d5b98764fcea8275ebaf585417458ce2ff61f6a2f67356e629ca6763f92aa434b740ce5e983518d013046

data/.github/workflows/gempush.yml

@@ -16,18 +16,6 @@ jobs:
       with:
         ruby-version: 2.6.x
 
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.GPR_AUTH_TOKEN}}
-        OWNER: skoji
-
     - name: Publish to RubyGems
       run: |
         mkdir -p $HOME/.gem

data/.github/workflows/test.yml

@@ -4,26 +4,19 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.4, 2.5, 2.6, 2.7, jruby]
+        ruby: [2.5, 2.6, 2.7, jruby]
         platform: [ubuntu-latest, macos-latest, windows-latest]
-        exclude:
-          # TODO: https://github.com/sparklemotion/nokogiri/issues/1961
-          # exclude windows with ruby 2.7 ; nokogiri is not supported for the present
-          - ruby: 2.7
-            platform: windows-latest
     runs-on: ${{ matrix.platform }}
     env:
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     steps:
-    - uses: actions/checkout@master
+    - uses: actions/checkout@v2
     - name: Set up Ruby
-      uses: eregon/use-ruby-action@master
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
     - name: setup gems
-      run: |
-        gem install bundler
-        bundle install
+      run: bundle install --jobs 4 --retry 3
     - name: run test and publish code coverage
       if: runner.os == 'Linux' && matrix.ruby == '2.7' && env.CC_TEST_REPORTER_ID != ''
       uses: paambaati/codeclimate-action@v2.3.0

data/.rubocop.yml

@@ -0,0 +1,5 @@
+AllCops:
+  DisabledByDefault: true
+
+Style/Tab:
+  Enabled: true

data/README.md

@@ -103,7 +103,7 @@ epubname = File.join(File.dirname(__FILE__), 'example_test.epub')
 # auto-generated nav file will not appear on spine.
 book.generate_epub(epubname)
 ```
- * [examples in this repository](https://github.com/skoji/gepub/tree/master/examples/) 
+ * [examples in this repository](https://github.com/skoji/gepub/tree/main/examples/) 
 
 ## INSTALL:
 

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 # also generates 'lib/gepub/book_add_item.rb' 
 file 'lib/gepub/metadata_add.rb' => 'tools/generate_function.rb' do
-	sh %Q(ruby tools/generate_function.rb)
+  sh %Q(ruby tools/generate_function.rb)
 end
 
 desc 'auto generate code'

data/gepub.gemspec

@@ -17,7 +17,9 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_runtime_dependency "nokogiri", ">= 1.8.2", "< 1.11"
-  s.add_runtime_dependency "rubyzip", "> 1.1.1", "< 2.3"
+  s.add_runtime_dependency "rubyzip", "> 1.1.1", "< 2.4"
+  s.add_development_dependency "epubcheck-ruby"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop"
 end

data/lib/gepub/book.rb

@@ -316,6 +316,9 @@ EOF
       # build nav
       builder = Nokogiri::XML::Builder.new {
         |doc|
+        unless version.to_f < 3.0
+          doc.doc.create_internal_subset('html', nil, nil )
+        end
         doc.html('xmlns' => "http://www.w3.org/1999/xhtml",'xmlns:epub' => "http://www.idpf.org/2007/ops") {
           doc.head {
             doc.title title

data/lib/gepub/book_add_item.rb

@@ -1,3 +1,5 @@
+## this file is automatically generated by tools/generate_function.rb . do not edit this code directly.
+
 module GEPUB
   class Book
     # add an item(i.e. html, images, audios, etc)  to Book.

data/lib/gepub/item.rb

@@ -106,9 +106,10 @@ module GEPUB
         else
           prefix = "#{ns_prefix}:"
         end
+        images = parsed.xpath("//#{prefix}img[starts-with(@src,'http')]")
         videos = parsed.xpath("//#{prefix}video[starts-with(@src,'http')]") + parsed.xpath("//#{prefix}video/#{prefix}source[starts-with(@src,'http')]")
         audios = parsed.xpath("//#{prefix}audio[starts-with(@src,'http')]") + parsed.xpath("//#{prefix}audio/#{prefix}source[starts-with(@src,'http')]")
-        if videos.size > 0 || audios.size > 0
+        if images.size > 0 || videos.size > 0 || audios.size > 0
           self.add_property('remote-resources')
         end
         if parsed.xpath("//p:math", { 'p' => 'http://www.w3.org/1998/Math/MathML' }).size > 0
@@ -137,12 +138,19 @@ module GEPUB
       self
     end
 
-    # add content form io or file to the item
+    # add content from io or file to the item
     def add_content(io_or_filename)
-      io = io_or_filename
       if io_or_filename.class == String
-        io = File.new(io_or_filename)
+        File.open(io_or_filename, mode='r') do |f|
+          add_content_io f
+        end
+      else
+        add_content_io io_or_filename
       end
+      self
+    end
+
+    def add_content_io(io)
       io.binmode
       @content = io.read
       if File.extname(self.href) =~ /x?html$/

data/lib/gepub/metadata_add.rb

@@ -1,5 +1,7 @@
+## this file is automatically generated by tools/generate_function.rb . do not edit this code directly.
+
 module GEPUB
-	class Metadata
+  class Metadata
     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 }
@@ -14,7 +16,7 @@ module GEPUB
 
       define_method(node, ->(content=UNASSIGNED, deprecated_id=nil, id:nil,
                              title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
-														 lang: nil, alternates: {}) {
+                             lang: nil, alternates: {}) {
                       if unassigned?(content)
                         get_first_node(node)
                       else
@@ -48,7 +50,7 @@ module GEPUB
 
     def add_title(content, deprecated_id = nil, deprecated_title_type = nil, id: nil,
                   title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
-									lang: nil, alternates: {})
+                  lang: nil, alternates: {})
       if deprecated_id
         warn 'second argument for add_title is deprecated. use id: instead'
         id = deprecated_id
@@ -58,15 +60,15 @@ module GEPUB
         title_type = deprecated_title_type
       end
       meta = add_metadata('title', content, id: id, 
-			                    title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
-													lang: lang, alternates: alternates)
+                          title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
+                          lang: lang, alternates: alternates)
       yield meta if block_given?
       meta
     end
 
     def add_person(name, content, deprecated_id = nil, deprecated_role = nil, id: nil,
-                  title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
-									lang: nil, alternates: {})
+                   title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
+                   lang: nil, alternates: {})
       if deprecated_id
         warn 'second argument for add_person is deprecated. use id: instead'
         id = deprecated_id
@@ -76,15 +78,15 @@ module GEPUB
         role = deprecated_role
       end
       meta = add_metadata(name, content, id: id,
-			                    title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
-													lang: lang, alternates: alternates)
+                          title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
+                          lang: lang, alternates: alternates)
       yield meta if block_given?
       meta
     end
 
     def add_creator(content, deprecated_id = nil, deprecated_role = nil, id: nil, 
                     title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
-  									lang: nil, alternates: {}) 
+                    lang: nil, alternates: {}) 
       if deprecated_id
         warn 'second argument for add_creator is deprecated. use id: instead'
         id = deprecated_id
@@ -93,17 +95,17 @@ module GEPUB
         warn 'third argument for add_creator is deprecated. use role: instead'
         role = deprecated_role
       end
-			role = 'aut' if role.nil?
+      role = 'aut' if role.nil?
       meta = add_person('creator', content, id: id,
-			                    title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
-													lang: lang, alternates: alternates)
+                        title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
+                        lang: lang, alternates: alternates)
       yield meta if block_given?
       meta
     end
 
     def add_contributor(content, deprecated_id = nil, deprecated_role = nil, id: nil,
                         title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
-											  lang: nil, alternates: {}) 
+                        lang: nil, alternates: {}) 
       if deprecated_id
         warn 'second argument for add_contributor is deprecated. use id: instead'
         id = deprecated_id
@@ -113,30 +115,30 @@ module GEPUB
         role = deprecated_role
       end
       meta = add_person('contributor', content, id: id, 
-			                  title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
-												lang: lang, alternates: alternates)
+                         title_type: title_type,identifier_type: identifier_type,display_seq: display_seq,file_as: file_as,group_position: group_position,role: role,
+                         lang: lang, alternates: alternates)
       yield meta if block_given?
       meta
     end
 
-		def add_metadata(name, content, id: nil, itemclass: Meta,
-		title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
-		lang: nil, alternates: {}
-		)
-			meta = add_metadata_internal(name, content, id: id, itemclass: itemclass)
+    def add_metadata(name, content, id: nil, itemclass: Meta,
+                     title_type: nil,identifier_type: nil,display_seq: nil,file_as: nil,group_position: nil,role: nil,
+                     lang: nil, alternates: {}
+                    )
+      meta = add_metadata_internal(name, content, id: id, itemclass: itemclass)
       [{ value: title_type, name: 'title-type'},{ value: identifier_type, name: 'identifier-type'},{ value: display_seq, name: 'display-seq'},{ value: file_as, name: 'file-as'},{ value: group_position, name: 'group-position'},{ value: role, name: 'role'}].each do |refiner|
-				if refiner[:value]
-				  meta.refine(refiner[:name], refiner[:value])
-				end
-	    end	
-			if lang
-			  meta.lang = lang
-			end
-			if alternates
-			  meta.add_alternates alternates
-			end
+        if refiner[:value]
+           meta.refine(refiner[:name], refiner[:value])
+        end
+      end 
+      if lang
+        meta.lang = lang
+      end
+      if alternates
+        meta.add_alternates alternates
+      end
       yield meta if block_given?
-			meta
-		end
-	end
+          meta
+      end
+    end
 end

data/lib/gepub/version.rb

@@ -1,4 +1,4 @@
 module GEPUB
   # GEPUB gem version
-  VERSION = "1.0.11"
+  VERSION = "1.0.12"
 end

data/tools/generate_function.rb

@@ -9,6 +9,8 @@ attrs << "property"
 attrs_arguments_string = attrs.map { |attr| "#{attr}: nil" }.join(',')
 attrs_internal_string = "{ " + attrs.map { |attr| "#{attr}: #{attr}"}.join(',') + " }"
 File.write(File.join(File.dirname(__FILE__), "../lib/gepub/book_add_item.rb"), <<EOF)
+## this file is automatically generated by tools/generate_function.rb . do not edit this code directly.
+
 module GEPUB
   class Book
     # add an item(i.e. html, images, audios, etc)  to Book.
@@ -35,7 +37,7 @@ require_relative '../lib/gepub/dsl_util.rb'
 require_relative '../lib/gepub/meta.rb'
 
 refiners = GEPUB::Meta::REFINERS.map do |refiner|
-	refiner.sub('-', '_')
+  refiner.sub('-', '_')
 end
 
 refiners_arguments_string = refiners.map { |refiner| "#{refiner}: nil" }.join(',')
@@ -46,8 +48,10 @@ meta_attr_arguments_string = "lang: nil, alternates: {}"
 meta_attr_arguments_set_string = "lang: lang, alternates: alternates"
 
 File.write(File.join(File.dirname(__FILE__), "../lib/gepub/metadata_add.rb"), <<EOF)
+## this file is automatically generated by tools/generate_function.rb . do not edit this code directly.
+
 module GEPUB
-	class Metadata
+  class Metadata
     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 }
@@ -62,7 +66,7 @@ module GEPUB
 
       define_method(node, ->(content=UNASSIGNED, deprecated_id=nil, id:nil,
                              #{refiners_arguments_string},
-														 #{meta_attr_arguments_string}) {
+                             #{meta_attr_arguments_string}) {
                       if unassigned?(content)
                         get_first_node(node)
                       else
@@ -96,7 +100,7 @@ module GEPUB
 
     def add_title(content, deprecated_id = nil, deprecated_title_type = nil, id: nil,
                   #{refiners_arguments_string},
-									#{meta_attr_arguments_string})
+                  #{meta_attr_arguments_string})
       if deprecated_id
         warn 'second argument for add_title is deprecated. use id: instead'
         id = deprecated_id
@@ -106,15 +110,15 @@ module GEPUB
         title_type = deprecated_title_type
       end
       meta = add_metadata('title', content, id: id, 
-			                    #{refiners_arguments_set_string},
-													#{meta_attr_arguments_set_string})
+                          #{refiners_arguments_set_string},
+                          #{meta_attr_arguments_set_string})
       yield meta if block_given?
       meta
     end
 
     def add_person(name, content, deprecated_id = nil, deprecated_role = nil, id: nil,
-                  #{refiners_arguments_string},
-									#{meta_attr_arguments_string})
+                   #{refiners_arguments_string},
+                   #{meta_attr_arguments_string})
       if deprecated_id
         warn 'second argument for add_person is deprecated. use id: instead'
         id = deprecated_id
@@ -124,15 +128,15 @@ module GEPUB
         role = deprecated_role
       end
       meta = add_metadata(name, content, id: id,
-			                    #{refiners_arguments_set_string},
-													#{meta_attr_arguments_set_string})
+                          #{refiners_arguments_set_string},
+                          #{meta_attr_arguments_set_string})
       yield meta if block_given?
       meta
     end
 
     def add_creator(content, deprecated_id = nil, deprecated_role = nil, id: nil, 
                     #{refiners_arguments_string},
-  									#{meta_attr_arguments_string}) 
+                    #{meta_attr_arguments_string}) 
       if deprecated_id
         warn 'second argument for add_creator is deprecated. use id: instead'
         id = deprecated_id
@@ -141,17 +145,17 @@ module GEPUB
         warn 'third argument for add_creator is deprecated. use role: instead'
         role = deprecated_role
       end
-			role = 'aut' if role.nil?
+      role = 'aut' if role.nil?
       meta = add_person('creator', content, id: id,
-			                    #{refiners_arguments_set_string},
-													#{meta_attr_arguments_set_string})
+                        #{refiners_arguments_set_string},
+                        #{meta_attr_arguments_set_string})
       yield meta if block_given?
       meta
     end
 
     def add_contributor(content, deprecated_id = nil, deprecated_role = nil, id: nil,
                         #{refiners_arguments_string},
-											  #{meta_attr_arguments_string}) 
+                        #{meta_attr_arguments_string}) 
       if deprecated_id
         warn 'second argument for add_contributor is deprecated. use id: instead'
         id = deprecated_id
@@ -161,32 +165,32 @@ module GEPUB
         role = deprecated_role
       end
       meta = add_person('contributor', content, id: id, 
-			                  #{refiners_arguments_set_string},
-												#{meta_attr_arguments_set_string})
+                         #{refiners_arguments_set_string},
+                         #{meta_attr_arguments_set_string})
       yield meta if block_given?
       meta
     end
 
-		def add_metadata(name, content, id: nil, itemclass: Meta,
-		#{refiners_arguments_string},
-		#{meta_attr_arguments_string}
-		)
-			meta = add_metadata_internal(name, content, id: id, itemclass: itemclass)
+    def add_metadata(name, content, id: nil, itemclass: Meta,
+                     #{refiners_arguments_string},
+                     #{meta_attr_arguments_string}
+                    )
+      meta = add_metadata_internal(name, content, id: id, itemclass: itemclass)
       #{refiners_string}.each do |refiner|
-				if refiner[:value]
-				  meta.refine(refiner[:name], refiner[:value])
-				end
-	    end	
-			if lang
-			  meta.lang = lang
-			end
-			if alternates
-			  meta.add_alternates alternates
-			end
+        if refiner[:value]
+           meta.refine(refiner[:name], refiner[:value])
+        end
+      end 
+      if lang
+        meta.lang = lang
+      end
+      if alternates
+        meta.add_alternates alternates
+      end
       yield meta if block_given?
-			meta
-		end
-	end
+          meta
+      end
+    end
 end
 EOF
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gepub
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - KOJIMA Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-02-24 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -39,7 +39,7 @@ dependencies:
         version: 1.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -49,7 +49,21 @@ dependencies:
         version: 1.1.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '2.3'
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: epubcheck-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +92,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: gepub is a generic EPUB parser/generator. Generates and parse EPUB2 and
   EPUB3
 email:
@@ -92,6 +120,7 @@ files:
 - ".github/workflows/gempush.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
+- ".rubocop.yml"
 - Gemfile
 - LICENSE.txt
 - README.md