gepub 1.0.14 → 1.0.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d719e4054e3b1ab330d8af93992edfc35ebaa355878ee0c623709ddff612f3d
-  data.tar.gz: d20aa19004c3591f7e17a5275fd957b5b1650514a8206ffe301e162fbec2a4af
+  metadata.gz: 93cb58ca825f4f30efeb8f1ce191ccf9bbb2e74d32f9cfd77f37dedb85cc7a3e
+  data.tar.gz: da3618e21ad20a7f6a12c4d52fe43d1159ecdd378a5eb4bae39d1eb2558fb605
 SHA512:
-  metadata.gz: 9070b08171d351372c4a46e0ac489d2a077f3dd106d52346358a895a4ac9036e9162699e7f72124381a7d53903c96dcaa438ef6a31d2b0d1832267cff4ba4b8a
-  data.tar.gz: c9914d0a1340504905c09b2afc591a6aa99c15e5ba219958dcbcb56fdbdb2caa5702950ef614b97977521088e0e30b068eae1098c048a946e6423eeb2e6dee9b
+  metadata.gz: 0ba5fbbd7590739ef20d73af2cc3b50811c0ba330959cc784a6246bb13dbd249d32a0c9fbe3c31adb15ae4e4b9c69a7c7988cc5c62b8b6e65cdf9c105eed85d6
+  data.tar.gz: bb66bd6e2f564ed780e0417b91e43993fb0ece0fc938095a31d10fdfff56b9c77d290df812e3ff94feb64256ac1b21e06aa2a36fb29553b6145ee89644c2f684

data/.github/workflows/gempush.yml

@@ -11,10 +11,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@master
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 3.1.x
 
     - name: Publish to GPR
       run: |

data/.github/workflows/test.yml

@@ -4,13 +4,13 @@ jobs:
   test:
     strategy:
       matrix:
-        ruby: [2.5, 2.6, 2.7, 3.0, jruby]
+        ruby: [2.7, 3.0, 3.1, 3.2, 3.3, jruby]
         platform: [ubuntu-latest, macos-latest, windows-latest]
     runs-on: ${{ matrix.platform }}
     env:
       CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
@@ -18,12 +18,12 @@ jobs:
     - name: setup gems
       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
+      if: runner.os == 'Linux' && matrix.ruby == '3.3' && env.CC_TEST_REPORTER_ID != ''
+      uses: paambaati/codeclimate-action@v5.0.0
       env:
         CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
       with:
         coverageCommand: bundle exec rake spec
     - name: run test
-      if: runner.os != 'Linux' || matrix.ruby != '2.7' || env.CC_TEST_REPORTER_ID == ''
+      if: runner.os != 'Linux' || matrix.ruby != '3.3' || env.CC_TEST_REPORTER_ID == ''
       run: bundle exec rake spec

data/.gitignore

@@ -19,8 +19,6 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-testepub*.epub
-example_test*.epub
 
 ## BUNDLER
 Gemfile.lock

data/Gemfile

@@ -3,6 +3,4 @@ source "http://rubygems.org"
 # Specify your gem's dependencies in gepub.gemspec
 gemspec
 
-# workarond : simplecov 0.18 with cc-reporter is broken
-# https://github.com/codeclimate/test-reporter/issues/418
 gem 'simplecov', '~> 0.21', require: false

data/README.md

