epuber 0.5.6 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b03d446f6c71a6105554b794179ec35e719bc3a3c630ece5bd2607edbf379681
-  data.tar.gz: b8c27f00396dc720d1e5dfc13d92fa5d97061f58947217d873a173c2ce939f7d
+  metadata.gz: 6560c1375c0b773b66e5938c09a94767ad7a9e8dae29b670e469028828e88db9
+  data.tar.gz: e6c72d1f60af9ea5b2f60b7bd9ee044d8896abe0d3e0a8ebead44965a1971876
 SHA512:
-  metadata.gz: 632a864249f1e89cdf915e28bcfdd8e83dbae9f3b8b4c84d933ccb873eed6d4b5ef3ab74d6775af229e9b49b6e21f9d199fe8990a542ef5b12f50fb8eda3e30d
-  data.tar.gz: 9105843aac2528104ff2febf949ccd89e9a3efe9724e8a422c5a98de003563b3bd58643f5894964c5a787071b30325c64ace3e13414c2960058c28c2417e1291
+  metadata.gz: 40f4c800bb62695192e7934402dae40c34540b0eebc175cc951bce8d669e4e9d61c855864281b134945d9e5b51f41467fb329a1a66ca47b326af2383151b2956
+  data.tar.gz: aa8ad6eeba9f8f0223dc3a4a62aef8477a0a6c7444441f871eb3a4d7138f60f3891e27227c49f96076669b9842a87c9e10e271822cb78a03f80712b237bf74cb

data/Gemfile

@@ -1,8 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in Epuber.gemspec
 gemspec
 
-gem 'coveralls', require: false
+group :dev, optional: true do
+  gem 'debase', require: false
+  gem 'ruby-debug-ide', require: false
+end

data/README.md

@@ -1,6 +1,6 @@
 # Epuber
 