@@ -5,7 +5,7 @@
 [![Test Coverage](https://api.codeclimate.com/v1/badges/acd6df07e071a4bbb399/test_coverage)](https://codeclimate.com/github/skoji/gepub/test_coverage)
 [![Gem Version](https://badge.fury.io/rb/gepub.svg)](http://badge.fury.io/rb/gepub)
 
-* http://rdoc.info/github/skoji/gepub/main/frames
+* https://rubydoc.info/github/skoji/gepub
 
 ## DESCRIPTION:
 
@@ -13,12 +13,12 @@ a generic EPUB parser/generator library.
 
 ## FEATURES/PROBLEMS:
 
-* GEPUB::Book provides functionality to create EPUB file, and parsing EPUB files
+* GEPUB::Book provides functionality to create EPUB files and parse EPUB files
 * Handle every metadata in EPUB2/EPUB3.
 
 * See [issues](https://github.com/skoji/gepub/issues/) for known problems.
 
-If you are using GEPUB::Builder and do not like its behaviour(e.g. the block inside is evaluated as inside the Builder instance), please consider using GEPUB::Book directly.
+If you are using GEPUB::Builder and do not like its behavior (e.g., GEPUB::Builder evaluates the block as inside the Builder instance),  consider using GEPUB::Book directly.
 
 ## SYNOPSIS:
 
@@ -98,9 +98,9 @@ book.ordered {
 }
 epubname = File.join(File.dirname(__FILE__), 'example_test.epub')
 
-# if you do not specify your own nav document with add_item, 
-# simple navigation text will be generated in generate_epub.
-# auto-generated nav file will not appear on spine.
+# if you do not specify a nav document with add_item, 
+# generate_epub will generate simple navigation text.
+# auto-generated nav file will not appear on the spine.
 book.generate_epub(epubname)
 ```
  * [examples in this repository](https://github.com/skoji/gepub/tree/main/examples/) 
@@ -112,4 +112,3 @@ book.generate_epub(epubname)
 ## DONATE:
 
 * Bitcoin Address: `1M69AwoxpgPZsp5KStLUEjP7so5dHVfDTH`
-

data/gepub.gemspec

@@ -16,7 +16,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.13"
+  s.add_runtime_dependency "nokogiri", ">= 1.8.2", "< 2.0"
   s.add_runtime_dependency "rubyzip", "> 1.1.1", "< 2.4"
   s.add_development_dependency "epubcheck-ruby"
   s.add_development_dependency "rake"

data/lib/gepub/bindings.rb

@@ -3,6 +3,8 @@ require 'nokogiri'
 module GEPUB
   class Bindings
     include XMLUtil
+    include InspectMixin
+
     class MediaType
       attr_accessor :handler, :media_type
       def initialize(handler, media_type)

data/lib/gepub/book.rb

@@ -79,6 +79,8 @@ module GEPUB
   # set page-proression-direction attribute to spine.
 
   class Book
+    include InspectMixin
+
     MIMETYPE='mimetype'
     MIMETYPE_CONTENTS='application/epub+zip'
     CONTAINER='META-INF/container.xml'
@@ -100,14 +102,14 @@ module GEPUB
       package = nil
       package_path = nil
       book = nil
-      Zip::InputStream::open(io) {
-        |zis|
-        package, package_path = parse_container(zis, files)
+      Zip::File.open_buffer(io) do
+        |zip_file|
+        package, package_path = parse_container(zip_file, files)
         check_consistency_of_package(package, package_path)
         parse_files_into_package(files, package)
         book = Book.new(package.path)
         book.instance_eval { @package = package; @optional_files = files }
-      }
+      end
       book
     end
 
@@ -377,12 +379,12 @@ EOF
     end
     
     private
-    def self.parse_container(zis, files) 
+    def self.parse_container(zip_file, files) 
       package_path = nil
       package = nil
-      while entry = zis.get_next_entry
+      zip_file.each do |entry|
         if !entry.directory?
-          files[entry.name] = zis.read
+          files[entry.name] = zip_file.read(entry)
           case entry.name
           when MIMETYPE then
             if files[MIMETYPE] != MIMETYPE_CONTENTS

data/lib/gepub/inspect_mixin.rb

@@ -0,0 +1,26 @@
+module GEPUB
+  module InspectMixin
+    def inspect
+      result = instance_variables.each
+        .with_object({}) { |name, h| h[name] = instance_variable_get(name) }
+        .reject { |name, value| value.nil? }
+        .map { |name, value|
+          case value
+          when true, false, Symbol, Numeric, Array, Hash
+            "#{name}=#{value.inspect}"
+          when String
+            if value.length > 80
+              "#{name}=(omitted)"
+            else
+              "#{name}=#{value.inspect}"
+            end
+          else
+            "#{name}=#<#{value.class.name}>"
+          end
+        }
+        .join(' ')
+
+      "#<#{self.class.name} " + result + '>'
+    end
+  end
+end

data/lib/gepub/item.rb

@@ -6,6 +6,8 @@ module GEPUB
   # #id, #id=, #set_id, #href, #href=, #set_href, #media_type, #media_type=, #set_media_type,
   # #fallback, #fallback=, #set_fallback, #media_overlay, #media_overlay=, #set_media_overlay
   class Item
+    include InspectMixin
+
     attr_accessor :content
     def self.create(parent, attributes = {})
       Item.new(attributes['id'], attributes['href'], attributes['media-type'], parent,
@@ -46,12 +48,14 @@ module GEPUB
       media_type
     end
 
-    def [](x)
-      @attributes[x]
+    # get +attribute+
+    def [](attribute)
+      @attributes[attribute]
     end
 
-    def []=(x,y)
-      @attributes[x] = y
+    # set +attribute+
+    def []=(attribute, value)
+      @attributes[attribute] = value
     end
 
     # add value to properties attribute.

data/lib/gepub/manifest.rb

@@ -3,6 +3,8 @@ require 'nokogiri'
 module GEPUB
   class Manifest
     include XMLUtil
+    include InspectMixin
+
     attr_accessor :opf_version
     def self.parse(manifest_xml, opf_version = '3.0', id_pool = Package::IDPool.new)
       Manifest.new(opf_version, id_pool) {

data/lib/gepub/meta.rb

@@ -16,12 +16,14 @@ module GEPUB
       @parent.register_meta(self) unless @parent.nil?
     end
 
-    def [](x)
-      @attributes[x]
+    # get +attribute+
+    def [](attribute)
+      @attributes[attribute]
     end
 
-    def []=(x,y)
-      @attributes[x] = y
+    # set +attribute+
+    def []=(attribute, value)
+      @attributes[attribute] = value
     end
 
     def refiner_list(name)

data/lib/gepub/metadata.rb

@@ -18,6 +18,8 @@ module GEPUB
       end
     end
     include XMLUtil, DSLUtil
+    include InspectMixin
+
     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)

data/lib/gepub/metadata_add.rb

@@ -138,7 +138,7 @@ module GEPUB
         meta.add_alternates alternates
       end
       yield meta if block_given?
-          meta
-      end
+      meta
     end
+  end
 end

data/lib/gepub/package.rb

@@ -6,6 +6,8 @@ module GEPUB
   # Holds data in opf file.
   class Package
     include XMLUtil, DSLUtil
+    include InspectMixin
+
     extend Forwardable
     attr_accessor :path, :metadata, :manifest, :spine, :bindings, :epub_backward_compat, :contents_prefix, :prefixes 
     def_delegators :@manifest, :item_by_href
@@ -142,15 +144,16 @@ module GEPUB
                     })
     }
 
-    def [](x)
-      @attributes[x]
+    # get +attribute+
+    def [](attribute)
+      @attributes[attribute]
     end
 
-    def []=(k,v)
-      @attributes[k] = v
+    # set +attribute+
+    def []=(attribute, value)
+      @attributes[attribute] = value
     end
 
-
     def identifier(identifier=UNASSIGNED)
       if unassigned?(identifier)
         @metadata.identifier_by_id(unique_identifier)

data/lib/gepub/spine.rb

@@ -3,6 +3,8 @@ require 'nokogiri'
 module GEPUB
   class Spine
     include XMLUtil
+    include InspectMixin
+
     attr_accessor :opf_version
     class Itemref
       def self.create(parent, attributes = {})
@@ -26,14 +28,16 @@ module GEPUB
         define_method(methodbase) { @attributes[name] }
       }
 
-      def [](x)
-        @attributes[x]
+      # get +attribute+
+      def [](attribute)
+        @attributes[attribute]
       end
 
-      def []=(x,y)
-        @attributes[x] = y
+      # set +attribute+
+      def []=(attribute, value)
+        @attributes[attribute] = value
       end
-      
+
       def add_property(property)
         (@attributes['properties'] ||=[]) << property
       end

data/lib/gepub/version.rb

@@ -1,4 +1,4 @@
 module GEPUB
   # GEPUB gem version
-  VERSION = "1.0.14"
+  VERSION = "1.0.16"
 end

data/lib/gepub.rb

@@ -4,6 +4,7 @@ end if RUBY_VERSION < "2.7" && !(defined? ruby2_keywords)
 require 'gepub/version'
 require 'gepub/dsl_util'
 require 'gepub/xml_util'
+require 'gepub/inspect_mixin'
 require 'gepub/meta'
 require 'gepub/datemeta'
 require 'gepub/meta_array'

data/tools/generate_function.rb

@@ -1,3 +1,4 @@
+require_relative '../lib/gepub/inspect_mixin.rb'
 require_relative '../lib/gepub/item.rb'
 attrs = GEPUB::Item::ATTRIBUTES.select do |attr|
   attr != 'href'
@@ -188,9 +189,9 @@ module GEPUB
         meta.add_alternates alternates
       end
       yield meta if block_given?
-          meta
-      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.14
+  version: 1.0.16
 platform: ruby
 authors:
 - KOJIMA Satoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-08-04 00:00:00.000000000 Z
+date: 2024-04-27 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.13'
+        version: '2.0'
   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.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rubyzip
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +143,7 @@ files:
 - lib/gepub/builder_mixin.rb
 - lib/gepub/datemeta.rb
 - lib/gepub/dsl_util.rb
+- lib/gepub/inspect_mixin.rb
 - lib/gepub/item.rb
 - lib/gepub/manifest.rb
 - lib/gepub/meta.rb
@@ -177,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: a generic EPUB library for Ruby.