-[![Gem Version](https://badge.fury.io/rb/epuber.svg)](http://badge.fury.io/rb/epuber) [![Build Status](https://travis-ci.org/epuber-io/epuber.svg?branch=master)](https://travis-ci.org/epuber-io/epuber) [![Coverage Status](https://coveralls.io/repos/epuber-io/epuber/badge.svg?branch=master&service=github)](https://coveralls.io/github/epuber-io/epuber?branch=master) [![Inline docs](http://inch-ci.org/github/epuber-io/epuber.svg?branch=master)](http://inch-ci.org/github/epuber-io/epuber) [![Join the chat at https://gitter.im/epuber-io/epuber](https://badges.gitter.im/epuber-io/epuber.svg)](https://gitter.im/epuber-io/epuber?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Gem Version](https://badge.fury.io/rb/epuber.svg)](http://badge.fury.io/rb/epuber) [![Build Status](https://github.com/epuber-io/epuber/actions/workflows/tests.yml/badge.svg)](https://github.com/epuber-io/epuber/actions) [![Coverage Status](https://coveralls.io/repos/epuber-io/epuber/badge.svg?branch=master&service=github)](https://coveralls.io/github/epuber-io/epuber?branch=master) [![Inline docs](https://inch-ci.org/github/epuber-io/epuber.svg?branch=master)](https://inch-ci.org/github/epuber-io/epuber)
 
 Epuber is simple tool to compile and pack source files into EPUB format. Offers to define multiple "targets" which allows to create multiple versions of the book by running only one command. Eliminates copying code and information, eliminates needs to use _git_ branches to differ ebook content.
 
@@ -46,21 +46,21 @@ end
 
 Except for paths to plugins `book.use`, every path could be only name of the file, even without extension. So you can rename them, move them, the correct path will always resolved. Only exception is when the same name has more then one file.
 
-           | Epuber
------------|------------------------------------------------------------
-:book:     | Creates seamless workflow for creating ebooks
-:monorail: | Defines different _targets_ for several book stores (iBookstore, Google Play store, ...)
-:wrench:   | Extend and customise the functionality with _plugins_
-:pencil2:  | Defines _constants_ so you can have link to related book in proper book store
-:pencil:   | Defines mechanisms to deal with duplicated 
-:tophat:   | Easy setup assistant to get started in a few minutes
-:ghost:    | Automatically validates generated text so you don't have to worry about typos and other mistakes
-:rocket:   | Saves you **hours** when developing new or updating existing book
-:page_with_curl: | Supports template engines, CSS preprocessors and standard EPUB formats at the same time
-:computer: | Have local development web server to iterate and experiment quickly
-:loop:     | Automatically refresh web browser when some source file changes
-:bomb:     | Quick jumping through pages with arrow keys on keyboard
-:closed_book: | Supports EPUB 2 and 3
+|                 | Epuber                                                                                           |
+|-----------------|------------------------------------------------------------------------------------------------- |
+|:book:           | Creates seamless workflow for creating ebooks                                                    |
+|:monorail:       | Defines different _targets_ for several book stores (iBookstore, Google Play store, ...)         |
+|:wrench:         | Extend and customise the functionality with _plugins_                                            |
+|:pencil2:        | Defines _constants_ so you can have link to related book in proper book store                    |
+|:pencil:         | Defines mechanisms to deal with duplicated                                                       |
+|:tophat:         | Easy setup assistant to get started in a few minutes                                             |
+|:ghost:          | Automatically validates generated text so you don't have to worry about typos and other mistakes |
+|:rocket:         | Saves you **hours** when developing new or updating existing book                                |
+|:page_with_curl: | Supports template engines, CSS preprocessors and standard EPUB formats at the same time          |
+|:computer:       | Have local development web server to iterate and experiment quickly                              |
+|:loop:           | Automatically refresh web browser when some source file changes                                  |
+|:bomb:           | Quick jumping through pages with arrow keys on keyboard                                          |
+|:closed_book:    | Supports EPUB 2 and 3                                                                            |
 
 
 ## Installation
@@ -74,20 +74,20 @@ On OS X make sure you Xcode Command Line Tools installed:
     
     xcode-select --install
 
-And the easiest way to install prerequisites on OS X is to use [brew](http://brew.sh):
+And the easiest way to install prerequisites on macOS is to use [brew](http://brew.sh):
 
-    brew install imagemagick pkg-config
+    brew install imagemagick node pkg-config
 
 On Ubuntu, you can run:
 
-    sudo apt-get install libmagickwand-dev
+    sudo apt install libmagickwand-dev
 
 
 ### Finish
 
 Then just type following line to terminal:
 
-    sudo gem install epuber
+    [sudo] gem install epuber
 
 If everything goes well, try running following line in terminal:
 
@@ -106,12 +106,6 @@ To install this gem onto your local machine, run `bundle exec rake install`.
 Bug reports and pull requests are welcome on GitHub at https://github.com/epuber-io/epuber. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 
-## TODO
-
-- [ ] move all cards from Trello to GitHub
-- [ ] create documentation 
-- [ ] create several examples of book specification
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/bin/epuber

@@ -1,10 +1,9 @@
 #!/usr/bin/env ruby -Ku
-# encoding: utf-8
+# frozen_string_literal: true
 
-lib = File.expand_path('../lib', File.dirname(__FILE__))
+lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'epuber'
 
-
 Epuber::Command.run(ARGV)

data/epuber.gemspec

@@ -1,6 +1,4 @@
-# encoding: utf-8
-
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'epuber/version'
@@ -14,14 +12,15 @@ Gem::Specification.new do |spec|
   spec.summary  = 'Epuber is simple tool to compile and pack source files into EPUB format.'
   spec.homepage = Epuber::HOME_URL
   spec.license  = 'MIT'
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.files         = Dir['bin/**/*'] + Dir['lib/**/*'] + %w(epuber.gemspec Gemfile LICENSE.txt README.md)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '~> 5.0'
+  spec.add_runtime_dependency 'activesupport', '>= 6.0', '< 8.0'
+  spec.add_runtime_dependency 'addressable', '~> 2.7'
   spec.add_runtime_dependency 'nokogiri', '~> 1.8', '>= 1.8.2'
   spec.add_runtime_dependency 'mime-types', '~> 3.0'
   spec.add_runtime_dependency 'claide', '~> 1.0'
@@ -33,18 +32,17 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'sinatra-contrib', '~> 2.0'
   spec.add_runtime_dependency 'thin', '~> 1.6'
 
-  spec.add_runtime_dependency 'rmagick', '~> 2.14'
-  spec.add_runtime_dependency 'rubyzip', '~> 1.0'
+  spec.add_runtime_dependency 'rmagick', '~> 4.2'
+  spec.add_runtime_dependency 'rubyzip', '~> 2.3'
 
   spec.add_runtime_dependency 'epubcheck-ruby', '~> 4.0'
 
   spec.add_runtime_dependency 'epuber-stylus', '~> 1.1', '>= 1.1.1'
   spec.add_runtime_dependency 'coffee-script', '~> 2.4'
-  spec.add_runtime_dependency 'bade', '~> 0.2.4'
+  spec.add_runtime_dependency 'bade', '~> 0.3', '>= 0.3.1'
 
-  spec.add_development_dependency 'bundler', '~> 1.15'
   spec.add_development_dependency 'rspec', '~> 3.2'
-  spec.add_development_dependency 'rubocop', '~> 0.49'
-  spec.add_development_dependency 'rake', '~> 12.2'
-  spec.add_development_dependency 'fakefs', '~> 0.6'
+  spec.add_development_dependency 'rubocop', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'fakefs', '~> 1.3'
 end

data/lib/epuber/book/contributor.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Book

data/lib/epuber/book/file_request.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Book

data/lib/epuber/book/target.rb

@@ -1,10 +1,9 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../vendor/version'
 require_relative '../vendor/size'
 require_relative '../dsl/tree_object'
 
-
 module Epuber
   class Book
     require_relative 'file_request'

data/lib/epuber/book/toc_item.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../dsl/tree_object'
 
-
 module Epuber
   class Book
     require_relative 'file_request'

data/lib/epuber/book.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'dsl/object'
 
-
 module Epuber
   class Book < DSL::Object
     require_relative 'book/contributor'

data/lib/epuber/checker/text_checker.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'active_support/core_ext/string/access'
 

data/lib/epuber/checker.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'checker_transformer_base'
 
-
 module Epuber
   class Checker < CheckerTransformerBase
     require_relative 'checker/text_checker'

data/lib/epuber/checker_transformer_base.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 module Epuber
   class CheckerTransformerBase

data/lib/epuber/command/build.rb

@@ -1,11 +1,10 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'fileutils'
 require 'os'
 
 require_relative '../command'
 
-
 module Epuber
   class Command
     class Build < Command

data/lib/epuber/command/compile.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative 'build'
 

data/lib/epuber/command/init.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'fileutils'
 
@@ -6,7 +6,6 @@ require_relative '../templates'
 require_relative '../command'
 require_relative '../vendor/ruby_templater'
 
-
 module Epuber
   class Command
     class Init < Command

data/lib/epuber/command/server.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../command'
 require 'os'
 
-
 module Epuber
   class Command
     class Server < Command

data/lib/epuber/command.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'claide'
 

data/lib/epuber/compiler/compilation_context.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 
 module Epuber

data/lib/epuber/compiler/file_database.rb

@@ -1,8 +1,6 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
-require 'yaml'
-
+require 'psych'
 
 module Epuber
   class Compiler
@@ -22,8 +20,8 @@ module Epuber
       #
       def initialize(path)
         @store_file_path = path
-        @all_files = YAML.load_file(path) || {}
-      rescue
+        @all_files = Psych.load_file(path, permitted_classes: [Epuber::Compiler::FileStat, Time]) || {}
+      rescue StandardError
         @all_files = {}
       end
 

data/lib/epuber/compiler/file_finders/abstract.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_finders/imaginary.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Compiler
@@ -169,4 +169,3 @@ module Epuber
     end
   end
 end
-

data/lib/epuber/compiler/file_finders/normal.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_resolver.rb

@@ -1,6 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require_relative '../ruby_extensions/string'
 require 'active_support/core_ext/object/try'
 
 module Epuber

data/lib/epuber/compiler/file_stat.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # frozen_string_literal: true
 
 module Epuber

data/lib/epuber/compiler/file_types/abstract_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/bade_file.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'bade'
 
-
 module Epuber
   class Compiler
     module FileTypes

data/lib/epuber/compiler/file_types/coffee_script_file.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'coffee-script'
 
-
 module Epuber
   class Compiler
     module FileTypes

data/lib/epuber/compiler/file_types/container_xml_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/generated_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/ibooks_display_options_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler
@@ -24,8 +23,3 @@ module Epuber
     end
   end
 end
-
-
-
-
-

data/lib/epuber/compiler/file_types/image_file.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'rmagick'
 
-
 module Epuber
   class Compiler
     module FileTypes

data/lib/epuber/compiler/file_types/mime_type_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/nav_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/opf_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/source_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/static_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/file_types/stylus_file.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'epuber-stylus'
 
-
 module Epuber
   class Compiler
     module FileTypes

data/lib/epuber/compiler/file_types/xhtml_file.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler
@@ -9,7 +8,6 @@ module Epuber
       require_relative 'source_file'
 
       class XHTMLFile < SourceFile
-
         # @return [Epuber::Book::TocItem]
         #
         attr_accessor :toc_item
@@ -52,7 +50,7 @@ module Epuber
           compilation_context.perform_plugin_things(Transformer, :source_text_file) do |transformer|
             xhtml_content = transformer.call(abs_source_path, xhtml_content, compilation_context)
           end
-          
+
           # perform custom validation
           if compilation_context.should_check
             compilation_context.perform_plugin_things(Checker, :source_text_file) do |checker|

data/lib/epuber/compiler/generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'nokogiri'
 

data/lib/epuber/compiler/meta_inf_generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'mime-types'
 

data/lib/epuber/compiler/nav_generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require_relative '../book/toc_item'
 
@@ -121,7 +121,7 @@ module Epuber
           end
         end
 
-        if @target.epub_version >= 3 && toc_items.length > 0
+        if @target.epub_version >= 3 && toc_items.length > 0 && contains_item_with_title(toc_items)
           @xml.ol do
             iterate_lambda.call
           end
@@ -130,6 +130,10 @@ module Epuber
         end
       end
 
+      def contains_item_with_title(toc_items)
+        toc_items.any? { |a| a.title || contains_item_with_title(a.sub_items) }
+      end
+
       # @param toc_item [Epuber::Book::TocItem]
       #
       def visit_toc_item(toc_item)

data/lib/epuber/compiler/opf_generator.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'time'
 

data/lib/epuber/compiler/problem.rb

@@ -1,5 +1,4 @@
-# encoding: utf-8
-
+# frozen_string_literal: true
 
 module Epuber
   class Compiler

data/lib/epuber/compiler/xhtml_processor.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'nokogiri'
-require 'uri'
+require 'addressable'
 
 
 module Epuber
@@ -20,6 +20,8 @@ module Epuber
       # @return [Nokogiri::XML::Document] parsed document
       #
       def self.xml_doc_from_str_with_errors(text, file_path = nil)
+        text = text.dup
+
         if /\A[\n\r ]+(<\?xml)/ =~ text
           UI.warning('XML header must be at the beginning of document', location: UI::Location.new(file_path, 1))
 
@@ -208,7 +210,7 @@ module Epuber
           uri = URI(path)
         rescue URI::InvalidURIError
           begin
-            uri = URI(URI::encode(path))
+            uri = URI(Addressable::URI.encode(path))
           rescue URI::InvalidURIError
             # skip not valid uri
             raise UnparseableLinkError, "Unparseable link `#{path}`"